# Self-host Backrest

> A 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.

- Page: https://levelrail.com/templates/backrest/
- JSON: https://levelrail.com/templates/backrest.json
- Category: Backups
- Licence: GPL-3.0 (Copyleft license)
- Source: https://github.com/garethgeorge/backrest
- Upstream docs: https://garethgeorge.github.io/backrest/

## Requirements
- Memory: about 256 MiB
- amd64: published, arm64: tested
- Needs configuration before start: no
- Pinned image tag: v1.14.1

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| backrest | garethgeorge/backrest | v1.14.1 | 9898 | data -> /data; config -> /config; cache -> /cache |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| backrest | BACKREST_CONFIG | preset |
| backrest | BACKREST_DATA | preset |
| backrest | TMPDIR | preset |
| backrest | XDG_CACHE_HOME | preset |

## Deploy

### CLI

```bash
levelrail-cli templates deploy backrest --name my-backrest
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/backrest/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### 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.

Self-host Backrest, Backrest docker compose file, deploy Backrest on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
