From 704bfa41ccfaa77add8877db9b1f91cc2203978c Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 13 Dec 2024 00:17:37 +0900 Subject: [PATCH] Update draupnir and mjolnir docs: edit the placeholder for matrix_bot_draupnir_pantalaimon_password and matrix_bot_mjolnir_pantalaimon_password Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-draupnir.md | 4 ++-- docs/configuring-playbook-bot-mjolnir.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index 46060ccf2..9bde3204d 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -94,9 +94,9 @@ matrix_pantalaimon_enabled: true # Tell Draupnir to use Pantalaimon matrix_bot_draupnir_pantalaimon_use: true -# User name and password for the bot. Required when using Pantalaimon. +# User name and password for the bot you have created above. Required when using Pantalaimon. matrix_bot_draupnir_pantalaimon_username: "bot.draupnir" -matrix_bot_draupnir_pantalaimon_password: ### you should create a secure password for the bot account +matrix_bot_draupnir_pantalaimon_password: "PASSWORD_FOR_THE_BOT" ``` The playbook's `group_vars` will configure other required settings. If using this role separately without the playbook, you also need to configure the two URLs that Draupnir uses to reach the homeserver, one through Pantalaimon and one "raw". This example is taken from the playbook's `group_vars`: diff --git a/docs/configuring-playbook-bot-mjolnir.md b/docs/configuring-playbook-bot-mjolnir.md index 8949f596a..f2f01371d 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -90,9 +90,9 @@ matrix_pantalaimon_enabled: true # Tell Mjolnir to use Pantalaimon matrix_bot_mjolnir_pantalaimon_use: true -# User name and password for the bot. Required when using Pantalaimon. +# User name and password for the bot you have created above. Required when using Pantalaimon. matrix_bot_mjolnir_pantalaimon_username: "bot.mjolnir" -matrix_bot_mjolnir_pantalaimon_password: ### you should create a secure password for the bot account +matrix_bot_mjolnir_pantalaimon_password: "PASSWORD_FOR_THE_BOT" ``` The playbook's `group_vars` will configure other required settings. If using this role separately without the playbook, you also need to configure the two URLs that Mjolnir uses to reach the homeserver, one through Pantalaimon and one "raw". This example is taken from the playbook's `group_vars`: