Merge pull request #3376 from bfabio/maubot-user-creation

Make maubot automatically create its own user.

CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2024-06-22
+
+## The maubot user is now managed by the playbook
+
+To make things easier and to be consistent with other roles, the [maubot](./docs/configuring-playbook-bot-maubot.md) user (`bot.maubot` by default) is [now](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3376) automatically created be the playbook.
+
+If you have an existing maubot installation, you will need to specify `matrix_bot_maubot_initial_password` in your `vars.yml` file to make the playbook not complain about it being undefined.
+Since the bot is already registered in your installation, there's nothing for the playbook to do anyway. In case you don't remember the password you've registered your maubot user account with, you can specify any value for this variable.
+
+If you've registered another username for the bot (other than the recommended default of `bot.maubot`), consider adjusting the `matrix_bot_maubot_login` variable (e.g. `matrix_bot_maubot_login: my.maubot.username`).
+
+
 # 2024-06-03
 
 ## WeChat bridging support

docs/configuring-playbook-bot-maubot.md

@@ -14,45 +14,42 @@ Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.
 
 ```yaml
 matrix_bot_maubot_enabled: true
+
+# Uncomment and adjust this part if you'd like to use a username different than the default
+# matrix_bot_maubot_login: bot.maubot
+
+# Generate a strong password here. Consider generating it with `pwgen -s 64 1`
+matrix_bot_maubot_initial_password: PASSWORD_FOR_THE_BOT
+
 matrix_bot_maubot_admins:
   - yourusername: securepassword
 ```
 
-You can add multiple admins. The admin accounts are not connected to any matrix ID and are only used to access the
+You can add multiple admins. The admin accounts are only used to access the maubot administration interface.
-maubot administration interface.
 
 
 ## Installing
 
-After configuring the playbook, run the [installation](installing.md) command again:
+After configuring the playbook, run the [installation](installing.md) command again (`just install-all`):
 
-```
+**Notes**:
-ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
+
-```
+- if you change the bot password (`matrix_bot_maubot_initial_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.
 
 ## Usage
 
 You can visit `matrix.<your-domain>/_matrix/maubot/` to manage your available plugins, clients and instances.
 
 You should start in the following order
-1. **Create one or more clients:** A client is a matrix account which the bot will use to message.
+1. **Create one or more clients:** A client is a matrix account which the bot will use to message. By default, the playbook creates a `bot.maubot` account (as per the configuration above). You only need to [obtain an access token](#obtaining-an-access-token) for it
 2. **Upload some Plugins:** Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source.
 3. **Create an instance:** An instance is the actual bot. You have to specify a client which the bot instance will use 
 and the plugin (how the bot will behave)
 
-To add a client you first need to create an account and obtain a valid access token.
+## Obtaining an access token
 
-## Registering the bot user
+This can be done via `mbc login` then `mbc auth` (see the [maubot documentation](https://docs.mau.fi/maubot/usage/cli/auth.html)). To run these commands, you'll first need to `exec` into the maubot container with `docker exec -it matrix-bot-maubot sh`.
 
-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):
+Alternatively, you can follow our generic [obtain an access token](obtaining-access-tokens.md) documentation.
-
-```
-ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.maubot password=PASSWORD_FOR_THE_BOT admin=yes' --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`.
-
-## Obtaining an admin access token
-
-This can be done via `mbc login` then `mbc auth` (see the [maubot documentation](https://docs.mau.fi/maubot/usage/cli/auth.html)). To run these commands you'll need to open the bot docker container with `docker exec -it matrix-bot-maubot sh`
-Alternatively, use Element or curl to [obtain an access token](obtaining-access-tokens.md).

group_vars/matrix_servers

@@ -5174,6 +5174,12 @@ matrix_user_creator_users_auto: |
       'initial_password': matrix_bot_buscarron_password,
       'initial_type': 'bot',
     }] if matrix_bot_buscarron_enabled else [])
+    +
+    ([{
+      'username': matrix_bot_maubot_login,
+      'initial_password': matrix_bot_maubot_initial_password,
+      'initial_type': 'bot',
+    }] if matrix_bot_maubot_enabled else [])
   }}
 
 ######################################################################

roles/custom/matrix-bot-maubot/defaults/main.yml

@@ -5,6 +5,12 @@
 
 matrix_bot_maubot_enabled: true
 
+matrix_bot_maubot_login: bot.maubot
+
+# This is just initial password and it will not manage subsequent password changes.
+# Use a tool like synapse-admin if you need to change it.
+matrix_bot_maubot_initial_password: ''
+
 matrix_bot_maubot_scheme: https
 matrix_bot_maubot_hostname: ''
 matrix_bot_maubot_path_prefix: /_matrix/maubot

roles/custom/matrix-bot-maubot/tasks/validate_config.yml

@@ -25,3 +25,4 @@
     - {'name': 'matrix_bot_maubot_container_network', when: true}
     - {'name': 'matrix_bot_maubot_homeserver_name', when: true}
     - {'name': 'matrix_bot_maubot_homeserver_url', when: true}
+    - {'name': 'matrix_bot_maubot_initial_password', when: true}