Docker Compose Quick Start
Yearning v4.0 is currently in Public Beta. Please deploy in staging or evaluation environments first, and always back up the PostgreSQL data volume and keyring.json before testing with important data.
Yearning v4 ships an all-in-one docker-compose.yml that bootstraps PostgreSQL 18, internal PostgreSQL TLS certificates, a 6-purpose AES-256-GCM AEAD keyring, automated versioned schema migrations, and the Yearning v4 control plane with embedded React UI in a single command.
Prerequisites
- Docker Engine 24+ and Docker Compose v2
- Available port
8080(override withYEARNING_PORT) - Minimum 2 vCPU / 2 GiB RAM (4 GiB+ recommended for large batch SQL fingerprinting)
Launch in Three Commands
Verify startup health:
Open http://<your-host-ip>:8080:
- Default admin username:
admin - Default initial password:
Yearning@2026!(or yourYEARNING_ADMIN_PASSWORD)
- Add and test at least one OpenAI-compatible AI Provider in Review Engine -> Providers (
/admin/review-engine/providers). - Compose a Rule Set in
/admin/rule-setsfrom built-in or custom skills. - Register target databases in Admin -> Datasources (
/admin/datasources) with separated read-only and execution credentials. - Create
change_reviewandquery_accessflows in/admin/flowsand assign them via Permission Groups (/admin/permission-groups). :::
Service Topology
:::danger Never run docker compose down -v during upgrades
Deleting the yearning_app_secrets volume permanently destroys your AEAD keyring (keyring.json), making all encrypted datasource passwords, AI provider keys, order SQL payloads, and rollback artifacts undecryptable.
Production Hardening Checklist
- Terminate HTTPS in front of Yearning (Nginx / Envoy / Ingress) and set
YEARNING_ENVIRONMENT=productionplusYEARNING_SESSION_SECURE=true. - Configure
YEARNING_TRUSTED_PROXIESso audit trails capture real client IP addresses. - Provision PostgreSQL 3-role isolation (
yearning_app,yearning_migrator,yearning_retention) and supplyYEARNING_RETENTION_DATABASE_DSN. See Kubernetes Production Deployment. - Back up
keyring.jsonin an external KMS or encrypted vault alongside PostgreSQL backups.