The following are the steps to install and set-up the Cloudinary module on your Magento site.
Download and Install the Module
In the Magento Marketplace, download and install the Cloudinary module for Magento 1.
For more information, see the help pages for the Magento Marketplace.
After installing the Cloudinary module, a new Cloudinary menu is available in the Magento Admin Panel.
Configure the Cloudinary Module
- In the Admin Panel, select Cloudinary > Configuration.
- In the Cloudinary Setup section:
- In Cloudinary Account Credentials, enter your CLOUDINARY_URL environment variable, as shown in the Dashboard of your Cloudinary console (including the "CLOUDINARY_URL=" part of the code). For example:
- Set Enable Cloudinary to Yes.
- If needed, adjust the default Cloudinary Configuration settings. For more details on the auto-mapping option, see "Migrate on Demand with Auto-Mapping (Recommended)" below.
- The Default Image Transformations section enables you to define the default transformations that will be applied to every asset you deliver via Cloudinary. In addition to setting your preferences for the specific transformation options in this section, you can add additional global custom transformations that will be applied to every image asset.
For details on transformations you can use for global custom transformations, see Cloudinary's image transformation guide and reference.
Click the Preview custom transformation button to make sure you are satisfied with your transformation settings.
- When finished, click the Save config button at the top of the page.
Migrate on Demand with Auto-Mapping (Recommended)
Auto upload mapping eliminates the need for manual migration. This option automatically fetches individual images from your Magento environment when they are first requested and uploads them to Cloudinary. On all subsequent page loads, the images will automatically be served directly from your Cloudinary Media Library.
To enable auto mapping:
- In the Magento Admin Panel, Cloudinary Configuration form, make sure that the Use auto upload mapping to upload images option is set to Yes (default). For details, see "Configure the Module" above.
- In the Magento Admin Panel, select System > Cache Management.
- Select all required cache types. Then select Refresh from the Actions drop-down above the options grid and click the Submit button.
Migrate All Images to Cloudinary (Manual Migration Fallback)
Manual migration is not required if you have enabled auto-mapping as described above. The manual migration option performs a full bulk migration of all images in your Magento environment.
- Make sure you have cron jobs defined on your Magento server.
- In the Magento Admin Panel, select Cloudinary > Manual Migration.
- Click Start Migration.
The migration takes place in the background via cron, so you can close the Manual Migration page or keep it open to track its progress. Any errors that prevent migration will be shown on the Manual Migration page. If this happens, click the Stop Migration button, resolve the problem, and then start the migration again.
- When the migration is complete, select System > Cache Management. Select all required cache types. Then select Refresh from the Actions drop-down above the options grid and click the Submit button.
Note that the initial migration process may take a while, especially if you have many images.