Skip to content
HubProxyHubProxy

Quick Start

HubProxy supports Docker images and native package installation.

Section titled “Docker (Recommended)”
Terminal window
docker run -d \
  --name hubproxy \
  -p 5000:5000 \
  --restart always \
  -v /path/to/config.toml:/app/config.toml:ro \
  ghcr.io/sky22333/hubproxy

Install Script

Section titled “Install Script”

Auto-detects OS and architecture, downloads .deb, .rpm, or .apk from GitHub Releases:

Terminal window
curl -fsSL https://raw.githubusercontent.com/sky22333/hubproxy/main/install.sh | sh

The service starts automatically. Config is at /etc/hubproxy/config.toml.

Verify

Section titled “Verify”
Terminal window
curl http://127.0.0.1:5000/ready   # Local health check

Expected response:

{
  "ready": true,
  "service": "hubproxy",
  "version": "v1.x.x",
  "start_time_unix": 1710000000,
  "uptime_sec": 42.5,
  "uptime_human": "42s"
}

Next Steps

Section titled “Next Steps”

Production recommendation

Section titled “Production recommendation”

After verification, set up a custom domain + reverse proxy + HTTPS (Caddy / Nginx) so clients use https://example.com instead of bare http://IP:5000. See Recommended Architecture and Reverse Proxy.