Files
computer-playbook/docs/contributing/environment/variables.md
T
kevinveenbirkenbachandClaude Opus 4.7 c02229b4be refactor(make): align targets to domain prefixes (compose-, network-, etc.)
Apply a consistent naming convention to the Make target inventory so
every target is grouped by its domain:

- compose-*  (compose-up/down/restart/stop/exec/inner-run)
- network-*  (network-dns-setup/remove, network-ipv6-disable/restore,
              network-refresh, network-trust-ca)
- security-* (security-apparmor-restore/teardown)
- diagnose-* (diagnose-network, diagnose-disk-usage)
- fix-*      (fix-chmod, fix-dockerignore)
- clean-*    (clean-cache, clean-pycache-dirs)
- install-*  (install-agent)
- meta-*     (meta-list, meta-tree, meta-mig)

Drop the stale debug-network target and reintroduce its functionality
as diagnose-network. Cascade renames through:

- Makefile (.PHONY entries, prereqs, recursive $(MAKE) calls)
- contributor docs, agent-iteration docs, role-level docs
- bundle README, environment scripts, install/lint/test wrappers
- AGENTS.md, CLAUDE.md, compose/cache.override.yml, .github/workflows

Historical entries under docs/requirements/ and changelog/ stay
untouched as audit logs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-21 21:00:45 +02:00

2.8 KiB

Environment Variables

The project's environment is owned by a single generator, not scattered across shell modules. Every variable is documented INLINE next to its definition with a one-line # ... comment above the key. This page is just a map of where to look.

Where the defaults live

  • default.env holds the committed defaults for every static key (network defaults like DNS, subnet, gateway, domain included), each preceded by a one-line comment. Edit this file to change a default or to read the per-variable documentation.
  • .env (gitignored) is generated by make dotenv, which delegates to python -m cli.meta.env. It combines default.env with runtime-resolved values (selected distro, GHA/Act flags, df/meminfo-derived cache sizes, sha256 secrets, repository owner, ...). Each line in .env is preceded by its own comment, so the file is self-describing. Open it after make dotenv to inspect the effective value-set together with its documentation.

Regenerating

make dotenv

Override individual values by exporting them before make dotenv. Already-set env vars take precedence over default.env defaults.

Pipeline

  • env/ (under utils/) holds the parser, runtime helpers, writer, and one handler module per dynamically-computed variable under handlers/.
  • env/ (under cli/meta/) provides the CLI entry point invoked as python -m cli.meta.env.
  • load.sh is the shell loader; it sources .env and auto-generates it on a cold clone.

Variables NOT in default.env

A handful of variables are documented next to their consumer because they cannot have a static default:

  • Driver-injected by make compose-up and the dev CLI (cache override paths like INFINITO_CACHE_REGISTRY_PROXY_CONF, the package-cache config paths, the frontend CA file). See common.py and compose.yml.md.
  • Computed at container start for INFINITO_PATH, set by entry.sh.
  • Persisted on the deploy target for INFINITO_VERSION, written by the sys-version role.
  • Compose literals with no env-side knob, namely GIT_SSL_NO_VERIFY and PYTHONHTTPSVERIFY, documented in compose.yml.md.

Role-scoped variables

App-specific container variables live next to the role that owns them, typically in roles/<role>/templates/env.j2, roles/<role>/templates/bootstrap.env.j2, or roles/<role>/templates/playwright.env.j2. They are intentionally NOT centralised here so the app documentation and its generated env file stay in sync.