diff --git a/docs/OPERATIONS.md b/docs/OPERATIONS.md index 4db8de3..a818309 100644 --- a/docs/OPERATIONS.md +++ b/docs/OPERATIONS.md @@ -13,10 +13,10 @@ docker compose down The expected health endpoints are: -- API: `GET http://localhost:8000/healthz` +- API: `GET http://localhost:8000/api/v1/health/live` - Web: `GET http://localhost:8080/healthz` -A service is ready only when Compose reports `healthy`; container running status alone is insufficient. The API health response includes `"outreach_enabled": false` as an operational safety check. +A service is ready only when Compose reports `healthy`; container running status alone is insufficient. The Compose environment explicitly carries `AUTOMATED_OUTREACH_ENABLED=false` as an operational safety setting. ## Configuration and deployment @@ -32,7 +32,11 @@ Before deployment: ## Data, backups, and retention -The canonical API runtime under `apps/api` uses the named Docker volume `prospect-platform-api-data`. Inspect it with `docker volume inspect prospect-platform-api-data`; do not treat a local Docker volume as a backup. +The canonical API runtime under `apps/api` uses the named Docker volume `prospect-platform-api-data`. + +Any older files under `infrastructure/docker/` are not referenced by Compose and are non-canonical; use `apps/api` and `apps/web` for all container changes. They can be removed during repository cleanup once no external tooling references them. + +Inspect the volume with `docker volume inspect prospect-platform-api-data`; do not treat a local Docker volume as a backup. For the current MVP there is no database migration or backup command. If runtime data is material, stop writes first and snapshot/copy the volume using an approved host backup process. Protect backup files with encryption and access controls, test a restore into an isolated environment, and document the result.