Using the Sirv extension for Magento (and Adobe Commerce)

On this page

The Sirv CDN extension for Magento (also called Adobe Commerce) is the best way to optimize and deliver your images rapidly. It can also replace your default media gallery with Sirv Media Viewer, to conveniently showcase 360 spins, videos and zoomable images.

Use the Sirv CDN extension to:

  • Optimize product images, WYSIWYG images, JS, CSS and static files.
  • Deliver these files rapidly in next-gen formats (e.g. WebP) from Sirv's CDN.
  • Resize images on-the-fly and lazy load them.
  • Use Sirv Media Viewer for 360 spins, product video & image zoom.

Learn more about the Magento CDN extension key features.


  1. Download the Sirv Magento 2 extension as a zip, or from Packagist or from the Magento 2 image CDN extension Marketplace listing.
  2. Install the extension and activate it from the command line:
    php -f bin/magento module:enable Sirv_Magento2 --clear-static-content
    php -f bin/magento setup:upgrade
    rm -rf var/generation
    php -f bin/magento setup:di:compile
    php -f bin/magento setup:static-content:deploy
  3. Go to the Sirv extension options, via System > Sirv CDN > Configuration:
    Sirv Settings navigation
  4. Log in to an existing Sirv account or create a new one:
    Magento Sirv registration

You'll receive 5 GB storage and 20 GB bandwidth for 30 days. After your free trial expires, you may choose either a paid plan or a free one (500 MB storage, 2 GB bandwidth and branding on Sirv Media Viewer).

How to set up your CDN in Magento 2

  1. Enable Sirv on the configuration page:
    Sirv settings in Magento 2

    Click to view all the settings (screenshot).

  2. Enter a folder name where images should be copied to, or keep the default name.
    Choose folder name for Magento image sync
  3. Choose to serve JS, CSS and associated files. If Sirv serves your JS, CSS and static files too, they will be minified and delivered rapidly from Sirv's CDN, benefitting from HTTP/2 and TLS 1.3.
    JS & CSS file CDN for Magento 2
  4. Enable lazy loading, to load images only when they enter in the viewport and to scale images to the correct dimensions:
    Enable Magento lazy loading images
  5. Choose a profile (optional):
    Profile optons in Magento 2

    Profiles are one of Sirv's powerful features, to apply transformations to images. You can tweak image quality, format, text overlays, watermarks and many other options, without altering your original images.

  6. Click the "Save Settings" button:

    Sirv M2 extension save settings button

ImportantRefresh your Magento page cache after modifying settings, to ensure you see the latest changes.

Congratulations, Sirv is now running on your Magento store! Enjoy the best possible image optimization, next-gen image formats and lightning-fast CDN page loading.

Image synchronization

Sirv will automatically copy your Magento images to Sirv, the first time they are requested. Visitors will receive images from Magento until they have synced, then future requests will be returned by Sirv - resized, optimized, cached and rapidly delivered from our Magento CDN.

The image sync status is shown on your settings page:

Sirv image synchronisation in Magento 2

The Sirv CDN extension for Magento will automatically stay in sync by copying new images to your Sirv account upon first request. You can also pre-sync your entire media gallery. It's a heavy process, so not suitable when testing but great before going live, for fastest possible loading. Click the "Sync Media Gallery" button.

You can replace your default Magento product gallery with the sophisticated Sirv Media Viewer, enabling you to add 360 spins, videos and additional images to your product gallery. It's highly customizable, optimized for speed and provides an outstanding mobile experience.

Here's a live demo:

How to add zoom, 360 spins and videos to Magento 2

  1. Choose the Sirv Media Viewer option:
    Sirv Media Viewer in Magento 2
  2. Select the source for the media to be included in your gallery - either Magento, Sirv or both:
    Sirv Media Viewer order of content in Magento 2

    Uploading directly to Sirv is popular because it's fast and easy. Unlike Magento, Sirv supports all types of media - 360 spins, streaming videos and 8 types of image zoom.

  3. Select the folder naming convention that you will use to upload media directly to Sirv. Use either {product-sku} or {product-id} convention:
    Sirv Media Viewer assets folder setting in Magento 2

    Create a master folder in your Sirv account, for example, a folder named 'products':


    Then create subfolders for each product, naming each one to match your SKUs or product IDs. A product with SKU 24-MB01 would be:


    Then upload the 360 spins, videos and images for that product, for example:


    AUTOMATION TIPUse the Sirv REST API or the S3 API to upload and manage files programmatically.

    Here's how the folder might look in Sirv:

    Sirv folder screenshot
  4. Flush the asset info cache in Sirv settings and remember to refresh Magento's page cache too:
    Flush product asset cache

Job done!

Here's how Sirv Media Viewer might look on the front-end:

Sirv Media Viewer on Magento Front front-end


Sirv Media Viewer is very customizable. You can change plenty of zoom, 360 spin, video options, as well as viewer options.

For really easy configuration, we've created a live interactive demo, for you to tweak every single option and copy the configuration code.

Sirv Media Viewer options in Magento

Paste the resulting code into the "Sirv Media Viewer" options text box:

Sirv Media Viewer options in Magento


You can translate text into other languages by applying different settings per store view.

English language is used by default for hints and buttons. To change the language, use the interactive demo to choose your text, then copy and paste the settings into the Sirv Media Viewer options box for that store view.

The options below would change "Click to zoom" and "Hover to zoom" to French:

SirvOptions = {
  viewer: {
    zoom: {
      hint: {
        text: {
          click: 'Cliquez pour zoomer',
          hover: 'Survolez pour zoomer'

Usage stats

A summary of your storage, transfer and API usage is shown on your Sirv settings page:

Sirv Stats in Magento 2

For detailed statistics, visit your Analytics page.


Can this work on localhost?
Yes, the extension can be used on localhost, with some limitations. Images will be synced to Sirv using our S3 API (not our REST API) and the option to serve media files (JS/CSS/etc.) won't work.

Should I use the same account for staging and live?
If you have multiple environments e.g. development, staging, UAT and live, there are 2 possible configurations to consider:

  • If product images have the same names and locations, use one Sirv account and the same master folder. This will allow faster sync. If you have enabled Sirv's option to sync JS/CSS/static and media files, then enable that option only on the live environment.
  • If product images have different names or locations, use one Sirv account per environment. This will avoid any possible conflicts but requires extra time and storage space to sync images.

How do I add a YouTube video to a product gallery?
You can add YouTube URLs to your Magento products in the normal way, on the Products page in Magento admin. The video will automatically appear in Sirv Media Viewer on your product page. See Magento for more about adding videos to products.

Add YouTube videos to Magento products


The Sirv support team is ready to help you. As Magento experts, they can install the extension for you, assist you with customization, or configure Sirv on highly customized Magento sites. Contact the team with your requirements.


  • v6.1.5
    September 27, 2023

    Small bugs fixed.

  • v6.1.4
    September 25, 2023

    Added product attribute 'Extra Sirv assets' to add extra images, videos, 360 spins or GLB models to the product page gallery.
    Added support for 'Catalog media URL format' option.
    Added improvements to more accurately calculate the index of the first slide in the product page gallery.
    Added improvements to module settings page.
    Small bugs fixed.

  • v6.1.3
    July 11, 2023

    Added 3D model support (GLB).
    Added improvements to module settings page.
    Small bugs fixed.

  • v6.1.2
    March 15, 2023

    Added improvements for "Product folder names on Sirv" option.
    Added Two-factor authentication support.
    Small bugs fixed.

  • v6.1.1
    January 31, 2023

    Optimized media gallery size calculation process.
    Added improvements for "Product folder names on Sirv" option.
    Small bugs fixed.

  • v6.1.0
    November 14, 2022

    Added option to choose Sirv JS features.
    Added lazy loading exclusion based on IMG tag properties.
    Redesigned auto fetch configuration logic.
    Optimized REST API usage.
    Better PHP 8 compatibility.
    Improved module settings page.
    Small bugs fixed.

  • v6.0.2
    October 11, 2022

    Small bugs fixed.

  • v6.0.1
    August 23, 2022

    Improved support for Magento v2.3.

  • v6.0.0
    August 19, 2022

    Improved process of copying primary images.
    Added 'Exclude images' option.
    Optimization of asset caching.
    Added feature to display Sirv image in product list when product gallery has no image.
    Added 'HTTP authentication' option for image synchronization.
    Improved module settings page.
    Small bugs fixed.

  • v5.2.2
    April 14, 2022

    Added support for Magento_CatalogStaging module.
    Small bugs fixed.

  • v5.2.1
    February 4, 2022

    Choice of 3 options to scale images to fit their container.
    Minor improvements to text and admin layout.

  • v5.2.0
    January 27, 2022

    Added option to apply image placeholders.
    Added option to add width/height for <img> tags.
    Improved module settings page.
    Small bugs fixed.

  • v5.1.2
    December 25, 2021

    Added ability to copy primary spin image from Sirv to Magento.
    Improved module settings page.

  • v5.1.1
    December 17, 2021

    Small bugs fixed.

  • v5.1.0
    November 29, 2021

    Added option to copy primary images from Sirv to Magento.
    Improved module settings page.
    Code optimization.
    Small bugs fixed.

  • v5.0.0
    September 3, 2021

    Added option to choose which domain files are served from.
    Added option to easily change the order of gallery items.
    Added option to pin items in the gallery.
    Improved layout of module settings page.
    Small bugs fixed.

  • v4.1.0
    June 30, 2021

    Added 'Sirv content cache TTL' option.
    Improved module settings page.
    Small bug fixed.

  • v4.0.0
    May 21, 2021

    Module name changed.
    Added 'Exclude page URLs' option.
    Added 'Exclude file URLs' option.
    Added 'Image zoom' option.
    Improved module settings page.
    Improved synchronization process.

  • v3.3.4
    April 19, 2021

    Small bug fixed.

  • v3.3.3
    January 21, 2021

    Added 'Custom CSS' option.
    Improved module settings page.

  • v3.3.2
    January 14, 2021

    Improved CDN usage logic.
    Small bug fixed.

  • v3.3.1
    December 28, 2020

    Improved module settings page.
    Small bug fixed.

  • v3.3.0
    December 16, 2020

    Added per store view configuration.
    Added image lazy loading option.
    Added streamlined sirv.js component selection.
    Improved module settings page.
    Small bug fixed.

  • v3.2.5
    December 2, 2020

    Small bug fixed.

  • v3.2.4
    November 12, 2020

    Improved module settings page.
    Small bug fixed.

  • v3.2.3
    October 8, 2020

    Improved Auto-Fetch feature.
    Improved module settings page.
    Small bug fixed.

  • v3.2.2
    August 5, 2020

    Improved support for third-party modules.
    Improved Auto-Fetch feature.
    Small bug fixed.

  • v3.2.1
    July 23, 2020

    Added 'Image quality' option.
    Added 'Max height' option.
    Small bug fixed.
    Improved module settings page.
    Added small performance improvements.

  • v3.2.0
    July 6, 2020

    Added Auto-Fetch feature for JS, CSS & static file CDN serving.
    More elegant module settings page.
    Improved the module menu.
    Better upgrade notification.
    Small bug fixed.

  • v3.1.2
    June 16, 2020

    Improved support for third-party modules.
    Small bug fixed.
    Improved module settings page.

  • v3.1.1
    June 9, 2020

    Added field for configuring Sirv Media Viewer options.

  • v3.1.0
    June 5, 2020

    Improved support for third-party modules.
    Improved module settings page.
    Improved synchronization process.
    Minor bug fixes.

  • v3.0.3
    May 26, 2020

    Improved synchronization process.

  • v3.0.2
    May 21, 2020

    Improved support for Magento v2.2.

  • v3.0.1
    May 13, 2020

    Improved support for Sirv Media Viewer.
    Small bug fixed.

  • v3.0.0
    May 1, 2020

    Added support for CMS block images.
    Added support for Sirv Media Viewer.
    Improved module settings page.
    Improved synchronization process.
    Added account creation form.

  • v2.1.0
    February 14, 2020

    Improved support for Magento v2.3.
    Improved support for MagicToolbox modules.
    Improved synchronization process.
    Small bug fixed.

  • v2.0.5
    November 29, 2019

    Improved module settings page.
    Minor bug fixes.

  • v2.0.4
    November 12, 2019

    Improved synchronization process.

  • v2.0.3
    November 8, 2019

    Added warming the cache by prefetching DNS.
    Improved module settings page.
    Minor bug fixes.

  • v2.0.2
    October 9, 2019

    Improved module settings page.

  • v2.0.1
    October 8, 2019

    Improved support for Magento v2.1.

  • v2.0.0
    October 7, 2019

    Added REST API integration.
    Optimized S3 usage.
    Small bug fixed.
    Improved module settings page.

  • v1.1.10
    August 13, 2019

    Improved synchronization process.

  • v1.1.9
    July 17, 2019

    Optimized flushing cache process.

  • v1.1.8
    July 16, 2019

    Small bug fixed.

  • v1.1.7
    July 15, 2019

    Optimized CDN usage.

  • v1.1.6
    April 18, 2019

    Optimized S3 usage.

  • v1.1.5
    February 13, 2019

    Improved support for PHP 5.

  • v1.1.4
    February 11, 2019

    Improved support for Magento v2.0, v2.1, v2.2.

  • v1.1.3
    February 5, 2019

    Fixed an issue with Magento 'Minify JavaScript Files' option.
    Improved compatibility with Magento v2.3.
    Fixed an issue with spaces in 'Folder name on Sirv' option's value.
    Fixed an issue with non-alphanumeric characters in watermark url.

  • v1.1.2
    November 29, 2018

    Optimization of S3 usage.

  • v1.1.1
    November 6, 2018

    Optimization of sync process.

  • v1.1.0
    September 28, 2018

    Improved caching.
    Improved module settings page.

  • v1.0.9
    September 4, 2018

    Optimized gallery synchronization.

  • v1.0.8
    June 27, 2018

    Improved media gallery synchronization.

  • v1.0.7
    May 30, 2018

    Added support for category images.

  • v1.0.6
    May 18, 2018

    Added support for Magento v2.2.4.
    Improved support for Magic360 module.

  • v1.0.5
    May 10, 2018

    Added button to synchronize media gallery.

  • v1.0.4
    April 10, 2018

    Fixed an issue with empty 'Folder name on Sirv' option.
    Fixed an issue with getting buckets list when user has multiple account names.
    Fixed an issue with caching image urls in some Magento version.

  • v1.0.3
    December 12, 2017

    Fixed an issue with uploading already cached images.

  • v1.0.2
    October 31, 2017

    Added support for Magento v2.2.0.

  • v1.0.1
    October 18, 2017

    Improved module settings page.

  • v1.0.0
    June 6, 2017

    Sirv module for Magento 2 created.

How to set up a CDN for Magento 1

ImportantWe continue to provide support for our Magento 1 extension, though new feature development is focused on Magento 2, so we recommend migrating to Magento 2.

  1. Download the Sirv Magento 1 extension (zip).
  2. Unpack the zip file to your computer, then upload it to your Magento server.
  3. Refresh the Magento cache.
  4. Create your Sirv account.
  5. Go to System > Sirv CDN and connect your Sirv account.
    Sirv login in Magento 1
  6. The extension will start working as soon as you have set "Enable Sirv" to "Yes" and saved your settings.
    Sirv settings in Magento 1

Was this article helpful?

Get help from a Sirv expert

help ukraine help ukraine Powered by Ukrainian determination and British ingenuity

How can you support Ukraine