Skip to content

System settings keys

Generated from src/system_settings/spec.cr and data/seeds/core.SystemSettings/definition.yml by make gen-docs-system-settings. Do not edit this file by hand.

Use this page to find a system settings key, its type, and its default.

System settings are the runtime platform configuration. One document, core.SystemSettings (id settings), holds every key.

  • A non-null field pins the value.
  • An explicit null returns the key to the config file.

The registry lists every key, its type, and the built-in default the file tier supplies.

The defaults are computed, not stored. The generator builds the built-in config from a minimal in-memory YAML and runs each entry’s file fallback — the code’s own third tier. At runtime a pinned document value overrides the default.

Secret keys never appear in a read API response. An operator sets them through the stage-and-adopt flow; the value lives in the secret store, and clearing it returns the key to the config file.

Key Type Default Purpose
artifact.grant_ttl_media_seconds number 21600 Seconds a signed link stays valid for audio and video, so seeking mid-playback does not hit an expired URL.
artifact.grant_ttl_seconds number 3600 Seconds a signed download link stays valid for documents and images.
artifact.prune_after_days number 30 Days an artifact stays protected after its last reference ends, before the prune run can delete it.
artifact.storage.type string “filesystem” Shows the effective storage adapter; the adapter wires at boot from the config file and the write gate refuses a pin.
assistant.api_endpoint string “https://api.openai.com/v1” OpenAI-compatible endpoint URL.
assistant.api_key secret — Set through the stage/adopt flow; shows as set/not-set, never as a value.
assistant.auto_execute_tools bool true When true, registered tools run without a confirmation round-trip.
assistant.max_history number — Conversation turns kept in context.
assistant.max_tokens number — Completion token cap.
assistant.model string “gpt-4o” Model identifier (e.g. ‘gpt-4o’).
assistant.name string “Assistant” Display name shown on every assistant surface — the workspace window, the builder window, and the top-bar entry point.
assistant.system_prompt text — Default persona prompt.
assistant.temperature number — Sampling temperature, 0.0 to 2.0.
iam.auth.mode string “hybrid” ‘hybrid’ allows password and federated login; ‘oidc_only’ removes the password path.
iam.change_password_expiration number 86400 Seconds a credential link stays valid: the password-reset link, the invite link, and the first-credential change token share one window.
iam.mfa.enforcement string “preferred” ‘preferred’ asks but never blocks; ‘always’ holds every un-enrolled login at the enrollment step.
iam.mfa.type string “totp” ‘totp’ enables TOTP MFA; ‘none’ turns MFA off — no challenge, no enroll hold.
localization.default_language string “en” Language code applied to accounts without their own language.
localization.default_timezone string “UTC” IANA timezone name (e.g. ‘Europe/Paris’) applied to accounts without their own timezone.
mail.adapter string “dev” ‘dev’ prints emails to stdout; ‘smtp’ delivers through the smtp sub-object.
mail.from_address string “no-reply@facet.local” Envelope and header sender address.
mail.from_name string “Facet” Display name on the From header.
mail.smtp.host string “localhost” SMTP server hostname.
mail.smtp.password secret — Set through the stage/adopt flow; shows as set/not-set, never as a value.
mail.smtp.port number 587 SMTP server port (1-65535).
mail.smtp.use_tls bool true Upgrade the connection with STARTTLS after connecting.
mail.smtp.username string — SMTP auth username.
mutations.retention_days number 180 Days of edit history kept per document; older entries fold into one snapshot, and rollback past the window answers 404.
tombstone.content_retention_days number 30 Days a deleted document keeps its content before the prune clears it.