mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-06-26 11:17:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs/configuring-playbook-bot-draupnir.md: create the subsection for running the playbook

Browse Source 
- Move the note about ensure-matrix-users-created from below
- Update the installation command: the "ensure-matrix-users-created" tag is no longer necessary as it is instructed to run above

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara
2025-01-19 15:09:29 +09:00
parent 5e2586a27e
commit f0e7bb1e1d
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/configuring-playbook-bot-draupnir.md
View File

@ -68,12 +68,16 @@ matrix_bot_draupnir_password: PASSWORD_FOR_THE_BOT
matrix_bot_draupnir_login_native: true matrix_bot_draupnir_login_native: true
``` ```
### Run the playbook
Before proceeding to the next step, run the playbook with the following command to make sure that the bot user has been created. Before proceeding to the next step, run the playbook with the following command to make sure that the bot user has been created.
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created
``` ```
The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.
### Make sure the account is free from rate limiting ### Make sure the account is free from rate limiting
If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a heavily recomended step. If you do not configure it, Draupnir performance will be degraded.** If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a heavily recomended step. If you do not configure it, Draupnir performance will be degraded.**
@ -163,14 +167,10 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```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 shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.
- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. `just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed.