SuperBackup is a set of simple yet powerful bash scripts that allows users to create backups and MySQL dumps of the environments that the script is installed on.
It uses rsync to create the backups, because of this it is quite convenient for remote disk usage. The script uses a retention schema that creates backups as follows:
- On Monday a full backup is created starting from the configured backup root
- The rest of the weekdays a incremental backup (only the changed files) will be created based on the backup of yesterday (with exception of Monday).
- In addition weekly and monthly retention can be enabled so you have a longer backup history. These are always full backups. The weekly backup is created on Monday and the monthly backup on the 1st of the month.
The backups will be placed on the remote machine in a simple construction:
- The hostname of the local machine is created as a folder on the remote machine
- Inside the hostname folder the days of the week (1 to 7) are created as folders and contain the backup data for that day
Based on this construction you can backup multiple hosts to 1 remote backup server!
The script has been tested on the following systems and is known to work:
- Ubuntu 10.04 up to Ubuntu 16.10
- CentOS 5 up to CentOS 7
- Debian 5 up to Debian 8
- ArchLinux and derivates
- Fedora (with dnf)
- (Open)SUSE (as of 13.1)
For the scripts to run at least Bash 3 is needed. For better code handling I will start shifting to Bash 4 so the requirements may change later on. For now with Bash 3 alot of obsolete OS'es will still work.
As for the hardware requirements: The scripts have been tested on embedded hardware with only 64MB of RAM (on ARMv5) with success. The reverse has been tested as well, so it functioned as a server well. Do note that especially CPU, bandwidth and disk I/O are more important for rsync to function instead of RAM. Although rsync is known for pretty fluent I/O operations you may be able to tune it by lowering or increasing the bandwidth limit.
For the backups itself at least rsync 3 is needed. Anything prior to version 3 is not supported.
Basically anything that accepts SSH connections. This may vary from a regular Linux server with the Bash shell to a custom shell only allowing rsync for example.
At this point the following panels are supported:
- DirectAdmin
- cPanel/WHM
- Plesk
- ISPConfig3
The MySQL configuration from the above panels is used to create MySQL dumps.
It assumes that the remote server has a shell available and the script will ask the remote disk usage information like the total size and free space to calculate some basic statistics for you. Filesystem quotas itself is currently not supported nor will it be supported very soon as the script always needs to be run as root and filesystem quotas thus are unavailable for the root user.
For the full suite to function the following software will be installed on the system if not present yet:
- Dialog
- Expect
- BC
- Rsync
- SSHFS (optional)
- Midnight Commander (optional)
- Nano
- Mailx / Sendmail
- Perl
- Curl
For as far as testing was done, the scripts should also function on the following architectures (for the earlier mentioned supported operating systems) but is not limited to it:
- x86(_64)
- arm
- mips
- powerpc
The backupscript was originally designed to have a simple way of creating backups. As it is now more mature than when I started with it I want to expand the featureset of the scripts. One of the main features that are on the agenda is the support of the following database servers:
- MongoDB
- PostgreSQL
It's always possible that you may find issues in the scripts, please do file issues in the issue tracker so that I'm aware of the issue and am able to investigate the issue further. When sending in a new issue please try to report the following information:
- OS / platform used
- What the exact error is, preferrably a copy-paste or screenshot
- Which script caused the issue
- How am I able to reproduce the issue