Install SynckHub Free Self-Hosting
SynckHub Free Self-Hosting is the supported customer-operated product for up to five active human users, including the owner. All five may write when their repository role permits it.
The supported topology is deliberately small: one SynckHub API process, PostgreSQL, filesystem blob storage, the matching web application, and a same-origin TLS edge. Kubernetes, multiple API replicas, external object storage, Common password login, and vendor remote access are not part of this release.
Before you start
You need:
- a Linux
amd64host with Docker Engine and Docker Compose v2; - a public DNS name whose ports 80 and 443 reach the host;
- outbound HTTPS to SynckHub Common and the admitted federation service;
- a modern browser;
- durable local storage and an off-host backup destination.
Use the qualified self-hosted bundle attached to one SynckHub GitHub release. Its environment
template pins every runtime image independently by digest and its manifest records both application
source revisions. Do not replace those references with latest, a version tag, or any other
mutable tag.
Install
Download the release bundle, JSON manifest, and checksum with the same version. Verify and extract the bundle, then run the installer:
sha256sum -c synckhub-self-hosted-vX.Y.Z.tar.gz.sha256
tar -xzf synckhub-self-hosted-vX.Y.Z.tar.gz
cd synckhub-self-hosted-vX.Y.Z
./selfhost-install
The installer asks for the public host, the owner’s email, the company name, and the company slug. To run it without prompts, pass all four:
./selfhost-install \
--host hub.example.com \
--owner [email protected] \
--company "Example Company" \
--slug example-company
The installer checks the pinned images, generates the local database password, and starts the stack. Common emails the owner a six-digit verification code; enter it in the same terminal. Common then checks that your host serves a signed challenge over HTTPS before it registers the installation. The local password and generated secrets never leave the host.
If the installer stops, rerun ./selfhost-install without options. It resumes
the same installation instead of creating a new one.
Create the owner password
The installer prints an owner bootstrap URL that is valid for 15 minutes. Open
it and choose the owner password. Common passwords and SynckHub administrator
credentials can’t sign in to this installation. After the account is created,
delete secrets/owner-bootstrap-capability.
Invite members
The owner can invite four more people. Open Settings > Self-hosting, and under Invite a member, enter their email and choose a Repository role: Reader, Writer, or Admin. Each invitation is for that one person and role. A sixth active person is rejected by the free plan; repository data isn’t deleted if you later change plans.
Operate it
The release bundle’s README.md is the normative operator runbook. It contains the exact
upgrade, owner recovery, cold backup and restore, local signing-key rotation, and Common credential
rotation procedures. Keep that runbook and the pinned deployment files with each backup.
Do not add vendor SSH keys, reverse tunnels, Common notify tokens, clearinghouse administrator
tokens, support credentials, or plaintext secrets in .env. Explicitly federated content is still
disclosed to its admitted federation route; local data that is not shared remains on the customer
host.
Read the managed federation model for the trust boundary, benefits, limitations, and comparison with email-style decentralization.