Appearance
Installation
Imager X 6.0 requires Craft 5.0 or newer.
To install Imager X, follow these steps:
- Install with composer via
composer require spacecatninja/imager-xfrom your project directory. - Install the plugin in the Craft Control Panel under Settings → Plugins, or from the command line via
./craft install/plugin imager-x. - Configure it, and you're off to space!
TIP
Imager X supports both GD and Imagick as image drivers, but please note that some features may not be available in all combinations of Imagick/ImageMagick. In particular, Imagick 3.4.4 compiled against ImageMagick 6.x, deprecates alot of methods, without providing alternatives. Due to how errors are handled in Imagine, this causes some issues with some of the effects.
Upgrading from Imager X 5.0 to 6.0
In Imager X 6.0, some functionality with external dependencies has been extracted into separate plugins. If you were using any of these features in 5.0, you will need to install the corresponding plugin(s):
| Feature | Plugin | Composer package |
|---|---|---|
| Imgix transformer | Imager X Imgix Transformer | spacecatninja/imager-x-imgix-transformer |
| AWS S3 external storage | Imager X AWS Storage Driver | spacecatninja/imager-x-aws-storage-driver |
| Google Cloud Storage | Imager X GCS Storage Driver | spacecatninja/imager-x-gcs-storage-driver |
| Kraken optimizer | Imager X Kraken Optimizer | spacecatninja/imager-x-kraken-optimizer |
| Tinify optimizer (previously "tinypng") | Imager X Tinify Optimizer | spacecatninja/imager-x-tinify-optimizer |
TIP
If you used the Imgix transformer in Imager X 5, you need to install the plugin and migrate your settings over to the plugins config file. The settings has been renamed, refer to the plugin documentation for details.
TIP
Note that the Tinify optimizer was previously called "tinypng" in Imager X 5. When upgrading, replace any references to tinypng in your optimizer config with tinify.
Refer to the respective plugin's documentation for setup instructions.
Upgrading from Imager X 4.0 to 5.0
There should be no breaking changes going from 4.0 to 5.0.
Upgrading from Imager X 3.0 to 5.0
There should be no breaking changes going from 3.0 to 5.0. A couple of things that was marked as deprecated in 3.0 was removed in 4.0, so make sure you solve any deprecation errors in Craft 3.0 before upgrading.