From 31ebe8a3db52cee4197661c7a119a87d61c2f368 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 29 Dec 2024 10:54:47 -0500 Subject: [PATCH] Update docs/configuring-playbook-mautrix-bridges.md: add descriptions to each section Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-mautrix-bridges.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-mautrix-bridges.md b/docs/configuring-playbook-mautrix-bridges.md index 667a2d72a..6552a0ed1 100644 --- a/docs/configuring-playbook-mautrix-bridges.md +++ b/docs/configuring-playbook-mautrix-bridges.md @@ -85,19 +85,21 @@ matrix_mautrix_SERVICENAME_configuration_extension_yaml: | ### Set the bot's username (optional) +To set the bot's username, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: + ```yaml matrix_mautrix_SERVICENAME_appservice_bot_username: "BOTNAME" ``` -Can be used to set the username for the bridge. - ### Configure the logging level (optional) +To specify the logging level, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: + ```yaml matrix_mautrix_SERVICENAME_logging_level: WARN ``` -to `vars.yml` to control the logging level, where you may replace WARN with one of the following to control the verbosity of the logs generated: TRACE, DEBUG, INFO, WARN, ERROR, or FATAL. +Replace WARN with one of the following to control the verbosity of the logs generated: TRACE, DEBUG, INFO, WARN, ERROR, or FATAL. If you have issues with a service, and are requesting support, the higher levels of logging will generally be more helpful.