Environment Variables
The strongDM command line recognizes environment variables to control and modify its functionality. This document details the available environment variables and their function.
| Name | Format | Function |
|---|---|---|
| SDM_ADMIN_TOKEN | <JWT token> | An admin token or service account token to use for sdm authentication. If set, this token will be used by strongDM and there is no need to log in via the CLI or GUI. |
| SDM_EMAIL | SDM_EMAIL=email-address-value@example.com | If set, the specified email address will be used automatically when using the sdm login command in the CLI. |
| SDM_HOME | /path/to/home | The location where sdm places its logs and keys. Defaults to ~/.sdm. Must be writable by the user running sdm. |
| SDM_VERBOSE | true|false | If set, log verbosity will be set to high for troubleshooting purposes. |
Variables for Relays/Gateways
The following variables are only for use with Relays and Gateways.
| Name | Format | Function |
|---|---|---|
| SDM_DOCKERIZED | true|false | stderr |
| SDM_ORCHESTRATOR_PROBES | :port | If set, the http://<GATEWAY OR RELAY IP>:port/liveness URL will be enabled to check whether the Gateway/Relay is in good health. |
| SDM_RELAY_LOG_ENCRYPTION | plaintext|pubkey:///pubkeyfullpath/file.pem | Overrides Relay log encryption settings configured in Admin UI. |
| SDM_RELAY_LOG_FORMAT | csv|json | Overrides Relay log format settings configured in Admin UI. |
| SDM_RELAY_LOG_STORAGE | stdout|file|none|tcp://host:port|socket:///fullpath/ | Overrides Relay log storage settings configured in Admin UI. |
| SDM_RELAY_TOKEN | <JWT_TOKEN> | A Relay or Gateway token to use when invoking the sdm binary. Normally not needed as this is entered when installing the Relay/Gateway. |