Installation
How to install and deploy image-proxy
Docker (Recommended)
First, take the examples/docker-compose.yml file and copy it anywhere you like. Then, run:
docker compose upBuilding from Source
Prerequisites
- Rust 1.95.0+
- clang, lld (for linking)
- nasm (for AVIF native codec)
- dav1d development libraries
- libjxl development libraries
- pkg-config
Build
cargo build --releaseThe binary will be at target/release/image-proxy.
Run
IMAGE_PROXY_ROOT_PATH=./data/images ./target/release/image-proxyProduction Deployment
Reverse Proxy
image-proxy should be placed behind a reverse proxy (e.g., Traefik, nginx, Caddy) for:
- TLS termination
- Rate limiting
- Request routing
If your reverse proxy adds a path prefix, use IMAGE_PROXY_STRIP_PATH to remove it:
IMAGE_PROXY_STRIP_PATH=/imagesCDN
See the dedicated CDN page for detailed guidance on using a CDN with image-proxy.