Skip to content

akeeba/social-magick

Repository files navigation

SocialMagick

Automatically generate OpenGraph data and images for Joomla! content.

Warning

🚧 Work In Progress 🚧 This project was recently transferred from Lucid Fox to Akeeba Ltd. We are actively reworking it.

What is this

This plugin allows you to automatically generate OpenGraph images for your site's pages, superimposing text and graphics over an image or a solid colour background. OpenGraph images are used by social media sites when sharing a URL to any of your site's pages on them.

Tip

If you want to preview your site's OpenGraph images you can use third-party sites such as metatags.io and opengraph.dev.

Requirements

This extension has the following minimum requirements:

  • Joomla 5.3 or later
  • PHP 8.1, 8.2, 8.3, or 8.4
  • The Imagick or GD PHP extension is installed and enabled. (If you're not sure how to do this, ask your host.)

Quick start

  • Download and install the ZIP file.
  • Review the templates in Components, SocialMagick, Templates.
  • Edit the menu item you want to have OpenGraph images automatically generated. It is in the “OpenGraph images” tab.
  • Set “Generate OpenGraph images” to Yes.
  • Select a template, e.g. the Solid template.
  • Save your menu item.
  • Go to metatags.io and paste the URL to the page of your site that corresponds to the menu item you selected. You can now see that it has a preview image.

If you have menu items with core content (Joomla articles) categories and articles which make use of images, you can select the Overlay template. You will need to set the “Extra image source” option to “Intro image” or “Full Article image”, depending on which image you want to use.

The templates provided are meant as examples; while you are welcome to use them on your live site, you can also replace the template images with ones that do not have the SocialMagick watermark.

History

This plugin was conceived in 2021 by Crystal Dionysopoulos of Lucid Fox. The code was written and had been maintained by us, with Crystal acting as the creative director. In 2025 Crystal decided to step back and transfer full ownership of the product back to us.

TODO

This is meant as a quick brain-dump. Things here may or may not be implemented and may end up becoming issues to handle later...

  • Document that imagick or gd are required. Explain how you can use the PHP Information page in Joomla to determine if they are installed. Explain that if it's not enabled you can do that from the hosting control panel, or ask your host.
  • Document that SVGs are only supported using ImageMagick.
  • Document image colorisation: underlay and desaturate the Extra Image, apply a semi-transparent Background Color.
  • Document that the lang strings are in the backend, but the overrides must be set for BOTH backend AND frontend
  • Extra image crop focus: face [gh-10]
  • Auto-generating article intro and/or full text images [gh-6] (Check that the cache ID / sum matches the one used for the current intro image; we may have to store extra info in the article.)

About

An Open Graph Image generator plugin for Joomla 3 and 4

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •