Documentation · Deployment

Deployment & API access

How to read the live API spec, run the production Docker image, use the example Compose and Kubernetes manifests, and configure every environment variable.

API specification (OpenAPI)

On a running instance (default local port 8080):

OpenAPI JSON — GET /docs/json (codegen, contract tests)
API browser — GET /docs (loads the JSON client-side)
REST v1 — all resources under /v1/…

Authoritative sources (GitHub)

deployment.md — deploy modes, RDS PG* + entrypoint, worker, checklist
environment-variables.md — complete variable listing (core, auth, LLM, MCP, jobs, connectors, seeds)
platform/deploy/README.md — Docker Compose and kubectl apply order

Example files in the repository

Path	Role
`platform/Dockerfile`	Production image: Prisma migrate, `web/dist`, uvicorn on 8080
`platform/docker-compose.yml`	Local Postgres only (port 5433)
`platform/deploy/docker-compose.app.example.yml`	Postgres + API; optional `worker` with profile `async-jobs`
`platform/deploy/kubernetes/*.yaml`	Namespace, ConfigMap, Secret template, API Deployment + Service, optional worker

← Documentation home