Skip to main content

Configuration

This document describes the configuration layers used by the platform.

Configuration Layers

Base topology (non-secret)

Files:

  • deployment/topology.env.template (tracked)
  • deployment/topology.env (generated)

Defines stable host ports and local URLs used by project .env templates and (when applicable) remote deployment.

Global config (non-secret)

File: .env (generated from .env.template)

Global orchestration settings shared by projects (network name, internal service URLs, global defaults).

Global secrets

File: .env.secrets (generated from .env.secrets.example)

Passwords/tokens used across projects. This is the only supported place for sensitive values.

Project templates and generated env

Files:

  • */.env.template or */.env.example (tracked)
  • */.env (generated)

Project .env files are generated by ./infra.sh env generate by merging topology + .env + .env.secrets into each project template.

Remote deployment configuration

File: deployment/remote.env (tracked)

Defines remote-only knobs and the public endpoint registry (REMOTE_BASE_DOMAIN, REMOTE_ENDPOINT_DOMAIN_*, REMOTE_ENDPOINT_PORT_*, etc.).

Notes

  • The shared Docker network name is DOCKER_NETWORK_NAME (root .env).
  • Avoid editing generated */.env by hand; change deployment/topology.env, .env, .env.secrets or the relevant */.env.template instead.