backrest/docs/content/0.index.md

title, navigation, layout, main

title	navigation	layout	main
Home	false	page	fluid false

:ellipsis{right=0px width=75% blur=150px}

::block-hero

cta:

• Get started
• /introduction/getting-started secondary:
• Open on GitHub →
• https://github.com/garethgeorge/backrest

---

#title Web UI and orchestrator for Restic backup.

#description

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.

#extra ::list

• 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) ::

#support ::code-group

brew tap garethgeorge/homebrew-backrest-tap
brew install backrest

paru -Sy backrest
sudo systemctl enable --now backreset@$USER.service

version: "3.2"
services:
  backrest:
    image: garethgeorge/backrest
    container_name: backrest
    hostname: backrest
    volumes:
      - ./backrest/data:/data
      - ./backrest/config:/config
      - ./backrest/cache:/cache
      - /MY-BACKUP-DATA:/userdata # mount your directories to backup somewhere in the filesystem
      - /MY-REPOS:/repos # (optional) mount your restic repositories somewhere in the filesystem.
    environment:
      - BACKREST_DATA=/data # path for backrest data. restic binary and the database are placed here.
      - BACKREST_CONFIG=/config/config.json # path for the backrest config file.
      - XDG_CACHE_HOME=/cache # path for the restic cache which greatly improves performance.
    restart: unless-stopped
    ports:
      - 9898:9898

:: ::