====== SEO WebP Image Optimizer for Magento 2 User Guide ====== ===== Related overview ===== For a shopper-friendly overview of features and setup, see the [[https://toweringmedia.com/magento-2-seo-webp-image-optimizer-user-guide|Magento 2 SEO WebP Image Optimizer User Guide]] on the storefront. This wiki page remains the full technical documentation. ===== Extension context ===== This is a Toweringmedia Magento 2 extension guide for the current admin extension catalog. ===== Product page ===== * [[https://toweringmedia.com/seo-webp-image-optimizer-for-magento-2|SEO WebP Image Optimizer for Magento 2]] (SKU ''tm-seo-images-webp'') ===== Overview ===== This extension serves WebP versions of Magento catalog cache images on the storefront to reduce page weight and improve Core Web Vitals, and provides an admin bulk conversion tool for CMS and media library assets that sit outside the catalog image cache. ===== What this extension does ===== * WebP delivery for Magento catalog cache images on the storefront. * Admin bulk conversion for CMS and media library assets. ===== Requirements ===== * Magento 2.4.x (Open Source or Adobe Commerce). * PHP: ~8.1.0||~8.2.0||~8.3.0 (as declared by the published package). * A current Toweringmedia license and Composer credentials for ''https://composer.toweringmedia.com/''. * No other Toweringmedia packages are required. * The server's PHP GD or Imagick build must support WebP. If it does not, conversion will fail regardless of configuration. ===== Installation ===== Install and validate in a staging environment before production rollout. cd /path/to/magento composer require toweringmedia/module-seo-images-webp bin/magento module:enable Toweringmedia_SeoImagesWebp bin/magento setup:upgrade bin/magento setup:di:compile bin/magento setup:static-content:deploy -f bin/magento cache:flush Currently published versions at the time of writing: * ''toweringmedia/module-seo-images-webp'' — 1.0.6 Toweringmedia packages are served from the licensed Composer repository ''https://composer.toweringmedia.com/''. If Composer reports that the package could not be found, your credentials are missing or the license does not cover this package yet. Retrieve your keys from **My Account** on toweringmedia.com, or contact [[mailto:support@toweringmedia.com|support@toweringmedia.com]]. General installation notes that apply to every Toweringmedia extension are in the [[https://toweringmedia.com/installation|installation guide]]. ==== Package naming note ==== The storefront product is named **SEO WebP Image Optimizer**, but the Composer package is ''toweringmedia/module-seo-images-webp'' and the Magento module is ''Toweringmedia_SeoImagesWebp''. The install command above uses the real package name. ===== Configuration ===== * Stores > Configuration > Towering Media > **SEO Images WebP** (config section ''seo_images_webp''), group ''general''. * Admin screens: Intelligence SEO Suite > **Images WebP** (configuration shortcut) and **WebP Optimizer** (bulk conversion tool). ===== Basic usage and what to expect ===== - Confirm WebP support exists in your PHP image library before enabling. - Enable storefront delivery, flush cache, then load a category page and check in browser dev tools that catalog images are served as WebP. - Run the WebP Optimizer for CMS and media library assets separately — those are not part of the catalog image cache. ===== Notes and limitations ===== * Storefront catalog delivery and admin bulk conversion are two separate mechanisms. Enabling one does not do the work of the other. ===== Validation checklist ===== * ''bin/magento module:status'' shows the module(s) as enabled. * Extension configuration saves without errors in Admin. * The admin screens listed above are reachable and load without error. * Expected storefront/admin behavior is present after a cache flush. * No critical PHP/JS errors appear in ''var/log/'' during the primary test flow. ===== Troubleshooting ===== * **Composer cannot find the package**: confirm the ''https://composer.toweringmedia.com/'' repository and your credentials are present in ''auth.json'', and that your license covers this package. * **Feature not visible**: verify module status, flush cache, and redeploy static content. * **Admin setting not applying**: clear cache and confirm the config scope (default / website / store view). * **Unexpected behavior**: retest with only the required related modules enabled. ===== Support ===== * [[mailto:support@toweringmedia.com|support@toweringmedia.com]] * [[https://toweringmedia.com/magento-maintenance-support|Magento maintenance and support]] ===== Related Magento 2 docs ===== * [[magento2:extensions:start|Magento 2 extension index]] * [[start|Global docs home]]