Skip to content
OctaFuse OctaFuse

Docker deployment

Docker fits local demos, private networks, and fully self-managed Postgres/MySQL with your existing ops practices.

Local quickstart

Section titled “Local quickstart”

Same as Quick start:

Terminal window
git clone https://github.com/OctaFuse/octafuse-gateway.git
cd octafuse-gateway
docker compose -f docker/compose/quickstart.yml up --build

Production self-host

Section titled “Production self-host”
  1. Provision DB: Postgres or MySQL with dedicated credentials.
  2. Configure env: copy .env.example → .env, set DATABASE_URL, DATABASE_DRIVER=mysql when needed, ADMIN_USERNAME / ADMIN_PASSWORD, etc.
  3. Migrate: npm run db:migrate:pg or npm run db:migrate:mysql from repo root (per docs).
  4. Run Proxy + Admin: Dockerfiles under the repo or your orchestrator.
  5. TLS: terminate HTTPS in front (Nginx/Caddy); split hostnames for Admin vs Proxy.
  6. Downstream env: GATEWAY_URL, GATEWAY_MASTER_URL, GATEWAY_MASTER_KEY — Integration.

vs Cloudflare

Section titled “vs Cloudflare”
  • Need data residency + private networking → Docker/self-host.
  • Need edge + managed D1 → Cloudflare Workers.

See also

Section titled “See also”