# Backrest

Backrest is a self-hosted backup app. Web UI and orchestrator for Restic backup. It is open source and self-hosted, installable on Docker Hub, Kubernetes (Helm), Proxmox, TrueNAS and Unraid.

Canonical page: https://ourlocalhost.com/app/639/backrest

## Description

Web UI and orchestrator for Restic backup. Backrest is a web-accessible backup solution built on top of restic, providing a WebUI that wraps the restic CLI to make it easy to create repositories, browse snapshots, and restore files. It can also run in the background, taking an opinionated approach to scheduling snapshots and orchestrating repository health operations. Features include importing existing restic repositories, cron-scheduled backups and health operations (such as prune and forget), a graphical interface for browsing and restoring files from snapshots, configurable backup notifications (Discord, Slack, Shoutrrr, Gotify), and shell command hooks that run before and after backup operations. Backrest is compatible with rclone remotes, supports cross-platform deployment (Linux, macOS, Windows, FreeBSD, Docker), and can back up to any restic-supported storage backend, including S3, Backblaze B2, Azure, Google Cloud Storage, local disk, and SFTP.

## Platform availability

Available on 5 of 9 platforms: Unraid, TrueNAS, Proxmox, Helm, Windows.

## Desktop and other devices

Windows.

## Health score

79/100 (Good), based on 4 of 5 factors.
- Maintained: 85 (last commit 86 days ago)
- Popular: 77 (7,469 GitHub stars)
- Easy to install: 75 (5 install platforms, install notes, Docker image)
- Security check: 76 (no serious findings, 4 minor, CI, tests)

## Links

- Official website: https://garethgeorge.github.io/backrest/
- Docker Hub: https://hub.docker.com/r/garethgeorge/backrest
- Documentation: https://garethgeorge.github.io/backrest/introduction/getting-started
- Kubernetes (Helm): https://artifacthub.io/packages/helm/robertobochet/backrest
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=backrest
- TrueNAS: https://apps.truenas.com/catalog/backrest/
- Unraid: https://ca.unraid.net/apps/backrest-1sz82s60ygnneq?q=backrest
- GitHub: https://github.com/garethgeorge/backrest
- desktop: https://github.com/garethgeorge/backrest/releases/latest

## Common questions

### What Docker paths and persistent volumes should I configure for Backrest?

Replace /path/to/backup/data and, if using local repositories, /path/to/local/repos with the real folders to protect. Keep ./backrest/config, data, cache, and rclone on persistent storage, otherwise Backrest can forget backup plans and cloud login details after changes.

### How do I allow other devices to reach the Backrest UI after installing it with the script?

Run it with --allow-remote-access if you want to use the 9898 page from another device. Without that flag, it listens only on 127.0.0.1.

### How can I reset Backrest login credentials?

Delete the "users" key from your saved configuration to reset the username and password.

### Can the Backrest installation ID be changed after initial setup?

No, it cannot be changed via the UI after initial setup. It is used to distinguish snapshots from different Backrest instances.

### What should I keep to recover a Backrest/restic repository?

Keep your repository passwords and 2FA recovery codes, since they are needed to recover the repository.

### Can Backrest schedule prune and forget operations?

Yes, it can run cron scheduled backups and health operations, such as prune and forget.

---
Source: Our Local Host (https://ourlocalhost.com/app/639/backrest), the self-hosted and open-source app directory.