Documentation

Last updated: 2026-08-05

Server settings

/server settings in the admin console is the single entry point for runtime-tunable, server-wide values. Settings live in the everlock-system store (settings.json), so every change is a git commit with an audit trail, and they survive restarts and upgrades.

/server settings list                    list all settings with values and defaults
/server settings get <key>               show a setting
/server settings set <key> <value>       set a setting
/server settings unset <key>             clear a setting (falls back to its default)

Keys are validated against a fixed registry — a typo is an error, and list always shows every known key with its current value, its default, and whether a change applies live or at the next restart.

Precedence

A setting overrides the corresponding CLI flag and config-file value, so the admin console can change behavior without touching the unit file or the store config:

  1. Hard CLI overrides — flags like --no-update beat everything (the recovery escape hatch).
  2. Server settings — this page.
  3. CLI flags / environment — the boot seed (e.g. --update-enabled, EVERLOCK_FRONTEND_HTTP_ACME_EMAIL).
  4. Config files — per-backend TOML in the everlock-system store.
  5. Built-in defaults.

Keys

KeyValuesAppliesPurpose
acme.emailemail addressrestartContact email on the ACME account used for certificate issuance. Optional — with it unset, the account is created without a contact, and certificates issue normally.
admin.http.vhosthostnamerestartVirtual host the admin dashboard is served on. Unset falls back to the --backend-admin-http-vhost CLI flag; without either, /admin is not served.
admin.mcp.vhosthostnamerestartVirtual host the admin MCP endpoint is served on. Unset falls back to the --backend-admin-mcp-vhost CLI flag; without either, /mcp is not served.
update.check_timeHH:MMliveDaily self-update check time. Randomized at first start so a fleet spreads its checks.
update.enabledtrue / falseliveAutomatic self-update from the update URL. Defaults to the CLI seed (true); --no-update forces it off regardless.

Examples

# Turn off automatic updates, effective immediately:
/server settings set update.enabled false

# Put a contact email on future ACME account registrations:
/server settings set acme.email ops@example.com

# Back to the default (account without a contact):
/server settings unset acme.email

The ACME contact is applied when the account is first created. To change it on a server that already has an account, delete config/frontend-http/acme-account.json from the everlock-system store and restart — the account is re-registered with the new contact on the next issuance.

settings admin operations