Field guide

Documentation by task.

Start the gateway, understand the routing model, connect a client or provider, then operate it without guessing about security or compatibility boundaries.

QuickstartInstall the published image without cloning or building. Generate .env once, keep state, and configure a provider. Native binaries also available.compose.yaml + .env → up -d Routing and architectureExact targets, named endpoints, retries, failover, adaptation, identity, and state.provider/model → endpoint ConfigurationYAML structure, environment precedence, provider policy, retention, and state paths.LLMGW_* · config.yaml Client setupClaude Code, Codex, Copilot CLI BYOK, OpenAI SDKs, and Anthropic SDKs.base URL + gateway key Provider integrationsAll 57 registry entries, authentication methods, scopes, lifecycle evidence, and caveats.hosted · OAuth · cloud · local Data-plane APIAuthentication, model listing, Chat, Responses, Messages, embeddings, audio, image, and video./v1/* Multi-user governanceHuman and service identity, projects, keys, private connections, quotas, audit, and alerts.principal → project → key OperationsDeployment, health, logs, retention, backups, restore recovery, release verification, and rollback.llmgw backup create SecurityTrust boundaries, key storage, SSO, logging, backup sensitivity, SSRF, and private reporting.private network · TLS · least privilege UpgradingBack up offline, update the image pin, and keep the same .env and volume. Source builds and rollback are separate paths.backup → pull → up -d LimitationsSingle-node, protocol, routing, provider, UI, identity, and operational non-goals.explicit boundaries