weserv/images

You can pull and run the pre-built container from the GitHub Container Registry. This command maps TCP port 80 inside the container to port 8080 on your host and sets the shared memory size to 1GB.

docker run -d -p 8080:80 --shm-size=1gb --name=weserv ghcr.io/weserv/images:5.x

To build the project, clone the repository with submodules, use meson to configure and compile the build, and then install it. After installing the core project, you must build and install a custom Nginx instance configured with the project's module.

# Build and install weserv/images
git clone --recurse-submodules https://github.com/weserv/images.git
cd images
meson setup build --prefix=/usr
meson compile -C build
meson install -C build

# Build and install custom Nginx with the module
mkdir nginx
curl -Ls https://nginx.org/download/nginx-1.31.2.tar.gz | \
  tar xzC nginx --strip-components=1
cd nginx
./configure --add-module=../ --with-http_ssl_module
make -j$(nproc)
make install

Use the weserv directive to enable the Weserv module for nginx requests. You must choose between two backend modes:

• proxy: Processes images from a remote server specified via the ?url= query parameter.
• filter: Processes images from responses generated by other nginx handlers (such as static content or proxied requests).

To build weserv/images from source on RHEL 10 or its derivatives, ensure the following dependencies are met:

• meson >= 0.63
• g++ >= 5.0
• pcre2 (for nginx rewrite module)
• zlib (for nginx gzip module)
• openssl (for SSL support)
• libvips >= 8.12

Use docker exec to perform administrative tasks on the Nginx service running inside the weserv container.

# Check nginx configuration for correct syntax
docker exec weserv nginx -t

# Reload the nginx configuration file
docker exec weserv nginx -s reload

Use these commands to manage the container environment, update packages, or inspect system settings.

# Access the container bash shell
docker exec -it weserv bash

# Update RPM packages
docker exec weserv dnf update -y

# Check jemalloc configuration
docker exec -e MALLOC_CONF="stats_print:true,stats_print_opts:mdablxeh" weserv bash

# Access to logs
docker logs weserv

# Retrieve the container's IP Address
docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $(docker ps -f name=weserv -q)
docker inspect $(docker ps -f name=weserv -q) | grep IPAddress