Server Configuration Reference

Complete reference for Miren server configuration. Settings can be specified via config file, environment variables, or CLI flags.

Configuration Precedence

Settings are resolved in this order (highest priority first):

CLI flags — e.g. --address :9443
Environment variables — e.g. MIREN_SERVER_ADDRESS=:9443
Config file — server.toml
Defaults

Config File

The server reads its config from the first file found:

Path specified via --config
/etc/miren/server.toml
{data_path}/config/server.toml (default: /var/lib/miren/config/server.toml)

Example

mode = "standalone"

[server]
address = ":8443"
data_path = "/var/lib/miren"
network_backend = "vxlan"
http_request_timeout = 60

[tls]
standard_tls = true
acme_email = "admin@example.com"

[etcd]
start_embedded = true

[buildkit]
gc_keep_storage = "20GB"
gc_keep_duration = "14d"

Server Modes

Miren has two operating modes:

Mode	Description
`standalone`	All components (etcd, containerd, buildkit, logs, metrics) run embedded within a single process. This is the default.
`distributed`	Components run as separate services. Experimental.

In standalone mode, embedded services start automatically unless explicitly disabled.

Top-Level Fields

Field	Type	Default	Env Var	CLI Flag
`mode`	string	`standalone`	`MIREN_MODE`	`--mode`, `-m`
`labs`	string[]	`[]`	`MIREN_LABS`	`--labs`

`[server]` — Core Settings

Field	Type	Default	Description	Env Var	CLI Flag
`address`	string	`:8443`	Address to listen on (`host:port`)	`MIREN_SERVER_ADDRESS`	`--address`, `-a`
`runner_address`	string	`localhost:8444`	Runner address (`host:port`)	`MIREN_SERVER_RUNNER_ADDRESS`	`--runner-address`
`data_path`	string	`/var/lib/miren`	Root data directory	`MIREN_SERVER_DATA_PATH`	`--data-path`, `-d`
`runner_id`	string	`miren`	Runner identifier	`MIREN_SERVER_RUNNER_ID`	`--runner-id`, `-r`
`release_path`	string	—	Path to release directory containing binaries	`MIREN_SERVER_RELEASE_PATH`	`--release-path`
`config_cluster_name`	string	`local`	Cluster name in client config	`MIREN_SERVER_CONFIG_CLUSTER_NAME`	`--config-cluster-name`, `-C`
`skip_client_config`	bool	`false`	Skip writing client config to `clientconfig.d`	`MIREN_SERVER_SKIP_CLIENT_CONFIG`	`--skip-client-config`
`http_request_timeout`	int	`60`	HTTP request timeout in seconds (minimum: 1)	`MIREN_SERVER_HTTP_REQUEST_TIMEOUT`	`--http-request-timeout`
`stop_sandboxes_on_shutdown`	bool	`false`	Stop all sandboxes when server shuts down (useful in development)	`MIREN_SERVER_STOP_SANDBOXES_ON_SHUTDOWN`	`--stop-sandboxes-on-shutdown`
`network_backend`	string	`vxlan`	Network backend: `vxlan` or `wireguard`	`MIREN_SERVER_NETWORK_BACKEND`	`--network-backend`

`[tls]` — TLS Settings

Controls TLS certificates for the server and HTTP ingress. See TLS for setup guides.

Field	Type	Default	Description	Env Var	CLI Flag
`additional_names`	string[]	`[]`	Extra DNS names for the server certificate	`MIREN_TLS_ADDITIONAL_NAMES`	`--dns-names`
`additional_ips`	string[]	`[]`	Extra IPs for the server certificate	`MIREN_TLS_ADDITIONAL_IPS`	`--ips`
`standard_tls`	bool	`true`	Expose HTTP ingress on standard TLS ports (443)	`MIREN_TLS_STANDARD_TLS`	`--serve-tls`
`acme_dns_provider`	string	—	DNS provider for ACME DNS-01 challenges (e.g. `cloudflare`, `route53`)	`MIREN_TLS_ACME_DNS_PROVIDER`	`--acme-dns-provider`
`acme_email`	string	—	Email for ACME account registration	`MIREN_TLS_ACME_EMAIL`	`--acme-email`
`self_signed`	bool	`false`	Use self-signed certificates (development only)	`MIREN_TLS_SELF_SIGNED`	`--self-signed-tls`

`[etcd]` — Etcd Settings

Miren uses etcd as its entity store. In standalone mode, an embedded etcd server starts automatically.

Field	Type	Default	Description	Env Var	CLI Flag
`endpoints`	string[]	`[]`	Etcd endpoints (auto-configured when embedded)	`MIREN_ETCD_ENDPOINTS`	`--etcd`, `-e`
`prefix`	string	`/miren`	Key prefix in etcd	`MIREN_ETCD_PREFIX`	`--etcd-prefix`, `-p`
`start_embedded`	bool	`true`*	Start embedded etcd server	`MIREN_ETCD_START_EMBEDDED`	`--start-etcd`
`client_port`	int	`12379`	Embedded etcd client port	`MIREN_ETCD_CLIENT_PORT`	`--etcd-client-port`
`peer_port`	int	`12380`	Embedded etcd peer port	`MIREN_ETCD_PEER_PORT`	`--etcd-peer-port`
`http_client_port`	int	`12381`	Embedded etcd HTTP client port	`MIREN_ETCD_HTTP_CLIENT_PORT`	`--etcd-http-client-port`