Cloudimage - Documentation

Magento plugin

The easiest way to use Cloudimage with Magento is via our plugin. This Magento 2 module implements the Cloudimage Responsive Images Plugin on Magento 2 shops and accelerates your shop's landing page, category and product pages.

github

Photo alt \#responsive

You can follow the steps below to install and configure the Magento plugin. If you prefer to implement Cloudimage manually or you cannot use the plugin, you can follow the Manual implementation tutorial.

Step 1: Create an account if you have not registered already

You can create an account on the Cloudimage registration page.

Photo alt \#responsive

Step 2: Install the Cloudimage module

To be able to install the module by Composer, you need to get a copy of the module on the Magento Marketplace, or directly from Github.

composer config repositories.cloudimage vcs https://github.com/scaleflex/magento-cloudimage-responsive
composer require cloudimage/module-responsive-plugin --sort-packages

Enable and install module in Magento:

php bin/magento module:enable Cloudimage_Responsive
php bin/magento setup:upgrade

Step 3: Activate the Cloudimage module

Activate the module and enter your Cloudimage token in the module configuration in Magento admin interface: Stores / Configuration / Cloudimage by Scaleflex / Cloudimage Responsive:

Photo alt \#responsive

Step 4: Configure the module

optiondescription
Use origin URLIf enabled, the module will only add query parameters to the image source URL without prefixing it with {token}.cloudimg.io. This is required if you use a dedicated subdomain for delivering your images (media) in Magento. You will need to enable a custom CNAME in Cloudimage.
Ignore Image Size NodeUseful for improving compatibility with some themes.
Ignore Image Size StyleUseful for improving compatibility with some themes.
Lazy LoadingIf enabled, images will be lazy-loaded for better loading times and user experience.

Step 5: Advanced settings (optional)

This setting is for advanced users only and allows to inject a custom JS function into the Magento templates in order to support some specific Magento templates. Feel free to contact us in order to get the custom JS function to address issues with your specific template.

optiondescription
Inject Custom JS functionIf enabled, you will be able to customize the JS function used to get the DOM information dynamically.
Custom JS functionThe JS function to customize Cloudimage library.

Step 6: Custom themes (optional)

Once activated, the Cloudimage Responsive module will replace your template's classic image tag elements on-the-fly. This functionality is 100% compatible with the Magento Luma theme.

In the case of a personalized template, please consult the Manual integration in Magento templates section in the Cloudimage plugin Github page.