Skip to content

Environment Variables

This page lists the environment variables used by the module, CLI, and runtime utilities.

Development Tenant

These are required for auto-bootstrap and the CLI commands that operate on your development tenant.

VariableDescription
C8Y_BASEURLCumulocity base URL, for example https://example.cumulocity.com
C8Y_DEVELOPMENT_TENANTDevelopment tenant ID
C8Y_DEVELOPMENT_USERDevelopment user name
C8Y_DEVELOPMENT_PASSWORDDevelopment user password

Bootstrap Credentials

These are written by auto-bootstrap or by the bootstrap CLI command.

VariableDescription
C8Y_BOOTSTRAP_TENANTTenant ID for the microservice bootstrap user
C8Y_BOOTSTRAP_USERBootstrap user name
C8Y_BOOTSTRAP_PASSWORDBootstrap user password

Runtime client and credential utilities rely on these values to access subscribed tenant credentials.

Runtime Config Overrides

Nitro runtime config values can be overridden through environment variables.

VariableDescription
NITRO_C8Y_CREDENTIALS_CACHE_TTLOverrides c8y.cache.credentialsTTL
NITRO_C8Y_DEFAULT_TENANT_OPTIONS_TTLOverrides c8y.cache.defaultTenantOptionsTTL

Values are in seconds.

Where They Are Loaded

The CLI loads project config and env files before validating required variables. During development, auto-bootstrap writes generated bootstrap credentials back into the env file and also updates process.env so the current process can continue immediately.

Released under the MIT License.