Document production domain split in README

api.amdbs.net (backend) / www.amdbs.net (frontend) -- records the required AURORA_API_HOST and CORS_ORIGINS values for the production .env, and the external-Traefik prerequisite docker-compose.prod.yml already assumed but never spelled out. Co-Authored-By: Claude Sonnet 5 <[email protected]>
2026-09-05 20:33:25 -05:00
parent 0a50e0ffb6
commit a8cb807d56
1 changed files with 13 additions and 0 deletions
@@ -180,6 +180,19 @@ disables asyncpg's server-side prepared statements, which don't survive
 transaction-mode pooling), horizontally-scaled API and worker replicas. See
 [`docs/architecture.md`](docs/architecture.md).

+Requires an external Traefik instance already running with a
+`traefik-public` Docker network and a `letsencrypt` cert resolver
+configured (`docker-compose.prod.yml` attaches to it, it doesn't run
+Traefik itself). Aurora Core's production domain split is `api.amdbs.net`
+(this backend) / `www.amdbs.net` (frontend, separate project) — the
+production `.env` (never committed) needs, beyond the base vars in
+`.env.example`:
+
+```bash
+AURORA_API_HOST=api.amdbs.net       # Traefik router rule (docker-compose.prod.yml only, not read by the app)
+CORS_ORIGINS=https://www.amdbs.net  # must include the frontend's real origin
+```
+
 ## Known limitations

 See [`docs/database.md#known-limitations`](docs/database.md#known-limitations)