GitHub technical reference

This page is generated from sync/contract.json and points to canonical technical docs in the octafuse-gateway repository. This website keeps user-facing summaries; APIs, deployments, migrations, architecture, and behavior semantics live with gateway code.

Suggested path

For day-to-day use, start with this site’s Quick start and user guides. Open the technical references below for APIs, migrations, deployment runbooks, or troubleshooting details.

Source

This page is generated by npm run sync:gateway. If this site and the gateway repository disagree, trust the gateway repository.

Gateway ref: main · commit: 386cd44987eb01e3b92f292222231afa3c4e4467

Quickstart Minimal Docker and Cloudflare local D1 startup paths.

User-facing APIs OpenAI / Anthropic / Gemini compatible fronts, model list, and budget state.

Admin HTTP API Automation APIs for providers, models, routes, users, keys, config, and logs.

Docker / self-hosted Docker images, Compose, GHCR, Postgres / MySQL, and Zeabur notes.

Reader entry points

Doc	What it covers
Documentation index	Entry points organized by users, developers, operators, and maintainers.
Quickstart	Minimal Docker and Cloudflare local D1 startup paths.
Admin configuration	Configure providers, routes, users, and API keys after deployment.

Developers and integration

Doc	What it covers
System integration	Boundaries, key types, and common flows for portals, backends, or SaaS integrations.
API overview	Proxy/Admin base URLs, authentication, and error shapes.
User-facing APIs	OpenAI / Anthropic / Gemini compatible fronts, model list, and budget state.
Admin HTTP API	Automation APIs for providers, models, routes, users, keys, config, and logs.
Local development and testing	D1, Node + Postgres, Node + MySQL, Docker, and smoke test combinations.

Architecture and behavior semantics

Doc	What it covers
Runtime and data storage	Cloudflare / Node and D1 / Postgres / MySQL combination matrix.
Proxy request lifecycle	Auth, routing, rate limits, circuit breakers, stickiness, failover, and async billing.
Users and API key data model	Relationships and constraints for users, API keys, budgets, request logs, and audit logs.
Streaming billing and cancellation	Streaming chat, client cancellation, usage parsing, and charge state.
Image models	gpt-image-2 and Seedream: endpoints, parameters, billing conversion, and ops acceptance.
Time and timezone	UTC storage, API output, Admin display, and business day boundaries.

Deployment and operations

Doc	What it covers
Deployment patterns	Overview of Cloudflare, Hybrid, full self-hosted, MySQL, and Zeabur modes.
Cloudflare deployment	Worker, Admin, D1, Build variables, Workers Builds, and migration order.
Docker / self-hosted	Docker images, Compose, GHCR, Postgres / MySQL, and Zeabur notes.
D1 ↔ Postgres cutover	ETL, reconciliation, canary, cutover, and rollback notes.
Cloudflare command cheatsheet	Commands for Cloudflare local dev, dev demo, and production Git deploy.

Maintainers and conventions

Doc	What it covers
Release and versioning	Changesets, Version PRs, tags, GitHub Releases, and GHCR images.
Documentation boundaries and secret hygiene	Repository docs layers, website boundaries, placeholders, and forbidden values.
Minimal curl examples	Minimal curl commands for health, user inference, and Admin config.