Skip to content

Deployment

  1. Download the release binary from GitHub Releases.
  2. Prepare config file:
Terminal window
cp gproxy.example.toml gproxy.toml
  1. Start service:
Terminal window
./gproxy

After startup, open:

  • Admin UI: http://127.0.0.1:8787/

Build image:

Terminal window
docker build -t gproxy:local .

Run container:

Terminal window
docker run --rm -p 8787:8787 \
-e GPROXY_HOST=0.0.0.0 \
-e GPROXY_PORT=8787 \
-e GPROXY_ADMIN_KEY=your-admin-key \
-e GPROXY_DSN='sqlite://app/data/gproxy.db?mode=rwc' \
-v $(pwd)/data:/app/data \
gproxy:local

Current cloud template support is Zeabur.

  • Template file: zeabur.yaml
  • Prebuilt image: ghcr.io/leenhawk/gproxy:latest

Recommended settings:

  • GPROXY_ADMIN_KEY: required
  • GPROXY_HOST: 0.0.0.0
  • GPROXY_PORT: 8787
  • GPROXY_DATA_DIR: /app/data
  • Persist volume at /app/data

Optional:

  • GPROXY_DSN (external database or custom sqlite path)
  • GPROXY_PROXY (upstream egress proxy)
  • RUST_LOG (log level)