diff --git a/CHANGELOG.md b/CHANGELOG.md index 9be9532..e2098aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Changed +- Align terminology used in README with the one used by B2 for credentials (keyId + applicationKey pair). ## [2.0.0] - 2022-02-01 ### Changed diff --git a/README.md b/README.md index a25b3bf..30a7084 100644 --- a/README.md +++ b/README.md @@ -90,17 +90,17 @@ Arch Linux users can install the aur package [restic-systemd-automatic-backup](h $ yaourt -S restic-systemd-automatic-backup ```` -## 1. Create Backblaze B2 account +## 1. Create Backblaze B2 Account, Bucket and keys First, see this official Backblaze [tutorial](https://help.backblaze.com/hc/en-us/articles/4403944998811-Quickstart-Guide-for-Restic-and-Backblaze-B2-Cloud-Storage) on restic, and follow the instructions ("Create Backblaze account with B2 enabled") there on how to create a new B2 bucket. In general, you'd want a private bucket, without B2 encryption (restic does the encryption client side for us) and without the object lock feature. -Take note of the your account ID and application key for the next steps. It's a good idea to create a separate application key that has access only to the newly created b2 bucket you created. +For restic to be able to connect to your bucket, you want to in the B2 settings create a pair of keyID and applicationKey. It's a good idea to create a separate pair of ID and Key with for each bucket that you will use, with limited read&write access to only that bucket. -## 2. Configure your B2 account locally +## 2. Configure your B2 credentials locally > **Attention!** Going the manual way requires that most of the following commands are run as root. Put these files in `/etc/restic/`: -* `_global.env`: Fill this file out with your global settings including B2 accountID & accountKey. A global exclude list is set here (explained in section below). +* `_global.env`: Fill this file out with your global settings including B2 keyID & applicationKey. A global exclude list is set here (explained in section below). * `default.env`: This is the default profile. Fill this out with bucket name, backup paths and retention policy. This file sources `_global.env` and is thus self-contained and can be sourced in the shell when you want to issue some manual restic commands. For example: ```console $ source /etc/restic/default.env diff --git a/etc/restic/_global.env.template b/etc/restic/_global.env.template index 448b23f..4ce429f 100644 --- a/etc/restic/_global.env.template +++ b/etc/restic/_global.env.template @@ -12,9 +12,10 @@ export RESTIC_PASSWORD_FILE="/etc/restic/pw.txt" # The global restic exclude file export RESTIC_BACKUP_EXCLUDE_FILE="/etc/restic/backup_exclude" -# Backblaze B2 credentials -export B2_ACCOUNT_ID="" # TODO fill with your account info -export B2_ACCOUNT_KEY="" # TODO fill with your account info +# Backblaze B2 credentials keyID & applicationKey pair. +# Restic environment variables are documented at https://restic.readthedocs.io/en/latest/040_backup.html#environment-variables +export B2_ACCOUNT_ID="" # TODO fill with your keyID +export B2_ACCOUNT_KEY="" # TODO fill with your applicationKey # How many network connections to set up to B2. Default is 5. export B2_CONNECTIONS=10