Files
proxmox/docs/04-configuration/PHOENIX_RAILING_OPERATOR_SETUP.md

27 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

# 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:**
```bash
# 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:
```bash
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](../00-meta/SANKOFA_API_COMPLETE_TASK_LIST.md) §3, [api/.env.example](https://gitea.d-bis.org/Sankofa_Phoenix/Phoenix_API) in Phoenix_API repo.