aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorColin Wilk <colin@wilk.cx>2026-06-27 14:59:14 +0200
committerColin Wilk <colin@wilk.cx>2026-06-27 15:43:21 +0200
commit2ff66fc090110dcf384e74bc26e73481eb780253 (patch)
treec601d5016facd3a34a76900a4548e5d9773cb236
parente15d494e96e9f9e6cdf21676ce3644c7894b3b53 (diff)
downloadansible-role-borgbackup-2ff66fc090110dcf384e74bc26e73481eb780253.tar.gz
ansible-role-borgbackup-2ff66fc090110dcf384e74bc26e73481eb780253.zip
docs: add passphrase warning for true e2ee
We should mention that users need to add a passphrase for true E2EE.
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7165469..d556818 100644
--- a/README.md
+++ b/README.md
@@ -116,6 +116,11 @@ supported modes see:
You can configure a passphrase for the encryption keys in `borg_passphrase`of
your Borg backups, but it is not used by default.
+> [!WARNING]
+> **Enable a passphrase for true end-to-end encryption.**
+> If you want true end-to-end encryption, you should configure a passphrase
+> Read more: [BorgBackup Security](https://borgbackup.readthedocs.io/en/stable/internals/security.html#offline-key-security)
+
`borg_included_dirs` and `borg_excluded_dirs` finally picks what directories
will be backed up by Borg.