Parametrize server-side borg user

Adds option to choose a non-default borg backup user on the server.

1 files changed, 15 insertions, 4 deletions

diff --git a/README.md b/README.md
index c01e109..300a87b 100644
--- a/README.md
+++ b/README.md
@@ -91,14 +91,25 @@ borg_server_host_ssh_key: "" # Required
 borg_server_host_url: { { borg_server_host } } # Optional
 ```
 
-The role creates a user for the Borg repositories on the Borg server. You can
-specify the location of the home directory with `borg_server_user_home`, which
-will also be the location for the backups.
+By default, the role uses the `borg` user on the backup server and creates it
+automatically. To use a different user, set `borg_server_user`:
 
 ```yaml
-borg_server_user_home: /opt/borg
+borg_server_user: backupserver
+borg_server_user_home: /var/backups
 ```
 
+The `borg_server_user_home` specifies the home directory of the borg user on
+the server. All client repositories will be saved in this directory.
+
+To disable automatic user creation (when the user is managed externally), set:
+
+```yaml
+borg_server_user_create: false
+```
+
+When disabled, the user must exist before running the role.
+
 For the backup itself, there are a few Borg parameters you can configure.
 Not all options that Borg offers are available in the Ansible role yet. For more
 configuration options, see <https://borgbackup.readthedocs.io>.