Skip to main content
This guide uses the published Docker images and the example Compose files from the repository. You need Docker with Compose on each machine.
You can run both apps on the same machine to try things out. In real use, Central usually runs on a separate, always-on host.

​
1. Start Central

On the machine that will store backups:
Edit .env and set a real POSTGRES_PASSWORD (and optionally INITIAL_ADMIN_PASSWORD), then start it:
Open http://localhost:6555/ and sign in as admin. See Sign-in and accounts.

​
2. Mint an Edge credential

In Central’s UI, mint a new Edge credential and copy it. You’ll paste it into Edge in the next step. See Edge credentials.

​
3. Start Edge

On the machine that has the files:
Edit .env:
.env
If Central runs on the same Docker Desktop host, CENTRAL_URL is usually http://host.docker.internal:6555.
Open http://localhost:6556/, sign in, and paste the credential from step 2 into Edge’s settings.

​
4. Mark a folder for backup

Create a file named .upload_dir in the folder you want backed up. An empty file works; Edge uses the folder name as the job name:
Or click Edit on the folder in Edge’s folder browser and save it as a job, which writes the marker for you. See Backup jobs.

​
5. Run the first backup

Edge backs up on its schedule (weekly by default). To back up now, click Run Backup Cycle Now in Edge’s UI. When it finishes, the snapshot appears in Central’s UI.
Back up Edge’s encryption.key right away. Without it, that Edge’s snapshots cannot be decrypted. See Encryption key.

​
Next steps

Back up several folders or drives

Mount more than one folder into Edge.

Restore files

Bring a snapshot back onto the Edge machine.