Environment vocabulary (canonical)
Single source of truth for what Restormel integration env vars are called and how they differ. Use these names in apps, CI, MCP, and admin wizards — do not invent alternate names for the same key or URL.
Repository copy (for PRs and agents): docs/guides/restormel-environment-vocabulary.md.
Implementers: One Gateway key may appear as both
RESTORMEL_GATEWAY_KEY and RESTORMEL_SERVER_TOKEN (same value). Three URL roles — RESTORMEL_KEYS_BASE (site origin), RESTORMEL_CONTROL_PLANE_URL (…/keys/dashboard), RESTORMEL_EVALUATE_URL (full …/api/policies/evaluate) — are never interchangeable.Canonical variables
| Name | Role | Hosted example |
|---|---|---|
RESTORMEL_GATEWAY_KEY | Project Gateway key; Bearer for Dashboard API | rk_… |
RESTORMEL_SERVER_TOKEN | Same value as Gateway key unless you use a separate management token (MCP control-plane, some wizards) | same rk_… |
RESTORMEL_PROJECT_ID | Project UUID | UUID |
RESTORMEL_ENVIRONMENT_ID | One dev/prod slot inside the project | UUID |
RESTORMEL_KEYS_BASE | Site origin only, no path | https://restormel.dev |
RESTORMEL_CONTROL_PLANE_URL | Dashboard app base; append /api/projects/…; no trailing slash | https://restormel.dev/keys/dashboard |
RESTORMEL_EVALUATE_URL | Full POST URL for policy evaluate | …/keys/dashboard/api/policies/evaluate |
CI secrets (*_STAGING)
GitHub secret names often end in _STAGING. Your workflow should still map them to the canonical runtime names above. The project dashboard Copy full CI snippet includes both prefixed and unprefixed lines.
Admin wizards
If a single field is labeled “Restormel URL” or “site”, use RESTORMEL_KEYS_BASE. “Control-plane” or MCP route/policy tools need RESTORMEL_CONTROL_PLANE_URL. Policy / Plot-style evaluate calls need RESTORMEL_EVALUATE_URL.
Further reading
- MCP integration — stdio env wiring
- Cloud API — Policy evaluate
- MCP implementation workflow (runbook)