pub-solar/matrix-docker-ansible-deploy
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge pull request #1748 from ofalvai/patch-3

Browse source 
Improve borg backup instructions
This commit is contained in:
Slavi Pantaleev 2022-04-13 10:23:18 +03:00 committed by GitHub
parent ce675b0e79 121f860d63
commit aef2c4c32e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/configuring-playbook-backup-borg.md
View file

@ -4,17 +4,23 @@ The playbook can install and configure [borgbackup](https://www.borgbackup.org/)
BorgBackup is a deduplicating backup program with optional compression and encryption. BorgBackup is a deduplicating backup program with optional compression and encryption.
That means your daily incremental backups can be stored in a fraction of the space and is safe whether you store it at home or on a cloud service. That means your daily incremental backups can be stored in a fraction of the space and is safe whether you store it at home or on a cloud service.
The backup will run based on `matrix_backup_borg_schedule` var (systemd timer calendar), default: 4am every day You will need a remote server where borg will store the backups. There are hosted, borg compatible solutions available, such as [BorgBase](https://www.borgbase.com).
The backup will run based on `matrix_backup_borg_schedule` var (systemd timer calendar), default: 4am every day.
## Prerequisites ## Prerequisites
1. Create ssh key on any machine: 1. Create a new SSH key:
```bash ```bash
ssh-keygen -t ed25519 -N '' -f matrix-borg-backup -C matrix ssh-keygen -t ed25519 -N '' -f matrix-borg-backup -C matrix
``` ```
2. Add public part of that ssh key to your borg provider / server: This can be done on any machine and you don't need to place the key in the `.ssh` folder. It will be added to the Ansible config later.
2. Add the **public** part of this SSH key (the `matrix-borg-backup.pub` file) to your borg provider/server:
If you plan to use a hosted solution, follow their instructions. If you have your own server, copy the key over:
```bash ```bash
# example to append the new PUBKEY contents, where: # example to append the new PUBKEY contents, where:
@ -39,13 +45,15 @@ matrix_backup_borg_ssh_key_private: |
where: where:
* USER - ssh user of a provider / server * USER - SSH user of a provider/server
* HOST - ssh host of a provider / server * HOST - SSH host of a provider/server
* REPO - borg repository name, it will be initialized on backup start, eg: `matrix` * REPO - borg repository name, it will be initialized on backup start, eg: `matrix`
* PASSPHRASE - super-secret borg passphrase, you may generate it with `pwgen -s 64 1` or use any password manager * PASSPHRASE - passphrase used for encrypting backups, you may generate it with `pwgen -s 64 1` or use any password manager
* PRIVATE KEY - the content of the public part of the ssh key you created before * PRIVATE KEY - the content of the **private** part of the SSH key you created before
Check the `roles/matrix-backup-borg/defaults/main.yml` for the full list of available options `matrix_backup_borg_location_source_directories` defines the list of directories to back up: it's set to `{{ matrix_base_data_path }}` by default, which is the base directory for every service's data, such as Synapse, Postgres and the bridges. You might want to exclude certain directories or file patterns from the backup using the `matrix_backup_borg_location_exclude_patterns` variable.
Check the `roles/matrix-backup-borg/defaults/main.yml` file for the full list of available options.
## Installing ## Installing