From f0e7bb1e1d02cb6895663d70fa9effd4b6cf6f68 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara <acioustick@noreply.codeberg.org> Date: Sun, 19 Jan 2025 15:09:29 +0900 Subject: [PATCH] Update docs/configuring-playbook-bot-draupnir.md: create the subsection for running the playbook - 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> --- docs/configuring-playbook-bot-draupnir.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index 4971b0420..8917ffadb 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -68,12 +68,16 @@ matrix_bot_draupnir_password: PASSWORD_FOR_THE_BOT 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. ```sh 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 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,16 +167,12 @@ 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. --> ```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. ## Usage