Installation

There are multiple ways you can install PreviewProxy:

Option 1: Install Script (easiest)​

The quickest way to install PreviewProxy on Linux or macOS:

curl -s -o- https://raw.githubusercontent.com/ViGrise/previewproxy/main/install.sh | sudo bash

Or with wget:

wget -qO- https://raw.githubusercontent.com/ViGrise/previewproxy/main/install.sh | sudo bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/ViGrise/previewproxy/main/install.ps1 | iex

Once installed, start the server:

previewproxy

That's it - open http://localhost:8080/health to confirm it's running.

previewproxy upgrade

Option 2: Docker​

PreviewProxy can (and this is highly recommended) be used as a standalone application inside a Docker container. Just pull the official image from GitHub Container Registry:

docker pull ghcr.io/vigrise/previewproxy:latest
docker run -p 8080:8080 -it ghcr.io/vigrise/previewproxy:latest

See Docker for a full example with Docker Compose.

Option 3: Pre-built Binary​

Download and run a binary directly — no package manager or build tools needed.

curl -Lo previewproxy https://github.com/ViGrise/previewproxy/releases/latest/download/previewproxy-linux-x86_64
chmod +x previewproxy
./previewproxy

See Install from Binary for all platforms and optional system-wide install.

Option 4: Build from Source​

Requires Rust (stable toolchain).

git clone https://github.com/ViGrise/previewproxy.git
cd previewproxy
cargo build --release
./target/release/previewproxy

See Build from Source for full prerequisites.

System Requirements​

Next Steps​

• Docker - run with Docker Compose
• Environment Variables - configure the server
• HMAC Signing - secure your deployment