From bad9785103573e01aec6b56660fb5c07cd60b4fc Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 30 Jan 2025 15:24:12 +0900 Subject: [PATCH 1/9] Update docs/configuring-playbook-etherpad.md: add the common section "Troubleshooting" See: https://etherpad.org/doc/v2.2.7/index.html Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-etherpad.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/configuring-playbook-etherpad.md b/docs/configuring-playbook-etherpad.md index 65f11b9b4..f6664f19d 100644 --- a/docs/configuring-playbook-etherpad.md +++ b/docs/configuring-playbook-etherpad.md @@ -105,3 +105,19 @@ Once the plugin is installed, you should have a "Manage pads" section in the UI. **Note**: this is how it works in Element Web. It might work quite similar with other clients: To integrate a standalone Etherpad in a room, create your pad by visiting `https://etherpad.example.com`. When the pad opens, copy the URL and send a command like this to the room: `/addwidget URL`. You will then find your integrated Etherpad within the right sidebar in the `Widgets` section. + +## 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-etherpad`. + +### 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: ERROR, WARN, INFO, DEBUG +etherpad_configuration_extension_json: | + { + "loglevel": "DEBUG", + } +``` From dd4690fba40fbda3108b25c0304eb2b0f43ef78d Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 30 Jan 2025 15:54:50 +0900 Subject: [PATCH 2/9] Update docs/configuring-playbook-dimension.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-dimension.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-dimension.md b/docs/configuring-playbook-dimension.md index 6a662e87c..5bc709c12 100644 --- a/docs/configuring-playbook-dimension.md +++ b/docs/configuring-playbook-dimension.md @@ -123,3 +123,7 @@ By default Dimension will use [jitsi.riot.im](https://jitsi.riot.im/) as the `co To set up the widget, an admin user needs to configure the domain via the admin UI once Dimension is running. In Element Web, go to *Manage Integrations* → *Settings* → *Widgets* → *Jitsi Conference Settings* and set *Jitsi Domain* and *Jitsi Script URL* appropriately. There is unfortunately no way to configure the widget via the playbook. See [this issue](https://github.com/turt2live/matrix-dimension/issues/345) for details. + +## 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-dimension`. From 271f386d1b659a9b6528621b81ad9724f060e7a5 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 30 Jan 2025 18:42:53 +0900 Subject: [PATCH 3/9] Update docs/configuring-playbook-turn.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-turn.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-turn.md b/docs/configuring-playbook-turn.md index a0915312d..611037415 100644 --- a/docs/configuring-playbook-turn.md +++ b/docs/configuring-playbook-turn.md @@ -94,3 +94,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-coturn`. From 76f35d95a24563f67eb62590d523001bf3784358 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 31 Jan 2025 00:46:12 +0900 Subject: [PATCH 4/9] Update docs/configuring-playbook-bridge-postmoogle.md: adopt the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-postmoogle.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index 18321207e..eff5b62e3 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -92,9 +92,11 @@ You can also refer to the upstream [documentation](https://github.com/etkecc/pos ## Troubleshooting -As with all other services, you can find their logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by running something like `journalctl -fu matrix-postmoogle` +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-postmoogle`. -The default logging level for this bridge is `INFO`, but you can increase it to `DEBUG` with the following additional configuration: +### Increase logging verbosity + +The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: ```yaml matrix_postmoogle_loglevel: 'DEBUG' From cf8e5f8e0a16f7ea0af5e8f4da910d5a2f283361 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 31 Jan 2025 00:47:41 +0900 Subject: [PATCH 5/9] Update docs/configuring-playbook-conduwuit.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-conduwuit.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-conduwuit.md b/docs/configuring-playbook-conduwuit.md index a2ea0c925..b198dd814 100644 --- a/docs/configuring-playbook-conduwuit.md +++ b/docs/configuring-playbook-conduwuit.md @@ -91,3 +91,7 @@ Then, send its content to the existing admin room: sender_localpart: _bot_signalbot url: http://matrix-mautrix-signal:29328 ``` + +## 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-conduwuit`. From b0e67c365baf4f1f0ed0e9fe2b24786d28852abd Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 31 Jan 2025 02:23:36 +0900 Subject: [PATCH 6/9] Update docs/configuring-playbook-bridge-appservice-kakaotalk.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- ...nfiguring-playbook-bridge-appservice-kakaotalk.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/configuring-playbook-bridge-appservice-kakaotalk.md b/docs/configuring-playbook-bridge-appservice-kakaotalk.md index 9b029e194..c8fbb12fc 100644 --- a/docs/configuring-playbook-bridge-appservice-kakaotalk.md +++ b/docs/configuring-playbook-bridge-appservice-kakaotalk.md @@ -56,3 +56,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 `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). You then need to send `login --save EMAIL_OR_PHONE_NUMBER` to the bridge bot to enable bridging for your Kakaotalk account. The `--save` flag may be omitted, if you'd rather not save your password. + +## 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-appservice-kakaotalk`. + +### 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_appservice_kakaotalk_logging_level: DEBUG +``` From f920bf2cba8ffa9bf949d252173b3058e15c7783 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 31 Jan 2025 02:29:35 +0900 Subject: [PATCH 7/9] Update docs/configuring-playbook-bridge-beeper-linkedin.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bridge-beeper-linkedin.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/configuring-playbook-bridge-beeper-linkedin.md b/docs/configuring-playbook-bridge-beeper-linkedin.md index 73059ce64..995ea6faa 100644 --- a/docs/configuring-playbook-bridge-beeper-linkedin.md +++ b/docs/configuring-playbook-bridge-beeper-linkedin.md @@ -55,6 +55,16 @@ You then need to send `login YOUR_LINKEDIN_EMAIL_ADDRESS` to the bridge bot to e ## 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-beeper-linkedin`. + +### 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_beeper_linkedin_logging_level: DEBUG +``` + ### Bridge asking for 2FA even if you don't have 2FA enabled If you don't have 2FA enabled and are logging in from a strange IP for the first time, LinkedIn will send an email with a one-time code. You can use this code to authorize the bridge session. In my experience, once the IP is authorized, you will not be asked again. From 4a178b534bbd6693a9da38863e14463bf6732adf Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 31 Jan 2025 02:37:32 +0900 Subject: [PATCH 8/9] Update docs/configuring-playbook-sliding-sync-proxy.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-sliding-sync-proxy.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-sliding-sync-proxy.md b/docs/configuring-playbook-sliding-sync-proxy.md index 406dc6196..3f74c45ef 100644 --- a/docs/configuring-playbook-sliding-sync-proxy.md +++ b/docs/configuring-playbook-sliding-sync-proxy.md @@ -68,3 +68,7 @@ You **don't need to do anything special** to make use of the Sliding Sync proxy. When the Sliding Sync proxy is [installed](#installing), your `/.well-known/matrix/client` file is also updated. A new `org.matrix.msc3575.proxy` section and `url` property are added there and made to point to your Sliding Sync proxy's base URL (e.g. `https://matrix.example.com/sliding-sync`). This allows clients which support Sliding Sync to detect the Sliding Sync proxy's URL and make use of it. + +## 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-sliding-sync-proxy`. From 056a502d5fab525dc58aa75072b7ee25f31e59e7 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 6 Feb 2025 23:22:28 +0900 Subject: [PATCH 9/9] Update files for Sliding Sync proxy: change "matrix-sliding-sync-proxy" to "matrix-sliding-sync" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-sliding-sync-proxy.md | 2 +- roles/custom/matrix-sliding-sync/defaults/main.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-sliding-sync-proxy.md b/docs/configuring-playbook-sliding-sync-proxy.md index 3f74c45ef..72da17ed3 100644 --- a/docs/configuring-playbook-sliding-sync-proxy.md +++ b/docs/configuring-playbook-sliding-sync-proxy.md @@ -71,4 +71,4 @@ This allows clients which support Sliding Sync to detect the Sliding Sync proxy' ## 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-sliding-sync-proxy`. +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-sliding-sync`. diff --git a/roles/custom/matrix-sliding-sync/defaults/main.yml b/roles/custom/matrix-sliding-sync/defaults/main.yml index adc6312ac..d8fbdff7c 100644 --- a/roles/custom/matrix-sliding-sync/defaults/main.yml +++ b/roles/custom/matrix-sliding-sync/defaults/main.yml @@ -93,13 +93,13 @@ matrix_sliding_sync_container_labels_additional_labels: '' # A list of extra arguments to pass to the container matrix_sliding_sync_container_extra_arguments: [] -# List of systemd services that matrix-sliding-sync-proxy.service depends on +# List of systemd services that matrix-sliding-sync.service depends on matrix_sliding_sync_systemd_required_services_list: "{{ matrix_sliding_sync_systemd_required_services_list_default + matrix_sliding_sync_systemd_required_services_list_auto + matrix_sliding_sync_systemd_required_services_list_custom }}" matrix_sliding_sync_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" matrix_sliding_sync_systemd_required_services_list_auto: [] matrix_sliding_sync_systemd_required_services_list_custom: [] -# List of systemd services that matrix-sliding-sync-proxy.service wants +# List of systemd services that matrix-sliding-sync.service wants matrix_sliding_sync_systemd_wanted_services_list: [] # Controls the SYNCV3_SERVER environment variable