Deployment Guide

This page summarizes the self-maintained deployment layer for Geoq API Gateway.

Local Start

Check dependencies:

./scripts/doctor.sh

Create the environment file:

cp ".env.example" ".env"
./scripts/generate-secrets.sh

Start services:

./scripts/up.sh

Check health:

./scripts/check.sh

Production Notes

The recommended production entrypoint is https://api.geoq.help, with https://gateway.geoq.help as a backup domain.

The deployment layer uses Docker Compose with PostgreSQL, Redis, the gateway service, and Cloudflare Tunnel. The origin service listens on 127.0.0.1:3000.

Admin Initialization

./scripts/init-admin.sh

After initialization, open the console, add upstream channels, configure models, and verify requests through the Logs page.