Skip to main content

Configuration

Documentation Map​

Configuration

This page is the short canonical map for repo-owned configuration.

The deep runtime contract remains:

  • Environment And Runtime Contract (docs/ENVIRONMENT_AND_RUNTIME_CONTRACT.md)

Primary Sources Of Truth​

  • .env.example
  • backend/app/config.py
  • docker-compose.v2.yml
  • Environment And Runtime Contract (docs/ENVIRONMENT_AND_RUNTIME_CONTRACT.md)

Core Runtime Variables​

App and session​

  • DATABASE_URL
  • BACKEND_BASE_URL
  • FRONTEND_ORIGIN
  • ALLOW_DEV_AUTH
  • SESSION_SECRET

Repo provider and sign-in​

  • GITEA_BASE_URL
  • GITEA_TOKEN
  • GITEA_OAUTH_CLIENT_ID
  • GITEA_OAUTH_CLIENT_SECRET
  • GITEA_OAUTH_REDIRECT_URI
  • GITHUB_BASE_URL
  • GITHUB_TOKEN
  • GITLAB_BASE_URL
  • GITLAB_TOKEN
  • OIDC_ISSUER_URL
  • OIDC_CLIENT_ID
  • OIDC_CLIENT_SECRET
  • OIDC_REDIRECT_URI
  • OIDC_SCOPES

Detailed posture:

  • OIDC Session Contract (docs/OIDC_SESSION_CONTRACT.md)
  • Operator Access Contract (docs/OPERATOR_ACCESS_CONTRACT.md)
  • Gitea OAuth Setup (docs/GITEA_OAUTH_SETUP.md)
  • Provider OAuth And SSO Setup (docs/PROVIDER_OAUTH_AND_SSO_SETUP.md)

Planning and delivery integrations​

  • PLANE_BASE_URL
  • PLANE_API_TOKEN
  • PLANE_DEFAULT_SYNC_MODE
  • PLANE_ALLOW_AUTO_SYNC_IN_PRODUCTION
  • PLANE_WEBHOOK_SECRET

See:

  • Plane Integration (docs/PLANE_INTEGRATION.md)
  • Plane Parity Contract (docs/PLANE_PARITY_CONTRACT.md)

n8n and automation​

  • N8N_BASE_URL
  • N8N_API_KEY
  • N8N_OPERATOR_ENABLED
  • N8N_OPERATOR_WEBHOOK_URL
  • N8N_EXPERT_ROOT
  • N8N_EXPERT_RUNTIME_ROOT

See:

  • N8N Operator Integration (docs/N8N_OPERATOR_INTEGRATION.md)

Runtime bridge​

  • OPENCLAW_RUNTIME_DISPATCH_WEBHOOK_URL
  • OPENCLAW_RUNTIME_DISPATCH_ENABLED
  • OPENCLAW_HOST
  • OPENCLAW_SSH_USER
  • OPENCLAW_SSH_PORT
  • OPENCLAW_RUNTIME_ROOT

Guardrails​

  • Production-changing configuration must remain issue-driven and verified.
  • Missing or conflicting upstream identity, Plane, or Fabric posture must fail closed.
  • Secrets stay outside repo truth.

Verify Path​

  • python -m pytest -q backend/tests/test_settings_regression.py
  • bash scripts/fabric-selfcheck.sh
  • curl -sf "http://<internal-runtime-redacted>:${PM_BACKEND_HOST_PORT:-18081}/contractz"

License: AGPLv3

Helpifyr: https://helpifyr.com