Deployment on WebP Server Documentation

Use with CDN

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

Use with CDN #

If you use CDN(such as Cloudflare) for your website, since WebP Server Go will render different image on different devices, its vital to make sure CDN doesn’t cache our outputs, for example, Cloudflare will cache all the images(by extension) from your website, which will cache the webp format of the image and use it for all visitors, this cached image cannot be shown on some old Safari browser.

Use with Docker (Recommended)

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

Usage with Docker (Recommended) #

We’ve build docker images on hub.docker.com and ghcr.io. If you want to run webp-server insider docker container without using docker-compose.yml and without limiting the resources it will use, you can run the command below:

Directory mapping and request flow #

flowchart LR client["Client\nGET /some-images/tsuki.jpg"] --> server["WebP Server Go\n:3333"] subgraph host["Host machine"] hostPics["/path/to/pics"] hostExhaust["./exhaust"] hostMeta["./metadata"] end subgraph container["Docker container"] cPics["/opt/pics (source images)"] cExhaust["/opt/exhaust (optimized cache)"] cMeta["/opt/metadata (source metadata)"] end hostPics <-- "volume mount" --> cPics hostExhaust <-- "volume mount" --> cExhaust hostMeta <-- "volume mount" --> cMeta server --> cPics server --> cExhaust server --> cMeta server --> response["Return optimized image\n(webp/avif/jxl)"]

Use with Binary (Advanced)

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

Usage with Binary (Advanced) #

Note: There is a potential memory leak problem with this server and remains unsolved, we recommend using Docker to mitigate this problem, refer to Docker. Related discussion: https://github.com/webp-sh/webp_server_go/issues/75

Download or build the binary #

Download the webp-server-go from release page.

Install dependencies #

Install libvips on your machine, more info here.

macOS

Run brew install vips pkg-config

Ubuntu

Run apt install libvips-dev

Fedora

Run dnf install vips-devel

If you don’t like to hassle around with your system, so do us, why not have a try using Docker? » Docker | WebP Server Documentation