Update files for some mautrix bridges: add the common section "Troubleshooting"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

docs/configuring-playbook-bridge-mautrix-discord.md

@@ -71,3 +71,16 @@ If you'd like to bridge guilds, send `guilds status` to see the list of guilds,
 After bridging, spaces will be created automatically, and rooms will be created if necessary when messages are received. You can also pass `--entire` to the bridge command to immediately create all rooms.
 
 If you want to manually bridge channels, invite the bot to the room you want to bridge, and run `!discord bridge CHANNEL_ID_HERE` to bridge the room. Make sure to replace `CHANNEL_ID_HERE` with the channel's ID.
+
+## Troubleshooting
+
+As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-discord`.
+
+### Increase logging verbosity
+
+The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
+
+```yaml
+# Valid values: fatal, error, warn, info, debug, trace
+matrix_mautrix_discord_logging_level: 'debug'
+```

docs/configuring-playbook-bridge-mautrix-gmessages.md

@@ -53,3 +53,16 @@ To use the bridge, you need to start a chat with `@gmessagesbot:example.com` (wh
 You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/gmessages/authentication.html).
 
 After logging in, the bridge will create portal rooms for recent chats.
+
+## Troubleshooting
+
+As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-gmessages`.
+
+### Increase logging verbosity
+
+The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
+
+```yaml
+# Valid values: fatal, error, warn, info, debug, trace
+matrix_mautrix_gmessages_logging_level: 'debug'
+```

docs/configuring-playbook-bridge-mautrix-signal.md

@@ -60,3 +60,16 @@ You can then follow instructions on the bridge's [official documentation on Auth
 After logging in, the bridge will bridge chats as you receive messages.
 
 **Note**: Signal does not support any kind of message history (even on official apps), so the bridge won't backfill any messages.
+
+## Troubleshooting
+
+As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-signal`.
+
+### Increase logging verbosity
+
+The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
+
+```yaml
+# Valid values: fatal, error, warn, info, debug, trace
+matrix_mautrix_signal_logging_level: 'debug'
+```

docs/configuring-playbook-bridge-mautrix-slack.md

@@ -63,3 +63,16 @@ To use the bridge, you need to start a chat with `@slackbot:example.com` (where
 You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/slack/authentication.html).
 
 If you authenticated using a token, the recent chats will be bridged automatically (depending on the `conversation_count` setting). Otherwise (i.e. logging with the Discord application), the chats the bot is in will be bridged automatically.
+
+## Troubleshooting
+
+As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-slack`.
+
+### Increase logging verbosity
+
+The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
+
+```yaml
+# Valid values: fatal, error, warn, info, debug, trace
+matrix_mautrix_slack_logging_level: 'debug'
+```

docs/configuring-playbook-bridge-mautrix-twitter.md

@@ -55,3 +55,16 @@ To use the bridge, you need to start a chat with `@twitterbot:example.com` (wher
 You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/twitter/authentication.html).
 
 After logging in, the bridge will create portal rooms for some recent chats. Portal rooms for other chats will be created as you receive messages.
+
+## Troubleshooting
+
+As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-twitter`.
+
+### Increase logging verbosity
+
+The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
+
+```yaml
+# Valid values: fatal, error, warn, info, debug, trace
+matrix_mautrix_twitter_logging_level: 'debug'
+```

docs/configuring-playbook-bridge-mautrix-whatsapp.md

@@ -56,3 +56,16 @@ You can then follow instructions on the bridge's [official documentation on Auth
 Approximately in a minute after logging in, the bridge will create portal rooms for recent chats.
 
 **Note**: your linked devices will be logged out if you don’t use your phone for over 14 days (see the official FAQ entry [here](https://faq.whatsapp.com/general/download-and-installation/about-linked-devices)). The bridge will warn you if it doesn't receive any data from the phone over 12 days.
+
+## Troubleshooting
+
+As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-whatsapp`.
+
+### Increase logging verbosity
+
+The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
+
+```yaml
+# Valid values: fatal, error, warn, info, debug, trace
+matrix_mautrix_whatsapp_logging_level: 'debug'
+```

roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml

@@ -118,7 +118,7 @@ matrix_mautrix_discord_appservice_bot_avatar: mxc://maunium.net/nIdEykemnwdisvHb
 matrix_mautrix_discord_provisioning_shared_secret: disable
 
 # Minimum severity of journal log messages.
-# Options: trace, debug, info, warn, error, fatal
+# Valid values: fatal, error, warn, info, debug, trace
 matrix_mautrix_discord_logging_level: 'warn'
 
 # Whether or not created rooms should have federation enabled.

roles/custom/matrix-bridge-mautrix-gmessages/defaults/main.yml

@@ -86,7 +86,7 @@ matrix_mautrix_gmessages_homeserver_token: ''
 matrix_mautrix_gmessages_appservice_bot_username: gmessagesbot
 
 # Minimum severity of journal log messages.
-# Options: trace, debug, info, warn, error, fatal
+# Valid values: fatal, error, warn, info, debug, trace
 matrix_mautrix_gmessages_logging_level: 'warn'
 
 # Whether or not created rooms should have federation enabled.

roles/custom/matrix-bridge-mautrix-signal/defaults/main.yml

@@ -93,7 +93,7 @@ matrix_mautrix_signal_homeserver_token: ''
 matrix_mautrix_signal_appservice_bot_username: signalbot
 
 # Minimum severity of journal log messages.
-# Options: trace, debug, info, warn, error, fatal
+# Valid values: fatal, error, warn, info, debug, trace
 matrix_mautrix_signal_logging_level: 'warn'
 
 # Whether or not created rooms should have federation enabled.

roles/custom/matrix-bridge-mautrix-slack/defaults/main.yml

@@ -62,7 +62,7 @@ matrix_mautrix_slack_backfill_unread_hours_threshold: 720
 matrix_mautrix_slack_backfill_threads_max_initial_messages: 50
 
 # Minimum severity of journal log messages.
-# Options: trace, debug, info, warn, error, fatal
+# Valid values: fatal, error, warn, info, debug, trace
 matrix_mautrix_slack_logging_level: 'warn'
 
 # Database-related configuration fields.

roles/custom/matrix-bridge-mautrix-twitter/defaults/main.yml

@@ -130,7 +130,7 @@ matrix_mautrix_twitter_backfill_max_catchup_messages: 500
 matrix_mautrix_twitter_provisioning_shared_secret: disable
 
 # Minimum severity of journal log messages.
-# Options: trace, debug, info, warn, error, fatal
+# Valid values: fatal, error, warn, info, debug, trace
 matrix_mautrix_twitter_logging_level: 'warn'
 
 # Whether or not metrics endpoint should be enabled.

roles/custom/matrix-bridge-mautrix-whatsapp/defaults/main.yml

@@ -82,7 +82,7 @@ matrix_mautrix_whatsapp_homeserver_token: ''
 matrix_mautrix_whatsapp_appservice_bot_username: whatsappbot
 
 # Minimum severity of journal log messages.
-# Options: trace, debug, info, warn, error, fatal
+# Valid values: fatal, error, warn, info, debug, trace
 matrix_mautrix_whatsapp_logging_level: 'warn'
 
 # Whether or not created rooms should have federation enabled.