quinninteractive/silverstripe-webp-substitution

Automatically convert images to WebP format

2.1.1 2024-09-09 17:15 UTC

Requires

• nette/finder: ^2.5
• rosell-dk/webp-convert: ^2.6
• silverstripe/framework: ^4.4 || ^5.0

Conflicts

• silverstripe/s3: *

BSD-3-Clause

• image
• cms
• images
• silverstripe
• Webp

README

This module provides a task, ConvertImagesToWebpTask, which is to be run periodically to provide WebP substitutes for all existing public images.

Requirements

• silverstripe/framework ^4.4
• Conflicts with silverstripe/s3 because this module works only with the default, filesystem-based asset manager.

Installation

composer require quinninteractive/silverstripe-webp-substitution ^2.0.0

License

See License

Configuration example

If you should need to change the assets-relative directory or the file suffix to be used for WebP images, you can do that in the configuration.

There is a default limit of 32 megapixels, over which conversion is not attempted. This is to avoid overtaxing the server's virtual memory. This setting can be overridden as shown below. If you change the webp_file_suffix, you must also change the suffix in your nginx configuration (see example below).

QuinnInteractive\WebPSub\Task\ConvertImagesToWebpTask:
  webp_directory_path: '.misc/.WebP'
  webp_file_suffix: '.wp'
  size_limit_megapixels: 16

Command-line example

sudo -Eu www ./vendor/bin/sake dev/tasks/webpconvert

Crontab example

DOCROOT=/var/silverstripe/live/current/docroot
SAKE=./vendor/bin/sake
SUDO=/usr/local/bin/sudo

# WebP graphics conversion task every hour
50 * * * *    (cd $DOCROOT && $SUDO -Eu www $SAKE dev/tasks/webpconvert) > /dev/null 2>&1

Nginx configuration example

To support this module, add these items to your existing Silverstripe configuration. If you have changed the YAML configuration, you will need to adjust these items accordingly.

In the http section

# webp dir to try, if we accept webp (or none if not)
map $http_accept $webp_dir {
    default   "";
    "~*image/webp"  "/assets/.webp/";
}

map $arg_nowebp $accept_webp {
    default   $webp_dir;
    '1'    "/fail-on-purpose/";
}

In the server section, before the main assets location directive

# first try to return allowed webp
location ~ ^/assets/.*\.(?i:gif|jpeg|jpg|png)$ {
    try_files $accept_webp$uri.webp $uri /index.php?$query_string;
}

# Never serve .protected, nor .webp not served above
location ~ ^/assets/\.(webp|protected)/ {
    return 403;
}

Apache configuration example

TBD

Filesystem preparation

If it can, the task will create the directories that it needs. If not, you must create the .webp directory (or the directory named in the webp_directory_path configuration) under the assets directory and make it writable by the web server.

Version

2.1.1

Release notes

2.1.1

Silverstripe 5 support.

2.1.0

This version introduces a backward-compatible feature so that converted WebP files are not used in the CMS. To take advantage of this new feature, you need to change your nginx configuration (see example above). If you do not make the changes, your site will work just as it did in earlier versions, so this is a non-breaking change.