MiravoEnvironment Variables
Default values for Miravo runtime, adapter, admin, logging, and platform environment variables.
Set defaults for detached runs, containers, and platform automation. Use environment variables when Docker, systemd, CI, or another process launches Miravo and repeating long flag lists is impractical.
Variables
| Name | Default | Purpose |
|---|---|---|
MIRAVO_NAME | Template or namespace derived | Environment name for start |
MIRAVO_TEMPLATE | Auto-detected | Template id, name, path, or comma-separated list |
MIRAVO_HOME | ~/.miravo | Local registry, auth store, detached runtime metadata, and persistence root |
MIRAVO_CATALOG_DIR | Unset | Catalog root for start, load, models, templates, fork, apply, cleanup, and exports |
MIRAVO_MQTT_PORT | 1883 | MQTT broker port |
MIRAVO_MQTT_HOST | 0.0.0.0 | MQTT bind host |
MIRAVO_MQTT_MODE | embedded | MQTT mode: embedded or external |
MIRAVO_MQTT_URL | Unset | External broker URL when MQTT runs in external mode |
MIRAVO_MQTT_USERNAME | Unset | External broker username |
MIRAVO_MQTT_PASSWORD | Unset | External broker password |
MIRAVO_MQTT_DRAIN_BUDGET | 16384 | Embedded MQTT drain budget per cycle |
MIRAVO_MQTT_BATCH_SIZE | 2048 | Embedded MQTT synchronous publish batch size |
MIRAVO_MQTT_BROKER_CONCURRENCY | 500 | Embedded MQTT broker concurrency |
MIRAVO_OPCUA_PORT | 4840 | OPC UA server port |
MIRAVO_OPCUA_HOST | Adapter default | OPC UA bind host |
MIRAVO_OPCUA_WRITE_BUDGET | 8192 | OPC UA write drain budget |
MIRAVO_MODBUS_PORT | 502 | Modbus TCP server port |
MIRAVO_MODBUS_HOST | Adapter default | Modbus TCP bind host |
MIRAVO_ADMIN_HOST | 0.0.0.0 for start, 127.0.0.1 for client fallback | Admin HTTP bind host or client fallback host |
MIRAVO_ADMIN_PORT | 8080 | Admin HTTP bind port or client fallback port |
MIRAVO_ADMIN_URL | Unset | Full admin URL for client commands |
MIRAVO_ADMIN_PASSWORD | Stored credential or built-in admin | Admin login password for CLI clients |
MIRAVO_ANONYMOUS_LOGIN | Unset | Disable admin auth when set to true |
MIRAVO_SOURCE_HOSTNAME | Unset | Hostname that external platforms use to reach Miravo protocol endpoints |
LITMUS_EDGE_HOSTNAME | Unset | Litmus Edge hostname or IP for apply le and cleanup le |
LITMUS_EDGE_API_TOKEN | Unset | Litmus Edge API token for apply le and cleanup le |
MIRAVO_DEBUG | Unset | Enable stack traces with 1 |
NO_COLOR | Unset | Disable ANSI color output when non-empty |
Resolution order
| Surface | Order |
|---|---|
| Runtime flags | CLI flag ⭢ environment variable ⭢ template or built-in default |
| Admin target | --admin-url ⭢ MIRAVO_ADMIN_URL ⭢ MIRAVO_ADMIN_HOST + MIRAVO_ADMIN_PORT ⭢ http://127.0.0.1:8080 |
| Litmus Edge auth | Named --target with flag overrides ⭢ CLI flags ⭢ LITMUS_EDGE_* ⭢ default saved target |
| Litmus source hostname | --source-hostname ⭢ MIRAVO_SOURCE_HOSTNAME ⭢ named environment ⭢ default saved target |
Next
CLI ⭢ miravo start
Which runtime flags each variable backs.
Docker
Container mounts and environment: wiring.
Logging
MIRAVO_DEBUG and NO_COLOR output behavior.
Was this page useful?
Last updated on