summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatthew Fennell <matthew@fennell.dev>2024-01-08 22:53:42 +0000
committerMatthew Fennell <matthew@fennell.dev>2024-01-08 22:53:42 +0000
commitf324bbdef4a71d33d4dd0adbd9037f600a058ad5 (patch)
treec85e20e304721313a8200ef1274e886b12f84479 /README.md
parentd7e71e34d6eb308b20b6e7fee9eb6e6a74224897 (diff)
Install borgmatic in the playbook
This commit adds borgmatic, to provide automated backups.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0943edd..c9fd8e6 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,13 @@ on the box itself will be taken care of by the playbook):
Install the `ansible` package via your package manager.
+### Backup
+
+You will need to initialise a borg repository on some host or managed provider.
+
+Once you have done this, make a note of the private key you will use to access
+the remote server and the address of the repo.
+
### Create a prod inventory file
Create an inventory file in `inventory/prod.ini` with the production hosts that
@@ -93,6 +100,9 @@ inventory/
```
```yaml
+borg_passphrase: # the passphrase that borg will encrypt your repo with
+borg_private_key_path: # e.g. /home/matthew/.ssh/some-key
+borg_repo: # the repo to use, e.g. ssh://example.org/./repo
certbot_email: an email address letsencrypt should use if renewal fails
virtual_host: the domain of the JID you'd like to use, e.g. koyo.haus
```