Installation
PreviewProxy can be installed in three ways. Choose the one that fits your environment.
Option 1: Docker (recommended)
The official image is published to the GitHub Container Registry. No build step required.
docker pull ghcr.io/vigrise/previewproxy:latest
Run it:
docker run -p 8080:8080 \
-e PORT=8080 \
-e APP_ENV=development \
ghcr.io/vigrise/previewproxy:latest
See Docker for a full example with Docker Compose.
Option 2: Pre-built Binary
Download the latest release binary for your platform from the GitHub Releases page.
# Linux x86_64 example
curl -LO https://github.com/ViGrise/previewproxy/releases/latest/download/previewproxy-linux-x86_64.tar.gz
tar -xzf previewproxy-linux-x86_64.tar.gz
chmod +x previewproxy
./previewproxy --help
info
Pre-built binaries include all supported formats except HEIC (requires libheif at runtime) and video thumbnails (requires ffmpeg on PATH).
Option 3: Build from Source
Requires Rust (stable toolchain).
git clone https://github.com/ViGrise/previewproxy.git
cd previewproxy
cargo build --release
./target/release/previewproxy --help
See Build from Source for full prerequisites and optional dependency setup (HEIC, PDF, video).
System Requirements
| Requirement | Notes |
|---|---|
| OS | Linux, macOS, Windows |
| RAM | 256 MB minimum; 512 MB+ recommended for production |
| Disk | Depends on cache size; set CACHE_DISK_MAX_MB to cap usage |
| ffmpeg | Required only for video thumbnail extraction |
| libheif | Required only for HEIC input support |
Next Steps
- Docker - run and test in under 2 minutes
- Environment Variables - full configuration reference
- HMAC Signing - secure your deployment