Add support for non-root backup clients

1 files changed, 17 insertions, 1 deletions

diff --git a/README.md b/README.md
index 5281a01..4235294 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,23 @@ ansible-galaxy role install git+https://github.com/kliwniloc/ansible-role-borgba
 
 ## Role Variables
 
-For more details, see: [`defaults/main.yml`](defaults/main.yml)
+Some configuration options were left out of this high level overview. For the
+full set of configuration options, see: [`defaults/main.yml`](defaults/main.yml)
+
+### Backup User Configuration
+
+By default, the role runs all client-side operations as `root`. To use a
+non-root user, set `borg_client_user`:
+
+```yaml
+borg_client_user: backup
+```
+
+The user must exist before running the role; it will not be created
+automatically. Ensure the user can read all directories specified in
+`borg_included_dirs`, or backups will fail at runtime.
+
+### Server Configuration
 
 You need to specify your Borg hostname (as defined in your Ansible inventory)
 as well as the public SSH key from that Borg SSH server.