Self-Host Guide

This section is for operators running SynckHub on their own infrastructure.

It is operations-first: topology, secrets, deploy workflow, recovery, and integrations.

What this section covers

• environment and topology choices (local, dev, selfhosted-prod)
• infra-ansible inventory, config, and release pinning
• maintenance-window deploy and rollback workflow
• Common and SynckHub control-plane wiring
• Office and Yjs coauthoring integration setup
• backups, monitoring, and secret rotation discipline

What changed in the platform

Self-hosting now has to cover more than “run the web app and a database.” Current SynckHub deployments may include:

• Common control-plane wiring and infra-token lifecycle
• desktop-assisted file flows and tus uploads
• Office WOPI or Yjs coauthoring
• public shared-link routing
• mail and calendar OAuth or webhook surfaces
• optional federation and structured-data features

That means operational discipline matters more now. A casual compose setup is not a deployment model.

Recommended reading paths

First deployment path

1. start-here/deployment-models-and-scope.md
2. start-here/prerequisites-checklist.md
3. deployment/quickstart-new-vm.md
4. deployment/config-and-inventory.md
5. deployment/release-and-maintenance-workflow.md
6. deployment/common-and-infra-registration.md

Ongoing operations path

1. operations/backups-and-restore.md
2. operations/monitoring-and-health.md
3. operations/secrets-and-rotations.md
4. operations/troubleshooting.md

Integrations path

1. integrations/office-coauthoring.md
2. integrations/yjs-coauthoring.md