NodeRingsDocs

Environment variables

Environment variables recognized by the nr CLI

Authentication and API

VariablePurpose
NR_API_TOKENService account JWT (highest token priority)
NR_ORGANIZATION_IDOrganization UUID sent as X-Organization-ID (same as --org-id; required for nr cluster register)
NODERINGS_API_TOKENAlternate token env
NR_TOKEN / NODERINGS_TOKENAdditional token fallbacks
NR_API_URLOverride API base URL
API_BASE_URL / NODERINGS_API_URLAlternate API URL envs
NR_FRONTEND_URLOverride frontend base URL (OAuth browser flows)
NODERINGS_FRONTEND_URL / FRONTEND_BASE_URLAlternate frontend URL envs
NR_API_TLS_INSECURE / API_TLS_INSECURESkip TLS verify (development only)

Proxmox operator (register)

VariablePurpose
PROXMOX_URLProxmox API URL (https:// required)
PROXMOX_USERNAMEAPI user (for example nrings-operator@pve)
PROXMOX_TOKEN_IDToken ID
PROXMOX_TOKEN_SECRETToken secret
PROXMOX_INSTANCE_IDOptional instance id (default proxmox-1)
PROXMOX_INSTANCES_FILEPath to multi-instance YAML (same as --proxmox-instances-file)

VirtFusion operator (register)

VariablePurpose
VIRTFUSION_URLControl origin only (https://cp.example.com — no /api/v1)
VIRTFUSION_TOKENGlobal API bearer token
VIRTFUSION_INSTANCES_FILEPath to multi-instance YAML (same as --virtfusion-instances-file)

Use with --hypervisor-driver virtfusion. Full path: Get started (VirtFusion).

SolusVM 2 operator (register)

VariablePurpose
SOLUSVM_URLManagement-node origin only (https://mn.example.com — no /api/v1, not :5656)
SOLUSVM_TOKENAdmin API bearer token
SOLUSVM_INSTANCES_FILEPath to multi-instance YAML (same as --solusvm-instances-file)

Use with --hypervisor-driver solusvm. Full path: Get started (SolusVM 2).

Operator / monitoring

VariablePurpose
MIMIR_BEARER_TOKENOptional override for Alloy remote_write. If unset, register issues or rotates a metrics write credential via the API
MIMIR_SERVICE_ENDPOINTOptional metrics endpoint host[:port] (production default is the platform metrics host)
MIMIR_TLS_ENABLEDToggle TLS for the metrics endpoint (1/0); defaults to secure (TLS on)
HELM_NAMESPACE / HELM_RELEASEOptional Helm namespace/release overrides
VNC_GATEWAY_NAMESPACEOptional VNC gateway namespace override

Legacy MIMIR_USERNAME, MIMIR_PASSWORD, and MIMIR_PROVIDER_ORG_ID are not used. Tenant isolation is enforced server-side; the CLI does not set a client org header for writes.

Networking edge cases

VariablePurpose
NR_DNS_CHECK_IMAGEContainer image used for DNS checks (air-gapped registries)
NR_LIQO_GW_CLIENT_ADDRESSOptional Liqo gateway client address override
NR_LIQO_GW_CLIENT_PORTOptional Liqo gateway client port override

Never commit tokens or hypervisor secrets. Pass them through your secret manager or a chmod 600 instances file on the agent host. Do not paste plaintext MIMIR_BEARER_TOKEN values into tickets or docs — leave it unset so the CLI manages rotation, or store it only in your secret manager.