ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-01-22 02:39:36 +00:00
Code Issues Projects Releases Wiki Activity

Update docs/configuring-playbook-bot-draupnir.md: create and soon invite the bot user to the management room

Browse Source 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2025-01-20 23:02:35 +09:00
parent 94b10ad446
commit cb0798bc06
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -72,12 +72,16 @@ matrix_bot_draupnir_login_native: true
matrix_bot_draupnir_management_room: "MANAGEMENT_ROOM_ID_HERE" matrix_bot_draupnir_management_room: "MANAGEMENT_ROOM_ID_HERE"
``` ```
Before proceeding to the next step, run the playbook with the following command to make sure that the bot user has been created. ### Create and invite the bot to the management room
Before proceeding to the next step, run the playbook with the following command to create the bot user.
```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
``` ```
Then, invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier.
### Make sure the account is free from rate limiting (optional, recommended) ### Make sure the account is free from rate limiting (optional, recommended)
If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a highly recommended 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 highly recommended step. If you do not configure it, Draupnir performance will be degraded.**
@ -171,8 +175,6 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
## Usage ## Usage
To use Draupnir, you need to invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier.
You can refer to the upstream [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) for additional ways to use and configure Draupnir and for a more detailed usage guide. You can refer to the upstream [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) for additional ways to use and configure Draupnir and for a more detailed usage guide.
Below is a **non-exhaustive quick-start guide** for the impatient. Below is a **non-exhaustive quick-start guide** for the impatient.