Admin Guide

The admin guide has been split into per-topic pages so each topic has a focused home rather than living in a single 2000-line reference. Start with the topic that matches what you’re doing:

Getting started

Quickstart — get a working deployment in under a minute
Architecture — system diagram, storage layer, write routing

Configuration

Configuration walkthrough — every YAML block, validation rules, hot-reload matrix
Authentication — SigV4 variants, credentials, multi-bucket isolation
Backends — provider quick-reference, routing strategies, usage limits, multi-backend topologies
Database — engine choice (SQLite vs PostgreSQL), schema, goose migrations
Encryption — envelope encryption, Vault Transit, key rotation, integrity verification
Notifications — webhook outbox pattern, CloudEvents JSON, HMAC signing

Operations

Operations — drain, rebalance, scrub, cache management, trace snapshot, credential rotation
Replication — replication factor, over-replication cleanup, orphan reconciliation
Cleanup and lifecycle — cleanup queue, PUT-before-COMMIT pending intents, lifecycle expiration
CLI subcommands — version, init, validate, sync, admin
Deployment — Nomad, Kubernetes, Docker, Debian package, multi-instance

Observability and troubleshooting

Monitoring — full Prometheus metric reference, OpenTelemetry traces, structured logs, audit log, panic recovery, on-demand reconciliation
Background services — worker reference table (intervals, advisory locks)
Performance tuning — connection pools, timeouts, broadcast tuning
Disaster recovery — failure scenarios and recovery procedures
Security hardening — TLS, mTLS, config security, network segmentation
API reference — UI and Admin API JSON endpoints