backrest
backrest
Docker app from AlexRed's Repository
Overview
Web UI and orchestrator for Restic backup.
Backrest is a web-accessible backup solution built on top of restic and providing a WebUI which wraps the restic CLI and makes it easy to create repos, browse snapshots, and restore files. Additionally, Backrest can run in the background and take an opinionated approach to scheduling snapshots and orchestrating repo health operations.
Features:
- Import your existing restic repositories
- Cron scheduled backups and health operations (e.g. prune and forget)
- UI for browing and restoring files from snapshots
- Configurable backup notifications (e.g. Discord, Slack, Shoutrrr, Gotify)
- Add shell command hooks to run before and after backup operations.
- Compatible with rclone remotes
- Cross-platform support (Linux, macOS, Windows, FreeBSD, Docker)
- Backup to any restic supported storage (e.g. S3, B2, Azure, GCS, local, SFTP, and all rclone remotes)
Github: https://github.com/garethgeorge/backrest
Documentation: https://garethgeorge.github.io/backrest/introduction/getting-started
Requirements
Notes
===
Environment Variables
BACKREST_PORT - the port to bind to. Defaults to 9898.
BACKREST_CONFIG - the path to the config file. Defaults to $HOME/.config/resticui/config.json or if $XDG_CONFIG_HOME is set, $XDG_CONFIG_HOME/resticui/config.json.
BACKREST_DATA - the path to the data directory. Defaults to $HOME/.local/share/resticui or if $XDG_DATA_HOME is set, $XDG_DATA_HOME/resticui.
BACKREST_RESTIC_COMMAND - the path to the restic binary. Defaults managed version of restic which will be downloaded and installed in the data directory.
XDG_CACHE_HOME -- the path to the cache directory. This is propagated to restic.
BACKREST_PORT -- port for webui application
===
Environment Variables
BACKREST_PORT - the port to bind to. Defaults to 9898.
BACKREST_CONFIG - the path to the config file. Defaults to $HOME/.config/resticui/config.json or if $XDG_CONFIG_HOME is set, $XDG_CONFIG_HOME/resticui/config.json.
BACKREST_DATA - the path to the data directory. Defaults to $HOME/.local/share/resticui or if $XDG_DATA_HOME is set, $XDG_DATA_HOME/resticui.
BACKREST_RESTIC_COMMAND - the path to the restic binary. Defaults managed version of restic which will be downloaded and installed in the data directory.
XDG_CACHE_HOME -- the path to the cache directory. This is propagated to restic.
BACKREST_PORT -- port for webui application
Runtime arguments
- Web UI
http://[IP]:[PORT:9898]- Network
bridge- Shell
bash- Privileged
- false
Template configuration
ConfigPathrw
location of the config.json file
- Target
- /config
- Default
- /mnt/user/appdata/backrest/config
- Value
- /mnt/user/appdata/backrest/config
CachePathrw
path for the restic cache which greatly improves performance.
- Target
- /cache
- Default
- /mnt/user/appdata/backrest/cache
- Value
- /mnt/user/appdata/backrest/cache
DataPathrw
- Target
- /data
- Default
- /mnt/user/appdata/backrest/data
- Value
- /mnt/user/appdata/backrest/data
Restic reposPathrw
(optional) - mount restic repositories on the filesystem
- Target
- /repos
- Default
- /mnt/user/appdata/backrest/repos
- Value
- /mnt/user/appdata/backrest/repos
Path to backupPathro
mount directories for backup
- Target
- /backup
- Default
- /mnt/user/backup
- Value
- /mnt/user/backup
WebUIPorttcp
Webui access port, BACKREST_PORT env variable can be used to change the app port as well
- Target
- 9898
- Default
- 9898
- Value
- 9898
BACKREST_DATAVariable
path for backrest data. restic binary and the database are placed here.
- Default
- /data
- Value
- /data
BACKREST_CONFIGVariable
path for the backrest config file.
- Default
- /config/config.json
- Value
- /config/config.json
XDG_CACHE_HOMEVariable
path for the restic cache which greatly improves performance.
- Default
- /cache
- Value
- /cache
TZVariable
Timezone
- Default
- America/Toronto
- Value
- America/Toronto
Categories
Download Statistics
3,237,530
Total Downloads
411,789
This Month
266,196
Avg / Month
Total Downloads Over Time
Loading chart...
Details
Repository
garethgeorge/backrest:latestLast Updated2026-05-04
First Seen2024-08-24
Run Backrest on Unraid.
Backrest is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.