Adjust matrix-registration-bot docs to tell people to perform a full installation

Running just `setup-all,start` is not enough, because it doesn't run `ensure-matrix-users-created`
and the bot account won't get created.
This commit is contained in:
Slavi Pantaleev 2024-01-09 10:16:51 +02:00
parent 5caf1fef1d
commit 2642cc1b18

View File

@ -17,9 +17,8 @@ To enable the bot, add the following configuration to your `inventory/host_vars/
```yaml ```yaml
matrix_bot_matrix_registration_bot_enabled: true matrix_bot_matrix_registration_bot_enabled: true
#By default, the playbook will set use the bot with a username like # By default, the playbook will set use the bot with a username like this: `@bot.matrix-registration-bot:DOMAIN`.
## this: `@bot.matrix-registration-bot:DOMAIN`. # To use a different username, uncomment & adjust the variable below:
# To use a different username, uncomment & adjust the variable.
# matrix_bot_matrix_registration_bot_matrix_user_id_localpart: bot.matrix-registration-bot # matrix_bot_matrix_registration_bot_matrix_user_id_localpart: bot.matrix-registration-bot
# Generate a strong password here. Consider generating it with `pwgen -s 64 1` # Generate a strong password here. Consider generating it with `pwgen -s 64 1`
@ -32,16 +31,11 @@ matrix_synapse_enable_registration: true
matrix_synapse_registration_requires_token: true matrix_synapse_registration_requires_token: true
``` ```
The bot account will be automatically created. The bot account will be created automatically.
## Installing ## Installing
After configuring the playbook, run the [installation](installing.md) command again: After configuring the playbook, re-run the [installation](installing.md) command again: `just install-all` or `just setup-all`
```
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```
## Usage ## Usage