Operate
This section is for operators who run Facet for their organization. It covers system requirements, container deployment, configuration, storage, email, background jobs, health and metrics, currencies, retention, upgrades, and localization.
Deploy and configure
Section titled “Deploy and configure”- System requirements and topology — what a host needs and how the services connect.
- Deploying with containers — the release images, config mounting, and the Caddy TLS edge.
- Deploy to production — the copy-paste Docker Compose walkthrough.
- Configuration files — one YAML file
configures the backend; inject secrets with
!env. - System settings — change platform knobs at runtime, with the config file as fallback.
- Bootstrap and CLI tasks — first deployment, accounts, lockout recovery, and maintenance commands.
- Email delivery — SMTP setup, the production gate, and runtime changes.
- File storage: filesystem or S3 — the artifact store, its knobs, and its care tasks.
- Configuring the assistant — connect an OpenAI-compatible provider and tune the turns.
- Database migrations — apply and revert, and the UTC and append-only rules.
- Managed indexes — watch index health and retry failed builds.
Run and maintain
Section titled “Run and maintain”- Background jobs and cron — the job queue, retries and leases, and the eight scheduled passes.
- Health checks, metrics, tracing, logs — the probes, the metric catalog, OpenTelemetry, and log setup.
- Currencies and money — curate the currency list and learn how money values are stored and filtered.
- Retention tuning — set the history and tombstone windows, in the file or at runtime.
- Upgrades and graceful shutdown — the release runbook and the clean-stop sequence.
- Localization — instance defaults for timezone and language, and the per-account settings.