Self-host Backrest with Levelrail
VerifiedA web UI for restic backups with scheduled snapshots, retention policies and restore browsing (GPL-3.0). Create the admin user on first visit, before exposing the address publicly.
- Authorgarethgeorge
- LicenceGPL-3.0
- Memory256 MiB
- Archarm64
- Services1
How to self-host Backrest
-
Pull the images
One image is pulled on your server.
Show images
garethgeorge/backrest:v1.14.1
-
Create the app
One service starts in a single Compose app, with 3 named volume mounts for your data, on port 9898.
-
Fill in the secrets
4 settings are preset, you do not have to fill in anything.
-
Open it
Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.
Backrest requirements
- Memory
- About 256 MiB
- Architectures
- amd64 image published, arm64 tested
- Ports
- 9898
- Domain
- Optional, an sslip.io address is used without one
- Settings
- none to fill in
- License
- GPL-3.0, copyleft license
- Verified. Verified on arm64 with image tag v1.14.1. Our CI ran this exact image version and it answered on its health path. Evidence
Install Levelrail first
On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Backrest. New to Levelrail? Install it on a fresh VPS first.
docker pull ghcr.io/glincker/levelrail:latest Then levelrail-cli login --device. See Getting started and the Backrest docs page.
Deploy Backrest your way
Every format below deploys the same pinned images. Pick the one that fits how you work.
Deploy Backrest from the CLI
levelrail-cli templates deploy backrest --name my-backrest Deploy Backrest with the API
curl -X POST -H "Authorization: Bearer $TOKEN" \
https://levelrail.example.com/api/v1/service-templates/backrest/deploy Backrest configuration
Backrest services
| Service | Image | Ports | Volumes |
|---|---|---|---|
| backrest | garethgeorge/backrest:v1.14.1 | 9898 | data -> /dataconfig -> /configcache -> /cache |
Backrest environment variables
| Variable | Service | Value |
|---|---|---|
| BACKREST_CONFIG | backrest | Preset by the template |
| BACKREST_DATA | backrest | Preset by the template |
| TMPDIR | backrest | Preset by the template |
| XDG_CACHE_HOME | backrest | Preset by the template |
Ports and volumes
- Ports
- 9898
- Volumes
- 3 named mounts: data -> /data, config -> /config, cache -> /cache
Backrest FAQ
How much memory does Backrest need?
The catalog lists about 256 MiB of memory for Backrest.
Does Backrest run on arm64?
For Backrest, arm64 is tested; amd64 is image published.
What licence is Backrest under?
Backrest is licensed under GPL-3.0, which is copyleft, so changes you distribute must be shared under the same terms.
Does Backrest need configuration before it starts?
No. The template fills in its own defaults.
Which ports does Backrest use?
Backrest listens on port 9898 inside the stack.
Where does Backrest keep its data?
In named volumes: data mounted at /data, config mounted at /config and cache mounted at /cache.
Can I deploy Backrest on Dokploy or Dokku?
The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id backrest for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image garethgeorge/backrest:v1.14.1 is what you deploy there.