Create and keep multiple backup versions of your running Raspberries

A high level summary is available on this page.

The complete raspiBackup documentation is available on this page

• Primary features
  • Unattended full or incremental system backup with no shutdown of the system.
  • Backup types
    • rsync
    • tar/tgz, compression bzip2, gzip, lzip, lzma, lzop, xz and zstd can also be used
    • dd/ddz
  • No manual intervention required. Backups are created via systemd timer 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 storage devices
    • SD card
    • eMMC
    • USB device (HDD, SSD, flash drive, USB SD adapter)
    • NVMe
  • Supported boot modes
    • 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
• Backup created can be synced with a local connected clone device
  • If it's important to get the system up and running again immediately without any manual backup restore, raspiBackup can synchronize at the end of the backup run the just created backup with any device. The device then can be used immediately in the event of an unexpected system failure to boot up the system again.
• 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 any 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

• Comprehensive raspiBackup Documentation
• Installation
• FAQ
• Error messages, root causes and suggested actions
• Smart recycle backup strategy
• Use synology as backup space

German

• Vollständige raspiBackup Documentation
• Installation
• FAQ
• Fehlermeldungen, Ursachen und Behebung
• Intelligente Rotationstrategie
• Nutzung von einer Synology/NFS Server als Backuspace

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

Installation of raspiBackup is started with following command:

curl -o install -L https://raw.githubusercontent.com/framps/raspiBackup/master/installation/install.sh; sudo bash ./install

Donation

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

Social media

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

Miscellaneous sample scripts (Code)

• Convenient helper script to backup and restore a backup. (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)

Sample extensions

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