raspiBackup - Backup and restore your active Raspberries

For a high level summary visit this page.

• Primary features
  • Unattended full or incremental system backup with no shutdown of the system.
  • Backup types
    • rsync
    • tar/tgz
    • dd/ddz
  • No manual intervention required. Backups are created via cron over night.
  • Important services can be stopped before starting the backup and will be restarted when the backup finished.
  • Any device mountable on Linux can be used as backup space (local USB disk, remote nfs drive, remote samba share, remote ssh server using sshfs, remote ftp server using curlftpfs, webdav drive using davfs, ...).
  • Supported systems
    • SD card only
    • USB disk or SSD only (USB boot mode)
    • SD card for boot and USB disk or SSD for root system (for older Raspberries which don't support USB boot)
  • Messages and completion status of backup sent via eMail, Telegram. Pushover or Slack
  • Any additional logic can be added at various steps in the backup and restore process via extensionpoints.
  • Restored backup will boot immediately.
• Backup strategies
  • Number of backup versions to keep configurable either for sum of backups or on individual backup types
  • Smart recycle backup strategy available (e.g. save backups of last 7 days, last 4 weeks, last 12 months and last n years) - also known as grandfather, father and son backup rotation principle. The smart recycle strategy algorithm was inspired by Manuel Dewalds great article Automating backups on a Raspberry Pi NAS
  • Manual backups allow to create a kind of snapshot (so called raspiBackup snapshots) of the system just before major updates are done on a system.
• Linux backup tools used
  • Standard Linux backup tools dd, tar and rsync can be used to create a backup.
  • dd and tar are full backups. rsync uses hardlinks for incremental backups.
  • dd backups can be restored with Windows tools.
• Installation
  • Menu driven installer installs and configures raspiBackup with all major options to get raspiBackup up and running in 5 minutes. Much more options can be configured in a configuration file.
• Usability
  • National language support:
    • English (Default)
    • German
    • Finnish (teemue)
    • Chinese (GoogleBeEvil)
    • French (mgrafr)
    • Many thanks to the folks above who translated raspiBackup messages into their native language 👍
      • Any translation help to add other languages to raspiBackup is greatly appreciated. Please read this page
  • More than 270 messages inform about
    • Backup progress
    • Configuration mismatches
    • Environment mismatches
    • Runtime errors
• Reliability
  • Automated regressiontests make sure a new release will still backup and restore successfully.
• Serviceability
  • Extensive logging helps to locate and fix backup/restore issues
• Much more features available (see below).

Support

raspiBackup is supported only for RaspberryOS and Ubuntu as operating system and only for Raspberry hardware. raspiBackup runs successfully also on other Raspberry compatible hardware and other Linux distros but any support request on these unsupported environments will be rejected. Just give it a try and be happy if it works but don't ask for any support. For details see here.

Support is also given only for raspiBackup specific issues. For general Linux related questions please use other information sources.

• Create issues
• Ask questions

Documentation

English

• Installation
• Users guide
• FAQ
• Error messages, root causes and suggested actions
• Smart recycle backup strategy
• Use synology as backup space

German

• Installation
• Benutzerhandbuch
• FAQ
• Fehlermeldungen, Ursachen und Behebung
• Intelligente Rotationsstrategie
• Benutzung von Synology als Backupspace

French

This README was translated into French. Credits to mgrafr for his translation work.

Installer

The installer uses menus, checklists and radiolists similar to raspi-config and helps to install and configure major options of raspiBackup and in 5 minutes the first backup can be created.

Installer demo

Installation of raspiBackup will started with following command:

curl -s https://raw.githubusercontent.com/framps/raspiBackup/master/installation/install.sh | sudo bash

Donations

raspiBackup is maintained just by me - framp. If you find raspiBackup useful please donate to support future development and acknowledge support. For details how to donate see here

Feature requests

Anybody is welcome to create feature requests in github. They are either immediately scheduled for the next release or moved into the backlog. The backlog will be reviewed every time a new release is planned and some issues are picked up and will be implemented in the next release. If you find some features useful just add a comment to the issue with 👍. This helps to prioritize the issues in the backlog.

Much more detailed documentation

• English
• German

Social media

• Youtube - Videos in English and German
• Twitter - News and announcements - English only
• Facebook - News, discussions, announcements and misc background information in English and German

Miscellaneous sample scripts (Code)

• Sample wrapper scripts to add any activities before and after backup (Code)

• Sample wrapper script which checks whether a nfsserver is online, mounts one exported directory and invokes raspiBackup. If the nfsserver is not online no backup is started. (Code)

• Sample script which restores an existing tar or rsync backup created by raspiBackup into an image file and then shrinks the image with pishrink. Result is the smallest possible dd image backup. When this image is restored via dd or windisk32imager it's expanding the root partition to the maximum possible size. (Code)

• Convenient helper script to restore a backup. (Code)

Sample extensions

There exist sample extesions for raspiBackup which report for example memory usage, CPU temperature, disk usage and more. There exist also user provided extensions.

Systemd

Instead of cron systemd can be used to start raspiBackup. See here (thx Hofei) for details.

REST API Server proof of concept

Allows to start raspiBackup from a remote system or any web UI.

1. Download executable from RESTAPI directory
2. Create a file /usr/local/etc/raspiBackup.auth and define access credentials for the API. For every user create a line userid:password
3. Set file attributes for /usr/local/etc/raspiBackup.auth to 600
4. Start the RESTAPI with sudo raspiBackupRESTAPIListener. Option -a can be used to define another listening port than :8080.
5. Use curl -u userid:password -H "Content-Type: application/json" -X POST -d '{"target":"/backup","type":"tar", "keep": 3}' http://<raspiHost>:8080/v0.1/backup to kick off a backup.