All Miravo configuration can be set through environment variables. CLI flags take precedence over env vars.
| Variable | Default | Description |
|---|
MIRAVO_NAME | Template-derived | Simulation name |
MIRAVO_TEMPLATE | Auto-select | Template name or path |
MIRAVO_HOME | ~/.miravo | Base directory for local registry and persistence |
| Variable | Default | Description |
|---|
MIRAVO_MQTT_PORT | 1883 | Broker port (0 = ephemeral) |
MIRAVO_MQTT_HOST | 127.0.0.1 | Broker bind host |
MIRAVO_MQTT_MODE | embedded | embedded or external |
MIRAVO_MQTT_URL | — | External broker URL (e.g., mqtt://broker:1883) |
MIRAVO_MQTT_USERNAME | — | External broker username |
MIRAVO_MQTT_PASSWORD | — | External broker password |
| Variable | Default | Range | Description |
|---|
MIRAVO_MQTT_DRAIN_BUDGET | 16384 | 512-65536 | Max messages per embedded drain cycle |
MIRAVO_MQTT_BATCH_SIZE | 2048 | 64-16384 | Synchronous publishes before yielding |
MIRAVO_MQTT_BROKER_CONCURRENCY | 500 | 10-5000 | Aedes internal message concurrency |
| Variable | Default | Description |
|---|
MIRAVO_OPCUA_PORT | 4840 | OPC UA server port |
MIRAVO_OPCUA_HOST | 0.0.0.0 | OPC UA server bind host |
MIRAVO_OPCUA_WRITE_BUDGET | 8192 | Max address space writes per drain cycle (512-65536) |
OPC UA env vars are only read when OPC UA is enabled (--opcua).
| Variable | Default | Description |
|---|
MIRAVO_ADMIN_HOST | 127.0.0.1 | Admin HTTP server bind host |
MIRAVO_ADMIN_PORT | 8080 | Admin HTTP server port |
MIRAVO_ADMIN_URL | — | Admin server URL for client commands (status, inject) |
MIRAVO_ADMIN_TOKEN | — | Bearer token for mutation endpoints. Required when binding to non-loopback. |
| Variable | Default | Description |
|---|
NO_COLOR | — | When set (any non-empty value), forces plain text output |
The Miravo Docker image sets these defaults:
MIRAVO_ADMIN_HOST=0.0.0.0
Override them in docker run or Docker Compose:
-e MIRAVO_ADMIN_PORT=9090 \
-e MIRAVO_MQTT_PORT=1884 \
-p 1884:1884 -p 9090:9090 \
amineamaach/miravo:latest