Configuration reference

The same schema describes the config file and environment variables. Unknown keys stop startup.

Reference2 min read
On this page

Resolution order#

Each value resolves from embedded defaults, then the optional config document, then environment variables. The last supplied value wins.

The default file path is /etc/ecluse/config.yaml. ECLUSE_CONFIG selects another path. An explicitly selected missing file is an error.

A double underscore descends into an object. An underscore splits a camelCase name. For example, mounts.npm.mirrorTarget.codeArtifact.url becomes ECLUSE_MOUNTS__NPM__MIRROR_TARGET__CODE_ARTIFACT__URL.

Find a setting#

All settings and defaultsThe complete reference, rendered from the embedded configuration. Rules and their orderDefaults, precedence, and public admission. Endpoint collisionsWhich repository combinations warn or prevent a role from starting. Registry backend tagsGeneric registries, Verdaccio, and CodeArtifact capabilities. Secret settingsEnvironment variables, file indirection, and refused URL credentials.

What validation establishes#

check-config prints the resolved settings and their sources, redacting typed secrets. It checks each role's configuration without contacting cloud services.

A shared configuration error returns exit 2. A refusal specific to one role can appear as a warning while the overall command returns 0.

Review warnings for the roles you deploy. Startup and operational checks still need to prove connectivity, permissions, and repository relationships.

Search documentation