Environment Variables
Here we cover environment variables used to configure the Server, Agent and CLI.
note
Some configuration and/or startup options do not have environment variable
equivalents. Use --help for additional parameters on the relevant CLI
commands.
Server
Settings here apply to hotrod run server and hotrod run stand-alone. Options without environment variables are omitted:
| CLI/Environment Variable | Default | Description |
|---|---|---|
| --staging-dir HOTROD_STAGING_DIR | ~/.local/hotrod | The data/working directory |
| --auto-enrollment-key HOTROD_AUTO_ENROLLMENT_KEY | none | The shared secret for Agent enrollments |
| --bind-address HOTROD_BIND_ADDRESS | 127.0.0.1:3000 | The Server 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 | 80 | Logs and metric data will be removed when the staging directory volume exceeds this threshold |
| --jwt-expiry-mins HOTROD_JWT_EXPIRY_MINS | 60 | JWT expiry time in minutes |
| --jwt-psk HOTROD_JWT_PSK | Auto-generated | Preshared JWT signing key |
| --log-retention-days HOTROD_LOG_RETENTION_DAYS | 30 | The maximum number of days that logs should be retained |
| --tls-cert HOTROD_TLS_CERT | none | Path to TLS certificate file (if using TLS) |
| --tls-key HOTROD_TLS_KEY | none | Path to TLS key (if using TLS) |
| --whitelist HOTRODD_WHITELIST | none | Allow unauthenticated access to metrics/logs from these IP addresses |
| --auth-db HOTROD_AUTH_DB | --staging-dir | Path to authentication DB. The recommended default is best used |
| n/a HOTROD_LICENSE | none | Used to provide the Server with a license key. If present, it will override existing licenses on every startup |
Agent
Settings here apply to Agents. Options without environment variables are omitted:
| CLI/Environment Variable | Default | Description |
|---|---|---|
| --hotrod-agent-api-key HOTROD_AGENT_API_KEY | n/a | API key for this Agent |
| --hotrod-agent-id HOTROD_AGENT_ID | auto-generated | Unique ID. Used to identify this Agent |
| --hotrod-agent-listener HOTROD_AGENT_LISTENER | 127.0.0.1:4040 127.0.0.1:3040 | Listening address for internal pipe-agent protocol. Don't bind on external address! Port 3040 by default on the Server's built-in Agent. Otherwise 4040 |
| --agent-api-bind-address HOTROD_AGENT_API_BIND_ADDRESS | 127.0.0.1:4041 127.0.0.1:3041 | Listening address for new internal pipe-agent protocol. Port 3041 by default on the Server's built-in Agent. Otherwise 4041 |
| --hotrod-agent-name HOTROD_AGENT_NAME | n/a | Name for this Agent |
| --hotrod-url HOTROD_URL | http://localhost:3000 | URL where the Server API can be reached |
| --auto-enrollment-key HOTROD_AUTO_ENROLLMENT_KEY | n/a | Enrollment secret if auto-enrollment is enabled on the Server |
| --pipes-dir HOTROD_PIPES_DIR | n/a | Directory where pipes are stored, defaulting to user cache directory |
| --poll-interval HOTROD_AGENT_POLL_INTERVAL | 15 | Poll Server for updates at this interval (seconds). 0 disables updates |
| --metrics-interval HOTROD_AGENT_METRICS_INTERVAL | 60 | Send metrics to Server at this interval (seconds) |
| --logs-interval HOTROD_AGENT_LOGS_INTERVAL | 5 | Send logs to Server at this interval (seconds) |
| --tags HOTROD_AGENT_TAGS | n/a | Tags to attach to Agent system information |
CLI
Settings here apply to administrative commands. These commands are a CLI wrapper to the Server HTTP API:
| Environment Variable | Default | Description |
|---|---|---|
| HOTROD_URL | http://localhost:3000 | Server URL |