Skip to content

Configuration reference

Every CLI flag and environment variable, with defaults. For the precedence rules (env var > control-plane setting > default) and which knobs are live vs. restart-only, see the Configuration model.

CLI

Global flags:

FlagDefaultDescription
--data-dir <path>./dataLocal data directory: partitions, single-node control plane, generated keys.
--verboseoffExtra diagnostics during serve.

serve:

FlagDefaultDescription
--port <n>7300HTTP/MCP listen port.
--host <addr>127.0.0.1Bind address (0.0.0.0 for all interfaces).
--shared-store <uri>FS/NFS path or s3://bucket/prefix for multi-node/DR.
--frontend-dir <path>Built SPA directory; must contain index.html.
--syslog-port <n>Override syslog UDP+TCP port; 0 disables. (Also HELIOS_SYSLOG_PORT.)

Admin bootstrap

Applied at startup. See First steps.

VariableDefaultDescription
HELIOS_ADMIN_USERadminFirst-run admin username.
HELIOS_ADMIN_PASSWORDFirst-run admin password. If unset (and no users), the setup wizard runs instead.
HELIOS_ADMIN_EMAIL<user>@localhostFirst-run admin email.
HELIOS_ADMIN_RESETTruthy + a password resets that admin's password (and revokes sessions) every boot.

Secrets & control plane

VariableDefaultDescription
HELIOS_CONTROL_KEY_PATH./secret-control.jsonControl-plane encryption key file (auto-created). Keep outside --data-dir.
HELIOS_JWT_SECRET_PATH./secret-jwt.jsonJWT signing-secret file (auto-created). Keep outside --data-dir.
HELIOS_CONTROL_ENCRYPTIONonAES-256-GCM encryption at rest. 0/off/false/no disables.
HELIOS_CONTROL_CACHE_TTL_SECS10TTL for the hot single-document read cache; 0 disables.

See Secrets & encryption.

Storage engine (startup-fixed)

VariableDefaultDescription
HELIOS_BLOCK_COMPRESSIONzstdBlock compression. off/none/0/false writes uncompressed.
HELIOS_BLOCK_QUEUE_CAP100000Ingest queue depth; full queue → backpressure (429 on shims).
HELIOS_BLOCK_FLUSH_CONCURRENCY2Concurrent block flushes (caps buffered memory).

Live tunables

Editable in Admin → General (env var, if set, wins and locks the field). See Performance tuning.

VariableDefaultLive?Description
HELIOS_BLOCK_COMPACT_SECS30yesCompaction walk interval.
HELIOS_BLOCK_TARGET_MB64yesCompaction target block size.
HELIOS_BLOCK_MIN_COMPACT_MB5yesCompaction floor.
HELIOS_BLOCK_MAX_SMALL_BLOCKS100yesSmall-block count that waives the floor.
HELIOS_BLOCK_FLUSH_ROWS50000yesBuffered-ingest row flush threshold.
HELIOS_BLOCK_FLUSH_SECS5yesBuffered-ingest time flush interval.
HELIOS_BLOCK_SYNC_SECS10yesShared-store sync interval (with --shared-store).
HELIOS_RETENTION_SWEEP_SECS3600yesRetention sweep interval.
HELIOS_AGG_MAX_PARTITIONS96yesPartitions aggregated exactly before stride-sampling.
HELIOS_QUERY_CACHE_MB1024yesPer-block match cache; 0 disables.
HELIOS_QUERY_THREADS4noQuery fan-out threads. Restart to apply.
HELIOS_AUTH_TOKEN_TTL_HOURS168yesSession (JWT) lifetime in hours (7 days).

Retention

VariableDefaultDescription
HELIOS_RETENTION_DEFAULT_DAYS— (keep forever)Global default retention in days; wins over the control setting. 0/blank = keep forever. Per-env overrides in Admin → Environments.

Syslog

VariableDefaultDescription
HELIOS_SYSLOG_PORTOverride the control-plane syslog UDP+TCP port; 0 disables the listener. (= --syslog-port.)

The rest of syslog (enable, bind, ports, routes) is configured in the control plane — see Syslog.

AWS / S3 (shared store)

When --shared-store is an s3:// URL:

VariableDefaultDescription
AWS_REGION— (required)S3 region. Required (IMDS is not used). May come from an AWS profile's region.

Credentials use the standard AWS provider chain (env vars, shared credentials, SSO, instance roles, …). See Multi-node & shared store.

Logging

VariableDefaultDescription
RUST_LOGinfo,hyper=warnLog verbosity filter (standard tracing syntax). Logs go to stderr.