Configuration on WebP Server Documentation

MultiPath

Mon, 01 Jan 0001 00:00:00 +0000

MultiPath #

Starting from version 0.9.9, we’re supporting multipath, thanks to contribution by @bugfest ❤️.

If you’d like to use multiple path for serving different images, you can use the new config.json format. You can specify additional paths mappings under IMG_MAP dict.

IMG_MAP’s keys are URIs or Hosts names will be translated to their corresponding mapped value. It works in two different modes:

URI map: Keys have the form /.*
Host map: Keys have the form http?s://.*

Keys not matching this format will be ignored

Remote Backend

Mon, 01 Jan 0001 00:00:00 +0000

Remote Backend #

WebP Server Go can fetch original images from a remote HTTP or HTTPS origin, optimize them, and cache the results locally.

Automatic detection #

Remote (proxy) mode is enabled when the resolved image source is an http:// or https:// URL:

Configuration	Remote when
`IMG_PATH`	Value is an `http://` or `https://` URL (for example `https://cdn.example.com/assets`)
`IMG_MAP`	A matched mapping value is an `http://` or `https://` URL (see MultiPath)

Otherwise the server serves and converts images from local filesystem paths.

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Configuration #

This is the unified documentation, please use the latest version of WebP Server Go if possible as some configuration might not be available in previous versions.

WebP Server Go can be configured by the following ways:

config.json file
Environment variables

Priority: Environment variables > config.json file.

Configuration changelog #

Remote mode is detected automatically from http(s) URLs in IMG_PATH / IMG_MAP; ProxyMode has been removed.

Security-related invalid paths and meta=full on missing resources now return 404 (see Security and Query parameters).

MAX_CACHE_SIZE is added at version 0.12.0

EXTRA_PARAMS_CROP_INTERESTING is added at version 0.11.2

STRIP_METADATA, CONVERT_TYPES is added at version 0.11.0, dropped ENABLE_AVIF entry.

CACHE_TTL is added at version 0.10.7

READ_BUFFER_SIZE, CONCURRENCY and DISABLE_KEEPALIVE is added at version 0.9.12

Remote backend detection #

WebP Server Go enables remote (origin-fetch) mode automatically when the resolved image source is an http:// or https:// URL:

Configuration Examples

Mon, 01 Jan 0001 00:00:00 +0000

Configuration Examples #

Use this page as a quick selector for common deployment patterns. Pick the closest scenario, copy the minimal config, then adjust paths and domains.

Scenario overview #

flowchart TD startNode["Choose image source pattern"] --> singleLocal["Single local directory"] startNode --> multiLocal["Multiple local directories"] startNode --> remoteOnly["Remote origin only"] startNode --> mixedMode["Local + remote mixed"] singleLocal --> useImgPath["Use IMG_PATH as local path"] multiLocal --> useImgMapLocal["Use IMG_MAP with local prefixes"] remoteOnly --> useImgPathRemote["Use IMG_PATH as https URL"] mixedMode --> useImgMapMixed["Use IMG_MAP with local and https targets"] useImgPath --> localExample["See Local single directory"] useImgMapLocal --> multiExample["See Local multi-directory with IMG_MAP"] useImgPathRemote --> remoteExample["See Remote backend address"] useImgMapMixed --> mixedExample["See Mixed local and remote mappings"]