Files
proxmox/docs/04-configuration/PHOENIX_RAILING_OPERATOR_SETUP.md
defiQUG 1580e19029
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
docs: operator runbook for PHOENIX_RAILING_URL; complete API task list
- PHOENIX_RAILING_OPERATOR_SETUP.md: exact env and verify steps for 3.1
- OPERATOR_READY_CHECKLIST: §5d Sankofa Phoenix API railing setup
- SANKOFA_API_COMPLETE_TASK_LIST: mark 3.1 done (operator runbook added)

Made-with: Cursor
2026-03-11 13:02:24 -07:00

1.2 KiB

Phoenix Railing — Operator Setup

Purpose: One-step operator instructions to enable the Phoenix API Railing proxy in Sankofa API.

3.1 Set PHOENIX_RAILING_URL in Sankofa API

Where: In the environment where the Sankofa Phoenix API runs (e.g. systemd, Docker, Kubernetes, or shell).

What to set:

# Required for /api/v1/infra, /api/v1/ve, /api/v1/health proxy to work
export PHOENIX_RAILING_URL=http://phoenix-deploy-api:4001
# Or use the full URL of your Phoenix Deploy API instance, e.g.:
# export PHOENIX_RAILING_URL=https://phoenix-api.example.com

Optional: If phoenix-deploy-api enforces PHOENIX_PARTNER_KEYS, set the same key in Sankofa API so server-to-server calls succeed:

export PHOENIX_RAILING_API_KEY=<same-key-as-in-PHOENIX_PARTNER_KEYS>

Verify: After restarting the Sankofa API, call GET /api/v1/infra/nodes (with a valid JWT or X-API-Key). If configured, you get node data (or stub); if not, 503 with message "Set PHOENIX_RAILING_URL".

Refs: SANKOFA_API_COMPLETE_TASK_LIST.md §3, api/.env.example in Phoenix_API repo.