README

📖 Full docs, design notes & production guidance: brocode.at/modules/module-image-optimizer Part of the BroCode Image Optimizer family for Magento 2.

This module provides an AVIF image converter for Magento 2. It is based on the brocode/module-image-optimizer

Requirements

• Magento 2.4.x
• Web server: nginx (the only server Adobe supports from 2.4.9; nginx 1.30). Apache config is included for older installs, but Apache was dropped from Magento's tested requirements at 2.4.8-p3 / 2.4.7-p7.
• PHP 8.3 / 8.4 (8.5 on 2.4.9)

Installation

composer require brocode/module-image-optimizer-avif
bin/magento module:enable BroCode_ImageAvifOptimizer
bin/magento setup:upgrade

Configuration

The configuration can be found under Stores -> Configuration -> Services -> BroCode ImageOptimizer -> Image Avif. Currently the image quality can be set (value between 0 and 100) and the converter can be disabled.

Apache Configuration

Add following snippet to the .htaccess file, which serves public images that are converted:

 ############################################
 ## if client accepts avif, rewrite image urls to use avif version
AddType image/avif .avif
RewriteCond %{HTTP_ACCEPT} image/avif
RewriteCond %{REQUEST_FILENAME} (.*)\.(png|gif|jpe?g)$
RewriteCond %{REQUEST_FILENAME}\.avif -f
RewriteRule ^ %{REQUEST_FILENAME}\.avif [L,T=image/avif]

Nginx Configuration

Merge into the project nginx vhost (nginx.conf.sample). Place the map in http {}; add the location before Magento's generic static location under /media/.

# In http { } (once per nginx instance or included vhost file)
map $http_accept $avif_suffix {
    default "";
    "~*avif" ".avif";
}

# In server { }
location ~* ^/media/.+\.(png|gif|jpe?g)$ {
    add_header Vary Accept;
    try_files $uri$avif_suffix $uri $uri/ /get.php$is_args$args;
}

Further Information

See base module for more informations on how to setup the image optimizer: brocode/module-image-optimizer

Module family

Docs & guides: brocode.at