Guides

Deployment

Deploy ProxyWhirl API services, validate sources, and publish proxy lists safely.

Deployment

ProxyWhirl deployments combine a Python runtime (CLI, API, or MCP), optional SQLite storage, and periodically refreshed proxy-list artifacts.

Pre-Deploy Validation

uv run proxywhirl sources --validate --fail-on-unhealthy --timeout 5 --concurrency 5
task quality-gates
pnpm --dir web run docs:generate && pnpm --dir web run build

API Service

PROXYWHIRL_STORAGE_PATH=/data/proxywhirl.db \
PROXYWHIRL_API_KEY=<key> \
  uv run uvicorn proxywhirl.api:app --host 0.0.0.0 --port 8000

Point load balancers at /api/ready. See REST API Deployment.

MCP Service

PROXYWHIRL_MCP_API_KEY=<key> \
PROXYWHIRL_MCP_DB=/data/proxywhirl.db \
  proxywhirl-mcp --transport http

See MCP Server.

Proxy List Publication

The public bundle at /proxy-lists/ is mirrored from docs/proxy-lists/ during pnpm --dir web run docs:generate. See Proxy Lists.

See Also

Proxy Lists

Public proxy-list assets at /proxy-lists/, file formats, freshness, and how to regenerate the bundle.

Operations Playbook

Operational guidance for validation, retries, source health, and deployment checks.

On this page

Deployment Pre-Deploy Validation API Service MCP Service Proxy List Publication See Also