Sorcha Deployment
This page routes you to the right guide for your deployment path.
Canonical operator path (Docker Compose)
For a self-hosted deployment using Docker Compose, follow the Admin Guide in order:
- Prerequisites & Sizing — hardware, software, and network requirements
- Installation & First Run — clone, configure
.env, start services, bootstrap - Configuration Reference — all environment variables
- Scaling & High Availability — horizontal scaling, Redis backplane, multi-replica patterns
Before starting services, work through the Production Pre-Flight Checklist — it covers six gaps between the shipped development defaults and a production-ready deployment (JWT key, database passwords, per-service environment overrides, Redis authentication, peer TLS, and the admin-verified user creation flag).
For a description of every compose file and the deploy/ tooling tree, see the Compose Files & Deployment Tooling section in the Admin Guide.
Azure deployment
| Guide | Purpose |
|---|---|
| Azure Deployment Quick Start | End-to-end Azure Container Apps deployment |
| Azure Database Initialization | PostgreSQL and MongoDB on Azure managed services |
| Azure Custom Domain Setup | Custom domain and TLS via Azure Front Door / App Service |
Backup and recovery
See the Administration guide — it covers PostgreSQL, MongoDB, and Redis backup procedures and the wallet encryption key backup/restore scripts.
Development quick start
For local development (not production):
- Docker Quick Start — fastest path to a running local stack
- Infrastructure Setup — databases only, services run from IDE or Aspire
Reset a Docker deployment
# Windows
.\scripts\reset-docker-state.ps1
# Linux/macOS
./scripts/reset-docker-state.shSee the Troubleshooting guide for common issues.