Deployment architecture
Understand public entry points, private dependencies, and stateful volumes.
Installation
Prepare a Linux host and launch the published images.
Environment variables
Configure shared secrets, URLs, providers, storage, and runtime behavior.
Caddy
Route API, web, CDN, logs, WebSockets, and automatic TLS.
Supported deployment shapes
- Single host
- Managed data services
Run the provided Compose stack on one VM. This is the documented baseline and the simplest way to keep service discovery, secrets, and upgrades consistent.
Public and private surfaces
Production readiness
- Public traffic terminates over HTTPS at Caddy or another trusted proxy.
- MongoDB, Redis, Qdrant, and MinIO are not directly reachable from the internet.
- Every example credential and signing secret has been replaced.
- Persistent volumes are backed up and a restore has been tested.
- Gateway, agent, worker, database, queue, and storage health are monitored.
- Container images are pinned to a reviewed release for repeatable deployments.
- CORS, allowed domains, email delivery, widget origin checks, and rate limits match production policy.
Recommended reading order
1
Understand the topology
Read deployment architecture and identify every stateful component.
2
Install and configure
Follow installation, then complete the environment reference.
3
Expose it safely
Configure Docker Compose and Caddy with real domains and HTTPS.
4
Operate and upgrade
Establish backups, monitoring, and a tested procedure from updating and upgrading.