From eaa9b7cfc4a05bce65cbc0424508bec827c44fb1 Mon Sep 17 00:00:00 2001
From: Slavi Pantaleev <slavi@devture.com>
Date: Tue, 1 Nov 2022 17:03:53 +0200
Subject: [PATCH] Add automatic user account creation support to Buscarron

Continuation of c3dc64b1d5e06f
---
 docs/configuring-playbook-bot-buscarron.md | 29 +++++++++-------------
 group_vars/matrix_servers                  |  6 +++++
 2 files changed, 18 insertions(+), 17 deletions(-)

diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md
index b38f25c6..0b80ba40 100644
--- a/docs/configuring-playbook-bot-buscarron.md
+++ b/docs/configuring-playbook-bot-buscarron.md
@@ -5,20 +5,6 @@ The playbook can install and configure [buscarron](https://gitlab.com/etke.cc/bu
 It's a bot you can use to setup **your own helpdesk on matrix**
 It's a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) matrix room
 
-## Registering the bot user
-
-By default, the playbook will set up the bot with a username like this: `@bot.buscarron:DOMAIN`.
-
-(to use a different username, adjust the `matrix_bot_buscarron_login` variable).
-
-You **need to register the bot user manually** before setting up the bot. You can use the playbook to [register a new user](registering-users.md):
-
-```
-ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.buscarron password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user
-```
-
-Choose a strong password for the bot. You can generate a good password with a command like this: `pwgen -s 64 1`.
-
 
 ## Adjusting the playbook configuration
 
@@ -27,7 +13,10 @@ Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.
 ```yaml
 matrix_bot_buscarron_enabled: true
 
-# Adjust this to whatever password you chose when registering the bot user
+# Uncomment and adjust this part if you'd like to use a username different than the default
+# matrix_bot_buscarron_login: bot.buscarron
+
+# Generate a strong password here. Consider generating it with `pwgen -s 64 1`
 matrix_bot_buscarron_password: PASSWORD_FOR_THE_BOT
 
 # Adjust accepted forms
@@ -57,9 +46,15 @@ matrix_server_fqn_buscarron: "form.{{ matrix_domain }}"
 
 After configuring the playbook, run the [installation](installing.md) command again:
 
+```sh
+ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
 ```
-ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
-```
+
+**Notes**:
+
+- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account
+
+- if you change the bot password (`matrix_bot_buscarron_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_buscarron_password` to let the bot know its new password
 
 
 ## Usage
diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers
index 872e778b..bdf5dcce 100755
--- a/group_vars/matrix_servers
+++ b/group_vars/matrix_servers
@@ -2704,6 +2704,12 @@ matrix_user_creator_users_auto: |
       'initial_password': matrix_bot_postmoogle_password,
       'initial_type': 'bot',
     }] if matrix_bot_postmoogle_enabled else []
+    +
+    [{
+      'username': matrix_bot_buscarron_login,
+      'initial_password': matrix_bot_buscarron_password,
+      'initial_type': 'bot',
+    }] if matrix_bot_buscarron_enabled else []
   }}
 
 ######################################################################