Install overview
Codesteward Review is a self-hosted monorepo product. Pick a path by maturity:
| Path | Use when |
|---|---|
| Compose category | Evaluate on a laptop / shared demo host |
| Compose profiles | Add Neo4j, Janus, queue brokers, Keycloak alone |
| Kubernetes quick start | Cluster eval / first Helm install (OCI from GHCR) |
| Helm reference | Production values, HPA, KEDA, graph |
| Local monorepo | Contribute or debug packages |
Production checklist
- Postgres with durable storage (
DATABASE_URLon API and workers) - Keycloak (or compatible OIDC) + public HTTPS URLs for UI and API
- Workers scaled separately from API (HPA or KEDA)
- Graph: Neo4j or JanusGraph; workers embed Graph MCP over stdio
- Model keys via env and/or org Models UI (encrypted at rest in product store)
- SCM GitHub App + webhook to
/v1/webhooks/github - Backups for Postgres (and graph DB)
Network surfaces
| Port (typical) | Service |
|---|---|
| 8080 | UI (nginx / static) |
| 8081 | API |
| 8083 | Keycloak (compose demo) |
| 5432 | Postgres |
| 7687 / 7474 | Neo4j (if used) |
Images
CI builds combined API + worker runtime images, a UI image, and publishes the Helm chart to GHCR (…/charts/codesteward). Graph MCP runs inside the worker (no separate graph-mcp Deployment). Keycloak can use a themed image for production login chrome.
Next: Kubernetes quick start · Helm · Compose