cjones/restic-automatic-backup-scheduler
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Made instructions easier to follow

Browse Source
This commit is contained in:
Erik Westrup
2018-06-02 11:31:51 +02:00
parent 415be87690
commit 0a0885e610
1 changed files with 77 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
README.md
View File

@@ -4,48 +4,102 @@
[restic](https://restic.net/) is a command-line tool for making backups, the right way. Check the official website for a feature explanation. As a storage backend, I recommend [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html) as restic works well with it, and it is (at the time of writing) very affordable for the hobbyist hacker!
First, see this official Backblaze [tutorial](https://help.backblaze.com/hc/en-us/articles/115002880514-How-to-configure-Backblaze-B2-with-Restic-on-Linux) on restic, on how to setup your B2 bucket.
## Automatic scheduled backups
Unfortunately restic does not come per-configured with a way to run automated backups, say every day. However it's possible to set this up yourself using. This example also features email notifications when a backup fails to complete.
### 1.
Put this file in `/etc/restic/`:
* `b2_env.sh`: Fill this file out with your B2 bucket settings etc. The reason for putting these in a separeate file is that it can be used also for you to simply source, when you want to issue some restic commands. For example:
Here follows a step-by step tutorial on how to set it up, with my sample script and configurations that you can modify to suit your needs.
Note, you can use any of the supported storage [backends](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html). The setup should be similar and you will have to other configuration variables to match that backend in later steps.
## Set up
### 1. Create Backblaze B2 account
First, see this official Backblaze [tutorial](https://help.backblaze.com/hc/en-us/articles/115002880514-How-to-configure-Backblaze-B2-with-Restic-on-Linux) on restic, and follow the instructions ("Create Backblaze account with B2 enabled"")there on how to create a new B2 bucket.
Take note of the your account ID, application key and password for the next steps.
### 2. Configure your B2 account locally
Put these files in `/etc/restic/`:
* `b2_env.sh`: Fill this file out with your B2 bucket settings etc. The reason for putting these in a separate file is that it can be used also for you to simply source, when you want to issue some restic commands. For example:
```bash
$ source /etc/restic/b2_env.sh
$ restic snapshots # You don't have to supply all paramters like --repo, as they are now in your envionment!
````
* `b2_pw.txt`: Put your b2 password in this file.
* `b2_pw.txt`: Put your B2 password in this file.
### 2.
Put these files in `/usr/local/sbin`:
* `restic_backup.sh`: A script that defines how to run the backup. Edit this file to respect your needs in terms of backup which paths to backup, retention (number of bakcups to save), etc.
* `systemd-email`: Sends email using sendmail. You must set up your computer so it can send mail, for example using [postfix and Gmail](https://easyengine.io/tutorials/linux/ubuntu-postfix-gmail-smtp/). This script also features time-out for not spamming Gmail servers.
### 3. Initialize your B2 repo
Now we must initialize the repository on the remote end:
```bash
source /etc/restic/b2_env.sh
restic init
```
### 4. Script for doing the backup
Put this file in `/usr/local/sbin`:
* `restic_backup.sh`: A script that defines how to run the backup. Edit this file to respect your needs in terms of backup which paths to backup, retention (number of backups to save), etc.
Put this file in `/`:
* `.backup_exclude`: A list of file pattern paths to exclude from you backups, that you consumes time, network and money, but is not worth having copies of.
### 5. Make first backup & verify
Now see if the backup itself works, by running
```bash
$ /usr/local/sbin/restic_backup.sh
$ less /var/local/log/restic/*
````
### 6. Backup automatically; systemd service + timer
Now we can do the modern version of a cron-job, a systemd service + timer, to run the backup every day!
### 3.
Put these files in `/etc/systemd/system/`:
* `restic-backup.service`: A service that calls the script above.
* `restic-backup.timer`: A timer (systemd's cronjobs) that starts the backup every day.
* `status-email-user@.service`: A service that can notify you via email when a systemd service fails. Edit the target email address in this file.
### 4.
Finally, put the file `.backup_exclude` in `/`, and add file patterns you want to exclude from your backups.
* `restic-backup.service`: A service that calls the backup script.
* `restic-backup.timer`: A timer that starts the backup every day.
### 5.
Now simply enable the timer with:
```bash
$ systemctl enable restic-backup.timer
````
and enjoy your computer being backed up every day!
You can see when your next backup will be schedued
You can see when your next backup is scheduled to run with
```bash
$ systemctl list-timers | grep restic
```
## Automatic backup checks
and see the status of a currently running backup with
Furthermore there are some `*-check*`-files in this repo too. Install these too if you want to run restic-check once in a while to verify that your remote backup is not corrupt.
```bash
$ systemctl status restic-backup
```
or start a backup manually
```bash
$ systemctl start restic-backup
```
### 7. Email notification on failure
We want to be aware when the automatic backup fails, so we can fix it. Since my laptop does not run a mail server, I went for a solution to set up my laptop to be able to send emails with [postfix via my Gmail](https://easyengine.io/tutorials/linux/ubuntu-postfix-gmail-smtp/). Follow the instructions over there.
Put this file in `/usr/local/sbin`:
* `systemd-email`: Sends email using sendmail(1). This script also features time-out for not spamming Gmail servers and getting my account blocked.
Put this files in `/etc/systemd/system/`:
* `status-email-user@.service`: A service that can notify you via email when a systemd service fails. Edit the target email address in this file.
As you maybe noticed already before, `restic-backup.service` is configured to start `status-email-user.service` on failure.
### 8. Optional: automated backup checks
Once in a while it can be good to do a health check of the remote repository, to make sure it's not getting corrupt. This can be done with `$ restic check`.
There are some `*-check*`-files in this git repo. Install these in the same way you installed the `*-backup*`-files.