Features
Apps
- Backs up 27 apps: Radarr, Sonarr, Lidarr, Whisparr (v2 and v3), Prowlarr, Profilarr, Bazarr, Tdarr (2 and 3), SABnzbd, NZBGet, Tautulli, Jellyfin, Emby, Plex, Seerr, Immich (its database), LazyLibrarian, Pi-hole (v6), Bitwarden (self-hosted), Vaultwarden, OPNsense, pfSense, UniFi, Home Assistant, Unraid (its boot device), Synology DSM and QNAP QuTS hero (their settings, not the NAS’s data). See Apps.
- Most apps are backed up through their own API. Jellyfin, Emby, Plex, Seerr, LazyLibrarian, Bitwarden and Vaultwarden also need a folder mounted into Backuparr.
- Include metadata on Jellyfin, Emby and Plex adds their posters, artwork and saved metadata, custom artwork too. History shows which backups have it.
- Up to 10 extra instances each of Radarr, Sonarr, Lidarr, Whisparr, Pi-hole, OPNsense, pfSense, UniFi, Immich, Home Assistant, Unraid, Synology DSM and QNAP QuTS hero, such as a 4K Radarr or a second firewall. See More than one instance.
- Prowlarr discovery fills in the apps Prowlarr already knows, API keys included. See Prowlarr discovery.
- Test connection on every app card.
- Signs in to Radarr, Sonarr, Lidarr, Whisparr and Prowlarr with their own login when they ask for one. See the note.
- Works with apps behind an authenticating reverse proxy. See Service authentication headers.
Destinations
- Local Storage, Google Drive, OneDrive and Dropbox. Every run uploads to each one you enable. See Destinations.
- Cloud connections are made in the web UI, with no rclone config.
- An optional bandwidth cap for uploads and downloads (
RCLONE_BWLIMIT).
Backups
- Scheduled backups (daily, weekly, every few hours or any cron schedule), and Run backup now for every app or just one.
- Each backup is checked before it’s uploaded. A damaged one isn’t uploaded, and the app shows as failed with the reason.
- Retention by age, set once or per destination, always keeping each app’s newest backup.
- A live log while a backup runs, and each app’s log from every run, kept with its backups.
- History lists, downloads and deletes backups on each destination, with the app version each backup came from.
- A summary after every run to Discord, Slack, Telegram, Gotify, ntfy or any webhook. See Notifications.
See Backups and history.
Restores
- Restore from the web UI, with live progress and a log. Every app can be restored this way except Profilarr and Tautulli’s database, which are restored by hand; for Profilarr the Restore tab gives the download and the steps.
- A backup is only restored onto the exact app version it came from. When the versions differ, the message names the version to install.
- Each download is checked against the checksum recorded when the backup was made.
- Restore to a different target: a one-off URL and key, for a rebuilt server or a trial restore.
See Restoring.
Home Assistant
- A read-only status for Home Assistant, opened by a token of its own. See Home Assistant.
- The Backuparr integration for Home Assistant: a problem sensor for every app’s backups, set up from Home Assistant’s UI.
Backuparr’s own backup
- At the end of each full run, Backuparr backs up its own settings, cloud connections, login, backup record and run logs to every destination, encrypted with your encryption key. It has its own card under Server, and Run & Status can back it up on its own.
- On a new install, restore it from the setup screen. On a running install, restore it from Settings.
See Restoring Backuparr itself.
Security
- An admin login, a lockout after repeated wrong passwords, and a password change from the user menu.
- A forgotten password can be replaced with your encryption key, keeping your settings. See Forgot your password?.
- Backups are encrypted with your encryption key before upload; turn it off per app, except for apps that are always encrypted. See Encrypted backups.
- API keys, passwords and cloud tokens are encrypted at rest.
- Local login can be turned off behind an authenticating reverse proxy.
See Login and security.
Install
- A Docker image for
linux/amd64andlinux/arm64, on Docker Hub and GitHub Container Registry. - An Unraid template in Community Applications.
See Getting started.