From e4e34333daf87b9be3137a25961477ff908e2960 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 31 Jan 2025 15:15:12 +0900 Subject: [PATCH 01/12] Update files for some mautrix bridges: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-mautrix-discord.md | 13 +++++++++++++ ...configuring-playbook-bridge-mautrix-gmessages.md | 13 +++++++++++++ docs/configuring-playbook-bridge-mautrix-signal.md | 13 +++++++++++++ docs/configuring-playbook-bridge-mautrix-slack.md | 13 +++++++++++++ docs/configuring-playbook-bridge-mautrix-twitter.md | 13 +++++++++++++ .../configuring-playbook-bridge-mautrix-whatsapp.md | 13 +++++++++++++ .../matrix-bridge-mautrix-discord/defaults/main.yml | 2 +- .../defaults/main.yml | 2 +- .../matrix-bridge-mautrix-signal/defaults/main.yml | 2 +- .../matrix-bridge-mautrix-slack/defaults/main.yml | 2 +- .../matrix-bridge-mautrix-twitter/defaults/main.yml | 2 +- .../defaults/main.yml | 2 +- 12 files changed, 84 insertions(+), 6 deletions(-) diff --git a/docs/configuring-playbook-bridge-mautrix-discord.md b/docs/configuring-playbook-bridge-mautrix-discord.md index d5e6b4834..0a8c743bb 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/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' +``` diff --git a/docs/configuring-playbook-bridge-mautrix-gmessages.md b/docs/configuring-playbook-bridge-mautrix-gmessages.md index eae32a1f7..658b8eb95 100644 --- a/docs/configuring-playbook-bridge-mautrix-gmessages.md +++ b/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' +``` diff --git a/docs/configuring-playbook-bridge-mautrix-signal.md b/docs/configuring-playbook-bridge-mautrix-signal.md index f0f1ccf74..d156c7b0a 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/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' +``` diff --git a/docs/configuring-playbook-bridge-mautrix-slack.md b/docs/configuring-playbook-bridge-mautrix-slack.md index b113f52f0..6ead5487d 100644 --- a/docs/configuring-playbook-bridge-mautrix-slack.md +++ b/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' +``` diff --git a/docs/configuring-playbook-bridge-mautrix-twitter.md b/docs/configuring-playbook-bridge-mautrix-twitter.md index bb25019fe..b24264a6c 100644 --- a/docs/configuring-playbook-bridge-mautrix-twitter.md +++ b/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' +``` diff --git a/docs/configuring-playbook-bridge-mautrix-whatsapp.md b/docs/configuring-playbook-bridge-mautrix-whatsapp.md index 8201be513..b9d23652e 100644 --- a/docs/configuring-playbook-bridge-mautrix-whatsapp.md +++ b/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' +``` diff --git a/roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml b/roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml index 779816b68..63a40c07f 100644 --- a/roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml +++ b/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. diff --git a/roles/custom/matrix-bridge-mautrix-gmessages/defaults/main.yml b/roles/custom/matrix-bridge-mautrix-gmessages/defaults/main.yml index 2cde7487f..c2409ec61 100644 --- a/roles/custom/matrix-bridge-mautrix-gmessages/defaults/main.yml +++ b/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. diff --git a/roles/custom/matrix-bridge-mautrix-signal/defaults/main.yml b/roles/custom/matrix-bridge-mautrix-signal/defaults/main.yml index b1aecf902..f4e754a41 100644 --- a/roles/custom/matrix-bridge-mautrix-signal/defaults/main.yml +++ b/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. diff --git a/roles/custom/matrix-bridge-mautrix-slack/defaults/main.yml b/roles/custom/matrix-bridge-mautrix-slack/defaults/main.yml index 9b95d069f..bf5ed4bd0 100644 --- a/roles/custom/matrix-bridge-mautrix-slack/defaults/main.yml +++ b/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. diff --git a/roles/custom/matrix-bridge-mautrix-twitter/defaults/main.yml b/roles/custom/matrix-bridge-mautrix-twitter/defaults/main.yml index 8a2fb4200..e79db967c 100644 --- a/roles/custom/matrix-bridge-mautrix-twitter/defaults/main.yml +++ b/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. diff --git a/roles/custom/matrix-bridge-mautrix-whatsapp/defaults/main.yml b/roles/custom/matrix-bridge-mautrix-whatsapp/defaults/main.yml index 2d2519338..88b40dd81 100644 --- a/roles/custom/matrix-bridge-mautrix-whatsapp/defaults/main.yml +++ b/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. From c69892ec1f3bfb203c750e5e0b6992950de822f4 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 1 Feb 2025 18:54:43 +0900 Subject: [PATCH 02/12] Update docs/configuring-playbook-bridge-mautrix-wsproxy.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-mautrix-wsproxy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-bridge-mautrix-wsproxy.md b/docs/configuring-playbook-bridge-mautrix-wsproxy.md index fb2005c6d..b761e71d9 100644 --- a/docs/configuring-playbook-bridge-mautrix-wsproxy.md +++ b/docs/configuring-playbook-bridge-mautrix-wsproxy.md @@ -67,3 +67,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use ## Usage Follow the [mautrix-imessage documenation](https://docs.mau.fi/bridges/go/imessage/index.html) for running `android-sms` and/or `matrix-imessage` on your device(s). + +## 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-wsproxy`. From c9ae1efa07053205f3f714042a682d736a5eb566 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 1 Feb 2025 19:03:34 +0900 Subject: [PATCH 03/12] Update docs for Meta Instagram and Messenger: add the common section "Troubleshooting" The comments are copied from the configuration files. Signed-off-by: Suguru Hirahara --- ...guring-playbook-bridge-mautrix-meta-instagram.md | 13 +++++++++++++ ...guring-playbook-bridge-mautrix-meta-messenger.md | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md index d89c1d50c..26c34f8d9 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -69,3 +69,16 @@ To use the bridge, you need to start a chat with `@instagrambot:example.com` (wh You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html). After logging in, the bridge will sync 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-meta-instagram`. + +### 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 +# This bridge uses zerolog, so valid levels are: panic, fatal, error, warn, info, debug, trace +matrix_mautrix_meta_instagram_logging_min_level: debug +``` diff --git a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md index 96041c829..51b1a40ca 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -84,3 +84,16 @@ You can then follow instructions on the bridge's [official documentation on Auth After logging in, the bridge will sync recent chats. **Note**: given that the bot is configured in `messenger` [bridge mode](#bridge-mode) by default, you will need to log in to [messenger.com](https://messenger.com/) (not `facebook.com`!) and obtain the cookies from there. + +## 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-meta-messenger`. + +### 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 +# This bridge uses zerolog, so valid levels are: panic, fatal, error, warn, info, debug, trace +matrix_mautrix_meta_messenger_logging_min_level: debug +``` From 145d2cc6758d15fb61753c2206471b653e831ec1 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 1 Feb 2025 19:04:20 +0900 Subject: [PATCH 04/12] Update docs for the other mautrix bridges: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-mautrix-facebook.md | 10 ++++++++++ ...configuring-playbook-bridge-mautrix-googlechat.md | 12 ++++++++++++ .../configuring-playbook-bridge-mautrix-instagram.md | 12 ++++++++++++ docs/configuring-playbook-bridge-mautrix-telegram.md | 12 ++++++++++++ 4 files changed, 46 insertions(+) diff --git a/docs/configuring-playbook-bridge-mautrix-facebook.md b/docs/configuring-playbook-bridge-mautrix-facebook.md index 51a162caf..67d2b3d9b 100644 --- a/docs/configuring-playbook-bridge-mautrix-facebook.md +++ b/docs/configuring-playbook-bridge-mautrix-facebook.md @@ -59,6 +59,16 @@ If you run into trouble, check the [Troubleshooting](#troubleshooting) section b ## 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-facebook`. + +### Increase logging verbosity + +The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +matrix_mautrix_facebook_logging_level: DEBUG +``` + ### Facebook rejecting login attempts and forcing you to change password If your Matrix server is in a wildly different location than where you usually use your Facebook account from, the bridge's login attempts may be outright rejected by Facebook. Along with that, Facebook may even force you to change the account's password. diff --git a/docs/configuring-playbook-bridge-mautrix-googlechat.md b/docs/configuring-playbook-bridge-mautrix-googlechat.md index 4dbde4dd8..a2e3dff61 100644 --- a/docs/configuring-playbook-bridge-mautrix-googlechat.md +++ b/docs/configuring-playbook-bridge-mautrix-googlechat.md @@ -55,3 +55,15 @@ To use the bridge, you need to start a chat with `@googlechatbot:example.com` (w You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/googlechat/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-googlechat`. + +### Increase logging verbosity + +The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +matrix_mautrix_googlechat_logging_level: DEBUG +``` diff --git a/docs/configuring-playbook-bridge-mautrix-instagram.md b/docs/configuring-playbook-bridge-mautrix-instagram.md index 99988df41..4bacb9ebd 100644 --- a/docs/configuring-playbook-bridge-mautrix-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-instagram.md @@ -44,3 +44,15 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use To use the bridge, you need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). You then need to send `login YOUR_INSTAGRAM_EMAIL_ADDRESS YOUR_INSTAGRAM_PASSWORD` to the bridge bot to enable bridging for your instagram/Messenger account. + +## 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-instagram`. + +### Increase logging verbosity + +The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +matrix_mautrix_instagram_logging_level: DEBUG +``` diff --git a/docs/configuring-playbook-bridge-mautrix-telegram.md b/docs/configuring-playbook-bridge-mautrix-telegram.md index f3deabc77..77f92a1dc 100644 --- a/docs/configuring-playbook-bridge-mautrix-telegram.md +++ b/docs/configuring-playbook-bridge-mautrix-telegram.md @@ -93,3 +93,15 @@ To use the bridge, you need to start a chat with `@telegrambot:example.com` (whe You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/telegram/authentication.html). After logging in, the bridge will create portal rooms for all of your Telegram groups and invite you to them. Note that the bridge won't automatically create rooms for private 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-telegram`. + +### Increase logging verbosity + +The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +matrix_mautrix_telegram_logging_level: DEBUG +``` From 63a6d7e73ae0fbeb8a13268f07e91bfab1c371dc Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 7 Feb 2025 16:03:38 +0900 Subject: [PATCH 05/12] Update docs/configuring-playbook-prometheus-grafana.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-prometheus-grafana.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 89530058e..013fa8869 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -155,6 +155,12 @@ scrape_configs: index: 18111 ``` +## 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 the commands below: +- `journalctl -fu matrix-prometheus` for Prometheus +- `journalctl -fu matrix-grafana` for Grafana + ## More information - [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md) From 4e977bd3b2c75005ad9356c7fc6354f48971e9c6 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 7 Feb 2025 16:07:00 +0900 Subject: [PATCH 06/12] Update docs/configuring-playbook-bot-matrix-registration-bot.md: fix the service name Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-matrix-registration-bot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index fffd239f2..96c9dd54a 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -75,7 +75,7 @@ just run-tags bot-matrix-registration-bot-clean-cache ## 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-registration-bot`. +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-bot-matrix-registration-bot`. ### Increase logging verbosity From 7f8f241e81842725a6b95e21747811bd61c37f07 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 7 Feb 2025 16:09:26 +0900 Subject: [PATCH 07/12] Update docs/configuring-playbook-bridge-appservice-webhooks.md: remove the duplicated instruction in favor of the dedicated section below Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-appservice-webhooks.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/configuring-playbook-bridge-appservice-webhooks.md b/docs/configuring-playbook-bridge-appservice-webhooks.md index c57e1239f..1fbecfdb1 100644 --- a/docs/configuring-playbook-bridge-appservice-webhooks.md +++ b/docs/configuring-playbook-bridge-appservice-webhooks.md @@ -14,9 +14,6 @@ To enable the bridge, add the following configuration to your `inventory/host_va matrix_appservice_webhooks_enabled: true matrix_appservice_webhooks_api_secret: '' -# Uncomment to increase the verbosity of logging via `journalctl -fu matrix-appservice-webhooks.service` -# matrix_appservice_webhooks_log_level: 'verbose' - # As of Synapse 1.90.0, uncomment to enable the backwards compatibility (https://matrix-org.github.io/synapse/latest/upgrade#upgrading-to-v1900) that this bridge needs. # Note: This deprecated method is considered insecure. # From 596136412574f5b58909cb9fabef8632f9ea6287 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 7 Feb 2025 16:11:09 +0900 Subject: [PATCH 08/12] Update docs/configuring-playbook-bridge-wechat.md: fix the service name Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-wechat.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-bridge-wechat.md b/docs/configuring-playbook-bridge-wechat.md index b42388bb7..0ae3fe21f 100644 --- a/docs/configuring-playbook-bridge-wechat.md +++ b/docs/configuring-playbook-bridge-wechat.md @@ -47,7 +47,7 @@ Send `help` to the bot to see the available commands. ## 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-bridge-wechat`. +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-wechat`. ### Increase logging verbosity From ddeae3c1c4f1ab5c7a801d5eef8a774587baa492 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 7 Feb 2025 16:12:27 +0900 Subject: [PATCH 09/12] Update docs/configuring-playbook-bridge-hookshot.md: fix the service name Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-hookshot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-bridge-hookshot.md b/docs/configuring-playbook-bridge-hookshot.md index 13c6eb6f3..4ed8d2186 100644 --- a/docs/configuring-playbook-bridge-hookshot.md +++ b/docs/configuring-playbook-bridge-hookshot.md @@ -146,7 +146,7 @@ If you are also running [matrix-appservice-webhooks](configuring-playbook-bridge ## 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-bridge-hookshot`. +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-hookshot`. ### Increase logging verbosity From eff8c8e4b34dd091b7c3ded838b6324c33eaf3aa Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 7 Feb 2025 16:21:43 +0900 Subject: [PATCH 10/12] Update docs/configuring-playbook-jitsi.md: adopt the common instruction for troubleshooting Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-jitsi.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index 9e976b691..48c7516c7 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -382,6 +382,12 @@ ansible-playbook -i inventory/hosts --limit jitsi_jvb_servers jitsi_jvb.yml --ta ## 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 the commands below: +- `journalctl -fu matrix-jitsi-web` +- `journalctl -fu matrix-jitsi-prosody` +- `journalctl -fu matrix-jitsi-jicofo` +- `journalctl -fu matrix-jitsi-jvb` + ### `Error: Account creation/modification not supported` If you get an error like `Error: Account creation/modification not supported` with authentication enabled, it's likely that you had previously installed Jitsi without auth/guest support. From b72de6995d88ef4ecbbff8d11f8dacc29ee30896 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 7 Feb 2025 16:24:56 +0900 Subject: [PATCH 11/12] Update docs/configuring-playbook-postgres-backup.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-postgres-backup.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-postgres-backup.md b/docs/configuring-playbook-postgres-backup.md index 165609d0c..08f88b8bf 100644 --- a/docs/configuring-playbook-postgres-backup.md +++ b/docs/configuring-playbook-postgres-backup.md @@ -36,3 +36,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start 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. Note these shortcuts run the `ensure-matrix-users-created` tag too. + +## 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-postgres-backup`. From 1bccda962905a87bbd72adcc046221e468e9ce20 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 7 Feb 2025 16:32:30 +0900 Subject: [PATCH 12/12] Update docs/configuring-playbook-s3-goofys.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-s3-goofys.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-s3-goofys.md b/docs/configuring-playbook-s3-goofys.md index 720c7d8b2..2efdac86e 100644 --- a/docs/configuring-playbook-s3-goofys.md +++ b/docs/configuring-playbook-s3-goofys.md @@ -124,3 +124,7 @@ After making the backup, follow one of the guides below for a migration path fro 7. You're done! Verify that loading existing (old) media files works and that you can upload new ones. 8. When confident that it all works, get rid of the local media store directory: `rm -rf /matrix/synapse/storage/media-store-local-backup` + +## 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-goofys`.