The purpose of this page is to explain step by step how to install and configure raspiBackup in 5 minutes to create a backup of your Raspberry very quick. This page describes for different platforms (Linux, Mac or Windows) how to restore the backup. After testing the backup and restore the next step should be to check which services have to be stopped before the backup starts. Finally cron should be configured to start raspiBackup on a regular base. Later on when you have some spare time read this page carefully to check which additional features of raspiBackup are useful for you and update the raspiBackup configuration accordingly. In any case it's strongly recommended to read the FAQ.


Installation and configuration can be installed with an installation script. The most important configuration options are prompted by the installer and will be saved in the configuration file.  All other options are described here in detail. Take your time to read the page at some point in time. Various other alternate installation methods are described here.

If there exists alreay an installation of raspiBackup the current together with the current configuration raspiBackup.conf will be saved in the same directory by renaming them and append the version number of the current raspiBackup version. Example: Current version is The backup will then become and raspiBackup.

The installation of raspiBackup will be started with

Note: There exists already a much more comfortable UI Installer (beta state) with more capabilities. For details see here

curl -s -L -O && sudo bash 

The install script asks following questions (You can overwrite them via options temporarily or update them in /usr/local/etc/raspibackup.conf):

1) Install beta version ?

If there exists a beta version it's possible to select this one to install. That way everybody can help to test new raspiBackup versions.

2) Message language ?

All messages of the installation script and raspiBackup will be written in the selected language. Englisch (en) and German (de) are available.

Corresponding raspiBackup option is -G.

3) Normal or partitionoriented mode ?

The normal mode supports only two partitions. An external root partition on an USB disk or USB stick will also be saved.  NOOBS installations have more than two partitions and requires the partitionoriented backup mode. An external root partition will not be saved.

Corresponding raspiBackup option is -P.

4) Backuptype ?

Linux offers following backup tools. dd, tar or rsync are available when using the normal backup mode. Partitionorientierted mode allows to use tar and rsync only. If you want to be able to restore your backup on a Windows system you have to use dd because that's the only format which windisk32imagersupports. But keep in mind you also can use your Raspberry to restore a backup and can restore the backuptypes tar and rsync which are much better than a dd backup. More details and a decition tree for the backup type is available here.

Corresponding raspiBackup option is -t.

5) Compress backup ?

dd and tar backups can be compressed and need less backupspace.

Corresponding raspiBackup option is -z.

6) Number of backups ?

raspiBackup keeps a specific number of backups per Raspberry.  If the number of backups is exceeded the oldes backup will be deleted.

Corresponding raspiBackup option is -k.

7) Verbose messages ?

raspiBackup can write detailed message when creating a backup.

Corresponding raspiBackup option is -m.

8) Configuration OK ?

That's the last question of the installationscript. If everything is OK answer y and the installation and configuration will start. Every other answer will start over the install script and ask again for all options.

curl -s -L -O && sudo bash 

Create the standard mount point used by raspiBackup to save the backup with

sudo mkdir /backup

Now mount the external device (USB disk USB dongle, nfs drive ...) on this mountpoint. The following example uses an external USB disk or external USB dongle.

sudo mount /dev/sda1 /backup

Before starting the backup chak that you mounted the right backup partition. Following commands will help on this:

sudo blkid -o list
mount | grep backup

or if you have labeled your partition

sudo blkid -o list | grep <label>


Create backup and test restore

Now everything is ready to create a backup. Please note you have to configure raspiBackup to shutdown some services before backup later on when raspiBackup is used on a regular base. Read FAQ18 for details about this. If you don't have to stop any services or if you just want to test raspiBackup start the backup with following command. Depending on the size of raspiBackup this may take some time.

sudo -a : -o : -m detailed

When the backup finished successfully then restore the backup on another SD card and test the restored image.


Backup your Raspberry unattended on a regular base


In order to test raspiBackup you can user the parameter : for options -a and -o. But when starting to use raspiBackup on a regular base check which services should be stopped beforehand (see FAQ18) and no inconsistent backups will be created. Then execute the restore of a backup (see here) to get familar with the restore process and to check that the restored image works.

Execute following steps in order to create an unattended backup. (Assumption: Backup should be created on Sunday 10 pm and samba and apache are stopped before creating the backup and started again when backup finished)

sudo crontab -e

and insert following line:

00 22  * * 0 /usr/local/bin/ -a "service samba start; service apache2 start" -o "service apache2 stop;service samba stop"

Note: The list of parameters for option -a and -o usually should be defined in the configuration file with options DEFAULT_STARTSERVICES and DEFAULT_STOPSERVICES.


Next steps

When you cerated your first backup and tested the restore take some time and check all other available options of raspiBackup and use them if they are useful for you. One nice option is -e <eMailAdress>. Then raspiBackup will send an eMail every time a backup was executed . In addition you can exclude directories from the backup, reduce the size of dd backups and a lot of other stuff.

Every option can be updated in /usr/local/etc/raspiBackup.conf so you don't have to pass any options when calling raspiBackup. Some options can be used only via the config file. You find all details about raspiBackup on the usersguide page


Invocationoptions of installation script

The installationscript will start a simple configuration wizzard which configures the most important options for raspiBackup. Other options can be used to control the installation process in more granularity. Option -U will uninstall raspiBackup.

Usage: sudo ./ [[-c] [-l DE | EN]] | [-U] | [-h]

No options will start a configuration wizzard and prompt for the most important configuration parameters

       -b - Install the beta version if available
       -B <directory> - Define the bin target directory
       -c - Install default config file
       -C <directory> - Define the cron target directory
       -e - Install and configure sampleextensions
       -E <directory> - Define the etc target directory
       -h - Show this help text
       -k - Keep installscript after successful installation
       -l - Install English (EN) or German (DE) version of the config file
-L <directory - Logdirectory
       If -c is used without -l the current system language is used for the config file
       -r - Updates the local script version with the latest script version available (Current configuration file will not be modified)
       -U - Uninstall with it's configuration file and the installer
Add comment


Spam comments are purged and not published. Review is done manually and therefore it usually takes between some hours and one day until a comment will be published.