Operations / Configuration reference

Configuration reference

The environment variables and portable policy objects that define an installation.

Production baseline

ENGINE_ISSUER=https://synaxis.example.com
ENGINE_PASSWORD=...
ENGINE_SECRET=...
DATABASE_URL=postgres://...
ENGINE_ENCRYPTION_KEY=...

ENGINE_PASSWORD and ENGINE_SECRET are mandatory outside development mode. DATABASE_URL selects PostgreSQL instead of ACCOUNTS_PATH file storage. ENGINE_ENCRYPTION_KEY is a base64-encoded 32-byte key for credentials at rest; without it, stored tokens are unencrypted. PORT takes precedence over ENGINE_PORT, and the listener defaults to 8080.

Local administration

ENGINE_DEVELOPMENT_MODE=true
ENGINE_LOCAL_ADMIN_AUTH_ENABLED=true
SYNAXIS_ADMIN_TOKEN=...
SYNAXIS_ENABLE_LEGACY_ADMIN=true

Development mode is only for a local disposable sandbox. Local password login, machine-token administration, and legacy admin routes are separate opt-ins. ENGINE_ADMIN_TOKEN and ENGINE_ENABLE_LEGACY_ADMIN are supported aliases for the two SYNAXIS_* names.

Hosted provisioning

ENGINE_CONSENT_URL=https://platform.example.com/consent
ENGINE_CONSENT_PUBLIC_KEY=...
SYNAXIS_WORKSPACE_ID=...
SYNAXIS_PROVISION_GENERATION=1
SYNAXIS_ADMIN_TOKEN=...
DATABASE_URL=postgres://...
ENGINE_ENCRYPTION_KEY=...

Configure the consent URL and base64-encoded 32-byte Ed25519 public key together. A hosted workspace ID also requires PostgreSQL, a positive provision generation, a configured encryption key, and a machine admin token for its trusted Platform proxy. Hosted mode verifies signed actor assertions and signed usage grants, and forces password login and legacy admin routes off.

Console and operations

  • CONSOLE_URL is the browser destination after upstream OAuth and the link in approval alerts; CONSOLE_ORIGIN is the comma-separated CORS allowlist.
  • ALERT_WEBHOOK_URL enables account health and approval webhook messages; Engine logs and the approval console still work without it.
  • APPROVAL_TIMEOUT_SECONDS defaults to 180. ENGINE_RECORD_PAYLOADS records payloads on the root /mcp surface; curated connectors opt in with their own Record setting.
  • AUDIT_RETENTION_DAYS defaults to 30 with PostgreSQL; set 0 to keep rows indefinitely. The file store retains its last 500 audit rows instead of performing time-based purge.

Portable configuration

Portable config v1 is a secret-free, merge-only export of connections, connectors, and legacy endpoint-bundle definitions. It never deletes existing objects and does not carry current ownership ACLs, connection scopes, or MCP-client registrations. Review those controls after every import.