Qirava DMS docs

Configuration

The DMS reads a tiny key = value config, resolved in order: $QDMS_CONFIG → ./dms.config → ~/.qdms/dms.config (auto-generated on first run). A few keys also have environment overrides.

The config file#

Edit the file and restart to apply. Blank lines and # comments are ignored.

text

# ~/.qdms/dms.config
addr = 127.0.0.1:7179      # UI + API share this port
require_api_key = true     # API needs a signed key (UI routes stay public)
data_dir = /home/you/.qdms/qdms-data   # or `memory` for ephemeral

Keys#

addr: Address the DMS binds. The UI and /api/qql share it. Env override: QDMS_ADDR.
require_api_key: When true, /api/qql needs an HMAC-signed API key (a bootstrap admin key is minted + printed once on first start). Set false for local dev. UI routes are always public.
data_dir: Durable data directory (WAL + crash recovery). Use memory for an ephemeral instance. Env override: QDMS_DATA.

Other environment knobs#

QDMS_CONFIG: Path to a config file to use instead of the default lookup.
QDMS_MAX_CONN: Cap on concurrent connections.
QDMS_REPL_ROLE: master | follower to enable single-leader replication (default: standalone).

See Performance tuning for the executor budget and WAL knobs.