Environment variables

This page is generated from the configuration loader, the environment reads of the programs and the deployment templates by make docs-gen. Do not edit it by hand: make docs-check fails when it differs from the code.

Configuration overrides

Every setting of the server configuration except lists of objects and maps can be overridden with an environment variable. The name is MYRIARCH_ followed by the YAML path in upper case, joined with _. A camelCase key is not split: server.publicUrl becomes MYRIARCH_SERVER_PUBLICURL.

• A list is given as comma separated values, for example MYRIARCH_AUTH_OIDC_SCOPES=openid,profile,email.
• A duration uses Go syntax such as 30s or 5m. A plain integer is rejected.
• An empty value is ignored for a boolean, a number and a duration. For a string it sets the empty string.
• The overrides apply to myriarchd serve, myriarchd dev, myriarchd config validate and myriarchd config print. myriarchd migrate applies only the overrides of the database settings (MYRIARCH_DATABASE_*).
• An override wins over the configuration file.
• Lists of objects and maps (opamp.enrollmentTokens, notifications.channels, auth.devLogin.users and the executors maps) cannot be set through the environment.

References inside configuration files

Two configuration files expand references to environment variables in their string values:

• myriarchd.yaml accepts ${VAR} and ${VAR:-default}. A variable that is unset or empty gives the default, or the empty string when there is none.
• The configuration of myriarch-updater accepts ${env:VAR} and ${env:VAR:-default}. A variable that is unset and has no default stops the updater with an error.

Executor secrets

An Executor object in Git can name an environment variable of the server for a secret (secretEnv, tokenEnv), see the Executor reference. The name must start with executors.secretEnvPrefix (default MYRIARCH_EXEC_), so Git cannot read arbitrary variables. Each such variable needs a destination binding in executors.secretEnvHosts or an entry in executors.secrets; myriarchd serve refuses an executor secret without one.

Variables that the programs read

These variables are not part of the configuration overrides.

Variables in the deployment templates

The templates under deploy/supervisor and deploy/updater (and the deprecated Kubernetes templates under contrib/legacy-kubernetes-collector) reference these variables as ${env:NAME}. They are resolved by the OpAMP Supervisor or by myriarch-updater when they load their configuration, not by myriarchd.