From cb0798bc0615687e3e1972b1c4c19774d565ee7f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 20 Jan 2025 23:02:35 +0900 Subject: [PATCH 1/2] Update docs/configuring-playbook-bot-draupnir.md: create and soon invite the bot user to the management room Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-draupnir.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index daa770567..eff27752d 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -72,12 +72,16 @@ matrix_bot_draupnir_login_native: true 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 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) 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 -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. Below is a **non-exhaustive quick-start guide** for the impatient. From 66d96844d66c4b82d053a0fb566fe2036da6444c Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 20 Jan 2025 23:06:42 +0900 Subject: [PATCH 2/2] Update docs/configuring-playbook-bot-draupnir.md: move the note about the "ensure-matrix-users-created" playbook tag Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-draupnir.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index eff27752d..f95adf68c 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -80,6 +80,8 @@ Before proceeding to the next step, run the playbook with the following command ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created ``` +**Note**: the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + 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) @@ -165,13 +167,9 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,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. ## Usage