jeremyfritzen / automated-borg-backup

Automate your Borg Backup local and remote jobs with simple configuration files and get notified on your mobile.

Borg Backup Automation script

Automate your Borg Backup remote and local jobs.

Prerequisites

Install Borg Backup: apt install borgbackup -y

This script was developed and tested on Debian 9. It should work on other Debian-based Linux distribution.

Configuration

Follow the steps below to setup and configure your Borg backup jobs. You should do it with sudo.

0. Init your borg repo with borg init command. Check https://borgbackup.readthedocs.io/en/stable/quickstart.html for more information.
1. Clone the repository in the /etc/backups directory: sudo clone https://github.com/jeremyfritzen/storj_earnings_notify.git /etc/backups/automated-borg-backup
2. Add Disk IDs in the backup.disks file. The backup will be launched only if one of these disks is plugged-in. To find the UUID of the file system that backups, run the following command: lsblk -o+uuid,label.
3. Copy general.conf.template file and rename it "general.conf". This will will allow to configure the backup script (pushbullet access, etc.)
4. Edit the general.conf file you just created with your own parameters to configure the backup script.
5. Copy the job.conf.template file and rename it as you want. Only the ".conf" extension in the end is important. This file will define your backup job.
6. Edit the conf file you just created with your own parameter to define your backup job.
7. Run setup script: ./install.sh

Usage

Just plug your backup disk on your USB port. Script should start and send you a Pushbullet notification to tell you the backup is ongoing. A notification will be sent if no backup has been made for more than a week.