Guide

How to install, run, and operate SHC. Audience: operators standing up SHC for their own infrastructure and deploying apps onto it.

For writing your own SHC apps, see ../app-development/. For internals, see ../architecture/. For exhaustive CLI/API/config lookup, see ../reference/.

---

• Installation — install via deb, source, or dev mode
• Quick start — first stack, first backup, first restore
• Core concepts — tenant, environment, stack, deployment, node

Standing up SHC on a public cloud. Each cloud has a Terraform module + example root and a live make test/<cloud> smoke lane.

• Cloud guides — per-cloud pages (AWS, Azure, GCP, DigitalOcean, Exoscale, OpenStack, Scaleway, Vultr) plus the shared make test/<cloud> env-var contract — one Cloudflare domain tests them all

Running pre-built SHC apps. (For authoring your own app, see ../app-development/.)

• App catalog — index of all bundled apps grouped by category (auto-generated from apps/*/app.yaml)

Featured app guides:

• Keycloak
• PostgreSQL
• Traefik
• OpenObserve
• Huly — including migrating an existing install off its bundled CockroachDB and MinIO

• Multi-node cluster setup — add nodes to an existing cluster
• Upgrading SHC — rolling upgrades, migrations, rollback
• Storage providers — local / NFS / CephFS setup
• Vault & secrets — unlocking, ref+vault://, provider options
• Disaster recovery — recovering from quorum loss, dead leaders, permanent node failure
• Observability — health endpoints, logs, metrics, traces, collector setup
• Monitoring — Grafana dashboard + Prometheus alert rules for SSE

• Troubleshooting index — symptom-first routing
• Common issues — install/integration/backup/cluster/vault failure walkthroughs
• SSE streaming issues