aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorColin Wilk <colin@wilk.cx>2026-06-29 20:56:50 +0200
committerColin Wilk <colin@wilk.cx>2026-06-29 20:56:50 +0200
commit66e46df3d2a840bf62ef8084ad171041772db65e (patch)
treea06192c5689ebf70e739941c1608c406b4b7ee2f /README.md
parenta0432093db76d7bb462f113d4bbeca0a8f376e95 (diff)
downloadansible-role-borgbackup-66e46df3d2a840bf62ef8084ad171041772db65e.tar.gz
ansible-role-borgbackup-66e46df3d2a840bf62ef8084ad171041772db65e.zip
Support custom arguments for borg create
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 300a87b..6dff957 100644
--- a/README.md
+++ b/README.md
@@ -156,11 +156,24 @@ will be backed up by Borg.
```yaml
borg_compression: zstd # -C argument
+borg_create_additional_arguments: "" # Additional borg create options
borg_passphrase: "" # Env variable
borg_included_dirs: [] # Positional arguments
borg_excluded_dirs: [] # --exclude arguments
```
+`borg_create_additional_arguments` lets you pass additional options to `borg
+create`. These arguments are appended after all role-defined options, so
+user-specified options can override defaults. For example:
+
+```yaml
+# Add verbose output
+borg_create_additional_arguments: "--stats --list --filter=AME"
+
+# Stay in one filesystem and exclude caches
+borg_create_additional_arguments: "--one-file-system --exclude-caches"
+```
+
To decrypt your backups without the client, we store the decryption keys in a
YAML file in your Ansible repository. You require the decryption keys as well as
access to the repository files on the Borg server to access the backups.