Skip to main content
Version: 3.3.1

Environment Variables

This reference covers the environment variables used to configure Hotrod Server, Hotrod Agent and Hotrod CLI.

note

Some configuration and/or startup options do not have environment variable equivalents. Please use --help for additional CLI parameters on the relevant commands for additional options.

Hotrod Server

These settings apply to both hotrod run server and hotrod run stand-alone.

Options without environment variables are omitted here.

CLI / Environment VariableDefaultDescription
--staging-dir
HOTROD_STAGING_DIR
~/.local/hotrodHotrod Server's data/working directory
--auto-enrollment-key
HOTROD_AUTO_ENROLLMENT_KEY
noneThe shared secret for agent enrollments
--bind-address
HOTROD_BIND_ADDRESS
127.0.0.1:3000The Server's HTTP API will be served on this address and port. Use 0.0.0.0:3000 for all network interfaces.
--disk-usage-max-percentage
HOTROD_DB_DISK_USE_MAX_PERCENT
80Hotrod will remove logs & metric data when its staging directory's volume exceeds this threshold
--jwt-expiry-mins
HOTROD_JWT_EXPIRY_MINS
60minJWT expiry time in minutes
--jwt-psk
HOTROD_JWT_PSK
Auto-generatedPreshared JWT signing key
--log-retention-days
HOTROD_LOG_RETENTION_DAYS
30The maximum number of days that logs should be retained
--tls-cert
HOTROD_TLS_CERT
nonePath to TLS certificate file (if using TLS)
--tls-key
HOTROD_TLS_KEY
nonePath to TLS key(if using TLS)
--whitelist
HOTRODD_WHITELIST
noneAllow get metrics/logs to access unauthenticated from these IP addresses
--auth-db
HOTROD_AUTH_DB
--staging-dirPath to authentication DB. Its recommended to use --staging-dir instead.
n/a
HOTROD_LICENSE
noneUsed to provide Hotrod Server with a license key. If present, it will override existing licenses on every startup.

Hotrod Agent

These settings apply to hotrod run agent.

Options without environment variables are omitted here.

CLI / Environment VariableDefaultDescription
--hotrod-agent-api-key
HOTROD_AGENT_API_KEY
n/aAPI KEY for this agent
--hotrod-agent-id
HOTROD_AGENT_ID
auto-generatedunique ID used to identify this agent
--hotrod-agent-listener
HOTROD_AGENT_LISTENER
127.0.0.1:4040Listening address for internal pipe-agent comms. Don't bind on external address.
--hotrod-agent-name
HOTROD_AGENT_NAME
n/aName for this agent
--hotrod-url
HOTROD_URL
http://localhost:3000Hotrod server URL
--auto-enrollment-key
HOTROD_AUTO_ENROLLMENT_KEY
n/aEnrollment secret if auto-enrollment is enabled on the server
--pipes-dir
HOTROD_PIPES_DIR
n/aDirectory where pipes are stored, defaulting to user's cache directory
--poll-interval
HOTROD_AGENT_POLL_INTERVAL
15Poll Hotrod server for updates at this interval (seconds). 0 disables updates
--metrics-interval
HOTROD_AGENT_METRICS_INTERVAL
60Send metrics to Hotrod server at this interval (seconds)
--logs-interval
HOTROD_AGENT_LOGS_INTERVAL
5Send logs to Hotrod server at this interval (seconds)
--tags
HOTROD_AGENT_TAGS
n/aTags to attach to this agent's system information

Hotrod CLI

These settings apply to the Hotrod binary's administrative commands. These commands are a CLI wrapper to Hotrod Server's HTTP API.

Environment VariableDefaultDescription
HOTROD_URLhttp://localhost:3000Hotrod server URL