Install from Binary
Pre-built binaries are available for Linux, macOS, and Windows. No Rust or build tools required.
Quick Start
Section titled “Quick Start”Linux / macOS
curl -s -o- https://raw.githubusercontent.com/ViGrise/previewproxy/main/install.sh | sudo bashpreviewproxyInstall use install.sh scripts, the binary placed at
/usr/local/bin.
Windows
irm https://raw.githubusercontent.com/ViGrise/previewproxy/main/install.ps1 | iexpreviewproxyInstall use install.ps1 scripts, the binary placed at
%LOCALAPPDATA%\previewproxy\bin.
Open http://localhost:8080/health to confirm it’s running.
Download
Section titled “Download”Go to the GitHub Releases page and download the archive for your platform.
Linux (x86_64)
Section titled “Linux (x86_64)”curl -fsSL https://github.com/ViGrise/previewproxy/releases/latest/download/previewproxy-linux-x86_64 -o previewproxychmod +x previewproxyLinux (arm64)
Section titled “Linux (arm64)”curl -fsSL https://github.com/ViGrise/previewproxy/releases/latest/download/previewproxy-linux-arm64 -o previewproxychmod +x previewproxymacOS (Apple Silicon)
Section titled “macOS (Apple Silicon)”curl -fsSL https://github.com/ViGrise/previewproxy/releases/latest/download/previewproxy-darwin-arm64 -o previewproxychmod +x previewproxymacOS (Intel)
Section titled “macOS (Intel)”curl -fsSL https://github.com/ViGrise/previewproxy/releases/latest/download/previewproxy-darwin-x86_64 -o previewproxychmod +x previewproxyWindows
Section titled “Windows”Download previewproxy-windows-x86_64.exe from the releases page.
./previewproxyOpen http://localhost:8080/health to confirm it’s running.
Run as a systemd Service
Section titled “Run as a systemd Service”To run PreviewProxy automatically on boot, create a systemd unit file:
sudo nano /etc/systemd/system/previewproxy.servicePaste the following:
[Unit]Description=PreviewProxyAfter=network.target
[Service]ExecStart=/usr/local/bin/previewproxyRestart=on-failureEnvironment=PP_PORT=8080Environment=PP_APP_ENV=production
[Install]WantedBy=multi-user.targetEnable and start the service:
sudo systemctl daemon-reloadsudo systemctl enable previewproxysudo systemctl start previewproxyCheck the status:
sudo systemctl status previewproxyRun as a Windows Service
Section titled “Run as a Windows Service”Use NSSM (Non-Sucking Service Manager) to run PreviewProxy as a Windows service.
Install NSSM (via Chocolatey):
choco install nssmRegister the service:
nssm install PreviewProxy "C:\path\to\previewproxy-windows-x86_64.exe"nssm set PreviewProxy AppEnvironmentExtra PP_PORT=8080 PP_APP_ENV=productionnssm start PreviewProxyManage the service:
nssm stop PreviewProxynssm restart PreviewProxynssm remove PreviewProxy confirmNext Steps
Section titled “Next Steps”- Environment Variables - configure the server
- HMAC Signing - secure your deployment