MiravoEnvironment Variables
Defaults and precedence for the MIRAVO_* and LITMUS_EDGE_* environment variables.
Use environment variables when Docker, systemd, CI, or another process launches Miravo and long flag lists are awkward. A flag always wins over its variable.
Variables
| Name | Default | Purpose |
|---|---|---|
MIRAVO_NAME | Template/namespace derived or generated | Factory name for start |
MIRAVO_TEMPLATE | Auto-detected | Template id, name, path, or comma-separated list |
MIRAVO_HOME | ~/.miravo | Root for personal template bundles, the auth store, the factory pointer, integration targets, and saved state. One factory per home |
MIRAVO_MQTT_PORT | 1883 | MQTT broker port |
MIRAVO_MQTT_HOST | 127.0.0.1 | MQTT bind host |
MIRAVO_MQTT_MODE | embedded | MQTT mode: embedded or external |
MIRAVO_MQTT_URL | Unset | External broker URL, for external mode. Its credentials, query, and fragment are never saved: set it on every start |
MIRAVO_MQTT_USERNAME | Unset | External broker username. Never saved: set it on every start |
MIRAVO_MQTT_PASSWORD | Unset | External broker password. Env only: there is no flag. Never saved: set it on every start |
MIRAVO_MQTT_DRAIN_BUDGET | 16384 | Embedded MQTT messages drained per cycle |
MIRAVO_MQTT_BATCH_SIZE | 2048 | Embedded MQTT publish batch size |
MIRAVO_MQTT_BROKER_CONCURRENCY | 500 | Embedded MQTT broker concurrency |
MIRAVO_OPCUA_PORT | 4840 | OPC UA server port |
MIRAVO_OPCUA_HOST | 127.0.0.1 | OPC UA bind host |
MIRAVO_OPCUA_WRITE_BUDGET | 8192 | OPC UA client writes applied per cycle |
MIRAVO_MODBUS_PORT | 1502 | Modbus TCP server port |
MIRAVO_MODBUS_HOST | 127.0.0.1 | Modbus TCP bind host |
MIRAVO_ADMIN_HOST | 127.0.0.1 (0.0.0.0 in the Docker image, which also sets the MQTT, OPC UA, and Modbus hosts) | Admin bind host for start. Client commands ignore it |
MIRAVO_ADMIN_PORT | 8080 | Admin bind port for start. Client commands ignore it |
MIRAVO_ADMIN_URL | Unset | Full admin URL for client commands. Overrides the MIRAVO_HOME pointer |
MIRAVO_ADMIN_PASSWORD | Unset (the password is admin) | Admin password for CLI Basic Auth and Console login |
MIRAVO_ANONYMOUS_LOGIN | Unset | Set to true to disable admin auth, like --no-auth |
MIRAVO_SOURCE_HOSTNAME | Unset | Hostname an integration uses to reach Miravo's protocol endpoints |
LITMUS_EDGE_HOSTNAME | Unset | Litmus Edge hostname or IP for le apply and le cleanup |
LITMUS_EDGE_API_TOKEN | Unset | Litmus Edge API token for le apply and le cleanup. Env only: there is no flag. A saved target can hold it instead |
MIRAVO_DEBUG | Unset | Set to 1 to print stack traces |
MIRAVO_NO_UPDATE_CHECK | Unset (1 in the Docker image) | Set to 1 to turn off the update check, which runs at most once every 24 hours. Miravo sends no telemetry. See Security |
NO_COLOR | Unset | Any non-empty value turns off ANSI color |
Resolution order
| Surface | Order |
|---|---|
| Runtime flags | CLI flag ⭢ environment variable ⭢ template or built-in default |
| Admin target | --admin-url ⭢ MIRAVO_ADMIN_URL ⭢ MIRAVO_HOME factory pointer ⭢ error. No 8080 fallback |
| Litmus Edge auth | With --target: the named target, with --le-hostname overriding the hostname. Otherwise: --le-hostname ⭢ LITMUS_EDGE_* ⭢ most recently used saved target. The API token has no flag: LITMUS_EDGE_API_TOKEN or the target |
| Litmus Edge source hostname | --source-hostname ⭢ MIRAVO_SOURCE_HOSTNAME ⭢ named target ⭢ most recently used saved target |
Next
CLI ⭢ miravo start
Which flag each variable backs.
Docker
Container mounts and environment:.
Logging
MIRAVO_DEBUG and NO_COLOR.
Was this page useful?
Last updated on