From 096b85bd966931c6ddca8196829c4b99f2fb664f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 6 Nov 2025 23:12:32 +0900 Subject: [PATCH] Update translation-templates/ Signed-off-by: Suguru Hirahara --- i18n/translation-templates/CHANGELOG.pot | 6821 +++++++++-------- i18n/translation-templates/README.pot | 246 +- i18n/translation-templates/YEAR-IN-REVIEW.pot | 160 +- i18n/translation-templates/docs/README.pot | 88 +- .../docs/alternative-architectures.pot | 22 +- i18n/translation-templates/docs/ansible.pot | 152 +- .../docs/configuring-captcha.pot | 34 +- .../docs/configuring-dns.pot | 60 +- .../docs/configuring-ipv6.pot | 361 + ...iguring-playbook-alertmanager-receiver.pot | 98 +- ...ring-playbook-appservice-double-puppet.pot | 44 +- ...g-playbook-appservice-draupnir-for-all.pot | 90 +- .../docs/configuring-playbook-backup-borg.pot | 168 +- ...nfiguring-playbook-base-domain-serving.pot | 72 +- .../docs/configuring-playbook-bot-baibot.pot | 240 +- .../configuring-playbook-bot-buscarron.pot | 78 +- .../docs/configuring-playbook-bot-chatgpt.pot | 104 +- .../configuring-playbook-bot-draupnir.pot | 319 +- .../docs/configuring-playbook-bot-go-neb.pot | 136 +- .../configuring-playbook-bot-honoroit.pot | 86 +- ...g-playbook-bot-matrix-registration-bot.pot | 116 +- ...uring-playbook-bot-matrix-reminder-bot.pot | 88 +- .../docs/configuring-playbook-bot-maubot.pot | 116 +- .../docs/configuring-playbook-bot-mjolnir.pot | 148 +- ...ing-playbook-bridge-appservice-discord.pot | 152 +- ...iguring-playbook-bridge-appservice-irc.pot | 70 +- ...g-playbook-bridge-appservice-kakaotalk.pot | 74 +- ...uring-playbook-bridge-appservice-slack.pot | 159 +- ...ng-playbook-bridge-appservice-webhooks.pot | 100 +- ...guring-playbook-bridge-beeper-linkedin.pot | 86 +- ...guring-playbook-bridge-go-skype-bridge.pot | 90 +- ...nfiguring-playbook-bridge-heisenbridge.pot | 82 +- .../configuring-playbook-bridge-hookshot.pot | 212 +- ...ring-playbook-bridge-matrix-bridge-sms.pot | 54 +- ...guring-playbook-bridge-mautrix-bluesky.pot | 121 + ...guring-playbook-bridge-mautrix-bridges.pot | 161 +- ...guring-playbook-bridge-mautrix-discord.pot | 114 +- ...uring-playbook-bridge-mautrix-facebook.pot | 148 +- ...ring-playbook-bridge-mautrix-gmessages.pot | 78 +- ...ing-playbook-bridge-mautrix-googlechat.pot | 74 +- ...uring-playbook-bridge-mautrix-hangouts.pot | 92 +- ...ring-playbook-bridge-mautrix-instagram.pot | 64 +- ...playbook-bridge-mautrix-meta-instagram.pot | 88 +- ...playbook-bridge-mautrix-meta-messenger.pot | 112 +- ...iguring-playbook-bridge-mautrix-signal.pot | 78 +- ...figuring-playbook-bridge-mautrix-slack.pot | 122 +- ...uring-playbook-bridge-mautrix-telegram.pot | 93 +- ...guring-playbook-bridge-mautrix-twitter.pot | 76 +- ...uring-playbook-bridge-mautrix-whatsapp.pot | 74 +- ...guring-playbook-bridge-mautrix-wsproxy.pot | 68 +- ...ring-playbook-bridge-mx-puppet-discord.pot | 78 +- ...ring-playbook-bridge-mx-puppet-groupme.pot | 44 +- ...ng-playbook-bridge-mx-puppet-instagram.pot | 86 +- ...guring-playbook-bridge-mx-puppet-skype.pot | 12 +- ...guring-playbook-bridge-mx-puppet-slack.pot | 82 +- ...guring-playbook-bridge-mx-puppet-steam.pot | 54 +- ...ring-playbook-bridge-mx-puppet-twitter.pot | 78 +- ...configuring-playbook-bridge-postmoogle.pot | 78 +- .../configuring-playbook-bridge-steam.pot | 85 + .../configuring-playbook-bridge-wechat.pot | 86 +- .../configuring-playbook-cactus-comments.pot | 100 +- .../configuring-playbook-client-cinny.pot | 68 +- ...onfiguring-playbook-client-element-web.pot | 146 +- ...iguring-playbook-client-fluffychat-web.pot | 101 + .../configuring-playbook-client-hydrogen.pot | 74 +- ...guring-playbook-client-schildichat-web.pot | 136 +- .../docs/configuring-playbook-conduit.pot | 84 +- .../docs/configuring-playbook-conduwuit.pot | 88 +- .../configuring-playbook-continuwuity.pot | 161 + .../docs/configuring-playbook-dendrite.pot | 58 +- .../docs/configuring-playbook-dimension.pot | 108 +- .../docs/configuring-playbook-dynamic-dns.pot | 64 +- .../configuring-playbook-element-admin.pot | 113 + .../configuring-playbook-element-call.pot | 245 + .../docs/configuring-playbook-email.pot | 110 +- .../configuring-playbook-email2matrix.pot | 252 +- .../docs/configuring-playbook-etherpad.pot | 136 +- ...configuring-playbook-external-postgres.pot | 16 +- .../docs/configuring-playbook-federation.pot | 38 +- .../docs/configuring-playbook-jitsi.pot | 470 +- .../docs/configuring-playbook-jwt-service.pot | 93 + .../docs/configuring-playbook-ldap-auth.pot | 46 +- ...nfiguring-playbook-livekit-jwt-service.pot | 45 + .../configuring-playbook-livekit-server.pot | 85 + .../docs/configuring-playbook-ma1sd.pot | 192 +- ...playbook-matrix-authentication-service.pot | 372 +- .../configuring-playbook-matrix-corporal.pot | 112 +- ...laybook-matrix-ldap-registration-proxy.pot | 56 +- ...configuring-playbook-matrix-media-repo.pot | 184 +- ...nfiguring-playbook-matrix-registration.pot | 112 +- .../docs/configuring-playbook-matrix-rtc.pot | 105 + .../docs/configuring-playbook-nginx.pot | 6 +- .../docs/configuring-playbook-ntfy.pot | 322 +- .../configuring-playbook-own-webserver.pot | 90 +- .../docs/configuring-playbook-pantalaimon.pot | 36 +- .../configuring-playbook-postgres-backup.pot | 146 +- ...onfiguring-playbook-prometheus-grafana.pot | 356 +- .../docs/configuring-playbook-rageshake.pot | 78 +- .../docs/configuring-playbook-rest-auth.pot | 42 +- .../docs/configuring-playbook-riot-web.pot | 38 +- .../docs/configuring-playbook-s3-goofys.pot | 112 +- .../docs/configuring-playbook-s3.pot | 148 +- ...onfiguring-playbook-shared-secret-auth.pot | 26 +- ...onfiguring-playbook-sliding-sync-proxy.pot | 96 +- .../configuring-playbook-ssl-certificates.pot | 112 +- .../docs/configuring-playbook-sygnal.pot | 74 +- .../configuring-playbook-synapse-admin.pot | 136 +- ...ng-playbook-synapse-auto-accept-invite.pot | 28 +- ...uring-playbook-synapse-auto-compressor.pot | 104 +- ...g-playbook-synapse-s3-storage-provider.pot | 304 +- ...uring-playbook-synapse-simple-antispam.pot | 32 +- ...guring-playbook-synapse-usage-exporter.pot | 84 +- .../docs/configuring-playbook-synapse.pot | 202 +- .../docs/configuring-playbook-telemetry.pot | 18 +- .../docs/configuring-playbook-traefik.pot | 144 +- .../docs/configuring-playbook-turn.pot | 116 +- ...ing-playbook-user-verification-service.pot | 108 +- .../docs/configuring-playbook.pot | 446 +- .../docs/configuring-well-known.pot | 124 +- .../docs/container-images.pot | 294 +- i18n/translation-templates/docs/faq.pot | 536 +- .../docs/getting-the-playbook.pot | 36 +- .../docs/howto-server-delegation.pot | 86 +- .../docs/howto-srv-server-delegation.pot | 70 +- .../docs/importing-postgres.pot | 143 +- .../docs/importing-synapse-media-store.pot | 24 +- .../docs/importing-synapse-sqlite.pot | 62 +- .../translation-templates/docs/installing.pot | 222 +- i18n/translation-templates/docs/just.pot | 34 +- .../docs/maintenance-and-troubleshooting.pot | 152 +- .../docs/maintenance-migrating.pot | 62 +- .../docs/maintenance-postgres.pot | 180 +- .../docs/maintenance-synapse.pot | 114 +- .../docs/maintenance-upgrading-services.pot | 56 +- .../docs/obtaining-access-tokens.pot | 40 +- .../docs/playbook-tags.pot | 58 +- .../docs/prerequisites.pot | 132 +- .../docs/quick-start.pot | 204 +- .../docs/registering-users.pot | 116 +- .../docs/self-building.pot | 84 +- .../docs/uninstalling.pot | 34 +- .../docs/updating-users-passwords.pot | 72 +- i18n/translation-templates/i18n/README.pot | 4 +- 143 files changed, 12813 insertions(+), 10672 deletions(-) create mode 100644 i18n/translation-templates/docs/configuring-ipv6.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bluesky.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-bridge-steam.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-client-fluffychat-web.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-continuwuity.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-element-admin.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-element-call.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-jwt-service.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-livekit-jwt-service.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-livekit-server.pot create mode 100644 i18n/translation-templates/docs/configuring-playbook-matrix-rtc.pot diff --git a/i18n/translation-templates/CHANGELOG.pot b/i18n/translation-templates/CHANGELOG.pot index 471062749..8370ca998 100644 --- a/i18n/translation-templates/CHANGELOG.pot +++ b/i18n/translation-templates/CHANGELOG.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -17,7063 +17,7484 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" #: ../../../CHANGELOG.md:1 -msgid "2025-01-27" +msgid "2025-11-05" msgstr "" #: ../../../CHANGELOG.md:3 -msgid "Redis and KeyDB are no longer part of the playbook" +msgid "The MX Puppet bridges for Discord, Instagram, Slack, and Twitter have been removed from the playbook" msgstr "" #: ../../../CHANGELOG.md:5 -msgid "**TLDR**: The playbook now exclusively uses Valkey as its Redis-compatible memorystore implementation, removing support for Redis and KeyDB. Most users are unaffected by this change unless they explicitly configured Redis or KeyDB variables. Only users that were explicitly definining `redis_*` or `keydb_*` variables will need to update their configuration to use `valkey_*` variables instead." +msgid "The MX Puppet bridges for Discord, Instagram, Slack, and Twitter have been removed from the playbook, as they have been unmaintained for more than several years and do not support important features like authenticated media. See [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3867) for the context." msgstr "" #: ../../../CHANGELOG.md:7 -msgid "The playbook has gone through several iterations of memorystore implementations:" +msgid "The playbook will let you know if you're using any variables for those bridges:" msgstr "" #: ../../../CHANGELOG.md:9 -msgid "It initially used Redis, auto-installing it when needed by features/services" +msgid "`matrix_mx_puppet_discord_*`" msgstr "" #: ../../../CHANGELOG.md:10 -msgid "[Switched to KeyDB](#backward-compatibility-break-the-playbook-now-defaults-to-keydb-instead-of-redis) as the default, while keeping Redis support for those who wished to remain on Redis" +msgid "`matrix_mx_puppet_instagram_*`" msgstr "" #: ../../../CHANGELOG.md:11 -msgid "[Switched to Valkey](#backward-compatibility-break-the-playbook-now-defaults-to-valkey-instead-of-keydb) due to [KeyDB issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3544), while keeping Redis and KeyDB support, for those who wished to remain on them" +msgid "`matrix_mx_puppet_slack_*`" msgstr "" -#: ../../../CHANGELOG.md:13 -msgid "To reduce configuration complexity and maintenance overhead, we are now:" +#: ../../../CHANGELOG.md:12 +msgid "`matrix_mx_puppet_twitter_*`" msgstr "" -#: ../../../CHANGELOG.md:15 -msgid "removing Redis and KeyDB support entirely" +#: ../../../CHANGELOG.md:14 +msgid "You'll need to remove them from `vars.yml` and potentially uninstall them manually. Consult pages below for details:" msgstr "" #: ../../../CHANGELOG.md:16 -msgid "using Valkey as the sole Redis-compatible memorystore implementation" +msgid "[Instruction for MX Puppet Discord bridge](./docs/configuring-playbook-bridge-mx-puppet-discord.md#uninstalling-the-bridge-manually)" +msgstr "" + +#: ../../../CHANGELOG.md:17 +msgid "[Instruction for MX Puppet Instagram bridge](./docs/configuring-playbook-bridge-mx-puppet-instagram.md#uninstalling-the-bridge-manually)" msgstr "" #: ../../../CHANGELOG.md:18 -msgid "To update your configuration:" +msgid "[Instruction for MX Puppet Slack bridge](./docs/configuring-playbook-bridge-mx-puppet-slack.md#uninstalling-the-bridge-manually)" msgstr "" -#: ../../../CHANGELOG.md:20 -msgid "**Most users** don't need to do anything" +#: ../../../CHANGELOG.md:19 +msgid "[Instruction for MX Puppet Twitter bridge](./docs/configuring-playbook-bridge-mx-puppet-twitter.md#uninstalling-the-bridge-manually)" msgstr "" #: ../../../CHANGELOG.md:21 -msgid "**Users that were explicitly sticking to Redis/KeyDB** need to update their `vars.yml` to use `valkey_*` variables instead" +msgid "2025-11-04" msgstr "" -#: ../../../CHANGELOG.md:24 -msgid "2025-01-19" +#: ../../../CHANGELOG.md:23 +msgid "The Go Skype bridge has been removed from the playbook" msgstr "" -#: ../../../CHANGELOG.md:26 -msgid "conduwuit support" +#: ../../../CHANGELOG.md:25 +msgid "The [go-skype-bridge](./docs/configuring-playbook-bridge-go-skype-bridge.md) has been removed from the playbook, as Skype has been discontinued since the May 2025." msgstr "" -#: ../../../CHANGELOG.md:28 -msgid "Thanks to [Virkkunen](https://github.com/Virkkunen), we now have optional experimental [conduwuit](https://conduwuit.puppyirl.gay/) homeserver support for new installations." +#: ../../../CHANGELOG.md:27 +msgid "The playbook will let you know if you're using any `matrix_go_skype_bridge_*` variables. You'll need to remove them from `vars.yml` and potentially [uninstall the bridge manually](./docs/configuring-playbook-bridge-go-skype-bridge.md#uninstalling-the-bridge-manually)." msgstr "" -#: ../../../CHANGELOG.md:30 -msgid "conduwuit is a fork of [Conduit](./docs/configuring-playbook-conduit.md), which the playbook also supports. See [Differences from upstream Conduit](https://conduwuit.puppyirl.gay/differences.html)." +#: ../../../CHANGELOG.md:29 +msgid "2025-10-02" msgstr "" -#: ../../../CHANGELOG.md:32 +#: ../../../CHANGELOG.md:31 +msgid "Element Admin support" +msgstr "" + +#: ../../../CHANGELOG.md:33 +msgid "The playbook now supports [Element Admin](./docs/configuring-playbook-element-admin.md) - a new web-based administration panel for Synapse and [Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md)." +msgstr "" + +#: ../../../CHANGELOG.md:35 +msgid "Deployments based on Matrix Authentication Service may find it useful to run both Synapse Admin and Element Admin at the same time." +msgstr "" + +#: ../../../CHANGELOG.md:37 +msgid "Deployments that don't rely on Matrix Authentication Service are unlikely to find anything useful in Element Admin right now (it's too basic in its current form)." +msgstr "" + +#: ../../../CHANGELOG.md:40 +msgid "2025-04-26" +msgstr "" + +#: ../../../CHANGELOG.md:42 +msgid "Continuwuity support" +msgstr "" + +#: ../../../CHANGELOG.md:44 +msgid "Thanks to [Virkkunen](https://github.com/Virkkunen), we now have optional experimental [Continuwuity](./docs/configuring-playbook-continuwuity.md) homeserver support." +msgstr "" + +#: ../../../CHANGELOG.md:46 +msgid "Continuwuity is a fork of [conduwuit](./docs/configuring-playbook-conduwuit.md), which the playbook also supports. It appears that conduwuit has been abandoned and various forks (like Continuwuity, [Tuwunel](https://github.com/matrix-construct/tuwunel) and possibly others) are continuing in its path." +msgstr "" + +#: ../../../CHANGELOG.md:48 +#: ../../../CHANGELOG.md:261 msgid "Existing installations do **not** need to be updated. **Synapse is still the default homeserver implementation** installed by the playbook." msgstr "" -#: ../../../CHANGELOG.md:34 -msgid "To try out conduwuit, we recommend that you **use a new server**. Refer to our [Configuring conduwuit](./docs/configuring-playbook-conduwuit.md) guide for details." +#: ../../../CHANGELOG.md:50 +msgid "People that used to run conduwuit, may wish to:" msgstr "" -#: ../../../CHANGELOG.md:36 -msgid "**The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse/Conduit/Dendrite to conduwuit) without data loss." +#: ../../../CHANGELOG.md:52 +msgid "either [migrate from conduwuit to Continuwuity](./docs/configuring-playbook-continuwuity.md#migrating-from-conduwuit)" msgstr "" -#: ../../../CHANGELOG.md:39 -msgid "2025-01-14" +#: ../../../CHANGELOG.md:53 +msgid "or wait for some of the other forks to progress and for support for them to get added to the playbook" msgstr "" -#: ../../../CHANGELOG.md:41 -msgid "(Backward Compatibility Break) Synapse v1.122.0 requires Postgres v13" +#: ../../../CHANGELOG.md:55 +msgid "**The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse/Conduit/Dendrite to Continuwuity) without data loss." msgstr "" -#: ../../../CHANGELOG.md:43 -msgid "The Synapse homeserver [requires Postgres v13 or newer](https://github.com/element-hq/synapse/issues/18034)." +#: ../../../CHANGELOG.md:58 +msgid "2025-04-09" msgstr "" -#: ../../../CHANGELOG.md:45 -msgid "If you've been maintaining your setup for a while and you haven't been doing [Postgres upgrades](docs/maintenance-postgres.md#upgrading-postgresql), you may be on an old version of Postgres. The easiest way to check is to see the contents of the `/matrix/postgres/data/PG_VERSION` file." +#: ../../../CHANGELOG.md:60 +msgid "Element Call frontend installation is now optional" msgstr "" -#: ../../../CHANGELOG.md:47 -msgid "If you're on a Postgres version older than v13, you need to [upgrade your Postgres setup](docs/maintenance-postgres.md#upgrading-postgresql) or Synapse will produce an error on startup." +#: ../../../CHANGELOG.md:62 +msgid "Because all Element clients (Element Web and Element X mobile) now embed and use their own Element Call frontend application (and not the one hosted via the playbook), it makes little sense for the playbook to self-host the Element Call frontend for you. Setting up the frontend requires an additional hostname (DNS setup) and it won't be used by Element clients anyway, so **we now recommend not installing the Element Call frontend**." msgstr "" -#: ../../../CHANGELOG.md:49 -msgid "If you're using an external Postgres server (not installed by this playbook), you'll need to figure out how to upgrade it yourself." +#: ../../../CHANGELOG.md:64 +msgid "💡 A reason you may wish to continue installing the Element Call frontend (despite Matrix clients not making use of it), is if you need to use it standalone - directly via a browser (without a Matrix client)." msgstr "" -#: ../../../CHANGELOG.md:51 -msgid "If you're not ready to upgrade your Postgres setup yet, you can temporarily remain on an old Synapse version by adding the following configuration to your `vars.yml` file:" +#: ../../../CHANGELOG.md:66 +msgid "The playbook now lets you [Decide between Element Call vs just the Matrix RTC stack](./docs/configuring-playbook-element-call.md#decide-between-element-call-vs-just-the-matrix-rtc-stack)." msgstr "" -#: ../../../CHANGELOG.md:59 -msgid "2024-11-26" +#: ../../../CHANGELOG.md:68 +msgid "If you've already installed Element Call (via `matrix_element_call_enabled: true`), you can switch to installing just the [Matrix RTC (Real-Time Communication) stack](./docs/configuring-playbook-matrix-rtc.md) (all supporting services **without the Element Call frontend**) by:" msgstr "" -#: ../../../CHANGELOG.md:61 -msgid "(Backward Compatibility Break) Synapse now defaults to enabling authenticated media" +#: ../../../CHANGELOG.md:70 +msgid "Adjusting your `vars.yml` configuration like this:" msgstr "" -#: ../../../CHANGELOG.md:63 -msgid "**TLDR**: with this update, your Synapse homeserver will start requiring authentication for newly-uploaded media files. While the majority of the ecosystem (clients, bots, etc.) should support this, certain software may lack support for it (and you may wish to turn it off, if it's causing issues)." +#: ../../../CHANGELOG.md:77 +msgid "[Re-running the playbook](./docs/installing.md) with the `setup-all` Ansible tag (e.g. `just setup-all`)" msgstr "" -#: ../../../CHANGELOG.md:65 -msgid "The default configuration for the Synapse homeserver now [enforces Authenticated media by default](https://element-hq.github.io/synapse/v1.120/upgrade.html#authenticated-media-is-now-enforced-by-default)." -msgstr "" - -#: ../../../CHANGELOG.md:67 -msgid "Servers like `matrix.org` have already [sunset unauthenticated media](https://matrix.org/blog/2024/06/26/sunsetting-unauthenticated-media/) months ago." -msgstr "" - -#: ../../../CHANGELOG.md:69 -msgid "Now that **various clients, bots, bridges and extra services have caught up with authenticated media support**, Synapse developers seem confident that it's time to enable authenticated media by default." -msgstr "" - -#: ../../../CHANGELOG.md:71 -msgid "We're changing the playbook configuration for authenticated media to keep up with upstream defaults changing." -msgstr "" - -#: ../../../CHANGELOG.md:73 -msgid "Old and unmaintained bridges (like all mx-puppet bridges, etc.) do not support authenticated media. Other software may be similarly affected. If you experience issues with some Matrix-related software, you may wish to disable authenticated media and contact the software maintainers to let them know." -msgstr "" - -#: ../../../CHANGELOG.md:75 -msgid "You can disable authenticated media at any time by setting `matrix_synapse_enable_authenticated_media: false` in your `vars.yml` configuration file and re-running the playbook." -msgstr "" - -#: ../../../CHANGELOG.md:78 -msgid "2024-11-23" -msgstr "" - -#: ../../../CHANGELOG.md:80 -msgid "(Backward Compatibility Break) The playbook now defaults to Valkey, instead of KeyDB" +#: ../../../CHANGELOG.md:79 +msgid "Getting rid of the `call.element.example.com` DNS record" msgstr "" #: ../../../CHANGELOG.md:82 -msgid "**TLDR**: if the playbook installed KeyDB (or Redis) as a dependency for you before, it will now replace it with [Valkey](https://valkey.io/) (a drop-in alternative). We [previously switched from Redis to KeyDB](#backward-compatibility-break-the-playbook-now-defaults-to-keydb-instead-of-redis), but Valkey is a better alternative, so we're switching again." +msgid "2025-03-15" msgstr "" #: ../../../CHANGELOG.md:84 -msgid "The playbook used to install Redis or KeyDB if services have a need for a Redis-compatible implementation ([enabling worker support for Synapse](docs/configuring-playbook-synapse.md#load-balancing-with-workers), [enabling Hookshot encryption](docs/configuring-playbook-bridge-hookshot.md#end-to-bridge-encryption), etc.)." +msgid "Element Call support" msgstr "" #: ../../../CHANGELOG.md:86 -msgid "Earlier this year, we switched from Redis to KeyDB — see [(Backward Compatibility Break) The playbook now defaults to KeyDB, instead of Redis](#backward-compatibility-break-the-playbook-now-defaults-to-keydb-instead-of-redis)." +msgid "The playbook now supports [Element Call](https://github.com/element-hq/element-call) as an optional feature. Thanks to [wjbeckett](https://github.com/wjbeckett) for getting us started via [PR#3562](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3562)." msgstr "" #: ../../../CHANGELOG.md:88 -msgid "Because Valkey seems to be a better successor to Redis (than KeyDB) and likely doesn't suffer from [issues like this one](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3544), we now replace KeyDB with Valkey." +msgid "Element Call is a native Matrix video conferencing application developed by [Element](https://element.io/) that has the goal of replacing [Jitsi](./docs/configuring-playbook-jitsi.md) and the old WebRTC stack used in previous Element versions." msgstr "" #: ../../../CHANGELOG.md:90 -msgid "Valkey (like KeyDB and Redis in the past) is an implicitly enabled dependency — you don't need custom configuration in `vars.yml` to enable it." +msgid "💡 For now, Element Call is only supported with the [Synapse](docs/configuring-playbook-synapse.md) homeserver (with [federation](docs/configuring-playbook-federation.md) enabled) and [Element Web](docs/configuring-playbook-client-element-web.md) and Element X mobile clients. See the [Prerequisites](docs/configuring-playbook-element-call.md#prerequisites) section of the [Element Call documentation](docs/configuring-playbook-element-call.md) for more details." msgstr "" #: ../../../CHANGELOG.md:92 -msgid "Next time your run the playbook (via the `setup-all` tag), **KeyDB will be automatically uninstalled and replaced with Valkey**. Some Synapse downtime may occur while the switch happens." +msgid "To get started, see the [Configuring Element Call](docs/configuring-playbook-element-call.md) documentation page." msgstr "" -#: ../../../CHANGELOG.md:94 -msgid "Users on `arm32` should be aware that there's **neither a prebuilt `arm32` container image for Valkey**, nor the Valkey role supports self-building yet. Users on this architecture likely don't run Synapse with workers, etc., so they're likely in no need of Valkey (or Redis/KeyDB). If Redis is necessary in an `arm32` deployment, disabling Valkey and making the playbook fall back to Redis is possible (see below)." +#: ../../../CHANGELOG.md:95 +msgid "2025-03-08" msgstr "" -#: ../../../CHANGELOG.md:96 -#: ../../../CHANGELOG.md:436 -msgid "**The playbook still supports Redis** and you can keep using Redis (for now) if you'd like, by adding this additional configuration to your `vars.yml` file:" +#: ../../../CHANGELOG.md:97 +msgid "6️⃣ IPv6 support enablement recommended by default" +msgstr "" + +#: ../../../CHANGELOG.md:99 +msgid "Our [default example configuration](./examples/vars.yml) and [Configuring DNS](./docs/configuring-dns.md) guides now recommend enabling [IPv6](https://en.wikipedia.org/wiki/IPv6) support. We recommend that everyone enables IPv6 support for their Matrix server, even if they don't have IPv6 connectivity yet." +msgstr "" + +#: ../../../CHANGELOG.md:101 +msgid "Our new [Configuring IPv6](./docs/configuring-ipv6.md) documentation page has more details about the playbook's IPv6 support." +msgstr "" + +#: ../../../CHANGELOG.md:103 +msgid "**Existing playbook users** will **need to do some manual work** to enable IPv6 support. This consists of:" +msgstr "" + +#: ../../../CHANGELOG.md:105 +msgid "enabling IPv6 support for the Docker container networks:" +msgstr "" + +#: ../../../CHANGELOG.md:106 +msgid "add `devture_systemd_docker_base_ipv6_enabled: true` to their `vars.yml` configuration file" msgstr "" #: ../../../CHANGELOG.md:107 -msgid "**The playbook still supports KeyDB** and you can keep using KeyDB (for now) if you'd like, by adding this additional configuration to your `vars.yml` file:" +msgid "stop all services (`just stop-all`)" +msgstr "" + +#: ../../../CHANGELOG.md:108 +msgid "delete all container networks on the server: `docker network rm $(docker network ls -q)`" +msgstr "" + +#: ../../../CHANGELOG.md:109 +msgid "re-run the playbook fully: `just install-all`" +msgstr "" + +#: ../../../CHANGELOG.md:111 +msgid "[configuring IPv6 (`AAAA`) DNS records](./docs/configuring-ipv6.md#configuring-dns-records-for-ipv6)" +msgstr "" + +#: ../../../CHANGELOG.md:113 +msgid "2025-02-26" +msgstr "" + +#: ../../../CHANGELOG.md:115 +msgid "🪦 Bye-bye, Email2Matrix" msgstr "" #: ../../../CHANGELOG.md:117 -msgid "At some point in time in the future, we'll remove both KeyDB and Redis from the playbook, so we recommend that you migrate to Valkey earlier anyway." +msgid "The [Email2Matrix](./docs/configuring-playbook-email2matrix.md) service has been superseded by the [Postmoogle](./docs/configuring-playbook-bridge-postmoogle.md) bridge for a long time now and was completely removed from the playbook today." msgstr "" -#: ../../../CHANGELOG.md:120 -msgid "2024-11-14" +#: ../../../CHANGELOG.md:119 +msgid "If you still have the Email2Matrix component installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually as described in the [Uninstalling Email2Matrix manually](./docs/configuring-playbook-email2matrix.md#uninstalling-email2matrix-manually) section of the documentation. The playbook will warn you if there are any `matrix_email2matrix_*` variables still remaining in your configuration." msgstr "" #: ../../../CHANGELOG.md:122 -msgid "HTTP-compression support for Traefik-based setups" +msgid "2025-02-23" msgstr "" #: ../../../CHANGELOG.md:124 -msgid "The playbook now **automatically enables HTTP-compression support** for major services powered by the playbook, like [Cinny](./docs/configuring-playbook-client-cinny.md), [Element Web](./docs/configuring-playbook-client-element-web.md), [Hydrogen](./docs/configuring-playbook-client-hydrogen.md), as well as for Matrix Client-Server and Federation APIs (`matrix.example.com`)." +msgid "The playbook defaults to exposing the Coturn STUN port (3478) over UDP once again" msgstr "" #: ../../../CHANGELOG.md:126 -msgid "Other services installed by the playbook are currently not compression-enabled, but may become so over time. This change is rolled out on a per-service basis (as opposed to doing it globally, at the Traefik entrypoint level) to allow certain services or route endpoints which do not behave well when compressed (e.g. [issue 3749](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749)) to be excluded from compression." +msgid "Recently, we made the playbook [default to exposing the Coturn STUN port (3478) only over TCP](#the-playbook-now-defaults-to-exposing-the-coturn-stun-port-3478-only-over-tcp) to reduce the severity of DDoS amplification/reflection attacks." msgstr "" #: ../../../CHANGELOG.md:128 -msgid "A long time ago, various services were operating with `gzip`-compression enabled at the nginx level. Since the switch to Traefik (see [Goodbye, `matrix-nginx-proxy` 🪦](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/57c5271d9d6265a34a9d9cceb93365f685074f96/CHANGELOG.md#goodbye-matrix-nginx-proxy-)), all services (with the exception of Matrix APIs for Synapse worker-enabled setups which are powered by `nginx` via `synapse-reverse-proxy-companion`) have been operating without HTTP-compression support." +msgid "It seems like old Element clients on mobile devices only support talking to the STUN port over UDP, not TCP. To accommodate such ancient clients, we're now **reversing this change** and **defaulting to exposing the Coturn STUN port (3478) over UDP once again**." msgstr "" -#: ../../../CHANGELOG.md:130 -msgid "HTTP-compression is now done via Traefik's [compress](https://doc.traefik.io/traefik/middlewares/http/compress/) middleware. We use the default configuration for this middleware, which enables `zstd`, `br` and `gzip` support (in this order). This middleware's configuration can be configured via variables in the Traefik role (see `traefik_config_http_middlewares_compression_middleware_options`)." +#: ../../../CHANGELOG.md:131 +msgid "In light of this new information, you have 2 options:" msgstr "" -#: ../../../CHANGELOG.md:132 -msgid "If you're using your own Traefik reverse-proxy server ([Traefik managed by you](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you)) instead of the playbook's integrated Traefik service, you can benefit from the same by:" -msgstr "" - -#: ../../../CHANGELOG.md:134 -msgid "defining a [compress](https://doc.traefik.io/traefik/middlewares/http/compress/) middleware (via the [file](https://doc.traefik.io/traefik/providers/file/) or [Docker](https://doc.traefik.io/traefik/providers/docker/) providers)" +#: ../../../CHANGELOG.md:133 +msgid "**If you already adapted to the previous change and would like to adapt to this change one again**:" msgstr "" #: ../../../CHANGELOG.md:135 -msgid "setting `matrix_playbook_reverse_proxy_traefik_middleware_compression_enabled` to `true`" +msgid "make sure the `3478/udp` port is whitelisted in your external firewall (if you have one) once again." msgstr "" -#: ../../../CHANGELOG.md:136 -msgid "specifying the middleware's name in `matrix_playbook_reverse_proxy_traefik_middleware_compression_name` (e.g. `matrix_playbook_reverse_proxy_traefik_middleware_compression_name: my-compression-middleware@file`)" +#: ../../../CHANGELOG.md:137 +msgid "**If you don't care about old Element clients and wish to reduce the severity of DDoS amplification/reflection attacks**:" msgstr "" -#: ../../../CHANGELOG.md:138 -msgid "Timeout adjustments for Traefik-based setups" +#: ../../../CHANGELOG.md:139 +msgid "Consider closing the STUN/UDP port with the following configuration:" msgstr "" -#: ../../../CHANGELOG.md:140 -msgid "The playbook now supports configuring various [transport.respondingTimeouts](https://doc.traefik.io/traefik/routing/entrypoints/#respondingtimeouts) timeout values (`readTimeout`, `writeTimeout`, `idleTimeout`) for the `web`, `web-secure` and `matrix-federation` entrypoints." +#: ../../../CHANGELOG.md:145 +msgid "Consider keeping `3478/udp` blocked in your external firewall (if you have one)" msgstr "" -#: ../../../CHANGELOG.md:142 -msgid "If you're using your own Traefik reverse-proxy server ([Traefik managed by you](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you)) instead of the playbook's integrated Traefik service, you may wish to do similar configuration changes to your setup manually." +#: ../../../CHANGELOG.md:147 +msgid "2025-02-21" msgstr "" -#: ../../../CHANGELOG.md:144 -msgid "The most interesting of these is the `readTimeout` configuration value (the maximum duration for reading the entire request, including the body), which used to default to `60s`. For large and slowly progressing file uploads, `60s` would often not be enough for the transfer to finish and uploads would end up being interrupted. The playbook now raises the `readTimeout` value to 5 minutes (`300s`) to improve this use-case." +#: ../../../CHANGELOG.md:149 +msgid "Docker daemon options are no longer adjusted when IPv6 is enabled" msgstr "" -#: ../../../CHANGELOG.md:146 -msgid "The `traefik_config_entrypoint_web_transport_respondingTimeouts_*` variables (for the `web` entrypoint) cascade to affecting the timeout values for the `web-secure` and `matrix-federation` entrypoints, so you can easily adjust all timeout values using them." +#: ../../../CHANGELOG.md:151 +msgid "We landed [initial IPv6 support](#initial-work-on-ipv6-support) in the past via a `devture_systemd_docker_base_ipv6_enabled` variable that one had to toggle to `true`." msgstr "" -#: ../../../CHANGELOG.md:148 -msgid "Example of the default timeout values used by the playbook:" +#: ../../../CHANGELOG.md:153 +msgid "This variable did **2 different things at once**:" +msgstr "" + +#: ../../../CHANGELOG.md:155 +msgid "ensured that container networks were created with IPv6 being enabled" +msgstr "" + +#: ../../../CHANGELOG.md:156 +msgid "adjusted the Docker daemon's configuration to set `experimental: true` and `ip6tables: true` (a necessary prerequisite for creating IPv6-enabled networks)" +msgstr "" + +#: ../../../CHANGELOG.md:158 +msgid "Since Docker 27.0.1's [changes to how it handles IPv6](https://docs.docker.com/engine/release-notes/27/#ipv6), **adjusting the Docker daemon's configuration is no longer necessary**, because:" msgstr "" #: ../../../CHANGELOG.md:159 -msgid "Alternatively, you may adjust the timeout values for specific entrypoints (like `web-secure` and `matrix-federation`) using dedicated variables (like `traefik_config_entrypoint_web_secure_transport_respondingTimeouts_readTimeout` and `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_transport_respondingTimeouts_readTimeout`)." +msgid "`ip6tables` defaults to `true` for everyone" +msgstr "" + +#: ../../../CHANGELOG.md:160 +msgid "`ip6tables` is out of the experimental phase, so `experimental` is no longer necessary" msgstr "" #: ../../../CHANGELOG.md:162 -msgid "2024-11-08" +msgid "In light of this, we're introducing a new variable (`devture_systemd_docker_base_ipv6_daemon_options_changing_enabled`) for controlling if IPv6 should be force-enabled in the Docker daemon's configuration options. Since most people should be on a modern enough Docker daemon version which doesn't require such changes, this variable defaults to `false`." msgstr "" -#: ../../../CHANGELOG.md:164 -msgid "Support for synapse-admin auto-configuration via /.well-known/matrix/client" +#: ../../../CHANGELOG.md:165 +msgid "This change affects you like this:" msgstr "" -#: ../../../CHANGELOG.md:166 -msgid "You can administrate your Synapse-powered homeserver using synapse-admin hosted externally (e.g. [admin.etke.cc](https://admin.etke.cc/)) and the synapse-admin instance would still auto-configure itself correctly for your server by [reading its `/.well-known/matrix/client` file](https://github.com/etkecc/synapse-admin/pull/126)." +#: ../../../CHANGELOG.md:167 +msgid "✅ if you're **not explicitly enabling IPv6** (via `devture_systemd_docker_base_ipv6_enabled` in your configuration): you're unaffected" msgstr "" #: ../../../CHANGELOG.md:168 -msgid "The playbook now configures the `/.well-known/matrix/client` file for this by default, injecting into it a `cc.etke.synapse-admin` section that contains the full synapse-admin configuration. This is done even if you don't enable the synapse-admin service in your configuration. The reason for always doing it is to allow users to skip the (small) overhead of self-hosting the non-core synapse-admin service, yet still be able to use it from elsewhere when needed." +msgid "❓ if you're **explicitly enabling IPv6** (via `devture_systemd_docker_base_ipv6_enabled` in your configuration):" +msgstr "" + +#: ../../../CHANGELOG.md:169 +msgid "✅ .. and you're on a modern enough Docker version (which you most likely are): the playbook will no longer mess with your Docker daemon options. You're unaffected." msgstr "" #: ../../../CHANGELOG.md:170 -msgid "If you don't ever plan on using synapse-admin from other servers (besides your own due to [self-hosting synapse-admin](./docs/configuring-playbook-synapse-admin.md)), you **can disable this** `/.well-known/matrix/client` configuration via `matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_enabled: false`" -msgstr "" - -#: ../../../CHANGELOG.md:173 -msgid "2024-10-28" -msgstr "" - -#: ../../../CHANGELOG.md:175 -msgid "(BC Break) Postmoogle's variable names need adjustments" -msgstr "" - -#: ../../../CHANGELOG.md:177 -msgid "Due to the recategorization of [Postmoogle](./docs/configuring-playbook-bridge-postmoogle.md) from the bot to the bridge, its variables were renamed (`matrix_bot_postmoogle_` -> `matrix_postmoogle_`). You need to adjust your `vars.yml` configuration accordingly." -msgstr "" - -#: ../../../CHANGELOG.md:179 -msgid "2024-10-19" +msgid "🔧 .. and you're on an old Docker version, you **are affected** and need to use the following configuration to restore the old behavior:" msgstr "" #: ../../../CHANGELOG.md:181 -msgid "Support for Matrix Authentication Service" +msgid "Support for bridging to Bluesky via mautrix-bluesky" msgstr "" #: ../../../CHANGELOG.md:183 -msgid "The playbook now supports installing and configuring [Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md) (MAS)." +msgid "Thanks to [Zepmann](https://github.com/Zepmann), the playbook now supports bridging to [Bluesky](https://bsky.app/) via [mautrix-bluesky](https://github.com/mautrix/bluesky)." msgstr "" #: ../../../CHANGELOG.md:185 -msgid "Huge thanks to [Quentin Gliech](https://github.com/sandhose) from the [Element](https://element.io/) / [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service) team for answering our numerous questions about MAS." +msgid "To learn more, see our [Setting up mautrix-bluesky](./docs/configuring-playbook-bridge-mautrix-bluesky.md) documentation page." msgstr "" -#: ../../../CHANGELOG.md:187 -msgid "This is an **experimental service** and there are **still certain issues with it** (see [Expectations](./docs/configuring-playbook-matrix-authentication-service.md#expectations)). Matrix server administrators should only consider switching if they identify with one or more [reasons to use Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md#reasons-to-use-matrix-authentication-service). As MAS adoption improves and more services are adjusted to support it, we expect that using MAS will become the norm." +#: ../../../CHANGELOG.md:188 +msgid "2025-02-19" msgstr "" -#: ../../../CHANGELOG.md:189 -msgid "Our [Setting up Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md) documentation page has more details about this new service, what you might expect from the switch and how you can migrate your existing (Synapse) homeserver setup to MAS." +#: ../../../CHANGELOG.md:190 +msgid "The playbook now defaults to exposing the Coturn STUN port (3478) only over TCP" msgstr "" #: ../../../CHANGELOG.md:192 -msgid "2024-09-27" +msgid "We've previously done some work to **decrease the severity** of DDoS amplification attacks done through the [Coturn](./docs/configuring-playbook-turn.md)'s STUN port (2.8x -> 1.6x) as reported in [coturn: Lower DDoS amplification/reflection factor from 2.8 to 1.6 #2592](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2592)." msgstr "" #: ../../../CHANGELOG.md:194 -msgid "(BC Break) Postgres & Traefik roles have been relocated and variable names need adjustments" +msgid "To **completely eliminate the problem** of DDoS amplification attacks done through the [Coturn](./docs/configuring-playbook-turn.md) STUN port even further (read more about this in [this article](https://stormwall.network/resources/blog/protect-against-ddos-based-on-stun-exploit)), the playbook now **disables exposure of the Coturn STUN port (`3478`) over UDP**. This is a bit heavy-handed, but is probably the only way to completely eliminate the problem." msgstr "" #: ../../../CHANGELOG.md:196 -msgid "Various roles have been relocated from the [devture](https://github.com/devture) organization to the [mother-of-all-self-hosting](https://github.com/mother-of-all-self-hosting) organization." +msgid "The playbook now **only exposes the Coturn STUN port (`3478`) over TCP by default**." msgstr "" #: ../../../CHANGELOG.md:198 -msgid "Along with the relocation, the `devture_` prefix was dropped from their variable names, so you need to adjust your `vars.yml` configuration." +msgid "💡 Users may wish to further remove the (now unnecessary) firewall rule allowing access to `3478/udp`." msgstr "" #: ../../../CHANGELOG.md:200 -msgid "You need to do the following replacements:" +msgid "If you'd like the Coturn STUN port to be exposed over UDP like before, you can revert to the previous behavior by using the following configuration in your `vars.yml` file:" msgstr "" -#: ../../../CHANGELOG.md:202 -msgid "`devture_postgres_` -> `postgres_`" -msgstr "" - -#: ../../../CHANGELOG.md:203 -msgid "`devture_traefik_` -> `traefik_`" -msgstr "" - -#: ../../../CHANGELOG.md:205 -msgid "As always, the playbook would let you know about this and point out any variables you may have missed." -msgstr "" - -#: ../../../CHANGELOG.md:208 -msgid "2024-09-12" +#: ../../../CHANGELOG.md:206 +msgid "[!WARNING] People running Coturn directly on the `host` network (using `matrix_coturn_container_network: host`) will still have the STUN port exposed over UDP, as port exposure is done directly via Coturn and not via Docker. In such cases, the playbook cannot prevent `3478/udp` port exposure and you'd need to do it in another way (separate firewall rule, etc)." msgstr "" #: ../../../CHANGELOG.md:210 -msgid "Support for baibot" +msgid "2025-02-17" msgstr "" #: ../../../CHANGELOG.md:212 -msgid "The playbook now supports installing [baibot](./docs/configuring-playbook-bot-baibot.md) (pronounced bye-bot) — a [Matrix](https://matrix.org/) bot developed by [etke.cc](https://etke.cc/) that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you. 🤖" +msgid "FluffyChat Web support" msgstr "" #: ../../../CHANGELOG.md:214 -msgid "It supports [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, as well as many other [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md)." +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook now supports [FluffyChat Web](https://github.com/krille-chan/fluffychat) as an additional Matrix client you can self-host." msgstr "" #: ../../../CHANGELOG.md:216 -msgid "It's designed as a more private and [✨ featureful](https://github.com/etkecc/baibot/?tab=readme-ov-file#-features) alternative to the now-unmaintained [matrix-chatgpt-bot](./docs/configuring-playbook-bot-chatgpt.md)." +msgid "To learn more, see our [Setting up FluffyChat Web](docs/configuring-playbook-client-fluffychat-web.md) documentation page." msgstr "" -#: ../../../CHANGELOG.md:218 -msgid "To get started, see the [Setting up baibot](./docs/configuring-playbook-bot-baibot.md) documentation page." +#: ../../../CHANGELOG.md:219 +msgid "2025-02-03" msgstr "" -#: ../../../CHANGELOG.md:220 -msgid "Switching synapse-admin to etke.cc's fork" +#: ../../../CHANGELOG.md:221 +msgid "The mautrix-hangouts bridge has been removed from the playbook" msgstr "" -#: ../../../CHANGELOG.md:222 -msgid "The playbook now installs [etke.cc](https://etke.cc/)'s [fork](https://github.com/etkecc/synapse-admin) of [synapse-admin](https://github.com/Awesome-Technologies/synapse-admin) (originally developed by [Awesome-Technologies](https://github.com/Awesome-Technologies)). This fork is a drop-in replacement for the original software." +#: ../../../CHANGELOG.md:223 +msgid "The [mautrix-hangouts](./docs/configuring-playbook-bridge-mautrix-hangouts.md) bridge has been deprecated in the playbook since December 2024 and finally got completely removed from the playbook in February 2025." msgstr "" -#: ../../../CHANGELOG.md:224 -msgid "The creation of the fork has been provoked by users frequently encountering issues with the original synapse-admin software, such as unintentionally deleting their one-and-only admin user account (fixed [here](https://github.com/etkecc/synapse-admin/pull/1) and also contributed upstream [here](https://github.com/Awesome-Technologies/synapse-admin/pull/608) — to no avail for now). Since its inception, [a bunch of other quality-of-life improvements](https://github.com/etkecc/synapse-admin?tab=readme-ov-file#changes) have been made to the fork." +#: ../../../CHANGELOG.md:225 +msgid "This is because Google Hangouts has been discontinued since the 1st of November 2022." msgstr "" -#: ../../../CHANGELOG.md:226 -msgid "If upstream synapse-admin picks up the pace and improves, the etke.cc fork may disappear and the playbook may switch to the original software again. Until that time comes, we believe that etke.cc's fork is the better software to use right now." +#: ../../../CHANGELOG.md:227 +msgid "The playbook will let you know if you're using any `matrix_mautrix_hangouts_*` variables. You'll need to remove them from `vars.yml` and potentially [uninstall the bridge manually](./docs/configuring-playbook-bridge-mautrix-hangouts.md#uninstalling-the-bridge-manually)." msgstr "" -#: ../../../CHANGELOG.md:228 -msgid "If you'd like to switch back to the original synapse-admin software, you can do so by adding the following configuration to your `vars.yml` file:" +#: ../../../CHANGELOG.md:230 +msgid "2025-01-27" msgstr "" -#: ../../../CHANGELOG.md:241 -msgid "2024-08-17" +#: ../../../CHANGELOG.md:232 +msgid "Redis and KeyDB are no longer part of the playbook" msgstr "" -#: ../../../CHANGELOG.md:243 -msgid "New appservice-double-puppet service for better double-puppeting" +#: ../../../CHANGELOG.md:234 +msgid "**TLDR**: The playbook now exclusively uses Valkey as its Redis-compatible memorystore implementation, removing support for Redis and KeyDB. Most users are unaffected by this change unless they explicitly configured Redis or KeyDB variables. Only users that were explicitly defining `redis_*` or `keydb_*` variables will need to update their configuration to use `valkey_*` variables instead." +msgstr "" + +#: ../../../CHANGELOG.md:236 +msgid "The playbook has gone through several iterations of memorystore implementations:" +msgstr "" + +#: ../../../CHANGELOG.md:238 +msgid "It initially used Redis, auto-installing it when needed by features/services" +msgstr "" + +#: ../../../CHANGELOG.md:239 +msgid "[Switched to KeyDB](#backward-compatibility-break-the-playbook-now-defaults-to-keydb-instead-of-redis) as the default, while keeping Redis support for those who wished to remain on Redis" +msgstr "" + +#: ../../../CHANGELOG.md:240 +msgid "[Switched to Valkey](#backward-compatibility-break-the-playbook-now-defaults-to-valkey-instead-of-keydb) due to [KeyDB issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3544), while keeping Redis and KeyDB support, for those who wished to remain on them" +msgstr "" + +#: ../../../CHANGELOG.md:242 +msgid "To reduce configuration complexity and maintenance overhead, we are now:" +msgstr "" + +#: ../../../CHANGELOG.md:244 +msgid "removing Redis and KeyDB support entirely" msgstr "" #: ../../../CHANGELOG.md:245 -msgid "Mautrix bridges are undergoing large changes as announced in the [August 2024 releases & progress](https://mau.fi/blog/2024-08-mautrix-release/) blog post." +msgid "using Valkey as the sole Redis-compatible memorystore implementation" msgstr "" #: ../../../CHANGELOG.md:247 -msgid "The playbook has already upgraded to the rewritten mautrix-slack ([v0.1.0](https://github.com/mautrix/slack/releases/tag/v0.1.0)) and mautrix-signal ([v0.7.0](https://github.com/mautrix/signal/releases/tag/v0.7.0)) bridges." +msgid "To update your configuration:" msgstr "" #: ../../../CHANGELOG.md:249 -msgid "The newly rewritten bridges do not support double-puppeting via [Shared Secret Auth](./docs/configuring-playbook-shared-secret-auth.md) anymore, which has prompted us to switch to the new & better [appservice method](https://docs.mau.fi/bridges/general/double-puppeting.html#appservice-method-new) for double-puppeting. The playbook automates this double-puppeting setup for you if you enable the new [Appservice Double Puppet](./docs/configuring-playbook-appservice-double-puppet.md) service." +msgid "**Most users** don't need to do anything" msgstr "" -#: ../../../CHANGELOG.md:251 -msgid "All non-deprecated mautrix bridges in the playbook have been reworked to support double-puppeting via an Appservice. Most bridges still support double-puppeting via [Shared Secret Auth](./docs/configuring-playbook-shared-secret-auth.md), so the playbook supports it too. If only Shared Secret Auth is enabled, double-puppeting will be configured using that method (for the bridges that support it). That said, **Shared Secret Auth double-puppeting is being phased out and we recommend replacing it with the new Appservice method**." +#: ../../../CHANGELOG.md:250 +msgid "**Users that were explicitly sticking to Redis/KeyDB** need to update their `vars.yml` to use `valkey_*` variables instead" msgstr "" #: ../../../CHANGELOG.md:253 -msgid "We recommend **enabling double-puppeting via the new Appservice method** by adding the following configuration to your `vars.yml` file:" +msgid "2025-01-19" +msgstr "" + +#: ../../../CHANGELOG.md:255 +msgid "conduwuit support" +msgstr "" + +#: ../../../CHANGELOG.md:257 +msgid "Thanks to [Virkkunen](https://github.com/Virkkunen), we now have optional experimental [conduwuit](https://conduwuit.puppyirl.gay/) homeserver support for new installations." msgstr "" #: ../../../CHANGELOG.md:259 -msgid "You can still **keep** [Shared Secret Auth](./docs/configuring-playbook-shared-secret-auth.md) enabled. Non-mautrix bridges and other services (e.g. [matrix-corporal](./docs/configuring-playbook-matrix-corporal.md)) may still require it." +msgid "conduwuit is a fork of [Conduit](./docs/configuring-playbook-conduit.md), which the playbook also supports. See [Differences from upstream Conduit](https://conduwuit.puppyirl.gay/differences.html)." msgstr "" -#: ../../../CHANGELOG.md:261 -msgid "When both double-puppeting methods are enabled, the playbook will automatically choose the new and better Appservice method for bridges that support it." +#: ../../../CHANGELOG.md:263 +msgid "To try out conduwuit, we recommend that you **use a new server**. Refer to our [Configuring conduwuit](./docs/configuring-playbook-conduwuit.md) guide for details." msgstr "" -#: ../../../CHANGELOG.md:264 -msgid "2024-08-15" -msgstr "" - -#: ../../../CHANGELOG.md:266 -msgid "matrix-media-repo now configured for Authenticated Media" +#: ../../../CHANGELOG.md:265 +msgid "**The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse/Conduit/Dendrite to conduwuit) without data loss." msgstr "" #: ../../../CHANGELOG.md:268 -msgid "Thanks to [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), our matrix-media-repo implementation now automatically [sets up signing keys](https://docs.t2bot.io/matrix-media-repo/v1.3.5/installation/signing-key/) for Authenticated Media (as per [MSC3916](https://github.com/matrix-org/matrix-spec-proposals/pull/3916))." +msgid "2025-01-14" msgstr "" #: ../../../CHANGELOG.md:270 -msgid "If you had never heard of Authenticated Media before, the [Sunsetting unauthenticated media](https://matrix.org/blog/2024/06/26/sunsetting-unauthenticated-media/) article on [matrix.org](https://matrix.org/) is a good introduction." +msgid "(Backward Compatibility Break) Synapse v1.122.0 requires Postgres v13" msgstr "" #: ../../../CHANGELOG.md:272 -msgid "This feature is enabled for matrix-media-repo installations by default and will append an additional (matrix-media-repo-generated signing key) to your homeserver's (Synapse or Dendrite) signing key. See the [Signing keys](./docs/configuring-playbook-matrix-media-repo.md#signing-keys) and [Key backup and revoking](./docs/configuring-playbook-matrix-media-repo.md#key-backup-and-revoking) sections of the matrix-media-repo documentation for more details." +msgid "The Synapse homeserver [requires Postgres v13 or newer](https://github.com/element-hq/synapse/issues/18034)." msgstr "" #: ../../../CHANGELOG.md:274 -msgid "If you'd like to avoid this new feature, you can disable it by setting `matrix_media_repo_generate_signing_key: false` in your `vars.yml` configuration file." +msgid "If you've been maintaining your setup for a while and you haven't been doing [Postgres upgrades](docs/maintenance-postgres.md#upgrading-postgresql), you may be on an old version of Postgres. The easiest way to check is to see the contents of the `/matrix/postgres/data/PG_VERSION` file." msgstr "" -#: ../../../CHANGELOG.md:277 -msgid "2024-08-08" +#: ../../../CHANGELOG.md:276 +msgid "If you're on a Postgres version older than v13, you need to [upgrade your Postgres setup](docs/maintenance-postgres.md#upgrading-postgresql) or Synapse will produce an error on startup." msgstr "" -#: ../../../CHANGELOG.md:279 -msgid "(Backward Compatibility Break) matrix-corporal has been upgraded to v3" +#: ../../../CHANGELOG.md:278 +msgid "If you're using an external Postgres server (not installed by this playbook), you'll need to figure out how to upgrade it yourself." msgstr "" -#: ../../../CHANGELOG.md:281 -msgid "The playbook now installs [matrix-corporal](https://github.com/devture/matrix-corporal) v3.0.0, which brings support for **power-level management** (thanks to [this PR](https://github.com/devture/matrix-corporal/pull/32))." +#: ../../../CHANGELOG.md:280 +msgid "If you're not ready to upgrade your Postgres setup yet, you can temporarily remain on an old Synapse version by adding the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../CHANGELOG.md:283 -msgid "This upgrade necessitates configuration policy changes as described in [matrix-corporal's changelog entry](https://github.com/devture/matrix-corporal/blob/5287cb81c82cd3b951c2a099b4697c3e0b384559/CHANGELOG.md#version-300-2024-08-08)." +#: ../../../CHANGELOG.md:288 +msgid "2024-11-26" msgstr "" -#: ../../../CHANGELOG.md:285 -msgid "If you'd like to remain on the old (v2) version of matrix-corporal, you can do so by adding the following configuration to your `vars.yml` file:" +#: ../../../CHANGELOG.md:290 +msgid "(Backward Compatibility Break) Synapse now defaults to enabling authenticated media" msgstr "" -#: ../../../CHANGELOG.md:291 -msgid "2024-07-25" +#: ../../../CHANGELOG.md:292 +msgid "**TLDR**: with this update, your Synapse homeserver will start requiring authentication for newly-uploaded media files. While the majority of the ecosystem (clients, bots, etc.) should support this, certain software may lack support for it (and you may wish to turn it off, if it's causing issues)." msgstr "" -#: ../../../CHANGELOG.md:293 -msgid "synapse-usage-exporter support" +#: ../../../CHANGELOG.md:294 +msgid "The default configuration for the Synapse homeserver now [enforces Authenticated media by default](https://element-hq.github.io/synapse/v1.120/upgrade.html#authenticated-media-is-now-enforced-by-default)." msgstr "" -#: ../../../CHANGELOG.md:295 -msgid "Thanks to [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/), the playbook can now set up [synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) — a small [Flask](https://flask.palletsprojects.com)-based webservice which can capture usage statistics from Synapse (via HTTP `PUT`) and then make them available for Prometheus to scrape." +#: ../../../CHANGELOG.md:296 +msgid "Servers like `matrix.org` have already [sunset unauthenticated media](https://matrix.org/blog/2024/06/26/sunsetting-unauthenticated-media/) months ago." msgstr "" -#: ../../../CHANGELOG.md:297 -msgid "To learn more see our [Enabling synapse-usage-exporter for Synapse usage statistics](docs/configuring-playbook-synapse-usage-exporter.md) documentation page." +#: ../../../CHANGELOG.md:298 +msgid "Now that **various clients, bots, bridges and extra services have caught up with authenticated media support**, Synapse developers seem confident that it's time to enable authenticated media by default." msgstr "" #: ../../../CHANGELOG.md:300 -msgid "2024-07-06" +msgid "We're changing the playbook configuration for authenticated media to keep up with upstream defaults changing." msgstr "" #: ../../../CHANGELOG.md:302 -msgid "matrix-alertmanager-receiver support" +msgid "Old and unmaintained bridges (like all mx-puppet bridges, etc.) do not support authenticated media. Other software may be similarly affected. If you experience issues with some Matrix-related software, you may wish to disable authenticated media and contact the software maintainers to let them know." msgstr "" #: ../../../CHANGELOG.md:304 -msgid "For those wishing to more easily integrate [Prometheus](https://prometheus.io/)' alerting service ([Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/)) with Matrix, the playbook can now set up [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver)." +msgid "You can disable authenticated media at any time by setting `matrix_synapse_enable_authenticated_media: false` in your `vars.yml` configuration file and re-running the playbook." msgstr "" -#: ../../../CHANGELOG.md:306 -msgid "See [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](./docs/configuring-playbook-alertmanager-receiver.md) for more details." +#: ../../../CHANGELOG.md:307 +msgid "2024-11-23" msgstr "" -#: ../../../CHANGELOG.md:308 -msgid "Traefik v3 and HTTP/3 are here now" +#: ../../../CHANGELOG.md:309 +msgid "(Backward Compatibility Break) The playbook now defaults to Valkey, instead of KeyDB" msgstr "" -#: ../../../CHANGELOG.md:310 -msgid "**TLDR**: Traefik was migrated from v2 to v3. Minor changes were done to the playbook. Mostly everything else worked out of the box. Most people will not have to do any tweaks to their configuration. In addition, [HTTP/3](https://en.wikipedia.org/wiki/HTTP/3) support is now auto-enabled for the `web-secure` (port 443) and `matrix-federation` (port `8448`) entrypoints. If you have a firewall in front of your server and you wish to benefit from `HTTP3`, you will need to open the `443` and `8448` UDP ports in it." +#: ../../../CHANGELOG.md:311 +msgid "**TLDR**: if the playbook installed KeyDB (or Redis) as a dependency for you before, it will now replace it with [Valkey](https://valkey.io/) (a drop-in alternative). We [previously switched from Redis to KeyDB](#backward-compatibility-break-the-playbook-now-defaults-to-keydb-instead-of-redis), but Valkey is a better alternative, so we're switching again." msgstr "" -#: ../../../CHANGELOG.md:312 -msgid "Traefik v3" +#: ../../../CHANGELOG.md:313 +msgid "The playbook used to install Redis or KeyDB if services have a need for a Redis-compatible implementation ([enabling worker support for Synapse](docs/configuring-playbook-synapse.md#load-balancing-with-workers), [enabling Hookshot encryption](docs/configuring-playbook-bridge-hookshot.md#end-to-bridge-encryption), etc.)." msgstr "" -#: ../../../CHANGELOG.md:314 -msgid "The reverse-proxy that the playbook uses by default (Traefik) has recently been upgraded to v3 (see [this blog post](https://traefik.io/blog/announcing-traefik-proxy-v3-rc/) to learn about its new features). Version 3 includes some small breaking configuration changes requiring a [migration](https://doc.traefik.io/traefik/migration/v2-to-v3/)." +#: ../../../CHANGELOG.md:315 +msgid "Earlier this year, we switched from Redis to KeyDB — see [(Backward Compatibility Break) The playbook now defaults to KeyDB, instead of Redis](#backward-compatibility-break-the-playbook-now-defaults-to-keydb-instead-of-redis)." msgstr "" -#: ../../../CHANGELOG.md:316 -msgid "We have **updated the playbook to Traefik v3** (make sure to run `just roles` / `make roles` to get it)." +#: ../../../CHANGELOG.md:317 +msgid "Because Valkey seems to be a better successor to Redis (than KeyDB) and likely doesn't suffer from [issues like this one](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3544), we now replace KeyDB with Valkey." msgstr "" -#: ../../../CHANGELOG.md:318 -msgid "There were **only minor playbook changes required** to adapt to Traefik v3, and only to the Ansible role for [matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md) where we changed a few [`PathPrefix` instances to `PathRegexp`](https://doc.traefik.io/traefik/routing/routers/#path-pathprefix-and-pathregexp), because these instances were using a regular expression instead of a fixed path. For fixed-path values, `PathPrefix` is still the preferred matcher function to use." +#: ../../../CHANGELOG.md:319 +msgid "Valkey (like KeyDB and Redis in the past) is an implicitly enabled dependency — you don't need custom configuration in `vars.yml` to enable it." msgstr "" -#: ../../../CHANGELOG.md:320 -msgid "**Most people using the playbook should not have to do any changes**." +#: ../../../CHANGELOG.md:321 +msgid "Next time your run the playbook (via the `setup-all` tag), **KeyDB will be automatically uninstalled and replaced with Valkey**. Some Synapse downtime may occur while the switch happens." msgstr "" -#: ../../../CHANGELOG.md:322 -msgid "If you're using the playbook's Traefik instance to reverse-proxy to some other services of your own (not managed by the playbook), you may wish to review their Traefik labels and make sure they're in line with the [Traefik v2 to v3 migration guide](https://doc.traefik.io/traefik/migration/v2-to-v3/)." +#: ../../../CHANGELOG.md:323 +msgid "Users on `arm32` should be aware that there's **neither a prebuilt `arm32` container image for Valkey**, nor the Valkey role supports self-building yet. Users on this architecture likely don't run Synapse with workers, etc., so they're likely in no need of Valkey (or Redis/KeyDB). If Redis is necessary in an `arm32` deployment, disabling Valkey and making the playbook fall back to Redis is possible (see below)." msgstr "" -#: ../../../CHANGELOG.md:324 -msgid "If you've tweaked any of this playbook's `_path_prefix` variables and made them use a regular expression, you will now need to make additional adjustments. The playbook makes extensive use of `PathPrefix()` matchers in Traefik rules and `PathPrefix` does not support regular expressions anymore. To work around it, you may now need to override a whole `_traefik_rule` variable and switch it from [`PathPrefix` to `PathRegexp`](https://doc.traefik.io/traefik/routing/routers/#path-pathprefix-and-pathregexp)." -msgstr "" - -#: ../../../CHANGELOG.md:326 -msgid "If you're not using [matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md) (the only role we had to tweak to adapt it to Traefik v3), you **may potentially downgrade to Traefik v2** (if necessary) by adding `traefik_verison: v2.11.4` to your configuration. People using `matrix-media-repo` cannot downgrade this way, because `matrix-media-repo` has been adjusted to use `PathRegexp` — a [routing matcher](https://doc.traefik.io/traefik/v2.11/routing/routers/#rule) that Traefik v2 does not understand." -msgstr "" - -#: ../../../CHANGELOG.md:328 -msgid "HTTP/3 is enabled by default" -msgstr "" - -#: ../../../CHANGELOG.md:330 -msgid "In Traefik v3, [HTTP/3](https://en.wikipedia.org/wiki/HTTP/3) support is no longer considered experimental now. Due to this, **the playbook auto-enables HTTP3** for the `web-secure` (port 443) and `matrix-federation` (port `8448`) entrypoints." -msgstr "" - -#: ../../../CHANGELOG.md:332 -msgid "HTTP3 uses the UDP protocol and **the playbook (together with Docker) will make sure that the appropriate ports** (`443` over UDP & `8448` over UDP) **are exposed and whitelisted in your server's firewall**. However, **if you have another firewall in front of your server** (as is the case for many cloud providers), **you will need to manually open these UDP ports**." -msgstr "" - -#: ../../../CHANGELOG.md:334 -msgid "If you do not open the UDP ports correctly or there is some other issue, clients (browsers, mostly) will fall-back to [HTTP/2](https://en.wikipedia.org/wiki/HTTP/2) or even [HTTP/1.1](https://en.wikipedia.org/wiki/HTTP)." +#: ../../../CHANGELOG.md:325 +#: ../../../CHANGELOG.md:665 +msgid "**The playbook still supports Redis** and you can keep using Redis (for now) if you'd like, by adding this additional configuration to your `vars.yml` file:" msgstr "" #: ../../../CHANGELOG.md:336 -msgid "Still, if HTTP/3 cannot function correctly in your setup, it's best to disable advertising support for it (and misleading clients into trying to use HTTP/3)." +msgid "**The playbook still supports KeyDB** and you can keep using KeyDB (for now) if you'd like, by adding this additional configuration to your `vars.yml` file:" msgstr "" -#: ../../../CHANGELOG.md:338 -msgid "To **disable HTTP/3**, you can use the following configuration:" +#: ../../../CHANGELOG.md:346 +msgid "At some point in time in the future, we'll remove both KeyDB and Redis from the playbook, so we recommend that you migrate to Valkey earlier anyway." msgstr "" -#: ../../../CHANGELOG.md:352 -msgid "If you are using [your own webserver](./docs/configuring-playbook-own-webserver.md) (in front of Traefik), port binding on UDP port `8448` by default due to HTTP/3 is either unnecessary or [may get in the way](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3402). If it does, you can disable it:" +#: ../../../CHANGELOG.md:349 +msgid "2024-11-14" +msgstr "" + +#: ../../../CHANGELOG.md:351 +msgid "HTTP-compression support for Traefik-based setups" +msgstr "" + +#: ../../../CHANGELOG.md:353 +msgid "The playbook now **automatically enables HTTP-compression support** for major services powered by the playbook, like [Cinny](./docs/configuring-playbook-client-cinny.md), [Element Web](./docs/configuring-playbook-client-element-web.md), [Hydrogen](./docs/configuring-playbook-client-hydrogen.md), as well as for Matrix Client-Server and Federation APIs (`matrix.example.com`)." +msgstr "" + +#: ../../../CHANGELOG.md:355 +msgid "Other services installed by the playbook are currently not compression-enabled, but may become so over time. This change is rolled out on a per-service basis (as opposed to doing it globally, at the Traefik entrypoint level) to allow certain services or route endpoints which do not behave well when compressed (e.g. [issue 3749](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749)) to be excluded from compression." +msgstr "" + +#: ../../../CHANGELOG.md:357 +msgid "A long time ago, various services were operating with `gzip`-compression enabled at the nginx level. Since the switch to Traefik (see [Goodbye, `matrix-nginx-proxy` 🪦](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/57c5271d9d6265a34a9d9cceb93365f685074f96/CHANGELOG.md#goodbye-matrix-nginx-proxy-)), all services (with the exception of Matrix APIs for Synapse worker-enabled setups which are powered by `nginx` via `synapse-reverse-proxy-companion`) have been operating without HTTP-compression support." +msgstr "" + +#: ../../../CHANGELOG.md:359 +msgid "HTTP-compression is now done via Traefik's [compress](https://doc.traefik.io/traefik/middlewares/http/compress/) middleware. We use the default configuration for this middleware, which enables `zstd`, `br` and `gzip` support (in this order). This middleware's configuration can be configured via variables in the Traefik role (see `traefik_config_http_middlewares_compression_middleware_options`)." +msgstr "" + +#: ../../../CHANGELOG.md:361 +msgid "If you're using your own Traefik reverse-proxy server ([Traefik managed by you](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you)) instead of the playbook's integrated Traefik service, you can benefit from the same by:" +msgstr "" + +#: ../../../CHANGELOG.md:363 +msgid "defining a [compress](https://doc.traefik.io/traefik/middlewares/http/compress/) middleware (via the [file](https://doc.traefik.io/traefik/providers/file/) or [Docker](https://doc.traefik.io/traefik/providers/docker/) providers)" +msgstr "" + +#: ../../../CHANGELOG.md:364 +msgid "setting `matrix_playbook_reverse_proxy_traefik_middleware_compression_enabled` to `true`" msgstr "" #: ../../../CHANGELOG.md:365 -msgid "2024-07-01" +msgid "specifying the middleware's name in `matrix_playbook_reverse_proxy_traefik_middleware_compression_name` (e.g. `matrix_playbook_reverse_proxy_traefik_middleware_compression_name: my-compression-middleware@file`)" msgstr "" #: ../../../CHANGELOG.md:367 -msgid "synapse-admin is now restricted to your homeserver's URL by default" +msgid "Timeout adjustments for Traefik-based setups" msgstr "" #: ../../../CHANGELOG.md:369 -msgid "A new feature introduced in synapse-admin [v0.10.0](https://github.com/Awesome-Technologies/synapse-admin/releases/tag/0.10.0) (released and supported by the playbook since a a few months ago) provides the ability to [restrict its usage to a specific homeserver](https://github.com/Awesome-Technologies/synapse-admin/blob/e21e44362c879ac41f47c580b04210842b6ff3d7/README.md#restricting-available-homeserver) (or multiple homeservers)." +msgid "The playbook now supports configuring various [transport.respondingTimeouts](https://doc.traefik.io/traefik/routing/entrypoints/#respondingtimeouts) timeout values (`readTimeout`, `writeTimeout`, `idleTimeout`) for the `web`, `web-secure` and `matrix-federation` entrypoints." msgstr "" #: ../../../CHANGELOG.md:371 -msgid "The playbook has just started making use of this feature. **From now on, your synapse-admin instance will be restricted to the homeserver you're managing via the playbook**. When configured like this, the *Homeserver URL* field in synapse-admin's web UI changes from a text field to a dropdown having a single value (the URL of your homeserver). This makes usage simpler for most people, as they won't need to manually enter a *Homeserver URL* anymore." +msgid "If you're using your own Traefik reverse-proxy server ([Traefik managed by you](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you)) instead of the playbook's integrated Traefik service, you may wish to do similar configuration changes to your setup manually." msgstr "" #: ../../../CHANGELOG.md:373 -msgid "If you'd like **to go back to the old unrestricted behavior**, use the following configuration:" +msgid "The most interesting of these is the `readTimeout` configuration value (the maximum duration for reading the entire request, including the body), which used to default to `60s`. For large and slowly progressing file uploads, `60s` would often not be enough for the transfer to finish and uploads would end up being interrupted. The playbook now raises the `readTimeout` value to 5 minutes (`300s`) to improve this use-case." msgstr "" -#: ../../../CHANGELOG.md:381 -msgid "2024-06-25" +#: ../../../CHANGELOG.md:375 +msgid "The `traefik_config_entrypoint_web_transport_respondingTimeouts_*` variables (for the `web` entrypoint) cascade to affecting the timeout values for the `web-secure` and `matrix-federation` entrypoints, so you can easily adjust all timeout values using them." msgstr "" -#: ../../../CHANGELOG.md:383 -msgid "The URL-prefix for Hookshot generic webhooks has changed" +#: ../../../CHANGELOG.md:377 +msgid "Example of the default timeout values used by the playbook:" msgstr "" -#: ../../../CHANGELOG.md:385 -msgid "Until now, generic Hookshot webhook URLs looked like this: `https://matrix.example.com/hookshot/webhooks/:hookId`." -msgstr "" - -#: ../../../CHANGELOG.md:387 -msgid "The `/hookshot/webhooks` common prefix gets stripped by Traefik automatically, so Hookshot only sees the part that comes after (`/:hookId`)." -msgstr "" - -#: ../../../CHANGELOG.md:389 -msgid "[A few years ago](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1681), Hookshot started to prefer to handle webhooks at a `/webhook/:hookId` path (instead of directly at `/:hookId`)." +#: ../../../CHANGELOG.md:388 +msgid "Alternatively, you may adjust the timeout values for specific entrypoints (like `web-secure` and `matrix-federation`) using dedicated variables (like `traefik_config_entrypoint_web_secure_transport_respondingTimeouts_readTimeout` and `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_transport_respondingTimeouts_readTimeout`)." msgstr "" #: ../../../CHANGELOG.md:391 -msgid "To avoid future problems, we've [reconfigured](https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/4704a60718946fd469aeee7fc3ae8127c633bb6b) our Hookshot configuration to use webhook URLs that include `/webhook` in the URL suffix (e.g. `/hookshot/webhooks/webhook/:hookId`, instead of `/hookshot/webhooks/:hookId`). This means that when we strip the common prefi (`/hookshot/webhooks`), we'll end up sending `/webhook/:hookId` to Hookshot, just like recommended." +msgid "2024-11-08" msgstr "" #: ../../../CHANGELOG.md:393 -msgid "When generating new webhooks, you should start seeing the new URLs being used." +msgid "Support for synapse-admin auto-configuration via /.well-known/matrix/client" msgstr "" #: ../../../CHANGELOG.md:395 -msgid "**For now**, **both** old URLs (`/hookshot/webhooks/:hookId`) and new URLs (`/hookshot/webhooks/webhook/:hookId`) **continue to work**, so your webhooks will not break just yet." +msgid "You can administrate your Synapse-powered homeserver using synapse-admin hosted externally (e.g. [admin.etke.cc](https://admin.etke.cc/)) and the synapse-admin instance would still auto-configure itself correctly for your server by [reading its `/.well-known/matrix/client` file](https://github.com/etkecc/synapse-admin/pull/126)." msgstr "" #: ../../../CHANGELOG.md:397 -msgid "However, **we recommend that you update all your old webhook URLs** (configured in other systems) to include the new `/webhook` path component, so that future Hookshot changes (whenever they come) will not break your webhooks. You don't need to do anything on the Hookshot side — you merely need to reconfigure the remote systems that use your webhook URLs." +msgid "The playbook now configures the `/.well-known/matrix/client` file for this by default, injecting into it a `cc.etke.synapse-admin` section that contains the full synapse-admin configuration. This is done even if you don't enable the synapse-admin service in your configuration. The reason for always doing it is to allow users to skip the (small) overhead of self-hosting the non-core synapse-admin service, yet still be able to use it from elsewhere when needed." msgstr "" -#: ../../../CHANGELOG.md:400 -msgid "2024-06-22" +#: ../../../CHANGELOG.md:399 +msgid "If you don't ever plan on using synapse-admin from other servers (besides your own due to [self-hosting synapse-admin](./docs/configuring-playbook-synapse-admin.md)), you **can disable this** `/.well-known/matrix/client` configuration via `matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_enabled: false`" msgstr "" #: ../../../CHANGELOG.md:402 -msgid "The maubot user is now managed by the playbook" +msgid "2024-10-28" msgstr "" #: ../../../CHANGELOG.md:404 -msgid "To make things easier and to be consistent with other roles, the [maubot](./docs/configuring-playbook-bot-maubot.md) user (`bot.maubot` by default) is [now](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3376) automatically created be the playbook." +msgid "(BC Break) Postmoogle's variable names need adjustments" msgstr "" #: ../../../CHANGELOG.md:406 -msgid "If you have an existing maubot installation, you will need to specify `matrix_bot_maubot_initial_password` in your `vars.yml` file to make the playbook not complain about it being undefined. Since the bot is already registered in your installation, there's nothing for the playbook to do anyway. In case you don't remember the password you've registered your maubot user account with, you can specify any value for this variable." +msgid "Due to the recategorization of [Postmoogle](./docs/configuring-playbook-bridge-postmoogle.md) from the bot to the bridge, its variables were renamed (`matrix_bot_postmoogle_` -> `matrix_postmoogle_`). You need to adjust your `vars.yml` configuration accordingly." msgstr "" #: ../../../CHANGELOG.md:408 -msgid "If you've registered another username for the bot (other than the recommended default of `bot.maubot`), consider adjusting the `matrix_bot_maubot_login` variable (e.g. `matrix_bot_maubot_login: my.maubot.username`)." +msgid "2024-10-19" msgstr "" -#: ../../../CHANGELOG.md:411 -msgid "2024-06-03" +#: ../../../CHANGELOG.md:410 +msgid "Support for Matrix Authentication Service" msgstr "" -#: ../../../CHANGELOG.md:413 -msgid "WeChat bridging support" +#: ../../../CHANGELOG.md:412 +msgid "The playbook now supports installing and configuring [Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md) (MAS)." msgstr "" -#: ../../../CHANGELOG.md:415 -msgid "Thanks to [Tobias Diez](https://github.com/tobiasdiez)'s [efforts](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3241), the playbook now supports bridging to [WeChat](https://www.wechat.com/) via the [matrix-wechat](https://github.com/duo/matrix-wechat) bridge." +#: ../../../CHANGELOG.md:414 +msgid "Huge thanks to [Quentin Gliech](https://github.com/sandhose) from the [Element](https://element.io/) / [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service) team for answering our numerous questions about MAS." msgstr "" -#: ../../../CHANGELOG.md:417 -msgid "See our [Setting up WeChat bridging](docs/configuring-playbook-bridge-wechat.md) documentation page for getting started." +#: ../../../CHANGELOG.md:416 +msgid "This is an **experimental service** and there are **still certain issues with it** (see [Expectations](./docs/configuring-playbook-matrix-authentication-service.md#expectations)). Matrix server administrators should only consider switching if they identify with one or more [reasons to use Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md#reasons-to-use-matrix-authentication-service). As MAS adoption improves and more services are adjusted to support it, we expect that using MAS will become the norm." msgstr "" -#: ../../../CHANGELOG.md:420 -msgid "2024-03-26" +#: ../../../CHANGELOG.md:418 +msgid "Our [Setting up Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md) documentation page has more details about this new service, what you might expect from the switch and how you can migrate your existing (Synapse) homeserver setup to MAS." msgstr "" -#: ../../../CHANGELOG.md:422 -msgid "(Backward Compatibility Break) The playbook now defaults to KeyDB, instead of Redis" +#: ../../../CHANGELOG.md:421 +msgid "2024-09-27" msgstr "" -#: ../../../CHANGELOG.md:424 -msgid "**TLDR**: if the playbook used installed Redis as a dependency for you before, it will now replace it with [KeyDB](https://docs.keydb.dev/) (a drop-in alternative) due to [Redis having changed its license](https://redis.com/blog/redis-adopts-dual-source-available-licensing/)." +#: ../../../CHANGELOG.md:423 +msgid "(BC Break) Postgres & Traefik roles have been relocated and variable names need adjustments" msgstr "" -#: ../../../CHANGELOG.md:426 -msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook now uses [KeyDB](https://docs.keydb.dev/) (a drop-in alternative for Redis), instead of [Redis](https://redis.io/)." +#: ../../../CHANGELOG.md:425 +msgid "Various roles have been relocated from the [devture](https://github.com/devture) organization to the [mother-of-all-self-hosting](https://github.com/mother-of-all-self-hosting) organization." msgstr "" -#: ../../../CHANGELOG.md:428 -msgid "The playbook used to install Redis (and now installs KeyDB in its place) if services have a need for it ([enabling worker support for Synapse](docs/configuring-playbook-synapse.md#load-balancing-with-workers), [enabling Hookshot encryption](docs/configuring-playbook-bridge-hookshot.md#end-to-bridge-encryption), etc.) or if you explicitly enabled the service (`redis_enabled: true` or `keydb_enabled: true`)." +#: ../../../CHANGELOG.md:427 +msgid "Along with the relocation, the `devture_` prefix was dropped from their variable names, so you need to adjust your `vars.yml` configuration." msgstr "" -#: ../../../CHANGELOG.md:430 -msgid "This change is provoked by the fact that [Redis is now \"source available\"](https://redis.com/blog/redis-adopts-dual-source-available-licensing/). According to the Limitations of [the new license](https://redis.com/legal/rsalv2-agreement/) (as best as we understand them, given that we're not lawyers), using Redis in the playbook (even in a commercial FOSS service like [etke.cc](https://etke.cc/)) does not violate the new Redis license. That said, we'd rather neither risk it, nor endorse shady licenses and products that pretend to be free-software. Another high-quality alternative to Redis seems to be [Dragonfly](https://www.dragonflydb.io/), but the [Dragonfly license](https://github.com/dragonflydb/dragonfly?tab=License-1-ov-file#readme) is no better than Redis's." +#: ../../../CHANGELOG.md:429 +msgid "You need to do the following replacements:" +msgstr "" + +#: ../../../CHANGELOG.md:431 +msgid "`devture_postgres_` -> `postgres_`" msgstr "" #: ../../../CHANGELOG.md:432 -msgid "Next time your run the playbook (via the `setup-all` tag), **Redis will be automatically uninstalled and replaced with KeyDB**. Some Synapse downtime may occur while the switch happens." +msgid "`devture_traefik_` -> `traefik_`" msgstr "" #: ../../../CHANGELOG.md:434 -msgid "Users on `arm32` should be aware that there's **neither a prebuilt `arm32` container image for KeyDB**, nor the KeyDB role supports self-building yet. Users on this architecture likely don't run Synapse with workers, etc., so they're likely in no need of KeyDB (or Redis). If Redis is necessary in an `arm32` deployment, disabling KeyDB and making the playbook fall back to Redis is possible (see below)." +msgid "As always, the playbook would let you know about this and point out any variables you may have missed." +msgstr "" + +#: ../../../CHANGELOG.md:437 +msgid "2024-09-12" +msgstr "" + +#: ../../../CHANGELOG.md:439 +msgid "Support for baibot" +msgstr "" + +#: ../../../CHANGELOG.md:441 +msgid "The playbook now supports installing [baibot](./docs/configuring-playbook-bot-baibot.md) (pronounced bye-bot) — a [Matrix](https://matrix.org/) bot developed by [etke.cc](https://etke.cc/) that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you. 🤖" +msgstr "" + +#: ../../../CHANGELOG.md:443 +msgid "It supports [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, as well as many other [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md)." msgstr "" #: ../../../CHANGELOG.md:445 -msgid "2024-03-24" +msgid "It's designed as a more private and [✨ featureful](https://github.com/etkecc/baibot/?tab=readme-ov-file#-features) alternative to the now-unmaintained [matrix-chatgpt-bot](./docs/configuring-playbook-bot-chatgpt.md)." msgstr "" #: ../../../CHANGELOG.md:447 -msgid "Initial work on IPv6 support" +msgid "To get started, see the [Setting up baibot](./docs/configuring-playbook-bot-baibot.md) documentation page." msgstr "" #: ../../../CHANGELOG.md:449 -msgid "Thanks to [Tilo Spannagel](https://github.com/tilosp), the playbook can now enable IPv6 for container networks for various components (roles) via [the `devture_systemd_docker_base_ipv6_enabled` variable](https://github.com/devture/com.devture.ansible.role.systemd_docker_base/blob/c11a526bb8e318b42eb52055056377bb31154f13/defaults/main.yml#L14-L31)." +msgid "Switching synapse-admin to etke.cc's fork" msgstr "" #: ../../../CHANGELOG.md:451 -msgid "It should be noted that:" +msgid "The playbook now installs [etke.cc](https://etke.cc/)'s [fork](https://github.com/etkecc/synapse-admin) of [synapse-admin](https://github.com/Awesome-Technologies/synapse-admin) (originally developed by [Awesome-Technologies](https://github.com/Awesome-Technologies)). This fork is a drop-in replacement for the original software." msgstr "" #: ../../../CHANGELOG.md:453 -msgid "Matrix roles (`roles/custom/matrix-*`) respect this variable, but external roles (those defined in `requirements.yml` and installed via `just roles`) do not respect it yet. Additional work is necessary" -msgstr "" - -#: ../../../CHANGELOG.md:454 -msgid "changing the variable subsequently may not change existing container networks. Refer to [these instructions](https://github.com/devture/com.devture.ansible.role.systemd_docker_base/blob/c11a526bb8e318b42eb52055056377bb31154f13/defaults/main.yml#L26-L30)" +msgid "The creation of the fork has been provoked by users frequently encountering issues with the original synapse-admin software, such as unintentionally deleting their one-and-only admin user account (fixed [here](https://github.com/etkecc/synapse-admin/pull/1) and also contributed upstream [here](https://github.com/Awesome-Technologies/synapse-admin/pull/608) — to no avail for now). Since its inception, [a bunch of other quality-of-life improvements](https://github.com/etkecc/synapse-admin?tab=readme-ov-file#changes) have been made to the fork." msgstr "" #: ../../../CHANGELOG.md:455 -msgid "this is all very new and untested" +msgid "If upstream synapse-admin picks up the pace and improves, the etke.cc fork may disappear and the playbook may switch to the original software again. Until that time comes, we believe that etke.cc's fork is the better software to use right now." msgstr "" #: ../../../CHANGELOG.md:457 -msgid "Pantalaimon support" -msgstr "" - -#: ../../../CHANGELOG.md:459 -msgid "Thanks to [Julian Foad](https://matrix.to/#/@julian:foad.me.uk), the playbook can now install the [Pantalaimon](https://github.com/matrix-org/pantalaimon) E2EE aware proxy daemon for you. It's already possible to integrate it with [Draupnir](docs/configuring-playbook-bot-draupnir.md) to allow it to work in E2EE rooms — see our Draupnir docs for details." -msgstr "" - -#: ../../../CHANGELOG.md:461 -msgid "See our [Setting up Pantalaimon](docs/configuring-playbook-pantalaimon.md) documentation to get started." -msgstr "" - -#: ../../../CHANGELOG.md:464 -msgid "2024-03-05" -msgstr "" - -#: ../../../CHANGELOG.md:466 -msgid "Support for Draupnir-for-all" -msgstr "" - -#: ../../../CHANGELOG.md:468 -msgid "Thanks to [FSG-Cat](https://github.com/FSG-Cat), the playbook can now install [Draupnir for all](./docs/configuring-playbook-appservice-draupnir-for-all.md) (aka multi-instance Draupnir running in appservice mode)." +msgid "If you'd like to switch back to the original synapse-admin software, you can do so by adding the following configuration to your `vars.yml` file:" msgstr "" #: ../../../CHANGELOG.md:470 -msgid "This is an alternative to [running Draupnir in bot mode](./docs/configuring-playbook-bot-draupnir.md), which is still supported by the playbook." +msgid "2024-08-17" msgstr "" #: ../../../CHANGELOG.md:472 -msgid "The documentation page for [Draupnir for all](./docs/configuring-playbook-appservice-draupnir-for-all.md) contains more information on how to install it." +msgid "New appservice-double-puppet service for better double-puppeting" msgstr "" -#: ../../../CHANGELOG.md:475 -msgid "2024-02-19" +#: ../../../CHANGELOG.md:474 +msgid "Mautrix bridges are undergoing large changes as announced in the [August 2024 releases & progress](https://mau.fi/blog/2024-08-mautrix-release/) blog post." msgstr "" -#: ../../../CHANGELOG.md:477 -msgid "Support for bridging to Facebook/Messenger via the new mautrix-meta bridge" +#: ../../../CHANGELOG.md:476 +msgid "The playbook has already upgraded to the rewritten mautrix-slack ([v0.1.0](https://github.com/mautrix/slack/releases/tag/v0.1.0)) and mautrix-signal ([v0.7.0](https://github.com/mautrix/signal/releases/tag/v0.7.0)) bridges." msgstr "" -#: ../../../CHANGELOG.md:479 -msgid "The [mautrix-facebook](./docs/configuring-playbook-bridge-mautrix-facebook.md) and [mautrix-instagram](./docs/configuring-playbook-bridge-mautrix-instagram.md) bridges are being [superseded by a new bridge](https://github.com/mautrix/facebook/issues/332) — the [mautrix-meta](https://github.com/mautrix/meta) bridge." +#: ../../../CHANGELOG.md:478 +msgid "The newly rewritten bridges do not support double-puppeting via [Shared Secret Auth](./docs/configuring-playbook-shared-secret-auth.md) anymore, which has prompted us to switch to the new & better [appservice method](https://docs.mau.fi/bridges/general/double-puppeting.html#appservice-method-new) for double-puppeting. The playbook automates this double-puppeting setup for you if you enable the new [Appservice Double Puppet](./docs/configuring-playbook-appservice-double-puppet.md) service." msgstr "" -#: ../../../CHANGELOG.md:481 -msgid "The playbook now supports the new mautrix-meta bridge — a single bridge, which can run in different modes and bridge to Messenger (via [Facebook](https://facebook.com/), Facebook over [Tor](https://www.torproject.org/) or via [Messenger](https://messenger.com/)) and [Instagram](https://instagram.com/). The playbook makes this bridge available via 2 separate Ansible roles, allowing you to easily run 2 instances of mautrix-meta, for bridging to both services at the same time." +#: ../../../CHANGELOG.md:480 +msgid "All non-deprecated mautrix bridges in the playbook have been reworked to support double-puppeting via an Appservice. Most bridges still support double-puppeting via [Shared Secret Auth](./docs/configuring-playbook-shared-secret-auth.md), so the playbook supports it too. If only Shared Secret Auth is enabled, double-puppeting will be configured using that method (for the bridges that support it). That said, **Shared Secret Auth double-puppeting is being phased out and we recommend replacing it with the new Appservice method**." msgstr "" -#: ../../../CHANGELOG.md:483 -msgid "If you're using mautrix-facebook or mautrix-instagram right now, **you can still continue using the old bridges, but may wish to change to the new bridge implementations**. See:" +#: ../../../CHANGELOG.md:482 +msgid "We recommend **enabling double-puppeting via the new Appservice method** by adding the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../CHANGELOG.md:485 -msgid "[Setting up Instagram bridging via Mautrix Meta](docs/configuring-playbook-bridge-mautrix-meta-instagram.md)" +#: ../../../CHANGELOG.md:488 +msgid "You can still **keep** [Shared Secret Auth](./docs/configuring-playbook-shared-secret-auth.md) enabled. Non-mautrix bridges and other services (e.g. [matrix-corporal](./docs/configuring-playbook-matrix-corporal.md)) may still require it." msgstr "" -#: ../../../CHANGELOG.md:487 -msgid "[Setting up Messenger bridging via Mautrix Meta](docs/configuring-playbook-bridge-mautrix-meta-messenger.md)" +#: ../../../CHANGELOG.md:490 +msgid "When both double-puppeting methods are enabled, the playbook will automatically choose the new and better Appservice method for bridges that support it." msgstr "" -#: ../../../CHANGELOG.md:489 -msgid "The documentation pages contain more information on how to migrate." +#: ../../../CHANGELOG.md:493 +msgid "2024-08-15" msgstr "" -#: ../../../CHANGELOG.md:492 -msgid "2024-02-14" +#: ../../../CHANGELOG.md:495 +msgid "matrix-media-repo now configured for Authenticated Media" msgstr "" -#: ../../../CHANGELOG.md:494 -msgid "Much larger Synapse caches and cache auto-tuning enabled by default" +#: ../../../CHANGELOG.md:497 +msgid "Thanks to [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), our matrix-media-repo implementation now automatically [sets up signing keys](https://docs.t2bot.io/matrix-media-repo/v1.3.5/installation/signing-key/) for Authenticated Media (as per [MSC3916](https://github.com/matrix-org/matrix-spec-proposals/pull/3916))." msgstr "" -#: ../../../CHANGELOG.md:496 -msgid "Thanks to [FSG-Cat](https://github.com/FSG-Cat), the playbook now uses much larger caches and enables Synapse's [cache auto-tuning functionality](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caches-and-associated-values). This work and the default values used by the playbook are inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/deployment/synapse.html)." +#: ../../../CHANGELOG.md:499 +msgid "If you had never heard of Authenticated Media before, the [Sunsetting unauthenticated media](https://matrix.org/blog/2024/06/26/sunsetting-unauthenticated-media/) article on [matrix.org](https://matrix.org/) is a good introduction." msgstr "" -#: ../../../CHANGELOG.md:498 -msgid "The playbook has always used a very conservative cache factor (`matrix_synapse_caches_global_factor`) value of `0.5`, which may be OK for small and underactive deployments, but is not ideal for larger servers. Paradoxically, a small global cache factor value [does not necessarily decrease RAM usage as a whole](https://github.com/matrix-org/synapse/issues/3939)." -msgstr "" - -#: ../../../CHANGELOG.md:500 -msgid "The playbook now uses **a 20x larger cache factor** (currently `10`), adjusts a few other cache-related variables, and **enables cache auto-tuning** via the following variables:" -msgstr "" - -#: ../../../CHANGELOG.md:502 -msgid "`matrix_synapse_cache_autotuning_max_cache_memory_usage` — defaults to 1/8 of total RAM with a cap of 2GB; values are specified in bytes" +#: ../../../CHANGELOG.md:501 +msgid "This feature is enabled for matrix-media-repo installations by default and will append an additional (matrix-media-repo-generated signing key) to your homeserver's (Synapse or Dendrite) signing key. See the [Signing keys](./docs/configuring-playbook-matrix-media-repo.md#signing-keys) and [Key backup and revoking](./docs/configuring-playbook-matrix-media-repo.md#key-backup-and-revoking) sections of the matrix-media-repo documentation for more details." msgstr "" #: ../../../CHANGELOG.md:503 -msgid "`matrix_synapse_cache_autotuning_target_cache_memory_usage` — defaults to 1/16 of total RAM with a cap of 1GB; values are specified in bytes" -msgstr "" - -#: ../../../CHANGELOG.md:504 -msgid "`matrix_synapse_cache_autotuning_min_cache_ttl` — defaults to `30s`" +msgid "If you'd like to avoid this new feature, you can disable it by setting `matrix_media_repo_generate_signing_key: false` in your `vars.yml` configuration file." msgstr "" #: ../../../CHANGELOG.md:506 -msgid "These values should be good defaults for most servers, but may change over time as we experiment further." +msgid "2024-08-08" msgstr "" #: ../../../CHANGELOG.md:508 -msgid "Refer to our new [Tuning caches and cache autotuning](docs/maintenance-synapse.md#tuning-caches-and-cache-autotuning) documentation section for more details." +msgid "(Backward Compatibility Break) matrix-corporal has been upgraded to v3" msgstr "" -#: ../../../CHANGELOG.md:511 -msgid "2024-01-31" +#: ../../../CHANGELOG.md:510 +msgid "The playbook now installs [matrix-corporal](https://github.com/devture/matrix-corporal) v3.0.0, which brings support for **power-level management** (thanks to [this PR](https://github.com/devture/matrix-corporal/pull/32))." msgstr "" -#: ../../../CHANGELOG.md:513 -msgid "(Backward-compatibility break) Minor changes necessary for some people serving a static website at the base domain" +#: ../../../CHANGELOG.md:512 +msgid "This upgrade necessitates configuration policy changes as described in [matrix-corporal's changelog entry](https://github.com/devture/matrix-corporal/blob/5287cb81c82cd3b951c2a099b4697c3e0b384559/CHANGELOG.md#version-300-2024-08-08)." msgstr "" -#: ../../../CHANGELOG.md:515 -msgid "This only affects people who are [Serving a static website at the base domain](./docs/configuring-playbook-base-domain-serving.md#serving-a-static-website-at-the-base-domain), but not managing its `index.html` through the playbook." +#: ../../../CHANGELOG.md:514 +msgid "If you'd like to remain on the old (v2) version of matrix-corporal, you can do so by adding the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../CHANGELOG.md:517 -msgid "That is, for people who have `matrix_static_files_file_index_html_enabled: false` in their `vars.yml` configuration, the playbook has a new default behavior. Since the playbook is not managing the `index.html` file, it will default to a more sensible way of handling the base domain — redirecting `https://example.com/` to `https://matrix.example.com/`, instead of serving a 404 page." -msgstr "" - -#: ../../../CHANGELOG.md:519 -msgid "If you are managing your static website by yourself (by dropping files into `/matrix/static-files/public` somehow), then you probably don't wish for such redirection to happen. You can disable it by adding `matrix_static_files_container_labels_base_domain_root_path_redirection_enabled: false` to your `vars.yml` configuration file." +#: ../../../CHANGELOG.md:520 +msgid "2024-07-25" msgstr "" #: ../../../CHANGELOG.md:522 -msgid "2024-01-20" +msgid "synapse-usage-exporter support" msgstr "" #: ../../../CHANGELOG.md:524 -msgid "Support for more efficient (specialized) Synapse workers" +msgid "Thanks to [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/), the playbook can now set up [synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) — a small [Flask](https://flask.palletsprojects.com)-based webservice which can capture usage statistics from Synapse (via HTTP `PUT`) and then make them available for Prometheus to scrape." msgstr "" #: ../../../CHANGELOG.md:526 -msgid "Thanks to [Charles Wright](https://github.com/cvwright) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/), the playbook has [received support](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3100) for load-balancing the Synapse workload via [specialized workers](./docs/configuring-playbook-synapse.md#specialized-workers) which are supposed to work better than our old [generic workers](./docs/configuring-playbook-synapse.md#generic-workers) implementation." +msgid "To learn more see our [Enabling synapse-usage-exporter for Synapse usage statistics](docs/configuring-playbook-synapse-usage-exporter.md) documentation page." msgstr "" -#: ../../../CHANGELOG.md:528 -msgid "For now, playbook defaults remain unchanged and the `one-of-each` [workers preset](./docs/configuring-playbook-synapse.md#worker-presets) continues being the default. However, the default may change in the future. If you'd like to remain on this preset even if/when the defaults change, consider explicitly adding `matrix_synapse_workers_preset: one-of-each` to your `vars.yml` configuration." +#: ../../../CHANGELOG.md:529 +msgid "2024-07-06" msgstr "" -#: ../../../CHANGELOG.md:530 -msgid "Our specialized workers setup is based on recommendations found in [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). What's special about our new setup is that we try to parse information out of the request (who the user is; which room is being operated on) and try to forward similar requests to the same worker. As an example, this means that once a worker caches some room information, subsequent requests for the same room will be routed to the same worker (which supposedly still has the room's state cached)." +#: ../../../CHANGELOG.md:531 +msgid "matrix-alertmanager-receiver support" msgstr "" -#: ../../../CHANGELOG.md:532 -msgid "To get started, refer to our [Specialized workers](./docs/configuring-playbook-synapse.md#specialized-workers) documentation section." +#: ../../../CHANGELOG.md:533 +msgid "For those wishing to more easily integrate [Prometheus](https://prometheus.io/)' alerting service ([Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/)) with Matrix, the playbook can now set up [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver)." msgstr "" #: ../../../CHANGELOG.md:535 -msgid "2024-01-17" +msgid "See [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](./docs/configuring-playbook-alertmanager-receiver.md) for more details." msgstr "" #: ../../../CHANGELOG.md:537 -msgid "Switching to Element's AGPLv3-licensed Synapse release" +msgid "Traefik v3 and HTTP/3 are here now" msgstr "" #: ../../../CHANGELOG.md:539 -msgid "A few months ago, the [Element](https://element.io/) company has [announced](https://element.io/blog/element-to-adopt-agplv3/) that their work on the Synapse homeserver would no longer be available under the permissive [Apache-2.0 license](https://www.apache.org/licenses/LICENSE-2.0), but only under:" +msgid "**TLDR**: Traefik was migrated from v2 to v3. Minor changes were done to the playbook. Mostly everything else worked out of the box. Most people will not have to do any tweaks to their configuration. In addition, [HTTP/3](https://en.wikipedia.org/wiki/HTTP/3) support is now auto-enabled for the `web-secure` (port 443) and `matrix-federation` (port `8448`) entrypoints. If you have a firewall in front of your server and you wish to benefit from `HTTP3`, you will need to open the `443` and `8448` UDP ports in it." msgstr "" #: ../../../CHANGELOG.md:541 -msgid "the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html) free-software license — the same license that this Ansible playbook has always used" +msgid "Traefik v3" msgstr "" -#: ../../../CHANGELOG.md:542 -msgid "a proprietary license, for those wishing for Element to [sell them an exception](https://gnu.org/philosophy/selling-exceptions.html) to the AGPLv3 license" +#: ../../../CHANGELOG.md:543 +msgid "The reverse-proxy that the playbook uses by default (Traefik) has recently been upgraded to v3 (see [this blog post](https://traefik.io/blog/announcing-traefik-proxy-v3-rc/) to learn about its new features). Version 3 includes some small breaking configuration changes requiring a [migration](https://doc.traefik.io/traefik/migration/v2-to-v3/)." msgstr "" -#: ../../../CHANGELOG.md:544 -msgid "You can also learn more in [this post](https://matrix.org/blog/2023/11/06/future-of-synapse-dendrite/) by the Matrix Foundation." +#: ../../../CHANGELOG.md:545 +msgid "We have **updated the playbook to Traefik v3** (make sure to run `just roles` / `make roles` to get it)." msgstr "" -#: ../../../CHANGELOG.md:546 -msgid "The change has [already happened](https://element.io/blog/synapse-now-lives-at-github-com-element-hq-synapse/) and the first Synapse release under the new license is here: [v1.99.0](https://github.com/element-hq/synapse/releases/tag/v1.99.0)." +#: ../../../CHANGELOG.md:547 +msgid "There were **only minor playbook changes required** to adapt to Traefik v3, and only to the Ansible role for [matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md) where we changed a few [`PathPrefix` instances to `PathRegexp`](https://doc.traefik.io/traefik/routing/routers/#path-pathprefix-and-pathregexp), because these instances were using a regular expression instead of a fixed path. For fixed-path values, `PathPrefix` is still the preferred matcher function to use." msgstr "" -#: ../../../CHANGELOG.md:548 -msgid "There is no up-to-date alternative Synapse fork right now and this free-software (AGPLv3-licensed) playbook is definitely not against free-software licenses, so we are now switching to the Element-maintained Synapse release." +#: ../../../CHANGELOG.md:549 +msgid "**Most people using the playbook should not have to do any changes**." msgstr "" -#: ../../../CHANGELOG.md:550 -msgid "**What does this mean to you?**" +#: ../../../CHANGELOG.md:551 +msgid "If you're using the playbook's Traefik instance to reverse-proxy to some other services of your own (not managed by the playbook), you may wish to review their Traefik labels and make sure they're in line with the [Traefik v2 to v3 migration guide](https://doc.traefik.io/traefik/migration/v2-to-v3/)." msgstr "" -#: ../../../CHANGELOG.md:552 -msgid "For most home users, it doesn't mean anything. Your installation will continue working as it should and you don't need to do anything." +#: ../../../CHANGELOG.md:553 +msgid "If you've tweaked any of this playbook's `_path_prefix` variables and made them use a regular expression, you will now need to make additional adjustments. The playbook makes extensive use of `PathPrefix()` matchers in Traefik rules and `PathPrefix` does not support regular expressions anymore. To work around it, you may now need to override a whole `_traefik_rule` variable and switch it from [`PathPrefix` to `PathRegexp`](https://doc.traefik.io/traefik/routing/routers/#path-pathprefix-and-pathregexp)." msgstr "" -#: ../../../CHANGELOG.md:554 -msgid "For people building commercial products on top of Synapse, they may have to either buy a license exception from Element (from what we hear, the fee depends on the number of monthly-active users on your instance) or they may need to release all related code as free-software (which is what we've been doing at [etke.cc](https://etke.cc/) ([here](https://gitlab.com/etke.cc)) all along)." +#: ../../../CHANGELOG.md:555 +msgid "If you're not using [matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md) (the only role we had to tweak to adapt it to Traefik v3), you **may potentially downgrade to Traefik v2** (if necessary) by adding `traefik_verison: v2.11.4` to your configuration. People using `matrix-media-repo` cannot downgrade this way, because `matrix-media-repo` has been adjusted to use `PathRegexp` — a [routing matcher](https://doc.traefik.io/traefik/v2.11/routing/routers/#rule) that Traefik v2 does not understand." msgstr "" -#: ../../../CHANGELOG.md:556 -msgid "We're no lawyers and this changelog entry does not aim to give you the best legal advice, so please research on your own!" +#: ../../../CHANGELOG.md:557 +msgid "HTTP/3 is enabled by default" msgstr "" -#: ../../../CHANGELOG.md:558 -msgid "If you'd like to continue using the old Apache-2.0-licensed Synapse (for a while longer anyway), the playbook makes it possible by intruducing a new Ansible variable. You can do it like this:" +#: ../../../CHANGELOG.md:559 +msgid "In Traefik v3, [HTTP/3](https://en.wikipedia.org/wiki/HTTP/3) support is no longer considered experimental now. Due to this, **the playbook auto-enables HTTP3** for the `web-secure` (port 443) and `matrix-federation` (port `8448`) entrypoints." msgstr "" -#: ../../../CHANGELOG.md:570 -msgid "Notes:" +#: ../../../CHANGELOG.md:561 +msgid "HTTP3 uses the UDP protocol and **the playbook (together with Docker) will make sure that the appropriate ports** (`443` over UDP & `8448` over UDP) **are exposed and whitelisted in your server's firewall**. However, **if you have another firewall in front of your server** (as is the case for many cloud providers), **you will need to manually open these UDP ports**." msgstr "" -#: ../../../CHANGELOG.md:572 -msgid "if you had already upgraded Synapse to `v1.99.0` by running this playbook, you will still be able to downgrade to `v1.98.0`, because both releases use the same database schema version (`SCHEMA_COMPAT_VERSION = 83` — see [here for v1.98.0](https://github.com/element-hq/synapse/blob/v1.98.0/synapse/storage/schema/__init__.py#L131-L134) and [here for v1.99.0](https://github.com/element-hq/synapse/blob/v1.99.0/synapse/storage/schema/__init__.py#L137-L140)). More details on Synapse's database schema are available [here](https://element-hq.github.io/synapse/develop/development/database_schema.html). It appears that there are no new database migrations introduced in `v1.99.0`, so going back to the older release is possible. This is not guaranteed to hold true for future Synapse releases, so if you're seeing this early-enough, consider pinning the version and organization before re-running the playbook and getting upgraded to the latest version" +#: ../../../CHANGELOG.md:563 +msgid "If you do not open the UDP ports correctly or there is some other issue, clients (browsers, mostly) will fall-back to [HTTP/2](https://en.wikipedia.org/wiki/HTTP/2) or even [HTTP/1.1](https://en.wikipedia.org/wiki/HTTP)." msgstr "" -#: ../../../CHANGELOG.md:574 -msgid "running an outdated homeserver exposes you to security issues and incompatibilities. Only consider doing this as a short-term solution." +#: ../../../CHANGELOG.md:565 +msgid "Still, if HTTP/3 cannot function correctly in your setup, it's best to disable advertising support for it (and misleading clients into trying to use HTTP/3)." msgstr "" -#: ../../../CHANGELOG.md:576 -msgid "2024-01-16" +#: ../../../CHANGELOG.md:567 +msgid "To **disable HTTP/3**, you can use the following configuration:" msgstr "" -#: ../../../CHANGELOG.md:578 -msgid "`Draupnir` has been relicensed to AFL-3.0" -msgstr "" - -#: ../../../CHANGELOG.md:580 -msgid "As of [#204](https://github.com/the-draupnir-project/Draupnir/pull/204) Draupnir changed its licence to AFL-3.0 from the CSL licence. This change affects playbook users who could not run Draupnir under the old license restrictions. The new license is considerably less restrictive and is OSI approved. Draupnir version v1.86.0 and later are covered by this license change." -msgstr "" - -#: ../../../CHANGELOG.md:582 -msgid "2024-01-15" -msgstr "" - -#: ../../../CHANGELOG.md:584 -msgid "Goodbye, `matrix-nginx-proxy` 🪦" -msgstr "" - -#: ../../../CHANGELOG.md:586 -msgid "**TLDR**: All traces of the `matrix-nginx-proxy` reverse-proxy component are now gone. This brought about many other internal changes (and security improvements), so setups may need minor adjustments or suffer some (temporary) breakage. People who have been on the Traefik-native setup may upgrade without much issues. Those running their own Traefik instance may need minor changes. People who have been postponing the migration away from `matrix-nginx-proxy` (for more than a year already!) will now finally need to do something about it." -msgstr "" - -#: ../../../CHANGELOG.md:588 -msgid "Backstory on `matrix-nginx-proxy`" -msgstr "" - -#: ../../../CHANGELOG.md:590 -msgid "We gather here today to celebrate the loss of a once-beloved component in our stack — `matrix-nginx-proxy`. It's been our [nginx](https://nginx.org/)-based reverse-proxy of choice since the [first commit](https://github.com/spantaleev/matrix-docker-ansible-deploy/tree/87f5883f2455fb115457b65f267f17de305c053c) of this playbook, 7 years ago." -msgstr "" - -#: ../../../CHANGELOG.md:592 -msgid "For 6 years, `matrix-nginx-proxy` has been the front-most reverse-proxy in our setup (doing SSL termination, etc.). After [transitioning to Traefik last year](#traefik-is-the-default-reverse-proxy-now), `matrix-nginx-proxy` took a step back. Nevertheless, since it was so ingrained into the playbook, it still remained in use — even if only internally. Despite our warnings of its imminent death, many of you have indubitably continued to use it instead of Traefik. Its suffering continued for too long, because it served many different purposes and massive effort was required to transition them to others." +#: ../../../CHANGELOG.md:581 +msgid "If you are using [your own webserver](./docs/configuring-playbook-own-webserver.md) (in front of Traefik), port binding on UDP port `8448` by default due to HTTP/3 is either unnecessary or [may get in the way](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3402). If it does, you can disable it:" msgstr "" #: ../../../CHANGELOG.md:594 -msgid "To us, `matrix-nginx-proxy` was:" +msgid "2024-07-01" msgstr "" #: ../../../CHANGELOG.md:596 -msgid "an [nginx](https://nginx.org/)-based reverse-proxy" -msgstr "" - -#: ../../../CHANGELOG.md:597 -msgid "an Ansible role organizing the work of [certbot](https://certbot.eff.org/) — retrieving free [Let's Encrypt](https://letsencrypt.org/) SSL certificates for `matrix-nginx-proxy` and for the [coturn TURN server](./docs/configuring-playbook-turn.md)" +msgid "synapse-admin is now restricted to your homeserver's URL by default" msgstr "" #: ../../../CHANGELOG.md:598 -msgid "a central component for reverse-proxying to the [long list of services](./docs/configuring-playbook.md) supported by the playbook. As such, it became a dependency that all these services had to inject themselves into during runtime" -msgstr "" - -#: ../../../CHANGELOG.md:599 -msgid "an intermediary through which addons (bridges, bots) communicated with the homeserver. Going through an intermediary (instead of directly talking to the homeserver) is useful when certain components (like [matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md) or [matrix-corporal](./docs/configuring-playbook-matrix-corporal.md)) are enabled, because it lets these services \"steal routes\" from the homeserver" +msgid "A new feature introduced in synapse-admin [v0.10.0](https://github.com/Awesome-Technologies/synapse-admin/releases/tag/0.10.0) (released and supported by the playbook since a a few months ago) provides the ability to [restrict its usage to a specific homeserver](https://github.com/Awesome-Technologies/synapse-admin/blob/e21e44362c879ac41f47c580b04210842b6ff3d7/README.md#restricting-available-homeserver) (or multiple homeservers)." msgstr "" #: ../../../CHANGELOG.md:600 -msgid "a webserver for serving the `/.well-known/matrix` static files (generated by the `matrix-base` role until now)" -msgstr "" - -#: ../../../CHANGELOG.md:601 -msgid "a webserver [serving your base domain](./docs/configuring-playbook-base-domain-serving.md) (and also generating the `index.html` page for it)" +msgid "The playbook has just started making use of this feature. **From now on, your synapse-admin instance will be restricted to the homeserver you're managing via the playbook**. When configured like this, the *Homeserver URL* field in synapse-admin's web UI changes from a text field to a dropdown having a single value (the URL of your homeserver). This makes usage simpler for most people, as they won't need to manually enter a *Homeserver URL* anymore." msgstr "" #: ../../../CHANGELOG.md:602 -msgid "a central component providing global [HTTP Basic Auth](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) password-protection for all `/metrics` endpoints when metrics were exposed publicly for consumption from a remote Prometheus server" -msgstr "" - -#: ../../../CHANGELOG.md:604 -msgid "Talk about a jack of all trades! The [UNIX philosophy](https://en.wikipedia.org/wiki/Unix_philosophy) (and Docker container philosophy) of \"do one thing and do it well\" had been severely violated for too long." -msgstr "" - -#: ../../../CHANGELOG.md:606 -msgid "On a related note, we also had a large chain of reverse-proxies in the mix. In the worst case, it was something like this: (Traefik -> `matrix-nginx-proxy:8080` -> `matrix-nginx-proxy:12080` -> `matrix-synapse-reverse-proxy-companion:8008` -> `matrix-synapse:8008`)." -msgstr "" - -#: ../../../CHANGELOG.md:608 -msgid "Due to complexity and the playbook's flexibility (trying to accommodate a mix of tens of components), many layers of indirection were necessary. We do like reverse-proxies, but… not quite enough to enjoy going through a chain of ~4 of them before reaching the target service." +msgid "If you'd like **to go back to the old unrestricted behavior**, use the following configuration:" msgstr "" #: ../../../CHANGELOG.md:610 -msgid "After **a ton of work** in the last weeks (200+ commits, which changed 467 files - 8684 insertions and 8913 deletions), **we're finally saying goodbye** to `matrix-nginx-proxy`." +msgid "2024-06-25" msgstr "" #: ../../../CHANGELOG.md:612 -msgid "Going Traefik-native and cutting out all middlemen" +msgid "The URL-prefix for Hookshot generic webhooks has changed" msgstr "" #: ../../../CHANGELOG.md:614 -msgid "In our new setup, you'll see the bare minimum number of reverse-proxies." +msgid "Until now, generic Hookshot webhook URLs looked like this: `https://matrix.example.com/hookshot/webhooks/:hookId`." msgstr "" #: ../../../CHANGELOG.md:616 -msgid "In most cases, there's only Traefik and all services being registered directly with it. When [Synapse workers](./docs/configuring-playbook-synapse.md#load-balancing-with-workers) are enabled, `matrix-synapse-reverse-proxy-companion` remains as an extra reverse-proxy that requests go through (for load-balancing to the correct Synapse worker), but in all other cases services are exposed directly." +msgid "The `/hookshot/webhooks` common prefix gets stripped by Traefik automatically, so Hookshot only sees the part that comes after (`/:hookId`)." msgstr "" #: ../../../CHANGELOG.md:618 -msgid "This reduces \"network\" hops (improving performance) and also decreases the number of components (containers). Each Ansible role in our setup is now independent and doesn't need to interact with other roles during runtime." +msgid "[A few years ago](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1681), Hookshot started to prefer to handle webhooks at a `/webhook/:hookId` path (instead of directly at `/:hookId`)." msgstr "" #: ../../../CHANGELOG.md:620 -msgid "Traefik now has an extra job" +msgid "To avoid future problems, we've [reconfigured](https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/4704a60718946fd469aeee7fc3ae8127c633bb6b) our Hookshot configuration to use webhook URLs that include `/webhook` in the URL suffix (e.g. `/hookshot/webhooks/webhook/:hookId`, instead of `/hookshot/webhooks/:hookId`). This means that when we strip the common prefi (`/hookshot/webhooks`), we'll end up sending `/webhook/:hookId` to Hookshot, just like recommended." msgstr "" #: ../../../CHANGELOG.md:622 -msgid "Previously, **Traefik had a single purpose** — being the main reverse-proxy. It was either front-most (terminating SSL, etc.) or you were [fronting Traefik with your own other reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy). In any case — it had this central (yet decentralized) job." +msgid "When generating new webhooks, you should start seeing the new URLs being used." msgstr "" #: ../../../CHANGELOG.md:624 -msgid "Now, **Traefik has one more role** — it serves as an intermediary which allows addon services (bridges, bots, etc.) to communicate with the homeserver. As mentioned above, such an intermediary service is not strictly necessary in all kinds of setups, but more complex setups (including [matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md) or [matrix-corporal](./docs/configuring-playbook-matrix-corporal.md)) benefit from it." +msgid "**For now**, **both** old URLs (`/hookshot/webhooks/:hookId`) and new URLs (`/hookshot/webhooks/webhook/:hookId`) **continue to work**, so your webhooks will not break just yet." msgstr "" #: ../../../CHANGELOG.md:626 -msgid "To perform this new role, Traefik now has a new internal [entrypoint](https://doc.traefik.io/traefik/routing/entrypoints/) called `matrix-internal-matrix-client-api`. All homeservers (Conduit, Dendrite, Synapse and even `matrix-synapse-reverse-proxy-companion`) and homeserver-related core services ([matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md), [matrix-corporal](./docs/configuring-playbook-matrix-corporal.md) and potentially others) register their routes (using [container labels](https://docs.docker.com/config/labels-custom-metadata/)) not only on the public entrypoints (`web-secure`, `matrix-federation`), but also on this new internal entrypoint." +msgid "However, **we recommend that you update all your old webhook URLs** (configured in other systems) to include the new `/webhook` path component, so that future Hookshot changes (whenever they come) will not break your webhooks. You don't need to do anything on the Hookshot side — you merely need to reconfigure the remote systems that use your webhook URLs." msgstr "" -#: ../../../CHANGELOG.md:628 -msgid "Doing so, services can contact Traefik on this entrypoint's dedicated port (the URL defaults to `http://matrix-traefik:8008`) and reach the homeserver Client-Server API as they expect. Internally, Traefik takes care of the routing to the correct service." +#: ../../../CHANGELOG.md:629 +msgid "2024-06-22" msgstr "" -#: ../../../CHANGELOG.md:630 -msgid "We've also considered keeping it simple and having services talk to the homeserver over the public internet (e.g. `https://matrix.example.com`) thus reusing all existing Traefik routing labels. In this scenario, performance was incredibly poor (e.g. 70 rps, instead of 1400 rps) due to TLS and networking overhead. The need for fast internal communication (via the new internal non-TLS-enabled Traefik entrypoint) is definitely there. In our benchmarks, Traefik even proved more efficient than nginx at doing this: ~1200 rps for Traefik compared to ~900 rps for nginx (out of ~1400 rps when talking to the Synapse homeserver directly)." +#: ../../../CHANGELOG.md:631 +msgid "The maubot user is now managed by the playbook" msgstr "" -#: ../../../CHANGELOG.md:632 -msgid "Traefik serving this second purpose has a few downsides:" -msgstr "" - -#: ../../../CHANGELOG.md:634 -msgid "Traefik becomes a runtime dependency for all homeserver-dependant container services" +#: ../../../CHANGELOG.md:633 +msgid "To make things easier and to be consistent with other roles, the [maubot](./docs/configuring-playbook-bot-maubot.md) user (`bot.maubot` by default) is [now](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3376) automatically created be the playbook." msgstr "" #: ../../../CHANGELOG.md:635 -msgid "all homeserver-dependant services now need to be connected to the `traefik` container network, even if they don't need public internet exposure" +msgid "If you have an existing maubot installation, you will need to specify `matrix_bot_maubot_initial_password` in your `vars.yml` file to make the playbook not complain about it being undefined. Since the bot is already registered in your installation, there's nothing for the playbook to do anyway. In case you don't remember the password you've registered your maubot user account with, you can specify any value for this variable." msgstr "" #: ../../../CHANGELOG.md:637 -msgid "Despite these downsides (which the playbook manages automatically), we believe it's still a good compromise given the amount of complexity it eliminates and the performance benefits it yields. One alternative we've [considered](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3045#issuecomment-1867327001) was adding a new intermediary service (e.g. `matrix-homeserver-proxy` powered by nginx), but this both had much higher complexity (one more component in the mix; duplication of effort to produce nginx-compatible route definitions for it) and slightly worse performance (see above)." +msgid "If you've registered another username for the bot (other than the recommended default of `bot.maubot`), consider adjusting the `matrix_bot_maubot_login` variable (e.g. `matrix_bot_maubot_login: my.maubot.username`)." msgstr "" -#: ../../../CHANGELOG.md:639 -msgid "People running the default Traefik setup do not need to do anything to make Traefik take on this extra job. Your Traefik configuration will be updated automatically." +#: ../../../CHANGELOG.md:640 +msgid "2024-06-03" msgstr "" -#: ../../../CHANGELOG.md:641 -msgid "**People runnning their own Traefik reverse-proxy need to do [minor adjustments](#people-managing-their-own-traefik-instance-need-to-do-minor-changes)**, as described in the section below." +#: ../../../CHANGELOG.md:642 +msgid "WeChat bridging support" msgstr "" -#: ../../../CHANGELOG.md:643 -msgid "You may disable Traefik acting as an intermediary by explicitly setting `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_enabled` to `false`. Services would then be configured to talk to the homeserver directly, giving you a slight performance boost and a \"simpler\" Traefik setup. However, such a configuration is less tested and will cause troubles, especially if you enable more services (like `matrix-media-repo`, etc.) in the future. As such, it's not recommended." +#: ../../../CHANGELOG.md:644 +msgid "Thanks to [Tobias Diez](https://github.com/tobiasdiez)'s [efforts](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3241), the playbook now supports bridging to [WeChat](https://www.wechat.com/) via the [matrix-wechat](https://github.com/duo/matrix-wechat) bridge." msgstr "" -#: ../../../CHANGELOG.md:645 -msgid "People managing their own Traefik instance need to do minor changes" -msgstr "" - -#: ../../../CHANGELOG.md:647 -msgid "This section is for people [managing their own Traefik instance on the Matrix server](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you). Those [using Traefik managed by the playbook](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-the-playbook) don't need to do any changes." +#: ../../../CHANGELOG.md:646 +msgid "See our [Setting up WeChat bridging](docs/configuring-playbook-bridge-wechat.md) documentation page for getting started." msgstr "" #: ../../../CHANGELOG.md:649 -msgid "Because [Traefik has an extra job now](#traefik-now-has-an-extra-job), you need to adapt your configuration to add the additional `matrix-internal-matrix-client-api` entrypoint and potentially configure the `matrix_playbook_reverse_proxy_container_network` variable. See the [Traefik managed by you](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you) documentation section for more details." +msgid "2024-03-26" msgstr "" #: ../../../CHANGELOG.md:651 -msgid "People fronting Traefik with another reverse proxy need to do minor changes" +msgid "(Backward Compatibility Break) The playbook now defaults to KeyDB, instead of Redis" msgstr "" #: ../../../CHANGELOG.md:653 -msgid "We've already previously mentioned that you need to do some minor [configuration changes related to `traefik_additional_entrypoints_auto`](#backward-compatibility-configuration-changes-required-for-people-fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy)." +msgid "**TLDR**: if the playbook used installed Redis as a dependency for you before, it will now replace it with [KeyDB](https://docs.keydb.dev/) (a drop-in alternative) due to [Redis having changed its license](https://redis.com/blog/redis-adopts-dual-source-available-licensing/)." msgstr "" #: ../../../CHANGELOG.md:655 -msgid "If you don't do these changes (switching from `traefik_additional_entrypoints_auto` to multiple other variables), your Traefik setup will not automatically receive the new `matrix-internal-matrix-client-api` Traefik entrypoint and Traefik would not be able to perform [its new duty of connecting addons with the homeserver](#traefik-now-has-an-extra-job)." +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook now uses [KeyDB](https://docs.keydb.dev/) (a drop-in alternative for Redis), instead of [Redis](https://redis.io/)." msgstr "" #: ../../../CHANGELOG.md:657 -msgid "Supported reverse proxy types are now fewer" +msgid "The playbook used to install Redis (and now installs KeyDB in its place) if services have a need for it ([enabling worker support for Synapse](docs/configuring-playbook-synapse.md#load-balancing-with-workers), [enabling Hookshot encryption](docs/configuring-playbook-bridge-hookshot.md#end-to-bridge-encryption), etc.) or if you explicitly enabled the service (`redis_enabled: true` or `keydb_enabled: true`)." msgstr "" #: ../../../CHANGELOG.md:659 -msgid "This section is for people using a more custom reverse-proxy setup — those having `matrix_playbook_reverse_proxy_type` set to a value different than the default (`playbook-managed-traefik`)." +msgid "This change is provoked by the fact that [Redis is now \"source available\"](https://redis.com/blog/redis-adopts-dual-source-available-licensing/). According to the Limitations of [the new license](https://redis.com/legal/rsalv2-agreement/) (as best as we understand them, given that we're not lawyers), using Redis in the playbook (even in a commercial FOSS service like [etke.cc](https://etke.cc/)) does not violate the new Redis license. That said, we'd rather neither risk it, nor endorse shady licenses and products that pretend to be free-software. Another high-quality alternative to Redis seems to be [Dragonfly](https://www.dragonflydb.io/), but the [Dragonfly license](https://github.com/dragonflydb/dragonfly?tab=License-1-ov-file#readme) is no better than Redis's." msgstr "" #: ../../../CHANGELOG.md:661 -msgid "Previously, we allowed you to set `matrix_playbook_reverse_proxy_type` to 7 different values to accommodate various reverse-proxy setups." +msgid "Next time your run the playbook (via the `setup-all` tag), **Redis will be automatically uninstalled and replaced with KeyDB**. Some Synapse downtime may occur while the switch happens." msgstr "" #: ../../../CHANGELOG.md:663 -msgid "The complexity of this is too high, so we only support 3 values right now:" +msgid "Users on `arm32` should be aware that there's **neither a prebuilt `arm32` container image for KeyDB**, nor the KeyDB role supports self-building yet. Users on this architecture likely don't run Synapse with workers, etc., so they're likely in no need of KeyDB (or Redis). If Redis is necessary in an `arm32` deployment, disabling KeyDB and making the playbook fall back to Redis is possible (see below)." msgstr "" -#: ../../../CHANGELOG.md:665 -msgid "(the default) `playbook-managed-traefik`, when you're [using Traefik managed by the playbook](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-the-playbook)" -msgstr "" - -#: ../../../CHANGELOG.md:666 -msgid "`other-traefik-container`, when you're [managing your own Traefik instance on the Matrix server](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you)" -msgstr "" - -#: ../../../CHANGELOG.md:667 -msgid "`none`, when you wish for [no reverse-proxy integration to be done at all](./docs/configuring-playbook-own-webserver.md#using-no-reverse-proxy-on-the-matrix-side-at-all)" -msgstr "" - -#: ../../../CHANGELOG.md:669 -msgid "The `none` value is not recommended and may not work adequately, due to lack of testing and [Traefik's new responsibilities](#traefik-now-has-an-extra-job) in our setup." -msgstr "" - -#: ../../../CHANGELOG.md:671 -msgid "**Previous values that are now gone** (and the playbook would report them as such) are: `playbook-managed-nginx`, `other-nginx-non-container`, `other-on-same-host` and `other-on-another-host`." -msgstr "" - -#: ../../../CHANGELOG.md:673 -msgid "If you were using these values as a way to stay away from Traefik, you now have 2 options:" -msgstr "" - -#: ../../../CHANGELOG.md:675 -msgid "(recommended) [Fronting Traefik with another reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy)" +#: ../../../CHANGELOG.md:674 +msgid "2024-03-24" msgstr "" #: ../../../CHANGELOG.md:676 -msgid "(not recommended) [Using no reverse-proxy on the Matrix side at all](./docs/configuring-playbook-own-webserver.md#using-no-reverse-proxy-on-the-matrix-side-at-all) and reverse-proxying to each and every service manually" +msgid "Initial work on IPv6 support" msgstr "" #: ../../../CHANGELOG.md:678 -msgid "Container networking changes" +msgid "Thanks to [Tilo Spannagel](https://github.com/tilosp), the playbook can now enable IPv6 for container networks for various components (roles) via [the `devture_systemd_docker_base_ipv6_enabled` variable](https://github.com/devture/com.devture.ansible.role.systemd_docker_base/blob/c11a526bb8e318b42eb52055056377bb31154f13/defaults/main.yml#L14-L31)." msgstr "" #: ../../../CHANGELOG.md:680 -msgid "Now that `matrix-nginx-proxy` is not in the mix, it became easier to clear out some other long-overdue technical debt." +msgid "It should be noted that:" msgstr "" #: ../../../CHANGELOG.md:682 -msgid "Since the very beginning of this playbook, all playbook services were connected to a single (shared) `matrix` container network. Later on, some additional container networks appeared, but most services (database, etc.) still remained in the `matrix` container network. This meant that any random container in this network could try to talk (or attack) the Postgres database operating in the same `matrix` network." +msgid "Matrix roles (`roles/custom/matrix-*`) respect this variable, but external roles (those defined in `requirements.yml` and installed via `just roles`) do not respect it yet. Additional work is necessary" +msgstr "" + +#: ../../../CHANGELOG.md:683 +msgid "changing the variable subsequently may not change existing container networks. Refer to [these instructions](https://github.com/devture/com.devture.ansible.role.systemd_docker_base/blob/c11a526bb8e318b42eb52055056377bb31154f13/defaults/main.yml#L26-L30)" msgstr "" #: ../../../CHANGELOG.md:684 -msgid "Moving components (especially the database) into other container networks was difficult — it required changes to many other components to ensure correct connectivity." +msgid "this is all very new and untested" msgstr "" #: ../../../CHANGELOG.md:686 -msgid "All the hard work has been done now. We've added much more isolation between services by splitting them up into separate networks (`matrix-homeserver`, `matrix-addons`, `matrix-monitoring`, `matrix-exim-relay`, etc). Components are only joined to the networks they need and should (for the most part) not be able to access unrelated things." +msgid "Pantalaimon support" msgstr "" #: ../../../CHANGELOG.md:688 -msgid "Carrying out these container networking changes necessitated modifying many components, so **we're hoping not too many bugs were introduced in the process**." +msgid "Thanks to [Julian Foad](https://matrix.to/#/@julian:foad.me.uk), the playbook can now install the [Pantalaimon](https://github.com/matrix-org/pantalaimon) E2EE aware proxy daemon for you. It's already possible to integrate it with [Draupnir](docs/configuring-playbook-bot-draupnir.md) to allow it to work in E2EE rooms — see our Draupnir docs for details." msgstr "" #: ../../../CHANGELOG.md:690 -msgid "We've refrained from creating too many container networks (e.g. one for each component), to avoid exhausting Docker's default network pool and contaminating the container networks list too much." +msgid "See our [Setting up Pantalaimon](docs/configuring-playbook-pantalaimon.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:692 -msgid "Metrics exposure changes" +#: ../../../CHANGELOG.md:693 +msgid "2024-03-05" msgstr "" -#: ../../../CHANGELOG.md:694 -msgid "This section is for people who are exposing monitoring metrics publicly, to be consumed by an external Prometheus server." +#: ../../../CHANGELOG.md:695 +msgid "Support for Draupnir-for-all" msgstr "" -#: ../../../CHANGELOG.md:696 -msgid "Previously, `matrix-nginx-proxy` was potentially password-protecting all `/metrics/*` endpoints with the same username and password (specified as plain-text in your `vars.yml` configuration file)." +#: ../../../CHANGELOG.md:697 +msgid "Thanks to [FSG-Cat](https://github.com/FSG-Cat), the playbook can now install [Draupnir for all](./docs/configuring-playbook-appservice-draupnir-for-all.md) (aka multi-instance Draupnir running in appservice mode)." msgstr "" -#: ../../../CHANGELOG.md:698 -msgid "From now on, there are new variables for doing roughly the same — `matrix_metrics_exposure_enabled`, `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users`. See the [Prometheus & Grafana](./docs/configuring-playbook-prometheus-grafana.md) docs page for details." +#: ../../../CHANGELOG.md:699 +msgid "This is an alternative to [running Draupnir in bot mode](./docs/configuring-playbook-bot-draupnir.md), which is still supported by the playbook." msgstr "" -#: ../../../CHANGELOG.md:700 -msgid "`matrix-nginx-proxy` is not acting as a \"global guardian\" anymore. Now, each role provides its own metrics exposure and protection by registering with Traefik. Nevertheless, all roles are wired (via playbook configuration in `group_vars/matrix_servers`) to obey these new `matrix_metrics_exposure_*` variables. We've eliminated the centralization, but have kept the ease of use. Now, you can also do per-service password-protection (with different credentials), should you need to do that for some reason." -msgstr "" - -#: ../../../CHANGELOG.md:702 -msgid "The playbook will tell you about all variables that you need to migrate during runtime, so rest assured — you shouldn't be able to miss anything!" +#: ../../../CHANGELOG.md:701 +msgid "The documentation page for [Draupnir for all](./docs/configuring-playbook-appservice-draupnir-for-all.md) contains more information on how to install it." msgstr "" #: ../../../CHANGELOG.md:704 -msgid "Matrix static files" +msgid "2024-02-19" msgstr "" #: ../../../CHANGELOG.md:706 -msgid "As mentioned above, static files like `/.well-known/matrix/*` or your base domain's `index.html` file (when [serving the base domain via the Matrix server](./docs/configuring-playbook-base-domain-serving.md) was enabled) were generated by the `matrix-base` or `matrix-nginx-proxy` roles and put into a `/matrix/static-files` directory on the server. Then `matrix-nginx-proxy` was serving all these static files." +msgid "Support for bridging to Facebook/Messenger via the new mautrix-meta bridge" msgstr "" #: ../../../CHANGELOG.md:708 -msgid "All of this has been extracted into a new `matrix-static-files` Ansible role that's part of the playbook. The static files generated by this new role still live at roughly the same place (`/matrix/static-files/public` directory, instead of `/matrix/static-files`)." +msgid "The [mautrix-facebook](./docs/configuring-playbook-bridge-mautrix-facebook.md) and [mautrix-instagram](./docs/configuring-playbook-bridge-mautrix-instagram.md) bridges are being [superseded by a new bridge](https://github.com/mautrix/facebook/issues/332) — the [mautrix-meta](https://github.com/mautrix/meta) bridge." msgstr "" #: ../../../CHANGELOG.md:710 -msgid "The playbook will migrate and update the `/.well-known/matrix/*` files automatically but not your own files in `nginx-proxy/data/matrix-domain/` you will need to back these up yourself otherwise they will be lost. It will also warn you about usage of old variable names, so you can adapt to the new names." +msgid "The playbook now supports the new mautrix-meta bridge — a single bridge, which can run in different modes and bridge to Messenger (via [Facebook](https://facebook.com/), Facebook over [Tor](https://www.torproject.org/) or via [Messenger](https://messenger.com/)) and [Instagram](https://instagram.com/). The playbook makes this bridge available via 2 separate Ansible roles, allowing you to easily run 2 instances of mautrix-meta, for bridging to both services at the same time." msgstr "" #: ../../../CHANGELOG.md:712 -msgid "A note on performance" +msgid "If you're using mautrix-facebook or mautrix-instagram right now, **you can still continue using the old bridges, but may wish to change to the new bridge implementations**. See:" msgstr "" #: ../../../CHANGELOG.md:714 -msgid "Some of you have been voicing their concerns (for a long time) about Traefik being too slow and nginx being better." +msgid "[Setting up Instagram bridging via Mautrix Meta](docs/configuring-playbook-bridge-mautrix-meta-instagram.md)" msgstr "" #: ../../../CHANGELOG.md:716 -msgid "Some online benchmarks support this by demonstrating slightly higher SSL-termination performance in favor of nginx. The upcoming Traefik v3 release is [said to](https://medium.com/beyn-technology/is-nginx-dead-is-traefik-v3-20-faster-than-traefik-v2-f28ffb7eed3e) improve Traefik's SSL performance by some 20%, but that still ends up being somewhat slower than nginx." +msgid "[Setting up Messenger bridging via Mautrix Meta](docs/configuring-playbook-bridge-mautrix-meta-messenger.md)" msgstr "" #: ../../../CHANGELOG.md:718 -msgid "We believe that using Traefik provides way too many benefits to worry about this minor performance impairment." +msgid "The documentation pages contain more information on how to migrate." msgstr "" -#: ../../../CHANGELOG.md:720 -msgid "The heaviest part of running a Matrix homeserver is all the slow and potentially inefficient things the homeserver (e.g. Synapse) is doing. These things affect performance much more than whatever reverse-proxy is in front. Your server will die the same way by joining the famously large **Matrix HQ** room, no matter which reverse-proxy you put in front." +#: ../../../CHANGELOG.md:721 +msgid "2024-02-14" msgstr "" -#: ../../../CHANGELOG.md:722 -msgid "Even our previously mentioned benchmarks (yielding ~1300 rps) are synthetic — hitting a useless `/_matrix/client/versions` endpoint. Real-use does much more than this." +#: ../../../CHANGELOG.md:723 +msgid "Much larger Synapse caches and cache auto-tuning enabled by default" msgstr "" -#: ../../../CHANGELOG.md:724 -msgid "If this is still not convincing enough for you and you want the best possible performance, consider [Fronting Traefik with another reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy) (thus having the slowest part — SSL termination — happen elsewhere) or [Using no reverse-proxy on the Matrix side at all](./docs/configuring-playbook-own-webserver.md#using-no-reverse-proxy-on-the-matrix-side-at-all). The playbook will not get in your way of doing that, but these options may make your life much harder. Performance comes at a cost, after all." +#: ../../../CHANGELOG.md:725 +msgid "Thanks to [FSG-Cat](https://github.com/FSG-Cat), the playbook now uses much larger caches and enables Synapse's [cache auto-tuning functionality](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caches-and-associated-values). This work and the default values used by the playbook are inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/deployment/synapse.html)." msgstr "" -#: ../../../CHANGELOG.md:726 -msgid "Migration procedure" +#: ../../../CHANGELOG.md:727 +msgid "The playbook has always used a very conservative cache factor (`matrix_synapse_caches_global_factor`) value of `0.5`, which may be OK for small and underactive deployments, but is not ideal for larger servers. Paradoxically, a small global cache factor value [does not necessarily decrease RAM usage as a whole](https://github.com/matrix-org/synapse/issues/3939)." msgstr "" -#: ../../../CHANGELOG.md:728 -msgid "The updated playbook will automatically perform some migration tasks for you:" +#: ../../../CHANGELOG.md:729 +msgid "The playbook now uses **a 20x larger cache factor** (currently `10`), adjusts a few other cache-related variables, and **enables cache auto-tuning** via the following variables:" msgstr "" -#: ../../../CHANGELOG.md:730 -msgid "It will stop and remove the `matrix-nginx-proxy` systemd service and container for you. This behavior cannot be disabled. It's essential that this service gets stopped, because it remaining running (and having container labels) may confuse Traefik as to where to route HTTP requests." +#: ../../../CHANGELOG.md:731 +msgid "`matrix_synapse_cache_autotuning_max_cache_memory_usage` — defaults to 1/8 of total RAM with a cap of 2GB; values are specified in bytes" msgstr "" #: ../../../CHANGELOG.md:732 -msgid "It will delete the `/matrix/nginx-proxy` directory and all files within it. You can disable this behavior by adding `matrix_playbook_migration_matrix_nginx_proxy_uninstallation_enabled: false` to your `vars.yml` configuration file. Doing so will leave its data around." +msgid "`matrix_synapse_cache_autotuning_target_cache_memory_usage` — defaults to 1/16 of total RAM with a cap of 1GB; values are specified in bytes" msgstr "" -#: ../../../CHANGELOG.md:734 -msgid "It will delete the `/matrix/ssl` directory and all files within it. You can disable this behavior by adding `matrix_playbook_migration_matrix_ssl_uninstallation_enabled: false` to your `vars.yml` configuration file. If you have some important certificates there for some reason, take them out or temporarily disable removal of these files until you do." +#: ../../../CHANGELOG.md:733 +msgid "`matrix_synapse_cache_autotuning_min_cache_ttl` — defaults to `30s`" msgstr "" -#: ../../../CHANGELOG.md:736 -msgid "It will tell you about all variables (`matrix_nginx_proxy_*` and many others — even from other roles) that have changed during this large nginx-elimination upgrade. You can disable this behavior by adding `matrix_playbook_migration_matrix_nginx_proxy_elimination_variable_transition_checks_enabled: false` to your `vars.yml` configuration file." +#: ../../../CHANGELOG.md:735 +msgid "These values should be good defaults for most servers, but may change over time as we experiment further." msgstr "" -#: ../../../CHANGELOG.md:738 -msgid "It will tell you about any leftover `matrix_nginx_proxy_*` variables in your `vars.yml` file. You can disable this behavior by adding `matrix_playbook_migration_matrix_nginx_proxy_leftover_variable_validation_checks_enabled: false` to your `vars.yml` configuration file." +#: ../../../CHANGELOG.md:737 +msgid "Refer to our new [Tuning caches and cache autotuning](docs/maintenance-synapse.md#tuning-caches-and-cache-autotuning) documentation section for more details." msgstr "" #: ../../../CHANGELOG.md:740 -msgid "It will tell you about any leftover `matrix_ssl_*` variables in your `vars.yml` file. You can disable this behavior by adding `matrix_playbook_migration_matrix_ssl_leftover_variable_checks_enabled: false` to your `vars.yml` configuration file." +msgid "2024-01-31" msgstr "" #: ../../../CHANGELOG.md:742 -msgid "We don't recommend changing these variables and suppressing warnings, unless you know what you're doing." +msgid "(Backward-compatibility break) Minor changes necessary for some people serving a static website at the base domain" msgstr "" #: ../../../CHANGELOG.md:744 -msgid "**Most people should just upgrade as per-normal**, bearing in mind that a lot has changed and some issues may arise. The playbook would guide you through renamed variables automatically." +msgid "This only affects people who are [Serving a static website at the base domain](./docs/configuring-playbook-base-domain-serving.md#serving-a-static-website-at-the-base-domain), but not managing its `index.html` through the playbook." msgstr "" #: ../../../CHANGELOG.md:746 -msgid "Conclusion" +msgid "That is, for people who have `matrix_static_files_file_index_html_enabled: false` in their `vars.yml` configuration, the playbook has a new default behavior. Since the playbook is not managing the `index.html` file, it will default to a more sensible way of handling the base domain — redirecting `https://example.com/` to `https://matrix.example.com/`, instead of serving a 404 page." msgstr "" #: ../../../CHANGELOG.md:748 -msgid "Thousands of lines of code were changed across hundreds of files. All addons (bridges, bots) were rewired in terms of container networking and in terms of how they reach the homeserver." +msgid "If you are managing your static website by yourself (by dropping files into `/matrix/static-files/public` somehow), then you probably don't wish for such redirection to happen. You can disable it by adding `matrix_static_files_container_labels_base_domain_root_path_redirection_enabled: false` to your `vars.yml` configuration file." msgstr "" -#: ../../../CHANGELOG.md:750 -msgid "I don't actively use all the ~100 components offered by the playbook (no one does), nor do I operate servers exercising all edge-cases. As such, issues may arise. Please have patience and report (or try to fix) these issues!" +#: ../../../CHANGELOG.md:751 +msgid "2024-01-20" msgstr "" #: ../../../CHANGELOG.md:753 -msgid "2024-01-14" +msgid "Support for more efficient (specialized) Synapse workers" msgstr "" #: ../../../CHANGELOG.md:755 -msgid "(Backward Compatibility) Configuration changes required for people fronting the integrated reverse-proxy webserver with another reverse-proxy" +msgid "Thanks to [Charles Wright](https://github.com/cvwright) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/), the playbook has [received support](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3100) for load-balancing the Synapse workload via [specialized workers](./docs/configuring-playbook-synapse.md#specialized-workers) which are supposed to work better than our old [generic workers](./docs/configuring-playbook-synapse.md#generic-workers) implementation." msgstr "" #: ../../../CHANGELOG.md:757 -msgid "If you're on the default setup (using the Traefik reverse-proxy as installed by the playbook), you don't need to do anything." +msgid "For now, playbook defaults remain unchanged and the `one-of-each` [workers preset](./docs/configuring-playbook-synapse.md#worker-presets) continues being the default. However, the default may change in the future. If you'd like to remain on this preset even if/when the defaults change, consider explicitly adding `matrix_synapse_workers_preset: one-of-each` to your `vars.yml` configuration." msgstr "" #: ../../../CHANGELOG.md:759 -msgid "People who are [Fronting the integrated Traefik reverse-proxy webserver with another reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy), as per our previous instructions are redefining `traefik_additional_entrypoints_auto` in their `vars.yml` configuration." +msgid "Our specialized workers setup is based on recommendations found in [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). What's special about our new setup is that we try to parse information out of the request (who the user is; which room is being operated on) and try to forward similar requests to the same worker. As an example, this means that once a worker caches some room information, subsequent requests for the same room will be routed to the same worker (which supposedly still has the room's state cached)." msgstr "" #: ../../../CHANGELOG.md:761 -msgid "Such a full variable redefinion is intrustive, because it prevents the playbook from injecting additional entrypoints into the Traefik webserver. In the future, the playbook may have a need to do so." +msgid "To get started, refer to our [Specialized workers](./docs/configuring-playbook-synapse.md#specialized-workers) documentation section." msgstr "" -#: ../../../CHANGELOG.md:763 -msgid "For this reason, we no longer recommend completely redefining `traefik_additional_entrypoints_auto`. The playbook now defines [various `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_*` variables in the `defaults/main.yml` file](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/roles/custom/matrix-base/defaults/main.yml) of the `matrix-base` role which can be used as a safer alternative to `traefik_additional_entrypoints_auto`." +#: ../../../CHANGELOG.md:764 +msgid "2024-01-17" msgstr "" -#: ../../../CHANGELOG.md:765 -msgid "Adapt your configuration as seen below:" +#: ../../../CHANGELOG.md:766 +msgid "Switching to Element's AGPLv3-licensed Synapse release" msgstr "" -#: ../../../CHANGELOG.md:798 -msgid "Also, feel free to read the [Fronting the integrated Traefik reverse-proxy webserver with another reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy) documentation section again for additional details." +#: ../../../CHANGELOG.md:768 +msgid "A few months ago, the [Element](https://element.io/) company has [announced](https://element.io/blog/element-to-adopt-agplv3/) that their work on the Synapse homeserver would no longer be available under the permissive [Apache-2.0 license](https://www.apache.org/licenses/LICENSE-2.0), but only under:" +msgstr "" + +#: ../../../CHANGELOG.md:770 +msgid "the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html) free-software license — the same license that this Ansible playbook has always used" +msgstr "" + +#: ../../../CHANGELOG.md:771 +msgid "a proprietary license, for those wishing for Element to [sell them an exception](https://gnu.org/philosophy/selling-exceptions.html) to the AGPLv3 license" +msgstr "" + +#: ../../../CHANGELOG.md:773 +msgid "You can also learn more in [this post](https://matrix.org/blog/2023/11/06/future-of-synapse-dendrite/) by the Matrix Foundation." +msgstr "" + +#: ../../../CHANGELOG.md:775 +msgid "The change has [already happened](https://element.io/blog/synapse-now-lives-at-github-com-element-hq-synapse/) and the first Synapse release under the new license is here: [v1.99.0](https://github.com/element-hq/synapse/releases/tag/v1.99.0)." +msgstr "" + +#: ../../../CHANGELOG.md:777 +msgid "There is no up-to-date alternative Synapse fork right now and this free-software (AGPLv3-licensed) playbook is definitely not against free-software licenses, so we are now switching to the Element-maintained Synapse release." +msgstr "" + +#: ../../../CHANGELOG.md:779 +msgid "**What does this mean to you?**" +msgstr "" + +#: ../../../CHANGELOG.md:781 +msgid "For most home users, it doesn't mean anything. Your installation will continue working as it should and you don't need to do anything." +msgstr "" + +#: ../../../CHANGELOG.md:783 +msgid "For people building commercial products on top of Synapse, they may have to either buy a license exception from Element (from what we hear, the fee depends on the number of monthly-active users on your instance) or they may need to release all related code as free-software (which is what we've been doing at [etke.cc](https://etke.cc/) ([here](https://gitlab.com/etke.cc)) all along)." +msgstr "" + +#: ../../../CHANGELOG.md:785 +msgid "We're no lawyers and this changelog entry does not aim to give you the best legal advice, so please research on your own!" +msgstr "" + +#: ../../../CHANGELOG.md:787 +msgid "If you'd like to continue using the old Apache-2.0-licensed Synapse (for a while longer anyway), the playbook makes it possible by introducing a new Ansible variable. You can do it like this:" +msgstr "" + +#: ../../../CHANGELOG.md:799 +msgid "Notes:" msgstr "" #: ../../../CHANGELOG.md:801 -msgid "2024-01-13" +msgid "if you had already upgraded Synapse to `v1.99.0` by running this playbook, you will still be able to downgrade to `v1.98.0`, because both releases use the same database schema version (`SCHEMA_COMPAT_VERSION = 83` — see [here for v1.98.0](https://github.com/element-hq/synapse/blob/v1.98.0/synapse/storage/schema/__init__.py#L131-L134) and [here for v1.99.0](https://github.com/element-hq/synapse/blob/v1.99.0/synapse/storage/schema/__init__.py#L137-L140)). More details on Synapse's database schema are available [here](https://element-hq.github.io/synapse/develop/development/database_schema.html). It appears that there are no new database migrations introduced in `v1.99.0`, so going back to the older release is possible. This is not guaranteed to hold true for future Synapse releases, so if you're seeing this early-enough, consider pinning the version and organization before re-running the playbook and getting upgraded to the latest version" msgstr "" #: ../../../CHANGELOG.md:803 -msgid "matrix-reminder-bot update with more secure (backward-incompatible) default settings" +msgid "running an outdated homeserver exposes you to security issues and incompatibilities. Only consider doing this as a short-term solution." msgstr "" #: ../../../CHANGELOG.md:805 -msgid "**TLDR**: your updated (to [v0.3.0](https://github.com/anoadragon453/matrix-reminder-bot/releases/tag/v0.3.0)) [matrix-reminder-bot](./docs/configuring-playbook-bot-matrix-reminder-bot.md) is now more secure. By default, like other bridges/bots managed by the playbook, it will only provide its services to users of your own server (not to anyone, even across the Matrix Federation). If that's fine, there's nothing you need to do." +msgid "2024-01-16" msgstr "" #: ../../../CHANGELOG.md:807 -msgid "Maintenance of [matrix-reminder-bot](./docs/configuring-playbook-bot-matrix-reminder-bot.md) has been picked up by [Kim Brose](https://github.com/HarHarLinks) and [@svierne](https://github.com/svierne)." +msgid "`Draupnir` has been relicensed to AFL-3.0" msgstr "" #: ../../../CHANGELOG.md:809 -msgid "Thanks to them, a new [v0.3.0](https://github.com/anoadragon453/matrix-reminder-bot/releases/tag/v0.3.0) release is out. The new version is now available for the ARM64 architecture, so playbook users on this architecture will no longer need to wait for [self-building](./docs/self-building.md) to happen." +msgid "As of [#204](https://github.com/the-draupnir-project/Draupnir/pull/204) Draupnir changed its licence to AFL-3.0 from the CSL licence. This change affects playbook users who could not run Draupnir under the old license restrictions. The new license is considerably less restrictive and is OSI approved. Draupnir version v1.86.0 and later are covered by this license change." msgstr "" #: ../../../CHANGELOG.md:811 -msgid "The new version also comes with new `allowlist` and `blocklist` settings, which make it possible to restrict who can use the bot. Previously anyone, even across the Matrix Federation could talk to it and schedule reminders." +msgid "2024-01-15" msgstr "" #: ../../../CHANGELOG.md:813 -msgid "The playbook defaults all bridges and bots (where possible) to only be exposed to users of the current homeserver, not users across federation. Thanks to the new version of this bot making such a restriction possible, we're now making use of it. The playbook (via its `group_vars/matrix_servers` file) automatically enables the `allowlist` (`matrix_bot_matrix_reminder_bot_allowlist_enabled: true`) and configures it in such a way (`matrix_bot_matrix_reminder_bot_allowlist_regexes_auto`) so as to restrict the bot to your homeserver's users." +msgid "Goodbye, `matrix-nginx-proxy` 🪦" msgstr "" #: ../../../CHANGELOG.md:815 -msgid "If you need **to undo or tweak these security improvements**, you can change your `vars.yml` file to:" +msgid "**TLDR**: All traces of the `matrix-nginx-proxy` reverse-proxy component are now gone. This brought about many other internal changes (and security improvements), so setups may need minor adjustments or suffer some (temporary) breakage. People who have been on the Traefik-native setup may upgrade without much issues. Those running their own Traefik instance may need minor changes. People who have been postponing the migration away from `matrix-nginx-proxy` (for more than a year already!) will now finally need to do something about it." msgstr "" #: ../../../CHANGELOG.md:817 -msgid "disable the allowlist (`matrix_bot_matrix_reminder_bot_allowlist_enabled: false`), making the bot allow usage by anyone, anywhere" +msgid "Backstory on `matrix-nginx-proxy`" msgstr "" #: ../../../CHANGELOG.md:819 -msgid "inject additional allowed servers or users by adding **additional** (on top of the default allowlist in `matrix_bot_matrix_reminder_bot_allowlist_regexes_auto`) custom regexes in the `matrix_bot_matrix_reminder_bot_allowlist_regexes_custom` list variable (see the [syntax reference](https://github.com/anoadragon453/matrix-reminder-bot/blob/1e910c0aa3469d280d93ee7e6c6d577227a3460c/sample.config.yaml#L43-L49))" +msgid "We gather here today to celebrate the loss of a once-beloved component in our stack — `matrix-nginx-proxy`. It's been our [nginx](https://nginx.org/)-based reverse-proxy of choice since the [first commit](https://github.com/spantaleev/matrix-docker-ansible-deploy/tree/87f5883f2455fb115457b65f267f17de305c053c) of this playbook, 7 years ago." msgstr "" #: ../../../CHANGELOG.md:821 -msgid "override the default allowlist (in the `group_vars/matrix_servers` file) by redefining `matrix_bot_matrix_reminder_bot_allowlist_regexes_auto`" +msgid "For 6 years, `matrix-nginx-proxy` has been the front-most reverse-proxy in our setup (doing SSL termination, etc.). After [transitioning to Traefik last year](#traefik-is-the-default-reverse-proxy-now), `matrix-nginx-proxy` took a step back. Nevertheless, since it was so ingrained into the playbook, it still remained in use — even if only internally. Despite our warnings of its imminent death, many of you have indubitably continued to use it instead of Traefik. Its suffering continued for too long, because it served many different purposes and massive effort was required to transition them to others." msgstr "" -#: ../../../CHANGELOG.md:824 -msgid "2024-01-05" +#: ../../../CHANGELOG.md:823 +msgid "To us, `matrix-nginx-proxy` was:" +msgstr "" + +#: ../../../CHANGELOG.md:825 +msgid "an [nginx](https://nginx.org/)-based reverse-proxy" msgstr "" #: ../../../CHANGELOG.md:826 -msgid "matrix-mailer has been replaced by the exim-relay external role" +msgid "an Ansible role organizing the work of [certbot](https://certbot.eff.org/) — retrieving free [Let's Encrypt](https://letsencrypt.org/) SSL certificates for `matrix-nginx-proxy` and for the [coturn TURN server](./docs/configuring-playbook-turn.md)" +msgstr "" + +#: ../../../CHANGELOG.md:827 +msgid "a central component for reverse-proxying to the [long list of services](./docs/configuring-playbook.md) supported by the playbook. As such, it became a dependency that all these services had to inject themselves into during runtime" msgstr "" #: ../../../CHANGELOG.md:828 -#: ../../../CHANGELOG.md:1468 -msgid "We're continuing our effort to make [the playbook use external roles for some things](#the-playbook-now-uses-external-roles-for-some-things), so as to avoid doing everything ourselves and to facilitate code re-use." +msgid "an intermediary through which addons (bridges, bots) communicated with the homeserver. Going through an intermediary (instead of directly talking to the homeserver) is useful when certain components (like [matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md) or [matrix-corporal](./docs/configuring-playbook-matrix-corporal.md)) are enabled, because it lets these services \"steal routes\" from the homeserver" +msgstr "" + +#: ../../../CHANGELOG.md:829 +msgid "a webserver for serving the `/.well-known/matrix` static files (generated by the `matrix-base` role until now)" msgstr "" #: ../../../CHANGELOG.md:830 -msgid "The `matrix-mailer` role has been moved to its own repository ([ansible-role-exim-relay](https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay)) that this playbook now includes." +msgid "a webserver [serving your base domain](./docs/configuring-playbook-base-domain-serving.md) (and also generating the `index.html` page for it)" msgstr "" -#: ../../../CHANGELOG.md:832 -msgid "To migrate:" +#: ../../../CHANGELOG.md:831 +msgid "a central component providing global [HTTP Basic Auth](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) password-protection for all `/metrics` endpoints when metrics were exposed publicly for consumption from a remote Prometheus server" msgstr "" -#: ../../../CHANGELOG.md:834 -msgid "pull the playbook changes, as usual" +#: ../../../CHANGELOG.md:833 +msgid "Talk about a jack of all trades! The [UNIX philosophy](https://en.wikipedia.org/wiki/Unix_philosophy) (and Docker container philosophy) of \"do one thing and do it well\" had been severely violated for too long." msgstr "" #: ../../../CHANGELOG.md:835 -msgid "update your roles (run `just roles` or `make roles`)" -msgstr "" - -#: ../../../CHANGELOG.md:836 -msgid "update your `vars.yml`, renaming `matrix_mailer`-prefixed variables to `exim_relay`-prefixed ones (e.g. `matrix_mailer_sender_address` -> `exim_relay_sender_address`). If you find none, it means you're using the default configuration and your migraiton job is even simpler." +msgid "On a related note, we also had a large chain of reverse-proxies in the mix. In the worst case, it was something like this: (Traefik -> `matrix-nginx-proxy:8080` -> `matrix-nginx-proxy:12080` -> `matrix-synapse-reverse-proxy-companion:8008` -> `matrix-synapse:8008`)." msgstr "" #: ../../../CHANGELOG.md:837 -msgid "re-run the playbook (`install-all` or `setup-all`)" +msgid "Due to complexity and the playbook's flexibility (trying to accommodate a mix of tens of components), many layers of indirection were necessary. We do like reverse-proxies, but… not quite enough to enjoy going through a chain of ~4 of them before reaching the target service." msgstr "" #: ../../../CHANGELOG.md:839 -msgid "The playbook will take care of stopping the old `matrix-mailer` systemd service, relocating its directory and restarting it under the new name (`matrix-exim-relay.service`)." +msgid "After **a ton of work** in the last weeks (200+ commits, which changed 467 files - 8684 insertions and 8913 deletions), **we're finally saying goodbye** to `matrix-nginx-proxy`." msgstr "" -#: ../../../CHANGELOG.md:842 -msgid "2024-01-02" +#: ../../../CHANGELOG.md:841 +msgid "Going Traefik-native and cutting out all middlemen" msgstr "" -#: ../../../CHANGELOG.md:844 -msgid "mautrix-signal now powered by the new Go-based bridge" +#: ../../../CHANGELOG.md:843 +msgid "In our new setup, you'll see the bare minimum number of reverse-proxies." msgstr "" -#: ../../../CHANGELOG.md:846 -msgid "The old Python-based [mautrix-signal](https://github.com/mautrix/signal) bridge is no longer maintained upstream. It's also known to have issues linking new devices." +#: ../../../CHANGELOG.md:845 +msgid "In most cases, there's only Traefik and all services being registered directly with it. When [Synapse workers](./docs/configuring-playbook-synapse.md#load-balancing-with-workers) are enabled, `matrix-synapse-reverse-proxy-companion` remains as an extra reverse-proxy that requests go through (for load-balancing to the correct Synapse worker), but in all other cases services are exposed directly." msgstr "" -#: ../../../CHANGELOG.md:848 -msgid "It seems like the path forward is to switch to the new mautrix-signal bridge written in Golang, which we did thanks to [PR #3031](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3041) by [Pierre 'McFly' Marty](https://github.com/pm-McFly)." +#: ../../../CHANGELOG.md:847 +msgid "This reduces \"network\" hops (improving performance) and also decreases the number of components (containers). Each Ansible role in our setup is now independent and doesn't need to interact with other roles during runtime." msgstr "" -#: ../../../CHANGELOG.md:850 -msgid "The playbook should **automatically migrate your mautrix-signal installation to the new bridge code**. You will **need to relink all your devices** to continue your bridged conversations." +#: ../../../CHANGELOG.md:849 +msgid "Traefik now has an extra job" +msgstr "" + +#: ../../../CHANGELOG.md:851 +msgid "Previously, **Traefik had a single purpose** — being the main reverse-proxy. It was either front-most (terminating SSL, etc.) or you were [fronting Traefik with your own other reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy). In any case — it had this central (yet decentralized) job." msgstr "" #: ../../../CHANGELOG.md:853 -msgid "2023-10-23" +msgid "Now, **Traefik has one more role** — it serves as an intermediary which allows addon services (bridges, bots, etc.) to communicate with the homeserver. As mentioned above, such an intermediary service is not strictly necessary in all kinds of setups, but more complex setups (including [matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md) or [matrix-corporal](./docs/configuring-playbook-matrix-corporal.md)) benefit from it." msgstr "" #: ../../../CHANGELOG.md:855 -msgid "Enabling `allow_public_rooms_over_federation` by default for Synapse" +msgid "To perform this new role, Traefik now has a new internal [entrypoint](https://doc.traefik.io/traefik/routing/entrypoints/) called `matrix-internal-matrix-client-api`. All homeservers (Conduit, Dendrite, Synapse and even `matrix-synapse-reverse-proxy-companion`) and homeserver-related core services ([matrix-media-repo](./docs/configuring-playbook-matrix-media-repo.md), [matrix-corporal](./docs/configuring-playbook-matrix-corporal.md) and potentially others) register their routes (using [container labels](https://docs.docker.com/config/labels-custom-metadata/)) not only on the public entrypoints (`web-secure`, `matrix-federation`), but also on this new internal entrypoint." msgstr "" #: ../../../CHANGELOG.md:857 -msgid "**TDLR**: if your Matrix server is federating (which it mostly likely is, unless you've [disabled federation](docs/configuring-playbook-federation.md#disabling-federation)), your public rooms will not only be joinable across federation (as they've always been), but from now on will be discoverable (made available as a list across federation). We're changing this by flipping the value for Synapse's `allow_public_rooms_over_federation` setting to `true`, going against the upstream default. Servers that disable federation are not affected. Servers that have public rooms which are not published to the room directory are also not affected." +msgid "Doing so, services can contact Traefik on this entrypoint's dedicated port (the URL defaults to `http://matrix-traefik:8008`) and reach the homeserver Client-Server API as they expect. Internally, Traefik takes care of the routing to the correct service." msgstr "" #: ../../../CHANGELOG.md:859 -msgid "We generally try to stick to the default configuration for Synapse (and all other components), unless these defaults seem wrong or harmful. One such previous case from a few months ago was us [Enabling `forget_rooms_on_leave` by default for Synapse](#enabling-forget_rooms_on_leave-by-default-for-synapse) — the default value was making Synapse more wasteful of resources by default." +msgid "We've also considered keeping it simple and having services talk to the homeserver over the public internet (e.g. `https://matrix.example.com`) thus reusing all existing Traefik routing labels. In this scenario, performance was incredibly poor (e.g. 70 rps, instead of 1400 rps) due to TLS and networking overhead. The need for fast internal communication (via the new internal non-TLS-enabled Traefik entrypoint) is definitely there. In our benchmarks, Traefik even proved more efficient than nginx at doing this: ~1200 rps for Traefik compared to ~900 rps for nginx (out of ~1400 rps when talking to the Synapse homeserver directly)." msgstr "" #: ../../../CHANGELOG.md:861 -msgid "Today, we're going against upstream defaults again and flipping the `allow_public_rooms_over_federation` configuration option to `true`. This way, public rooms on your server will be made discoverable by others via federation, using the [`GET /_matrix/federation/v1/publicRooms` of the Server-Server API](https://spec.matrix.org/v1.8/server-server-api/#get_matrixfederationv1publicrooms)." +msgid "Traefik serving this second purpose has a few downsides:" msgstr "" #: ../../../CHANGELOG.md:863 -msgid "The upstream Synapse default is `false` (disabled), so that public rooms are not exposed for other servers to discover (learn about their existence). Nevertheless, even if these rooms are not exposed (listed) for discovery, they are **still joinable** by anyone who knows their address or is invited to the room by an existing member." +msgid "Traefik becomes a runtime dependency for all homeserver-dependant container services" msgstr "" -#: ../../../CHANGELOG.md:865 -msgid "**We go against the upstream default** in an effort to make Matrix federation more useful — a public room should be globally public — not only joinable, but also discoverable across federation." +#: ../../../CHANGELOG.md:864 +msgid "all homeserver-dependant services now need to be connected to the `traefik` container network, even if they don't need public internet exposure" msgstr "" -#: ../../../CHANGELOG.md:867 -msgid "The **historical reasoning** behind this change is as follows:" +#: ../../../CHANGELOG.md:866 +msgid "Despite these downsides (which the playbook manages automatically), we believe it's still a good compromise given the amount of complexity it eliminates and the performance benefits it yields. One alternative we've [considered](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3045#issuecomment-1867327001) was adding a new intermediary service (e.g. `matrix-homeserver-proxy` powered by nginx), but this both had much higher complexity (one more component in the mix; duplication of effort to produce nginx-compatible route definitions for it) and slightly worse performance (see above)." msgstr "" -#: ../../../CHANGELOG.md:869 -msgid "`allow_public_rooms_over_federation` seems to have been enabled by default for Synapse until v1.7.0 (~2019), just like we believe it should be for a globally-federating network — rooms should be joinable and discoverable across federation." +#: ../../../CHANGELOG.md:868 +msgid "People running the default Traefik setup do not need to do anything to make Traefik take on this extra job. Your Traefik configuration will be updated automatically." msgstr "" -#: ../../../CHANGELOG.md:871 -msgid "In Synapse v1.7.0 (~2019), `allow_public_rooms_over_federation` [got disabled](https://github.com/element-hq/synapse/blob/e9069c9f919685606506f04527332e83fbfa44d9/docs/upgrade.md?plain=1#L1877-L1891) by default in a [security-by-obscurity](https://en.wikipedia.org/wiki/Security_through_obscurity) workaround for misconfigured servers. See the [Avoiding unwelcome visitors on private Matrix servers](https://matrix.org/blog/2019/11/09/avoiding-unwelcome-visitors-on-private-matrix-servers/) `matrix.org` blog article. We believe that people wishing for a truly private server, should [disable federation](docs/configuring-playbook-federation.md#disabling-federation), instead of having a fully-federating server and trying to hide its public rooms. We also provide other workarounds below. We (and the Synapse team, obviously) believe that Matrix should federate by default, so federating the public room list seems to make sense." +#: ../../../CHANGELOG.md:870 +msgid "**People running their own Traefik reverse-proxy need to do [minor adjustments](#people-managing-their-own-traefik-instance-need-to-do-minor-changes)**, as described in the section below." msgstr "" -#: ../../../CHANGELOG.md:873 -msgid "[etke.cc](https://etke.cc/) has been developing the free-software [Matrix Rooms Search](https://github.com/etkecc/mrs) project for a while now. One public (demo) instance of it is hosted at [matrixrooms.info](https://matrixrooms.info/). This search engine tries to go through the Matrix federation and discover & index public rooms to allow people to find them. We believe it's vital for Matrix (and any chat or social network for that matter) to be more discoverable, so that people can find communities and others to talk to. Today (on 23rd of October 2023), `matrixrooms.info` is indexing `23066` Matrix servers. Of these, only `1567` servers (7%) are making their public rooms discoverable. Who knows what wonderful communities and rooms are available on these 93% other Matrix servers that are supposedly federating, but are still gate-keeping their public room list. Indubitably, many of these servers are hosted via matrix-docker-ansible-deploy, so we feel partially responsible for making Matrix federation less useful." +#: ../../../CHANGELOG.md:872 +msgid "You may disable Traefik acting as an intermediary by explicitly setting `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_enabled` to `false`. Services would then be configured to talk to the homeserver directly, giving you a slight performance boost and a \"simpler\" Traefik setup. However, such a configuration is less tested and will cause troubles, especially if you enable more services (like `matrix-media-repo`, etc.) in the future. As such, it's not recommended." msgstr "" -#: ../../../CHANGELOG.md:875 -msgid "Here are **actions you may wish to take** as a result of this change:" +#: ../../../CHANGELOG.md:874 +msgid "People managing their own Traefik instance need to do minor changes" msgstr "" -#: ../../../CHANGELOG.md:877 -msgid "(recommended) embrace the new default. If your Matrix server is federating, your public rooms have always been joinable across federation anyway. Exposing the list of public rooms does no harm and more-so does good by contributing to the usefulness of the Matrix network by facilitating room discovery." +#: ../../../CHANGELOG.md:876 +msgid "This section is for people [managing their own Traefik instance on the Matrix server](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you). Those [using Traefik managed by the playbook](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-the-playbook) don't need to do any changes." msgstr "" -#: ../../../CHANGELOG.md:879 -msgid "(switch to a better way of doings things on your semi-private server) The problem that the Synapse team appears to have solved by flipping the `allow_public_rooms_over_federation` default in Synapse v1.7.0 seems to for \"mostly private\" servers, which federate and have a bunch of rooms made public (and published in their room directory) in an effort to allow people on the same homeserver to easily find and join them (self-onboarding). With the introduction of Matrix Spaces, you can reorganize your flow around spaces — you can auto-join your users to a Matrix Space (via Synapse's `auto_join_rooms` setting — controlled by our `matrix_synapse_auto_join_rooms` variable), then add a bunch of rooms to the space and make them joinable by people belonging to the space. That is to say, do not make rooms public and do not publish them to the room directory unless they are really public. Instead, use other mechanisms for semi-public rooms or private rooms. One alternative is to stick to what you're doing (public rooms published to your rooms directory) but having a `m.federate: true` flag set during creation (clients like Element Web have a nice UI checkbox for this) to explicitly disable federation for them." +#: ../../../CHANGELOG.md:878 +msgid "Because [Traefik has an extra job now](#traefik-now-has-an-extra-job), you need to adapt your configuration to add the additional `matrix-internal-matrix-client-api` entrypoint and potentially configure the `matrix_playbook_reverse_proxy_container_network` variable. See the [Traefik managed by you](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you) documentation section for more details." msgstr "" -#: ../../../CHANGELOG.md:881 -msgid "(keeping the old behavior) if you wish to keep doing what you're doing (keeping your Matrix server federating, but hiding its public rooms list), add `matrix_synapse_allow_public_rooms_over_federation: false` to your `vars.yml` configuration. This restores the old behavior. You may also consider [disabling federation](docs/configuring-playbook-federation.md#disabling-federation) completely instead of relying on security-by-obscurity measures." +#: ../../../CHANGELOG.md:880 +msgid "People fronting Traefik with another reverse proxy need to do minor changes" +msgstr "" + +#: ../../../CHANGELOG.md:882 +msgid "We've already previously mentioned that you need to do some minor [configuration changes related to `traefik_additional_entrypoints_auto`](#backward-compatibility-configuration-changes-required-for-people-fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy)." msgstr "" #: ../../../CHANGELOG.md:884 -msgid "2023-10-18" +msgid "If you don't do these changes (switching from `traefik_additional_entrypoints_auto` to multiple other variables), your Traefik setup will not automatically receive the new `matrix-internal-matrix-client-api` Traefik entrypoint and Traefik would not be able to perform [its new duty of connecting addons with the homeserver](#traefik-now-has-an-extra-job)." msgstr "" #: ../../../CHANGELOG.md:886 -msgid "Postgres parameters are automatically tuned now" +msgid "Supported reverse proxy types are now fewer" msgstr "" #: ../../../CHANGELOG.md:888 -msgid "The playbook has provided some hints about [Tuning PostgreSQL](docs/maintenance-postgres.md#tuning-postgresql) for quite a while now." +msgid "This section is for people using a more custom reverse-proxy setup — those having `matrix_playbook_reverse_proxy_type` set to a value different than the default (`playbook-managed-traefik`)." msgstr "" #: ../../../CHANGELOG.md:890 -msgid "From now on, the [Postgres Ansible role](https://github.com/mother-of-all-self-hosting/ansible-role-postgres) automatically tunes your Postgres configuration with the same [calculation logic](https://github.com/le0pard/pgtune/blob/master/src/features/configuration/configurationSlice.js) that powers https://pgtune.leopard.in.ua/." +msgid "Previously, we allowed you to set `matrix_playbook_reverse_proxy_type` to 7 different values to accommodate various reverse-proxy setups." msgstr "" #: ../../../CHANGELOG.md:892 -msgid "Our [Tuning PostgreSQL](docs/maintenance-postgres.md#tuning-postgresql) documentation page has details about how you can turn auto-tuning off or adjust the automatically-determined Postgres configuration parameters manually." +msgid "The complexity of this is too high, so we only support 3 values right now:" msgstr "" #: ../../../CHANGELOG.md:894 -msgid "People who [enable load-balancing with Synapse workers](docs/configuring-playbook-synapse.md#load-balancing-with-workers) no longer need to increase the maximum number of Postgres connections manually (previously done via `postgres_process_extra_arguments`). There's a new variable (`postgres_max_connections`) for controlling this number and the playbook automatically raises its value from `200` to `500` for setups which enable workers." +msgid "(the default) `playbook-managed-traefik`, when you're [using Traefik managed by the playbook](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-the-playbook)" msgstr "" -#: ../../../CHANGELOG.md:897 -msgid "2023-08-31" +#: ../../../CHANGELOG.md:895 +msgid "`other-traefik-container`, when you're [managing your own Traefik instance on the Matrix server](./docs/configuring-playbook-own-webserver.md#traefik-managed-by-you)" msgstr "" -#: ../../../CHANGELOG.md:899 -msgid "SchildiChat Web support" +#: ../../../CHANGELOG.md:896 +msgid "`none`, when you wish for [no reverse-proxy integration to be done at all](./docs/configuring-playbook-own-webserver.md#using-no-reverse-proxy-on-the-matrix-side-at-all)" msgstr "" -#: ../../../CHANGELOG.md:901 -msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) client." +#: ../../../CHANGELOG.md:898 +msgid "The `none` value is not recommended and may not work adequately, due to lack of testing and [Traefik's new responsibilities](#traefik-now-has-an-extra-job) in our setup." msgstr "" -#: ../../../CHANGELOG.md:903 -msgid "See our [Configuring SchildiChat Web](docs/configuring-playbook-client-schildichat-web.md) documentation to get started." +#: ../../../CHANGELOG.md:900 +msgid "**Previous values that are now gone** (and the playbook would report them as such) are: `playbook-managed-nginx`, `other-nginx-non-container`, `other-on-same-host` and `other-on-another-host`." msgstr "" -#: ../../../CHANGELOG.md:906 -msgid "2023-08-23" +#: ../../../CHANGELOG.md:902 +msgid "If you were using these values as a way to stay away from Traefik, you now have 2 options:" msgstr "" -#: ../../../CHANGELOG.md:908 -msgid "mautrix-wsproxy support" +#: ../../../CHANGELOG.md:904 +msgid "(recommended) [Fronting Traefik with another reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy)" msgstr "" -#: ../../../CHANGELOG.md:910 -msgid "Thanks to [Johan Swetzén](https://github.com/jswetzen)'s efforts (who finished what was started by [James Reilly](https://github.com/hanthor) and [Shreyas Ajjarapu](https://github.com/shreyasajj)), the playbook now supports bridging to Android SMS and Apple iMessage via the [mautrix-wsproxy](https://github.com/mautrix/wsproxy) service (in combination with a [mautrix-imessage](https://github.com/mautrix/imessage) bridge running on your Mac or Android phone)." +#: ../../../CHANGELOG.md:905 +msgid "(not recommended) [Using no reverse-proxy on the Matrix side at all](./docs/configuring-playbook-own-webserver.md#using-no-reverse-proxy-on-the-matrix-side-at-all) and reverse-proxying to each and every service manually" msgstr "" -#: ../../../CHANGELOG.md:912 -msgid "See our [Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage](docs/configuring-playbook-bridge-mautrix-wsproxy.md) documentation page for getting started." +#: ../../../CHANGELOG.md:907 +msgid "Container networking changes" +msgstr "" + +#: ../../../CHANGELOG.md:909 +msgid "Now that `matrix-nginx-proxy` is not in the mix, it became easier to clear out some other long-overdue technical debt." +msgstr "" + +#: ../../../CHANGELOG.md:911 +msgid "Since the very beginning of this playbook, all playbook services were connected to a single (shared) `matrix` container network. Later on, some additional container networks appeared, but most services (database, etc.) still remained in the `matrix` container network. This meant that any random container in this network could try to talk (or attack) the Postgres database operating in the same `matrix` network." +msgstr "" + +#: ../../../CHANGELOG.md:913 +msgid "Moving components (especially the database) into other container networks was difficult — it required changes to many other components to ensure correct connectivity." msgstr "" #: ../../../CHANGELOG.md:915 -msgid "2023-07-24" +msgid "All the hard work has been done now. We've added much more isolation between services by splitting them up into separate networks (`matrix-homeserver`, `matrix-addons`, `matrix-monitoring`, `matrix-exim-relay`, etc). Components are only joined to the networks they need and should (for the most part) not be able to access unrelated things." msgstr "" #: ../../../CHANGELOG.md:917 -msgid "matrix-registration-bot usage changed" +msgid "Carrying out these container networking changes necessitated modifying many components, so **we're hoping not too many bugs were introduced in the process**." msgstr "" #: ../../../CHANGELOG.md:919 -msgid "[matrix-registration-bot](docs/configuring-playbook-bot-matrix-registration-bot.md) got some updates and now supports password-only-based login. Therefore the bot now doesn't need any manual configuration except setting a password in your `vars.yml`. The bot will be registered as admin and access tokens will be obtained automatically by the bot." +msgid "We've refrained from creating too many container networks (e.g. one for each component), to avoid exhausting Docker's default network pool and contaminating the container networks list too much." msgstr "" #: ../../../CHANGELOG.md:921 -msgid "**For existing users** You need to set `matrix_bot_matrix_registration_bot_bot_password` if you previously only used `matrix_bot_matrix_registration_bot_bot_access_token`. Please also remove the following deprecated settings" +msgid "Metrics exposure changes" msgstr "" #: ../../../CHANGELOG.md:923 -msgid "`matrix_bot_matrix_registration_bot_bot_access_token`" +msgid "This section is for people who are exposing monitoring metrics publicly, to be consumed by an external Prometheus server." msgstr "" -#: ../../../CHANGELOG.md:924 -msgid "`matrix_bot_matrix_registration_bot_api_token`" +#: ../../../CHANGELOG.md:925 +msgid "Previously, `matrix-nginx-proxy` was potentially password-protecting all `/metrics/*` endpoints with the same username and password (specified as plain-text in your `vars.yml` configuration file)." msgstr "" #: ../../../CHANGELOG.md:927 -msgid "2023-07-21" +msgid "From now on, there are new variables for doing roughly the same — `matrix_metrics_exposure_enabled`, `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users`. See the [Prometheus & Grafana](./docs/configuring-playbook-prometheus-grafana.md) docs page for details." msgstr "" #: ../../../CHANGELOG.md:929 -msgid "mautrix-gmessages support" +msgid "`matrix-nginx-proxy` is not acting as a \"global guardian\" anymore. Now, each role provides its own metrics exposure and protection by registering with Traefik. Nevertheless, all roles are wired (via playbook configuration in `group_vars/matrix_servers`) to obey these new `matrix_metrics_exposure_*` variables. We've eliminated the centralization, but have kept the ease of use. Now, you can also do per-service password-protection (with different credentials), should you need to do that for some reason." msgstr "" #: ../../../CHANGELOG.md:931 -msgid "Thanks to [Shreyas Ajjarapu](https://github.com/shreyasajj)'s efforts, the playbook now supports bridging to [Google Messages](https://messages.google.com/) via the [mautrix-gmessages](https://github.com/mautrix/gmessages) bridge. See our [Setting up Mautrix Google Messages bridging](docs/configuring-playbook-bridge-mautrix-gmessages.md) documentation page for getting started." +msgid "The playbook will tell you about all variables that you need to migrate during runtime, so rest assured — you shouldn't be able to miss anything!" msgstr "" -#: ../../../CHANGELOG.md:934 -msgid "2023-07-17" +#: ../../../CHANGELOG.md:933 +msgid "Matrix static files" msgstr "" -#: ../../../CHANGELOG.md:936 -msgid "matrix-media-repo support" +#: ../../../CHANGELOG.md:935 +msgid "As mentioned above, static files like `/.well-known/matrix/*` or your base domain's `index.html` file (when [serving the base domain via the Matrix server](./docs/configuring-playbook-base-domain-serving.md) was enabled) were generated by the `matrix-base` or `matrix-nginx-proxy` roles and put into a `/matrix/static-files` directory on the server. Then `matrix-nginx-proxy` was serving all these static files." msgstr "" -#: ../../../CHANGELOG.md:938 -msgid "Thanks to [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/), the playbook can now set up [matrix-media-repo](https://github.com/turt2live/matrix-media-repo) — an alternative way to store homeserver media files, powered by a homeserver-independent implementation which supports S3 storage, IPFS, deduplication and other advanced features." +#: ../../../CHANGELOG.md:937 +msgid "All of this has been extracted into a new `matrix-static-files` Ansible role that's part of the playbook. The static files generated by this new role still live at roughly the same place (`/matrix/static-files/public` directory, instead of `/matrix/static-files`)." msgstr "" -#: ../../../CHANGELOG.md:940 -msgid "To learn more see our [Storing Matrix media files using matrix-media-repo](docs/configuring-playbook-matrix-media-repo.md) documentation page." +#: ../../../CHANGELOG.md:939 +msgid "The playbook will migrate and update the `/.well-known/matrix/*` files automatically but not your own files in `nginx-proxy/data/matrix-domain/` you will need to back these up yourself otherwise they will be lost. It will also warn you about usage of old variable names, so you can adapt to the new names." +msgstr "" + +#: ../../../CHANGELOG.md:941 +msgid "A note on performance" msgstr "" #: ../../../CHANGELOG.md:943 -msgid "2023-05-25" +msgid "Some of you have been voicing their concerns (for a long time) about Traefik being too slow and nginx being better." msgstr "" #: ../../../CHANGELOG.md:945 -msgid "Enabling `forget_rooms_on_leave` by default for Synapse" +msgid "Some online benchmarks support this by demonstrating slightly higher SSL-termination performance in favor of nginx. The upcoming Traefik v3 release is [said to](https://medium.com/beyn-technology/is-nginx-dead-is-traefik-v3-20-faster-than-traefik-v2-f28ffb7eed3e) improve Traefik's SSL performance by some 20%, but that still ends up being somewhat slower than nginx." msgstr "" #: ../../../CHANGELOG.md:947 -msgid "With the [Synapse v1.84.0 update](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2698), we've also **changed the default value** of the `forget_rooms_on_leave` setting of Synapse to a value of `true`. This way, **when you leave a room, Synapse will now forget it automatically**." +msgid "We believe that using Traefik provides way too many benefits to worry about this minor performance impairment." msgstr "" #: ../../../CHANGELOG.md:949 -msgid "The upstream Synapse default is `false` (disabled), so that you must forget rooms manually after leaving." +msgid "The heaviest part of running a Matrix homeserver is all the slow and potentially inefficient things the homeserver (e.g. Synapse) is doing. These things affect performance much more than whatever reverse-proxy is in front. Your server will die the same way by joining the famously large **Matrix HQ** room, no matter which reverse-proxy you put in front." msgstr "" #: ../../../CHANGELOG.md:951 -msgid "**We go against the upstream default** ([somewhat controversially](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2700)) in an effort to make Synapse leaner and potentially do what we believe most users would expect their homeserver to be doing." +msgid "Even our previously mentioned benchmarks (yielding ~1300 rps) are synthetic — hitting a useless `/_matrix/client/versions` endpoint. Real-use does much more than this." msgstr "" #: ../../../CHANGELOG.md:953 -msgid "If you'd like to go back to the old behavior, add the following to your configuration: `matrix_synapse_forget_rooms_on_leave: false`" +msgid "If this is still not convincing enough for you and you want the best possible performance, consider [Fronting Traefik with another reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy) (thus having the slowest part — SSL termination — happen elsewhere) or [Using no reverse-proxy on the Matrix side at all](./docs/configuring-playbook-own-webserver.md#using-no-reverse-proxy-on-the-matrix-side-at-all). The playbook will not get in your way of doing that, but these options may make your life much harder. Performance comes at a cost, after all." msgstr "" -#: ../../../CHANGELOG.md:956 -msgid "2023-04-03" +#: ../../../CHANGELOG.md:955 +msgid "Migration procedure" msgstr "" -#: ../../../CHANGELOG.md:958 -msgid "The matrix-jitsi role lives independently now" +#: ../../../CHANGELOG.md:957 +msgid "The updated playbook will automatically perform some migration tasks for you:" msgstr "" -#: ../../../CHANGELOG.md:960 -msgid "**TLDR**: the `matrix-jitsi` role is now included from the [ansible-role-jitsi](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi) repository, part of the [MASH playbook](https://github.com/mother-of-all-self-hosting/mash-playbook). Some variables have been renamed. All functionality remains intact." +#: ../../../CHANGELOG.md:959 +msgid "It will stop and remove the `matrix-nginx-proxy` systemd service and container for you. This behavior cannot be disabled. It's essential that this service gets stopped, because it remaining running (and having container labels) may confuse Traefik as to where to route HTTP requests." msgstr "" -#: ../../../CHANGELOG.md:962 -msgid "The `matrix-jitsi` role has been relocated in its own repository, part of the [MASH playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) project — an Ansible playbook for self-hosting [a growing list of FOSS software](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md). If hosting a Jitsi stack on the Matrix server itself did not stand right with you or you always wanted to host most stuff, you can now use this new playbook to do so." +#: ../../../CHANGELOG.md:961 +msgid "It will delete the `/matrix/nginx-proxy` directory and all files within it. You can disable this behavior by adding `matrix_playbook_migration_matrix_nginx_proxy_uninstallation_enabled: false` to your `vars.yml` configuration file. Doing so will leave its data around." msgstr "" -#: ../../../CHANGELOG.md:964 -msgid "As part of the extraction process of this role out of the Matrix playbook, a few other things improved:" +#: ../../../CHANGELOG.md:963 +msgid "It will delete the `/matrix/ssl` directory and all files within it. You can disable this behavior by adding `matrix_playbook_migration_matrix_ssl_uninstallation_enabled: false` to your `vars.yml` configuration file. If you have some important certificates there for some reason, take them out or temporarily disable removal of these files until you do." msgstr "" -#: ../../../CHANGELOG.md:966 -msgid "**native Traefik support** has been added" +#: ../../../CHANGELOG.md:965 +msgid "It will tell you about all variables (`matrix_nginx_proxy_*` and many others — even from other roles) that have changed during this large nginx-elimination upgrade. You can disable this behavior by adding `matrix_playbook_migration_matrix_nginx_proxy_elimination_variable_transition_checks_enabled: false` to your `vars.yml` configuration file." msgstr "" #: ../../../CHANGELOG.md:967 -msgid "**support for hosting under a subpath** has been added, although it suffers from a few minor issues listed [here](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/jitsi.md#url)" +msgid "It will tell you about any leftover `matrix_nginx_proxy_*` variables in your `vars.yml` file. You can disable this behavior by adding `matrix_playbook_migration_matrix_nginx_proxy_leftover_variable_validation_checks_enabled: false` to your `vars.yml` configuration file." msgstr "" #: ../../../CHANGELOG.md:969 -msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're using Jitsi or not." +msgid "It will tell you about any leftover `matrix_ssl_*` variables in your `vars.yml` file. You can disable this behavior by adding `matrix_playbook_migration_matrix_ssl_leftover_variable_checks_enabled: false` to your `vars.yml` configuration file." msgstr "" #: ../../../CHANGELOG.md:971 -msgid "If you're making use of Jitsi via this playbook, you will need to update variable references in your `vars.yml` file:" +msgid "We don't recommend changing these variables and suppressing warnings, unless you know what you're doing." msgstr "" #: ../../../CHANGELOG.md:973 -msgid "`matrix_jitsi_*_docker_image_` -> `matrix_jitsi_*_container_image_`" -msgstr "" - -#: ../../../CHANGELOG.md:974 -msgid "`matrix_jitsi_` -> `jitsi_`" +msgid "**Most people should just upgrade as per-normal**, bearing in mind that a lot has changed and some issues may arise. The playbook would guide you through renamed variables automatically." msgstr "" #: ../../../CHANGELOG.md:975 -#: ../../../CHANGELOG.md:1002 -msgid "some other internal variables have changed, but the playbook will tell you about them" +msgid "Conclusion" msgstr "" #: ../../../CHANGELOG.md:977 -msgid "2023-03-22" +msgid "Thousands of lines of code were changed across hundreds of files. All addons (bridges, bots) were rewired in terms of container networking and in terms of how they reach the homeserver." msgstr "" #: ../../../CHANGELOG.md:979 -msgid "ntfy Web App is disabled by default" +msgid "I don't actively use all the ~100 components offered by the playbook (no one does), nor do I operate servers exercising all edge-cases. As such, issues may arise. Please have patience and report (or try to fix) these issues!" msgstr "" -#: ../../../CHANGELOG.md:981 -msgid "ntfy provides a web app, which is now disabled by default, because it may be unknown to and unused by most users of this playbook. You can enable it by setting `ntfy_web_root: \"app\"` (see [ntfy documentation](docs/configuring-playbook-ntfy.md))." +#: ../../../CHANGELOG.md:982 +msgid "2024-01-14" msgstr "" -#: ../../../CHANGELOG.md:983 -msgid "This change was already applied a while before this entry, but as some users were reporting the missing web app, this entry was added (see [#2529](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2529))." +#: ../../../CHANGELOG.md:984 +msgid "(Backward Compatibility) Configuration changes required for people fronting the integrated reverse-proxy webserver with another reverse-proxy" msgstr "" #: ../../../CHANGELOG.md:986 -msgid "2023-03-21" +msgid "If you're on the default setup (using the Traefik reverse-proxy as installed by the playbook), you don't need to do anything." msgstr "" #: ../../../CHANGELOG.md:988 -msgid "The matrix-prometheus role lives independently now" +msgid "People who are [Fronting the integrated Traefik reverse-proxy webserver with another reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy), as per our previous instructions are redefining `traefik_additional_entrypoints_auto` in their `vars.yml` configuration." msgstr "" #: ../../../CHANGELOG.md:990 -msgid "**TLDR**: the `matrix-prometheus` role is now included from the [ansible-role-prometheus](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus) repository, part of the [MASH playbook](https://github.com/mother-of-all-self-hosting/mash-playbook). Some variables have been renamed. All functionality remains intact." +msgid "Such a full variable redefinion is intrustive, because it prevents the playbook from injecting additional entrypoints into the Traefik webserver. In the future, the playbook may have a need to do so." msgstr "" #: ../../../CHANGELOG.md:992 -msgid "The `matrix-prometheus` role has been relocated in its own repository, part of the [MASH playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) project — an Ansible playbook for self-hosting [a growing list of FOSS software](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md). If hosting a Prometheus stack on the Matrix server itself did not stand right with you or you always wanted to host most stuff, you can now use this new playbook to do so." +msgid "For this reason, we no longer recommend completely redefining `traefik_additional_entrypoints_auto`. The playbook now defines [various `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_*` variables in the `defaults/main.yml` file](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/roles/custom/matrix-base/defaults/main.yml) of the `matrix-base` role which can be used as a safer alternative to `traefik_additional_entrypoints_auto`." msgstr "" #: ../../../CHANGELOG.md:994 -msgid "Extracting the Prometheus role out of this Matrix playbook required huge internal refactoring to the way the Prometheus configuration (scraping jobs) is generated. If you notice any breakage after upgrading, let us know." -msgstr "" - -#: ../../../CHANGELOG.md:996 -msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're using Prometheus or not." -msgstr "" - -#: ../../../CHANGELOG.md:998 -msgid "If you're making use of Prometheus via this playbook, you will need to update variable references in your `vars.yml` file:" -msgstr "" - -#: ../../../CHANGELOG.md:1000 -msgid "`matrix_prometheus_docker_image_` -> `matrix_prometheus_container_image_`" -msgstr "" - -#: ../../../CHANGELOG.md:1001 -msgid "`matrix_prometheus_` -> `prometheus_`" -msgstr "" - -#: ../../../CHANGELOG.md:1005 -msgid "2023-03-12" -msgstr "" - -#: ../../../CHANGELOG.md:1007 -msgid "synapse-auto-compressor support" -msgstr "" - -#: ../../../CHANGELOG.md:1009 -msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state)'s `synapse_auto_compressor` tool to run periodically." -msgstr "" - -#: ../../../CHANGELOG.md:1011 -msgid "If enabled, `synapse_auto_compressor` runs on a schedule and compresses your Synapse database's `state_groups` table. It was possible to run `rust-synapse-compress-state` manually via the playbook even before — see [Compressing state with rust-synapse-compress-state](docs/maintenance-synapse.md#compressing-state-with-rust-synapse-compress-state). However, using `synapse_auto_compressor` is better, because:" -msgstr "" - -#: ../../../CHANGELOG.md:1013 -msgid "it runs on a more up-to-date version of `rust-synapse-compress-state`" -msgstr "" - -#: ../../../CHANGELOG.md:1014 -msgid "it's a set-it-and-forget-it tool that you can enable and never have to deal with manual compression anymore" -msgstr "" - -#: ../../../CHANGELOG.md:1016 -msgid "This tool needs to be enabled manually, for now. In the future, we're considering enabling it by default for all Synapse installations." -msgstr "" - -#: ../../../CHANGELOG.md:1018 -msgid "See our [Setting up synapse-auto-compressor](docs/configuring-playbook-synapse-auto-compressor.md) documentation to get started." -msgstr "" - -#: ../../../CHANGELOG.md:1021 -msgid "2023-03-07" -msgstr "" - -#: ../../../CHANGELOG.md:1023 -msgid "Sliding Sync proxy (Element X) support" -msgstr "" - -#: ../../../CHANGELOG.md:1025 -msgid "Thanks to [Benjamin Kampmann](https://github.com/gnunicorn) for [getting it started](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2515), [FSG-Cat](https://github.com/FSG-Cat) for fixing it up and me ([Slavi](https://github.com/spantaleev)) for polishing it up, the playbook can now install and configure the [sliding-sync proxy](https://github.com/matrix-org/sliding-sync)." +msgid "Adapt your configuration as seen below:" msgstr "" #: ../../../CHANGELOG.md:1027 -msgid "The upcoming Element X clients ([Element X iOS](https://github.com/vector-im/element-x-ios) and [Element X Android](https://github.com/vector-im/element-x-android)) require the `sliding-sync` proxy to do their job. **These clients are still in beta** (especially Element X Android, which requires manual compilation to get it working with a non-`matrix.org` homeseserver). Playbook users can now easily give these clients a try and help test them thanks to us having `sliding-sync` support." +msgid "Also, feel free to read the [Fronting the integrated Traefik reverse-proxy webserver with another reverse-proxy](./docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy) documentation section again for additional details." msgstr "" -#: ../../../CHANGELOG.md:1029 -msgid "To get started, see our [Setting up the Sliding Sync proxy](docs/configuring-playbook-sliding-sync-proxy.md) documentation page." +#: ../../../CHANGELOG.md:1030 +msgid "2024-01-13" msgstr "" #: ../../../CHANGELOG.md:1032 -msgid "2023-03-02" +msgid "matrix-reminder-bot update with more secure (backward-incompatible) default settings" msgstr "" #: ../../../CHANGELOG.md:1034 -msgid "The matrix-etherpad role lives independently now" +msgid "**TLDR**: your updated (to [v0.3.0](https://github.com/anoadragon453/matrix-reminder-bot/releases/tag/v0.3.0)) [matrix-reminder-bot](./docs/configuring-playbook-bot-matrix-reminder-bot.md) is now more secure. By default, like other bridges/bots managed by the playbook, it will only provide its services to users of your own server (not to anyone, even across the Matrix Federation). If that's fine, there's nothing you need to do." msgstr "" #: ../../../CHANGELOG.md:1036 -msgid "**TLDR**: the `matrix-etherpad` role is now included from [another repository](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad). Some variables have been renamed. All functionality remains intact." +msgid "Maintenance of [matrix-reminder-bot](./docs/configuring-playbook-bot-matrix-reminder-bot.md) has been picked up by [Kim Brose](https://github.com/HarHarLinks) and [@svierne](https://github.com/svierne)." msgstr "" #: ../../../CHANGELOG.md:1038 -msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're using Etherpad or not." +msgid "Thanks to them, a new [v0.3.0](https://github.com/anoadragon453/matrix-reminder-bot/releases/tag/v0.3.0) release is out. The new version is now available for the ARM64 architecture, so playbook users on this architecture will no longer need to wait for [self-building](./docs/self-building.md) to happen." msgstr "" #: ../../../CHANGELOG.md:1040 -msgid "If you're making use of Etherpad via this playbook, you will need to update variable references in your `vars.yml` file:" +msgid "The new version also comes with new `allowlist` and `blocklist` settings, which make it possible to restrict who can use the bot. Previously anyone, even across the Matrix Federation could talk to it and schedule reminders." msgstr "" #: ../../../CHANGELOG.md:1042 -msgid "Rename `matrix_etherpad_public_endpoint` to `etherpad_path_prefix`" +msgid "The playbook defaults all bridges and bots (where possible) to only be exposed to users of the current homeserver, not users across federation. Thanks to the new version of this bot making such a restriction possible, we're now making use of it. The playbook (via its `group_vars/matrix_servers` file) automatically enables the `allowlist` (`matrix_bot_matrix_reminder_bot_allowlist_enabled: true`) and configures it in such a way (`matrix_bot_matrix_reminder_bot_allowlist_regexes_auto`) so as to restrict the bot to your homeserver's users." msgstr "" #: ../../../CHANGELOG.md:1044 -msgid "Replace `matrix_etherpad_mode: dimension` with:" -msgstr "" - -#: ../../../CHANGELOG.md:1045 -msgid "for `matrix-nginx-proxy` users:" +msgid "If you need **to undo or tweak these security improvements**, you can change your `vars.yml` file to:" msgstr "" #: ../../../CHANGELOG.md:1046 -msgid "`etherpad_nginx_proxy_dimension_integration_enabled: true`" -msgstr "" - -#: ../../../CHANGELOG.md:1047 -msgid "`etherpad_hostname: \"{{ matrix_server_fqn_dimension }}\"`" +msgid "disable the allowlist (`matrix_bot_matrix_reminder_bot_allowlist_enabled: false`), making the bot allow usage by anyone, anywhere" msgstr "" #: ../../../CHANGELOG.md:1048 -msgid "for Traefik users:" +msgid "inject additional allowed servers or users by adding **additional** (on top of the default allowlist in `matrix_bot_matrix_reminder_bot_allowlist_regexes_auto`) custom regexes in the `matrix_bot_matrix_reminder_bot_allowlist_regexes_custom` list variable (see the [syntax reference](https://github.com/anoadragon453/matrix-reminder-bot/blob/1e910c0aa3469d280d93ee7e6c6d577227a3460c/sample.config.yaml#L43-L49))" msgstr "" -#: ../../../CHANGELOG.md:1049 -msgid "define your own `etherpad_hostname` and `etherpad_path_prefix` as you see fit" -msgstr "" - -#: ../../../CHANGELOG.md:1051 -msgid "Rename all other variables:" -msgstr "" - -#: ../../../CHANGELOG.md:1052 -msgid "`matrix_etherpad_docker_image_` -> `matrix_etherpad_container_image_`" +#: ../../../CHANGELOG.md:1050 +msgid "override the default allowlist (in the `group_vars/matrix_servers` file) by redefining `matrix_bot_matrix_reminder_bot_allowlist_regexes_auto`" msgstr "" #: ../../../CHANGELOG.md:1053 -msgid "`matrix_etherpad_` -> `etherpad_`" +msgid "2024-01-05" msgstr "" #: ../../../CHANGELOG.md:1055 -msgid "Along with this relocation, the new role also:" +msgid "matrix-mailer has been replaced by the exim-relay external role" msgstr "" #: ../../../CHANGELOG.md:1057 -msgid "supports [self-building](docs/self-building.md), so it should work on `arm32` and `arm64` architectures" +#: ../../../CHANGELOG.md:1695 +msgid "We're continuing our effort to make [the playbook use external roles for some things](#the-playbook-now-uses-external-roles-for-some-things), so as to avoid doing everything ourselves and to facilitate code re-use." msgstr "" -#: ../../../CHANGELOG.md:1058 -msgid "has native Traefik reverse-proxy support (Etherpad requests no longer go through `matrix-nginx-proxy` when using Traefik)" +#: ../../../CHANGELOG.md:1059 +msgid "The `matrix-mailer` role has been moved to its own repository ([ansible-role-exim-relay](https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay)) that this playbook now includes." msgstr "" #: ../../../CHANGELOG.md:1061 -msgid "2023-02-26" +msgid "To migrate:" msgstr "" #: ../../../CHANGELOG.md:1063 -msgid "Traefik is the default reverse-proxy now" +msgid "pull the playbook changes, as usual" +msgstr "" + +#: ../../../CHANGELOG.md:1064 +msgid "update your roles (run `just roles` or `make roles`)" msgstr "" #: ../../../CHANGELOG.md:1065 -msgid "**TLDR**: new installations will now default to Traefik as their reverse-proxy. Existing users need to explicitly choose their reverse-proxy type. [Switching to Traefik](#how-do-i-switch-my-existing-setup-to-traefik) is strongly encouraged. `matrix-nginx-proxy` may break over time and will ultimately be removed." +msgid "update your `vars.yml`, renaming `matrix_mailer`-prefixed variables to `exim_relay`-prefixed ones (e.g. `matrix_mailer_sender_address` -> `exim_relay_sender_address`). If you find none, it means you're using the default configuration and your migraiton job is even simpler." msgstr "" -#: ../../../CHANGELOG.md:1067 -msgid "As mentioned 2 weeks ago in [(Backward Compatibility) Reverse-proxy configuration changes and initial Traefik support](#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support), the playbook is moving to Traefik as its default SSL-terminating reverse-proxy." +#: ../../../CHANGELOG.md:1066 +msgid "re-run the playbook (`install-all` or `setup-all`)" msgstr "" -#: ../../../CHANGELOG.md:1069 -msgid "Until now, we've been doing the migration gradually and keeping full backward compatibility. New installations were defaulting to `matrix-nginx-proxy` (just like before), while existing installations were allowed to remain on `matrix-nginx-proxy` as well. This makes things very difficult for us, because we need to maintain and think about lots of different setups:" +#: ../../../CHANGELOG.md:1068 +msgid "The playbook will take care of stopping the old `matrix-mailer` systemd service, relocating its directory and restarting it under the new name (`matrix-exim-relay.service`)." msgstr "" #: ../../../CHANGELOG.md:1071 -msgid "Traefik managed by the playbook" -msgstr "" - -#: ../../../CHANGELOG.md:1072 -msgid "Traefik managed by the user in another way" +msgid "2024-01-02" msgstr "" #: ../../../CHANGELOG.md:1073 -msgid "another reverse-proxy on the same host (`127.0.0.1` port exposure)" -msgstr "" - -#: ../../../CHANGELOG.md:1074 -msgid "another reverse-proxy on another host (`0.0.0.0` port exposure)" +msgid "mautrix-signal now powered by the new Go-based bridge" msgstr "" #: ../../../CHANGELOG.md:1075 -msgid "`matrix-nginx-proxy` — an `nginx` container managed by the playbook" +msgid "The old Python-based [mautrix-signal](https://github.com/mautrix/signal) bridge is no longer maintained upstream. It's also known to have issues linking new devices." msgstr "" -#: ../../../CHANGELOG.md:1076 -msgid "`nginx` webserver operated by the user, running without a container on the same server" +#: ../../../CHANGELOG.md:1077 +msgid "It seems like the path forward is to switch to the new mautrix-signal bridge written in Golang, which we did thanks to [PR #3031](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3041) by [Pierre 'McFly' Marty](https://github.com/pm-McFly)." msgstr "" -#: ../../../CHANGELOG.md:1078 -msgid "Each change we do and each new feature that comes in needs to support all these different ways of reverse-proxying. Because `matrix-nginx-proxy` was the default and pretty much everyone was (and still is) using it, means that new PRs also come with `matrix-nginx-proxy` as their main focus and Traefik as an afterthought, which means we need to spend hours fixing up Traefik support." -msgstr "" - -#: ../../../CHANGELOG.md:1080 -msgid "We can't spend all this time maintaining so many different configurations anymore. Traefik support has been an option for 2 weeks and lots of people have already migrated their server and have tested things out. Traefik is what we use and preferentially test for." +#: ../../../CHANGELOG.md:1079 +msgid "The playbook should **automatically migrate your mautrix-signal installation to the new bridge code**. You will **need to relink all your devices** to continue your bridged conversations." msgstr "" #: ../../../CHANGELOG.md:1082 -msgid "It's time for the **next step in our migration process** to Traefik and elimination of `matrix-nginx-proxy`:" +msgid "2023-10-23" msgstr "" #: ../../../CHANGELOG.md:1084 -msgid "Traefik is now the default reverse-proxy for new installations" +msgid "Enabling `allow_public_rooms_over_federation` by default for Synapse" msgstr "" -#: ../../../CHANGELOG.md:1085 -msgid "All existing users need to explicitly choose their reverse-proxy type by defining the `matrix_playbook_reverse_proxy_type` variable in their `vars.yml` configuration file. We strongly encourage existing users to [switch the Traefik](#how-to-switch-an-existing-setup-to-traefik), as the nginx setup is bound to become more and more broken over time until it's ultimately removed" +#: ../../../CHANGELOG.md:1086 +msgid "**TDLR**: if your Matrix server is federating (which it mostly likely is, unless you've [disabled federation](docs/configuring-playbook-federation.md#disabling-federation)), your public rooms will not only be joinable across federation (as they've always been), but from now on will be discoverable (made available as a list across federation). We're changing this by flipping the value for Synapse's `allow_public_rooms_over_federation` setting to `true`, going against the upstream default. Servers that disable federation are not affected. Servers that have public rooms which are not published to the room directory are also not affected." msgstr "" -#: ../../../CHANGELOG.md:1087 -msgid "How do I switch my existing setup to Traefik?" +#: ../../../CHANGELOG.md:1088 +msgid "We generally try to stick to the default configuration for Synapse (and all other components), unless these defaults seem wrong or harmful. One such previous case from a few months ago was us [Enabling `forget_rooms_on_leave` by default for Synapse](#enabling-forget_rooms_on_leave-by-default-for-synapse) — the default value was making Synapse more wasteful of resources by default." msgstr "" -#: ../../../CHANGELOG.md:1089 -msgid "**For users who are on `matrix-nginx-proxy`** (the default reverse-proxy provided by the playbook), switching to Traefik can happen with a simple configuration change. Follow this section from 2 weeks ago: [How do I explicitly switch to Traefik right now?](#how-do-i-explicitly-switch-to-traefik-right-now)." +#: ../../../CHANGELOG.md:1090 +msgid "Today, we're going against upstream defaults again and flipping the `allow_public_rooms_over_federation` configuration option to `true`. This way, public rooms on your server will be made discoverable by others via federation, using the [`GET /_matrix/federation/v1/publicRooms` of the Server-Server API](https://spec.matrix.org/v1.8/server-server-api/#get_matrixfederationv1publicrooms)." msgstr "" -#: ../../../CHANGELOG.md:1091 -msgid "If you experience trouble:" -msgstr "" - -#: ../../../CHANGELOG.md:1093 -msgid "Follow [How do I remain on matrix-nginx-proxy?](#how-do-i-remain-on-matrix-nginx-proxy) to bring your server back online using the old reverse-proxy" +#: ../../../CHANGELOG.md:1092 +msgid "The upstream Synapse default is `false` (disabled), so that public rooms are not exposed for other servers to discover (learn about their existence). Nevertheless, even if these rooms are not exposed (listed) for discovery, they are **still joinable** by anyone who knows their address or is invited to the room by an existing member." msgstr "" #: ../../../CHANGELOG.md:1094 -msgid "Ask for help in our [support channels](README.md#support)" +msgid "**We go against the upstream default** in an effort to make Matrix federation more useful — a public room should be globally public — not only joinable, but also discoverable across federation." msgstr "" -#: ../../../CHANGELOG.md:1095 -msgid "Try switching to Traefik again later" +#: ../../../CHANGELOG.md:1096 +msgid "The **historical reasoning** behind this change is as follows:" msgstr "" -#: ../../../CHANGELOG.md:1097 -msgid "**For users with a more special reverse-proxying setup** (another nginx server, Apache, Caddy, etc.), the migration may not be so smooth. Follow the [Using your own webserver](docs/configuring-playbook-own-webserver.md) guide. Ideally, your custom reverse-proxy will be configured in such a way that it **fronts the Traefik reverse-proxy** provided by the playbook. Other means of reverse-proxying are more fragile and may be deprecated in the future." +#: ../../../CHANGELOG.md:1098 +msgid "`allow_public_rooms_over_federation` seems to have been enabled by default for Synapse until v1.7.0 (~2019), just like we believe it should be for a globally-federating network — rooms should be joinable and discoverable across federation." msgstr "" -#: ../../../CHANGELOG.md:1099 -msgid "I already use my own Traefik server. How do I plug that in?" +#: ../../../CHANGELOG.md:1100 +msgid "In Synapse v1.7.0 (~2019), `allow_public_rooms_over_federation` [got disabled](https://github.com/element-hq/synapse/blob/e9069c9f919685606506f04527332e83fbfa44d9/docs/upgrade.md?plain=1#L1877-L1891) by default in a [security-by-obscurity](https://en.wikipedia.org/wiki/Security_through_obscurity) workaround for misconfigured servers. See the [Avoiding unwelcome visitors on private Matrix servers](https://matrix.org/blog/2019/11/09/avoiding-unwelcome-visitors-on-private-matrix-servers/) `matrix.org` blog article. We believe that people wishing for a truly private server, should [disable federation](docs/configuring-playbook-federation.md#disabling-federation), instead of having a fully-federating server and trying to hide its public rooms. We also provide other workarounds below. We (and the Synapse team, obviously) believe that Matrix should federate by default, so federating the public room list seems to make sense." msgstr "" -#: ../../../CHANGELOG.md:1101 -msgid "See the [Traefik managed by the playbook](docs/configuring-playbook-own-webserver.md#traefik-managed-by-the-playbook) section." +#: ../../../CHANGELOG.md:1102 +msgid "[etke.cc](https://etke.cc/) has been developing the free-software [Matrix Rooms Search](https://github.com/etkecc/mrs) project for a while now. One public (demo) instance of it is hosted at [matrixrooms.info](https://matrixrooms.info/). This search engine tries to go through the Matrix federation and discover & index public rooms to allow people to find them. We believe it's vital for Matrix (and any chat or social network for that matter) to be more discoverable, so that people can find communities and others to talk to. Today (on 23rd of October 2023), `matrixrooms.info` is indexing `23066` Matrix servers. Of these, only `1567` servers (7%) are making their public rooms discoverable. Who knows what wonderful communities and rooms are available on these 93% other Matrix servers that are supposedly federating, but are still gate-keeping their public room list. Indubitably, many of these servers are hosted via matrix-docker-ansible-deploy, so we feel partially responsible for making Matrix federation less useful." msgstr "" -#: ../../../CHANGELOG.md:1103 -msgid "Why is matrix-nginx-proxy used even after switching to Traefik?" +#: ../../../CHANGELOG.md:1104 +msgid "Here are **actions you may wish to take** as a result of this change:" msgstr "" -#: ../../../CHANGELOG.md:1105 -msgid "This playbook manages many different services. All these services were initially integrated with `matrix-nginx-proxy`." +#: ../../../CHANGELOG.md:1106 +msgid "(recommended) embrace the new default. If your Matrix server is federating, your public rooms have always been joinable across federation anyway. Exposing the list of public rooms does no harm and more-so does good by contributing to the usefulness of the Matrix network by facilitating room discovery." msgstr "" -#: ../../../CHANGELOG.md:1107 -msgid "While we migrate all these components to have native Traefik support, some still go through nginx internally (Traefik -> local `matrix-nginx-proxy` -> component). As time goes on, internal reliance on `matrix-nginx-proxy` will gradually decrease until it's completely removed." +#: ../../../CHANGELOG.md:1108 +msgid "(switch to a better way of doings things on your semi-private server) The problem that the Synapse team appears to have solved by flipping the `allow_public_rooms_over_federation` default in Synapse v1.7.0 seems to for \"mostly private\" servers, which federate and have a bunch of rooms made public (and published in their room directory) in an effort to allow people on the same homeserver to easily find and join them (self-onboarding). With the introduction of Matrix Spaces, you can reorganize your flow around spaces — you can auto-join your users to a Matrix Space (via Synapse's `auto_join_rooms` setting — controlled by our `matrix_synapse_auto_join_rooms` variable), then add a bunch of rooms to the space and make them joinable by people belonging to the space. That is to say, do not make rooms public and do not publish them to the room directory unless they are really public. Instead, use other mechanisms for semi-public rooms or private rooms. One alternative is to stick to what you're doing (public rooms published to your rooms directory) but having a `m.federate: true` flag set during creation (clients like Element Web have a nice UI checkbox for this) to explicitly disable federation for them." msgstr "" -#: ../../../CHANGELOG.md:1109 -msgid "How do I remain on matrix-nginx-proxy?" -msgstr "" - -#: ../../../CHANGELOG.md:1111 -msgid "Most new work and testing targets Traefik, so remaining on nginx is **not** \"the good old stable\" option, but rather the \"still available, but largely untested and likely to be broken very soon\" option." +#: ../../../CHANGELOG.md:1110 +msgid "(keeping the old behavior) if you wish to keep doing what you're doing (keeping your Matrix server federating, but hiding its public rooms list), add `matrix_synapse_allow_public_rooms_over_federation: false` to your `vars.yml` configuration. This restores the old behavior. You may also consider [disabling federation](docs/configuring-playbook-federation.md#disabling-federation) completely instead of relying on security-by-obscurity measures." msgstr "" #: ../../../CHANGELOG.md:1113 -msgid "To proceed regardless of this warning, add `matrix_playbook_reverse_proxy_type: playbook-managed-nginx` to your configuration." +msgid "2023-10-18" msgstr "" #: ../../../CHANGELOG.md:1115 -msgid "At some point in the **near** future (days, or even weeks at most), we hope to completely get rid of `matrix-nginx-proxy` (or break it enough to make it unusable), so you **will soon be forced to migrate** anyway. Plan your migration accordingly." +msgid "Postgres parameters are automatically tuned now" msgstr "" #: ../../../CHANGELOG.md:1117 -msgid "How do I keep using my own other reverse-proxy?" +msgid "The playbook has provided some hints about [Tuning PostgreSQL](docs/maintenance-postgres.md#tuning-postgresql) for quite a while now." msgstr "" #: ../../../CHANGELOG.md:1119 -msgid "We recommend that you follow the guide for [Fronting the integrated reverse-proxy webserver with another reverse-proxy](docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy)." +msgid "From now on, the [Postgres Ansible role](https://github.com/mother-of-all-self-hosting/ansible-role-postgres) automatically tunes your Postgres configuration with the same [calculation logic](https://github.com/le0pard/pgtune/blob/master/src/features/configuration/configurationSlice.js) that powers https://pgtune.leopard.in.ua/." msgstr "" -#: ../../../CHANGELOG.md:1122 -msgid "2023-02-25" +#: ../../../CHANGELOG.md:1121 +msgid "Our [Tuning PostgreSQL](docs/maintenance-postgres.md#tuning-postgresql) documentation page has details about how you can turn auto-tuning off or adjust the automatically-determined Postgres configuration parameters manually." msgstr "" -#: ../../../CHANGELOG.md:1124 -msgid "rageshake support" +#: ../../../CHANGELOG.md:1123 +msgid "People who [enable load-balancing with Synapse workers](docs/configuring-playbook-synapse.md#load-balancing-with-workers) no longer need to increase the maximum number of Postgres connections manually (previously done via `postgres_process_extra_arguments`). There's a new variable (`postgres_max_connections`) for controlling this number and the playbook automatically raises its value from `200` to `500` for setups which enable workers." msgstr "" #: ../../../CHANGELOG.md:1126 -msgid "Thanks to [Benjamin Kampmann](https://github.com/gnunicorn), the playbook can now install and configure the [rageshake](https://github.com/matrix-org/rageshake) bug report server." +msgid "2023-08-31" msgstr "" #: ../../../CHANGELOG.md:1128 -msgid "Additional details are available in [Setting up rageshake](docs/configuring-playbook-rageshake.md)." +msgid "SchildiChat Web support" msgstr "" -#: ../../../CHANGELOG.md:1131 -msgid "2023-02-17" +#: ../../../CHANGELOG.md:1130 +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) client." msgstr "" -#: ../../../CHANGELOG.md:1133 -msgid "Synapse templates customization support" +#: ../../../CHANGELOG.md:1132 +msgid "See our [Configuring SchildiChat Web](docs/configuring-playbook-client-schildichat-web.md) documentation to get started." msgstr "" #: ../../../CHANGELOG.md:1135 -msgid "The playbook can now help you customize Synapse's templates." +msgid "2023-08-23" msgstr "" #: ../../../CHANGELOG.md:1137 -msgid "Additional details are available in the [Customizing templates](docs/configuring-playbook-synapse.md#customizing-templates) section of our Synapse documentation." +msgid "mautrix-wsproxy support" msgstr "" #: ../../../CHANGELOG.md:1139 -msgid "The matrix-redis role lives independently now" +msgid "Thanks to [Johan Swetzén](https://github.com/jswetzen)'s efforts (who finished what was started by [James Reilly](https://github.com/hanthor) and [Shreyas Ajjarapu](https://github.com/shreyasajj)), the playbook now supports bridging to Android SMS and Apple iMessage via the [mautrix-wsproxy](https://github.com/mautrix/wsproxy) service (in combination with a [mautrix-imessage](https://github.com/mautrix/imessage) bridge running on your Mac or Android phone)." msgstr "" #: ../../../CHANGELOG.md:1141 -msgid "**TLDR**: the `matrix-redis` role is now included from another repository. Some variables have been renamed. All functionality remains intact." +msgid "See our [Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage](docs/configuring-playbook-bridge-mautrix-wsproxy.md) documentation page for getting started." msgstr "" -#: ../../../CHANGELOG.md:1143 -msgid "The `matrix-redis` role (which configures [Redis](https://redis.io/)) has been extracted from the playbook and now lives in its [own repository](https://github.com/mother-of-all-self-hosting/ansible-role-redis). This makes it possible to easily use it in other Ansible playbooks." +#: ../../../CHANGELOG.md:1144 +msgid "2023-07-24" msgstr "" -#: ../../../CHANGELOG.md:1145 -msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're enabling Ntfy or not. If you're making use of Ntfy via this playbook, you will need to update variable references in your `vars.yml` file (`matrix_redis_` -> `redis_`)." +#: ../../../CHANGELOG.md:1146 +msgid "matrix-registration-bot usage changed" msgstr "" -#: ../../../CHANGELOG.md:1147 -msgid "The matrix-ntfy role lives independently now" +#: ../../../CHANGELOG.md:1148 +msgid "[matrix-registration-bot](docs/configuring-playbook-bot-matrix-registration-bot.md) got some updates and now supports password-only-based login. Therefore the bot now doesn't need any manual configuration except setting a password in your `vars.yml`. The bot will be registered as admin and access tokens will be obtained automatically by the bot." msgstr "" -#: ../../../CHANGELOG.md:1149 -msgid "**TLDR**: the `matrix-ntfy` role is now included from another repository. Some variables have been renamed. All functionality remains intact." +#: ../../../CHANGELOG.md:1150 +msgid "**For existing users** You need to set `matrix_bot_matrix_registration_bot_bot_password` if you previously only used `matrix_bot_matrix_registration_bot_bot_access_token`. Please also remove the following deprecated settings" msgstr "" -#: ../../../CHANGELOG.md:1151 -msgid "The `matrix-ntfy` role (which configures [Ntfy](https://ntfy.sh/)) has been extracted from the playbook and now lives in its [own repository](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy). This makes it possible to easily use it in other Ansible playbooks." +#: ../../../CHANGELOG.md:1152 +msgid "`matrix_bot_matrix_registration_bot_bot_access_token`" msgstr "" #: ../../../CHANGELOG.md:1153 -msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're enabling Ntfy or not. If you're making use of Ntfy via this playbook, you will need to update variable references in your `vars.yml` file (`matrix_ntfy_` -> `ntfy_`)." +msgid "`matrix_bot_matrix_registration_bot_api_token`" msgstr "" #: ../../../CHANGELOG.md:1156 -msgid "2023-02-15" +msgid "2023-07-21" msgstr "" #: ../../../CHANGELOG.md:1158 -msgid "The matrix-grafana role lives independently now" +msgid "mautrix-gmessages support" msgstr "" #: ../../../CHANGELOG.md:1160 -msgid "**TLDR**: the `matrix-grafana` role is now included from another repository. Some variables have been renamed. All functionality remains intact." +msgid "Thanks to [Shreyas Ajjarapu](https://github.com/shreyasajj)'s efforts, the playbook now supports bridging to [Google Messages](https://messages.google.com/) via the [mautrix-gmessages](https://github.com/mautrix/gmessages) bridge. See our [Setting up Mautrix Google Messages bridging](docs/configuring-playbook-bridge-mautrix-gmessages.md) documentation page for getting started." msgstr "" -#: ../../../CHANGELOG.md:1162 -msgid "The `matrix-grafana` role (which configures [Grafana](docs/configuring-playbook-prometheus-grafana.md)) has been extracted from the playbook and now lives in its [own repository](https://github.com/mother-of-all-self-hosting/ansible-role-grafana). This makes it possible to easily use it in other Ansible playbooks." +#: ../../../CHANGELOG.md:1163 +msgid "2023-07-17" msgstr "" -#: ../../../CHANGELOG.md:1164 -msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're enabling Grafana or not. If you're making use of Grafana via this playbook, you will need to update variable references in your `vars.yml` file (`matrix_grafana_` -> `grafana_`)." +#: ../../../CHANGELOG.md:1165 +msgid "matrix-media-repo support" msgstr "" #: ../../../CHANGELOG.md:1167 -msgid "2023-02-13" +msgid "Thanks to [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/), the playbook can now set up [matrix-media-repo](https://github.com/turt2live/matrix-media-repo) — an alternative way to store homeserver media files, powered by a homeserver-independent implementation which supports S3 storage, IPFS, deduplication and other advanced features." msgstr "" #: ../../../CHANGELOG.md:1169 -msgid "The matrix-backup-borg role lives independently now" +msgid "To learn more see our [Storing Matrix media files using matrix-media-repo](docs/configuring-playbook-matrix-media-repo.md) documentation page." msgstr "" -#: ../../../CHANGELOG.md:1171 -msgid "**TLDR**: the `matrix-backup-borg` role is now included from another repository. Some variables have been renamed. All functionality remains intact." +#: ../../../CHANGELOG.md:1172 +msgid "2023-05-25" msgstr "" -#: ../../../CHANGELOG.md:1173 -msgid "Thanks to [moan0s](https://github.com/moan0s), the `matrix-backup-borg` role (which configures [BorgBackup](docs/configuring-playbook-backup-borg.md)) has been extracted from the playbook and now lives in its [own repository](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg). This makes it possible to easily use it in other Ansible playbooks and will become part of [nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy) soon." +#: ../../../CHANGELOG.md:1174 +msgid "Enabling `forget_rooms_on_leave` by default for Synapse" msgstr "" -#: ../../../CHANGELOG.md:1175 -msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're enabling Borg's backup functionality or not. If you're making use of BorgBackup via this playbook, you will need to update variable references in your `vars.yml` file (`matrix_backup_borg_` -> `backup_borg_`)." +#: ../../../CHANGELOG.md:1176 +msgid "With the [Synapse v1.84.0 update](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2698), we've also **changed the default value** of the `forget_rooms_on_leave` setting of Synapse to a value of `true`. This way, **when you leave a room, Synapse will now forget it automatically**." msgstr "" #: ../../../CHANGELOG.md:1178 -msgid "2023-02-12" +msgid "The upstream Synapse default is `false` (disabled), so that you must forget rooms manually after leaving." msgstr "" #: ../../../CHANGELOG.md:1180 -msgid "(Backward Compatibility) Reverse-proxy configuration changes and initial Traefik support" +msgid "**We go against the upstream default** ([somewhat controversially](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2700)) in an effort to make Synapse leaner and potentially do what we believe most users would expect their homeserver to be doing." msgstr "" #: ../../../CHANGELOG.md:1182 -msgid "**TLDR**:" -msgstr "" - -#: ../../../CHANGELOG.md:1184 -msgid "there's a new `matrix_playbook_reverse_proxy_type` variable (see [roles/custom/matrix-base/defaults/main.yml](roles/custom/matrix-base/defaults/main.yml)), which lets you tell the playbook what reverse-proxy setup you'd like to have. This makes it easier for people who want to do reverse-proxying in other ways." +msgid "If you'd like to go back to the old behavior, add the following to your configuration: `matrix_synapse_forget_rooms_on_leave: false`" msgstr "" #: ../../../CHANGELOG.md:1185 -msgid "the default reverse-proxy (`matrix_playbook_reverse_proxy_type`) is still `playbook-managed-nginx` (via `matrix-nginx-proxy`), for now. **Existing `matrix-nginx-proxy` users should not observe any changes** and can stay on this for now." -msgstr "" - -#: ../../../CHANGELOG.md:1186 -msgid "**Users who use their [own other webserver](docs/configuring-playbook-own-webserver.md) (e.g. Apache, etc.) need to change** `matrix_playbook_reverse_proxy_type` to something like `other-on-same-host`, `other-on-another-host` or `other-nginx-non-container`" +msgid "2023-04-03" msgstr "" #: ../../../CHANGELOG.md:1187 -msgid "we now have **optional [Traefik](https://traefik.io/) support**, so you could easily host Matrix and other Traefik-native services in containers on the same server. Traefik support is still experimental (albeit, good enough) and will improve over time. It does work, but certain esoteric features may not be there yet." +msgid "The matrix-jitsi role lives independently now" msgstr "" -#: ../../../CHANGELOG.md:1188 -msgid "**Traefik will become the default reverse-proxy in the near future**. `matrix-nginx-proxy` will either remain as an option, or be completely removed to simplify the playbook" +#: ../../../CHANGELOG.md:1189 +msgid "**TLDR**: the `matrix-jitsi` role is now included from the [ansible-role-jitsi](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi) repository, part of the [MASH playbook](https://github.com/mother-of-all-self-hosting/mash-playbook). Some variables have been renamed. All functionality remains intact." msgstr "" -#: ../../../CHANGELOG.md:1190 -msgid "Motivation for redoing our reverse-proxy setup" +#: ../../../CHANGELOG.md:1191 +msgid "The `matrix-jitsi` role has been relocated in its own repository, part of the [MASH playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) project — an Ansible playbook for self-hosting [a growing list of FOSS software](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md). If hosting a Jitsi stack on the Matrix server itself did not stand right with you or you always wanted to host most stuff, you can now use this new playbook to do so." msgstr "" -#: ../../../CHANGELOG.md:1192 -msgid "The playbook has supported various reverse-proxy setups for a long time. We have various configuration variables (`matrix_nginx_proxy_enabled`, various `_host_bind_port` variables, etc.) which allow the playbook to adapt to these different setups. The whole situation was messy though — hard to figure out and with lots of variables to toggle to make things work as you'd expect — huge **operational complexity**." +#: ../../../CHANGELOG.md:1193 +msgid "As part of the extraction process of this role out of the Matrix playbook, a few other things improved:" msgstr "" -#: ../../../CHANGELOG.md:1194 -msgid "We love containers, proven by the fact that **everything** that this playbook manages runs in a container. Yet, we weren't allowing people to easily host other web-exposed containers alongside Matrix services on the same server. We were using `matrix-nginx-proxy` (our integrated [nginx](https://nginx.org/) server), which was handling web-exposure and SSL termination for our own services, but we **weren't helping you with all your other containers**." +#: ../../../CHANGELOG.md:1195 +msgid "**native Traefik support** has been added" msgstr "" #: ../../../CHANGELOG.md:1196 -msgid "People who were **using `matrix-nginx-proxy`** were on the happy path on which everything worked well by default (Matrix-wise), **but** could not easily run other web-exposed services on their Matrix server because `matrix-nginx-proxy` was occupying ports `80` and `443`. Other services which wanted to get web exposure either had to be plugged into `matrix-nginx-proxy` (somewhat difficult) or people had to forgo using `matrix-nginx-proxy` in favor of something else." +msgid "**support for hosting under a subpath** has been added, although it suffers from a few minor issues listed [here](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/jitsi.md#url)" msgstr "" #: ../../../CHANGELOG.md:1198 -msgid "Of those that decided to forgo `matrix-nginx-proxy`, many were **using nginx** on the same server without a container. This was likely some ancient nginx version, depending on your choice of distro. The Matrix playbook was trying to be helpful and even with `matrix_nginx_proxy_enabled: false` was still generating nginx configuration in `/matrix/nginx-proxy/conf.d`. Those configuration files were adapted for inclusion into an nginx server running locally. Disabling the `matrix-nginx-proxy` role like this, yet still having it produce files is a bit disgusting, but it's what we've had since the early beginnings of this playbook." +msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're using Jitsi or not." msgstr "" #: ../../../CHANGELOG.md:1200 -msgid "Others still, wanted to run Matrix locally (no SSL certificates), regardless of which web server technology this relied on, and then **reverse-proxy from another machine on the network** which was doing SSL termination. These people were:" +msgid "If you're making use of Jitsi via this playbook, you will need to update variable references in your `vars.yml` file:" msgstr "" #: ../../../CHANGELOG.md:1202 -msgid "*either* relying on `matrix_nginx_proxy_enabled: false` as well, combined with exposing services manually (setting `_bind_port` variables)" +msgid "`matrix_jitsi_*_docker_image_` -> `matrix_jitsi_*_container_image_`" msgstr "" #: ../../../CHANGELOG.md:1203 -msgid "*or* better yet, they were keeping `matrix-nginx-proxy` enabled, but in `http`-only mode (no SSL certificate retrieval)." +msgid "`matrix_jitsi_` -> `jitsi_`" msgstr "" -#: ../../../CHANGELOG.md:1205 -msgid "Despite this operational complexity, things worked and were reasonably flexible to adapt to all these situations." +#: ../../../CHANGELOG.md:1204 +#: ../../../CHANGELOG.md:1231 +msgid "some other internal variables have changed, but the playbook will tell you about them" msgstr "" -#: ../../../CHANGELOG.md:1207 -msgid "When using `matrix-nginx-proxy` as is, we still had another problem — one of **internal playbook complexity**. Too many services need to be web-exposed (port 80/443, SSL certificates). Because of this, they all had to integrate with the `matrix-nginx-proxy` role. Tens of different roles explicitly integrating with `matrix-nginx-proxy` is not what we call clean. The `matrix-nginx-proxy` role contains variables for many of these roles (yikes). Other roles were more decoupled from it and were injecting configuration into `matrix-nginx-proxy` at runtime — see all the `inject_into_nginx_proxy.yml` task files in this playbook (more decoupled, but still… yikes)." +#: ../../../CHANGELOG.md:1206 +msgid "2023-03-22" msgstr "" -#: ../../../CHANGELOG.md:1209 -msgid "The next problem is one of **efficiency, interoperability and cost-saving**. We're working on other playbooks:" +#: ../../../CHANGELOG.md:1208 +msgid "ntfy Web App is disabled by default" msgstr "" -#: ../../../CHANGELOG.md:1211 -msgid "[vaultwarden-docker-ansible-deploy](https://github.com/spantaleev/vaultwarden-docker-ansible-deploy) for hosting the [Vaultwarden](https://github.com/dani-garcia/vaultwarden) server — an alternative implementation of the [Bitwarden](https://bitwarden.com/) password manager" +#: ../../../CHANGELOG.md:1210 +msgid "ntfy provides a web app, which is now disabled by default, because it may be unknown to and unused by most users of this playbook. You can enable it by setting `ntfy_web_root: \"app\"` (see [ntfy documentation](docs/configuring-playbook-ntfy.md))." msgstr "" #: ../../../CHANGELOG.md:1212 -msgid "[gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy) — for hosting the [Gitea](https://gitea.io/) git source code hosting service" -msgstr "" - -#: ../../../CHANGELOG.md:1213 -msgid "[nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy) — for hosting the [Nextcloud](https://nextcloud.com/) groupware platform" +msgid "This change was already applied a while before this entry, but as some users were reporting the missing web app, this entry was added (see [#2529](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2529))." msgstr "" #: ../../../CHANGELOG.md:1215 -msgid "We'd love for users to be able to **seamlessly use all these playbooks (and others, even) against a single server**. We don't want `matrix-nginx-proxy` to have a monopoly on port `80`/`443` and make it hard for other services to join in on the party. Such a thing forces people into running multiple servers (one for each service), which does provide nice security benefits, but is costly and ineffiecient. We'd like to make self-hosting these services cheap and easy." +msgid "2023-03-21" msgstr "" #: ../../../CHANGELOG.md:1217 -msgid "These other playbooks have been using [Traefik](https://traefik.io/) as their default reverse-proxy for a long time. They can all coexist nicely together (as an example, see the [Interoperability](https://github.com/spantaleev/nextcloud-docker-ansible-deploy/blob/master/docs/configuring-playbook-interoperability.md) documentation for the [Nextcloud playbook](https://github.com/spantaleev/nextcloud-docker-ansible-deploy)). Now that this playbook is gaining Traefik support, it will be able to interoperate with them. If you're going this way, make sure to have the Matrix playbook install Traefik and have the others use `*_reverse_proxy_type: other-traefik-container`." +msgid "The matrix-prometheus role lives independently now" msgstr "" #: ../../../CHANGELOG.md:1219 -msgid "Finally, at [etke.cc — a managed Matrix server hosting service](https://etke.cc) (built on top of this playbook, and coincidentally [turning 2 years old today](https://etke.cc/news/upsyw4ykbtgmwhz8k7ukldx0zbbfq-fh0iqi3llixi0/) 🎉), we're allowing people to host some additional services besides Matrix components. Exposing these services to the web requires ugly hacks and configuration files being dropped into `/matrix/nginx-proxy/conf.d`. We believe that everything should run in independent containers and be exposed to the web via a Traefik server, without a huge Ansible role like `matrix-nginx-proxy` that everything else needs to integrate with." +msgid "**TLDR**: the `matrix-prometheus` role is now included from the [ansible-role-prometheus](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus) repository, part of the [MASH playbook](https://github.com/mother-of-all-self-hosting/mash-playbook). Some variables have been renamed. All functionality remains intact." msgstr "" #: ../../../CHANGELOG.md:1221 -msgid "How do these changes fix all these problems?" +msgid "The `matrix-prometheus` role has been relocated in its own repository, part of the [MASH playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) project — an Ansible playbook for self-hosting [a growing list of FOSS software](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md). If hosting a Prometheus stack on the Matrix server itself did not stand right with you or you always wanted to host most stuff, you can now use this new playbook to do so." msgstr "" #: ../../../CHANGELOG.md:1223 -msgid "The new `matrix_playbook_reverse_proxy_type` lets you easily specify your preferred reverse-proxy type, including `other-on-same-host`, `other-on-another-host` and `none`, so people who'd like to reverse-proxy with their own web server have more options now." +msgid "Extracting the Prometheus role out of this Matrix playbook required huge internal refactoring to the way the Prometheus configuration (scraping jobs) is generated. If you notice any breakage after upgrading, let us know." msgstr "" #: ../../../CHANGELOG.md:1225 -msgid "Using Traefik greatly simplifies things, so going forward we'll have a simpler and easier to maintain playbook, which is also interoperable with other services." +msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're using Prometheus or not." msgstr "" #: ../../../CHANGELOG.md:1227 -msgid "Traefik is a web server, which has been specifically **designed for reverse-proxying to services running in containers**. It's ideal for usage in an Ansible playbook which runs everything in containers." +msgid "If you're making use of Prometheus via this playbook, you will need to update variable references in your `vars.yml` file:" msgstr "" #: ../../../CHANGELOG.md:1229 -msgid "**Traefik obtains SSL certificates automatically**, so there's no need for plugging additional tools like [Certbot](https://certbot.eff.org/) into your web server (like we were doing in the `matrix-nginx-proxy` role). No more certificate renewal timers, web server reloading timers, etc. It's just simpler." +msgid "`matrix_prometheus_docker_image_` -> `matrix_prometheus_container_image_`" msgstr "" -#: ../../../CHANGELOG.md:1231 -msgid "Traefik is a **modern web server**. [HTTP/3](https://doc.traefik.io/traefik/routing/entrypoints/#http3) is supported already (experimentally) and will move to stable soon, in the upcoming Traefik v3 release." +#: ../../../CHANGELOG.md:1230 +msgid "`matrix_prometheus_` -> `prometheus_`" msgstr "" -#: ../../../CHANGELOG.md:1233 -msgid "Traefik does not lock important functionality we'd like to use into [plus packages like nginx does](https://www.nginx.com/products/nginx/), leading us to resolve to configuration workarounds. The default Traefik package is good enough as it is." +#: ../../../CHANGELOG.md:1234 +msgid "2023-03-12" msgstr "" -#: ../../../CHANGELOG.md:1235 -msgid "Where we're at right now?" +#: ../../../CHANGELOG.md:1236 +msgid "synapse-auto-compressor support" msgstr "" -#: ../../../CHANGELOG.md:1237 -msgid "`matrix_playbook_reverse_proxy_type` still defaults to a value of `playbook-managed-nginx`." +#: ../../../CHANGELOG.md:1238 +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state)'s `synapse_auto_compressor` tool to run periodically." msgstr "" -#: ../../../CHANGELOG.md:1239 -msgid "Unless we have some regression, **existing `matrix-nginx-proxy` users should be able to update their Matrix server and not observe any changes**. Their setup should still remain on nginx and everything should still work as expected." +#: ../../../CHANGELOG.md:1240 +msgid "If enabled, `synapse_auto_compressor` runs on a schedule and compresses your Synapse database's `state_groups` table. It was possible to run `rust-synapse-compress-state` manually via the playbook even before — see [Compressing state with rust-synapse-compress-state](docs/maintenance-synapse.md#compressing-state-with-rust-synapse-compress-state). However, using `synapse_auto_compressor` is better, because:" msgstr "" -#: ../../../CHANGELOG.md:1241 -msgid "**Users using [their own webservers](docs/configuring-playbook-own-webserver.md) will need to change `matrix_playbook_reverse_proxy_type`** to something like `other-on-same-host`, `other-on-another-host` or `other-nginx-non-container`. Previously, they could toggle `matrix_nginx_proxy_enabled` to `false`, and that made the playbook automatically expose services locally. Currently, we only do this if you change the reverse-proxy type to `other-on-same-host`, `other-on-another-host` or `other-nginx-non-container`." +#: ../../../CHANGELOG.md:1242 +msgid "it runs on a more up-to-date version of `rust-synapse-compress-state`" msgstr "" #: ../../../CHANGELOG.md:1243 -msgid "How do I explicitly switch to Traefik right now?" +msgid "it's a set-it-and-forget-it tool that you can enable and never have to deal with manual compression anymore" msgstr "" #: ../../../CHANGELOG.md:1245 -msgid "**Users who wish to migrate to Traefik** today, can do so by **adding** this to their configuration:" +msgid "This tool needs to be enabled manually, for now. In the future, we're considering enabling it by default for all Synapse installations." msgstr "" -#: ../../../CHANGELOG.md:1253 -msgid "You may still need to keep certain old `matrix_nginx_proxy_*` variables (like `matrix_nginx_proxy_base_domain_serving_enabled`), even when using Traefik. For now, we recommend keeping all `matrix_nginx_proxy_*` variables just in case. In the future, reliance on `matrix-nginx-proxy` will be removed." +#: ../../../CHANGELOG.md:1247 +msgid "See our [Setting up synapse-auto-compressor](docs/configuring-playbook-synapse-auto-compressor.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:1255 -msgid "Switching to Traefik will obtain new SSL certificates from Let's Encrypt (stored in `/matrix/traefik/ssl/acme.json`). **The switch is reversible**. You can always go back to `playbook-managed-nginx` if Traefik is causing you trouble." +#: ../../../CHANGELOG.md:1250 +msgid "2023-03-07" msgstr "" -#: ../../../CHANGELOG.md:1257 -msgid "**Note**: toggling `matrix_playbook_reverse_proxy_type` between Traefik and nginx will uninstall the Traefik role and all of its data (under `/matrix/traefik`), so you may run into a Let's Encrypt rate limit if you do it often." +#: ../../../CHANGELOG.md:1252 +msgid "Sliding Sync proxy (Element X) support" msgstr "" -#: ../../../CHANGELOG.md:1259 -msgid "Treafik directly reverse-proxies to **some** services right now, but for most other services it goes through `matrix-nginx-proxy` (e.g. Traefik -> `matrix-nginx-proxy` -> [Ntfy](docs/configuring-playbook-ntfy.md)). So, even if you opt into Traefik, you'll still see `matrix-nginx-proxy` being installed in local-only mode. This will improve with time." +#: ../../../CHANGELOG.md:1254 +msgid "Thanks to [Benjamin Kampmann](https://github.com/gnunicorn) for [getting it started](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2515), [FSG-Cat](https://github.com/FSG-Cat) for fixing it up and me ([Slavi](https://github.com/spantaleev)) for polishing it up, the playbook can now install and configure the [sliding-sync proxy](https://github.com/matrix-org/sliding-sync)." +msgstr "" + +#: ../../../CHANGELOG.md:1256 +msgid "The upcoming Element X clients ([Element X iOS](https://github.com/vector-im/element-x-ios) and [Element X Android](https://github.com/vector-im/element-x-android)) require the `sliding-sync` proxy to do their job. **These clients are still in beta** (especially Element X Android, which requires manual compilation to get it working with a non-`matrix.org` homeseserver). Playbook users can now easily give these clients a try and help test them thanks to us having `sliding-sync` support." +msgstr "" + +#: ../../../CHANGELOG.md:1258 +msgid "To get started, see our [Setting up the Sliding Sync proxy](docs/configuring-playbook-sliding-sync-proxy.md) documentation page." msgstr "" #: ../../../CHANGELOG.md:1261 -msgid "Some services (like [coturn](docs/configuring-playbook-turn.md) and [Postmoogle](docs/configuring-playbook-bridge-postmoogle.md)) cannot be reverse-proxied to directly from Traefik, so they require direct access to SSL certificate files extracted out of Traefik. The playbook does this automatically thanks to a new [com.devture.ansible.role.traefik_certs_dumper](https://github.com/devture/com.devture.ansible.role.traefik_certs_dumper) role utilizing the [traefik-certs-dumper](https://github.com/ldez/traefik-certs-dumper) tool." +msgid "2023-03-02" msgstr "" #: ../../../CHANGELOG.md:1263 -msgid "Our Traefik setup mostly works, but certain esoteric features may not work. If you have a default setup, we expect you to have a good experience." +msgid "The matrix-etherpad role lives independently now" msgstr "" #: ../../../CHANGELOG.md:1265 -msgid "Where we're going in the near future?" +msgid "**TLDR**: the `matrix-etherpad` role is now included from [another repository](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad). Some variables have been renamed. All functionality remains intact." msgstr "" #: ../../../CHANGELOG.md:1267 -msgid "The `matrix-nginx-proxy` role is quite messy. It manages both nginx and Certbot and its certificate renewal scripts and timers. It generates configuration even when the role is disabled (weird). Although it doesn't directly reach into variables from other roles, it has explicit awareness of various other services that it reverse-proxies to (`roles/custom/matrix-nginx-proxy/templates/nginx/conf.d/matrix-ntfy.conf.j2`, etc.). We'd like to clean this up. The only way is probably to just get rid of the whole thing at some point." +msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're using Etherpad or not." msgstr "" #: ../../../CHANGELOG.md:1269 -msgid "For now, `matrix-nginx-proxy` will stay around." +msgid "If you're making use of Etherpad via this playbook, you will need to update variable references in your `vars.yml` file:" msgstr "" #: ../../../CHANGELOG.md:1271 -msgid "As mentioned above, Traefik still reverse-proxies to some (most) services by going through a local-only `matrix-nginx-proxy` server. This has allowed us to add Traefik support to the playbook early on (without having to rework all services), but is not the final goal. We'll **work on making each service support Traefik natively**, so that traffic will not need to go through `matrix-nginx-proxy` anymore. In the end, choosing Traefik should only give you a pure Traefik installation with no `matrix-nginx-proxy` in sight." +msgid "Rename `matrix_etherpad_public_endpoint` to `etherpad_path_prefix`" msgstr "" #: ../../../CHANGELOG.md:1273 -msgid "As Traefik support becomes complete and proves to be stable for a while, especially as a playbook default, we will **most likely remove `matrix-nginx-proxy` completely**. It will likely be some months before this happens though. Keeping support for both Traefik and nginx in the playbook will be a burden, especially with most of us running Traefik in the future. The Traefik role should do everything nginx does in a better and cleaner way. Users who use their own `nginx` server on the Matrix server will be inconvenienced, as nothing will generate ready-to-include nginx configuration for them. Still, we hope it won't be too hard to migrate their setup to another way of doing things, like:" +msgid "Replace `matrix_etherpad_mode: dimension` with:" +msgstr "" + +#: ../../../CHANGELOG.md:1274 +msgid "for `matrix-nginx-proxy` users:" msgstr "" #: ../../../CHANGELOG.md:1275 -msgid "not using nginx anymore. A common reason for using nginx until now was that you were running other containers and you need your own nginx to reverse-proxy to all of them. Just switch them to Traefik as well." +msgid "`etherpad_nginx_proxy_dimension_integration_enabled: true`" msgstr "" #: ../../../CHANGELOG.md:1276 -msgid "running Traefik in local-only mode (`traefik_config_entrypoint_web_secure_enabled: false`) and using some nginx configuration which reverse-proxies to Traefik (we should introduce examples for this in `examples/nginx`)." +msgid "`etherpad_hostname: \"{{ matrix_server_fqn_dimension }}\"`" +msgstr "" + +#: ../../../CHANGELOG.md:1277 +msgid "for Traefik users:" msgstr "" #: ../../../CHANGELOG.md:1278 -msgid "How do I help?" +msgid "define your own `etherpad_hostname` and `etherpad_path_prefix` as you see fit" msgstr "" #: ../../../CHANGELOG.md:1280 -msgid "You can help by:" +msgid "Rename all other variables:" +msgstr "" + +#: ../../../CHANGELOG.md:1281 +msgid "`matrix_etherpad_docker_image_` -> `matrix_etherpad_container_image_`" msgstr "" #: ../../../CHANGELOG.md:1282 -msgid "**explicitly switching your server to Traefik** right now (see example configuration in [How do I explicitly switch to Traefik right now?](#how-do-i-explicitly-switch-to-traefik-right-now) above), testing, reporting troubles" +msgid "`matrix_etherpad_` -> `etherpad_`" msgstr "" #: ../../../CHANGELOG.md:1284 -msgid "**adding native Traefik support to a role** (requires adding Traefik labels, etc.) — for inspiration, see these roles ([prometheus_node_exporter](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-node-exporter), [prometheus_postgres_exporter](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-postgres-exporter)) and how they're hooked into the playbook via [group_vars/matrix_servers](group_vars/matrix_servers)." +msgid "Along with this relocation, the new role also:" msgstr "" #: ../../../CHANGELOG.md:1286 -msgid "**adding reverse-proxying examples for nginx users** in `examples/nginx`. People who insist on using their own `nginx` server on the same Matrix host, can run Traefik in local-only mode (`traefik_config_entrypoint_web_secure_enabled: false`) and reverse-proxy to the Traefik server" +msgid "supports [self-building](docs/self-building.md), so it should work on `arm32` and `arm64` architectures" msgstr "" -#: ../../../CHANGELOG.md:1289 -msgid "2023-02-10" +#: ../../../CHANGELOG.md:1287 +msgid "has native Traefik reverse-proxy support (Etherpad requests no longer go through `matrix-nginx-proxy` when using Traefik)" msgstr "" -#: ../../../CHANGELOG.md:1291 -msgid "Matrix Authentication Support for Jitsi" +#: ../../../CHANGELOG.md:1290 +msgid "2023-02-26" msgstr "" -#: ../../../CHANGELOG.md:1293 -msgid "Thanks to [Jakob S.](https://github.com/jakicoll) ([zakk gGmbH](https://github.com/zakk-it)), Jitsi can now use Matrix for authentication (via [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service))." +#: ../../../CHANGELOG.md:1292 +msgid "Traefik is the default reverse-proxy now" msgstr "" -#: ../../../CHANGELOG.md:1295 -msgid "Additional details are available in the [Authenticate using Matrix OpenID (Auth-Type 'matrix')](docs/configuring-playbook-jitsi.md#authenticate-using-matrix-openid-auth-type-matrix)." +#: ../../../CHANGELOG.md:1294 +msgid "**TLDR**: new installations will now default to Traefik as their reverse-proxy. Existing users need to explicitly choose their reverse-proxy type. [Switching to Traefik](#how-do-i-switch-my-existing-setup-to-traefik) is strongly encouraged. `matrix-nginx-proxy` may break over time and will ultimately be removed." msgstr "" -#: ../../../CHANGELOG.md:1297 -msgid "Draupnir moderation tool (bot) support" +#: ../../../CHANGELOG.md:1296 +msgid "As mentioned 2 weeks ago in [(Backward Compatibility) Reverse-proxy configuration changes and initial Traefik support](#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support), the playbook is moving to Traefik as its default SSL-terminating reverse-proxy." msgstr "" -#: ../../../CHANGELOG.md:1299 -msgid "Thanks to [FSG-Cat](https://github.com/FSG-Cat), the playbook can now install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool (bot). Draupnir is a fork of [Mjolnir](docs/configuring-playbook-bot-mjolnir.md) (which the playbook has supported for a long time) maintained by Mjolnir's former lead developer." +#: ../../../CHANGELOG.md:1298 +msgid "Until now, we've been doing the migration gradually and keeping full backward compatibility. New installations were defaulting to `matrix-nginx-proxy` (just like before), while existing installations were allowed to remain on `matrix-nginx-proxy` as well. This makes things very difficult for us, because we need to maintain and think about lots of different setups:" +msgstr "" + +#: ../../../CHANGELOG.md:1300 +msgid "Traefik managed by the playbook" msgstr "" #: ../../../CHANGELOG.md:1301 -msgid "Additional details are available in [Setting up Draupnir](docs/configuring-playbook-bot-draupnir.md)." +msgid "Traefik managed by the user in another way" +msgstr "" + +#: ../../../CHANGELOG.md:1302 +msgid "another reverse-proxy on the same host (`127.0.0.1` port exposure)" +msgstr "" + +#: ../../../CHANGELOG.md:1303 +msgid "another reverse-proxy on another host (`0.0.0.0` port exposure)" msgstr "" #: ../../../CHANGELOG.md:1304 -msgid "2023-02-05" +msgid "`matrix-nginx-proxy` — an `nginx` container managed by the playbook" msgstr "" -#: ../../../CHANGELOG.md:1306 -msgid "The matrix-prometheus-postgres-exporter role lives independently now" +#: ../../../CHANGELOG.md:1305 +msgid "`nginx` webserver operated by the user, running without a container on the same server" msgstr "" -#: ../../../CHANGELOG.md:1308 -msgid "**TLDR**: the `matrix-prometheus-postgres-exporter` role is now included from another repository. Some variables have been renamed. All functionality remains intact." +#: ../../../CHANGELOG.md:1307 +msgid "Each change we do and each new feature that comes in needs to support all these different ways of reverse-proxying. Because `matrix-nginx-proxy` was the default and pretty much everyone was (and still is) using it, means that new PRs also come with `matrix-nginx-proxy` as their main focus and Traefik as an afterthought, which means we need to spend hours fixing up Traefik support." msgstr "" -#: ../../../CHANGELOG.md:1310 -msgid "The `matrix-prometheus-postgres-exporter` role (which configures [Prometheus Postgres Exporter](https://github.com/prometheus-community/postgres_exporter)) has been extracted from the playbook and now lives in its own repository at https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-postgres-exporter" +#: ../../../CHANGELOG.md:1309 +msgid "We can't spend all this time maintaining so many different configurations anymore. Traefik support has been an option for 2 weeks and lots of people have already migrated their server and have tested things out. Traefik is what we use and preferentially test for." msgstr "" -#: ../../../CHANGELOG.md:1312 -msgid "It's still part of the playbook, but is now installed via `ansible-galaxy` (by running `just roles` / `make roles`). Some variables have been renamed (`matrix_prometheus_postgres_exporter_` -> `prometheus_postgres_exporter_`, etc.). The playbook will report all variables that you need to rename to get upgraded. All functionality remains intact." +#: ../../../CHANGELOG.md:1311 +msgid "It's time for the **next step in our migration process** to Traefik and elimination of `matrix-nginx-proxy`:" +msgstr "" + +#: ../../../CHANGELOG.md:1313 +msgid "Traefik is now the default reverse-proxy for new installations" msgstr "" #: ../../../CHANGELOG.md:1314 -msgid "The `matrix-prometheus-services-proxy-connect` role has bee adjusted to help integrate the new `prometheus_postgres_exporter` role with our own services (`matrix-nginx-proxy`)" +msgid "All existing users need to explicitly choose their reverse-proxy type by defining the `matrix_playbook_reverse_proxy_type` variable in their `vars.yml` configuration file. We strongly encourage existing users to [switch the Traefik](#how-to-switch-an-existing-setup-to-traefik), as the nginx setup is bound to become more and more broken over time until it's ultimately removed" msgstr "" #: ../../../CHANGELOG.md:1316 -#: ../../../CHANGELOG.md:1358 -msgid "Other roles which aren't strictly related to Matrix are likely to follow this fate of moving to their own repositories. Extracting them out allows other Ansible playbooks to make use of these roles easily." +msgid "How do I switch my existing setup to Traefik?" msgstr "" -#: ../../../CHANGELOG.md:1319 -msgid "2023-01-26" +#: ../../../CHANGELOG.md:1318 +msgid "**For users who are on `matrix-nginx-proxy`** (the default reverse-proxy provided by the playbook), switching to Traefik can happen with a simple configuration change. Follow this section from 2 weeks ago: [How do I explicitly switch to Traefik right now?](#how-do-i-explicitly-switch-to-traefik-right-now)." msgstr "" -#: ../../../CHANGELOG.md:1321 -msgid "coturn can now use host-networking" +#: ../../../CHANGELOG.md:1320 +msgid "If you experience trouble:" +msgstr "" + +#: ../../../CHANGELOG.md:1322 +msgid "Follow [How do I remain on matrix-nginx-proxy?](#how-do-i-remain-on-matrix-nginx-proxy) to bring your server back online using the old reverse-proxy" msgstr "" #: ../../../CHANGELOG.md:1323 -msgid "Large coturn deployments (with a huge range of ports specified via `matrix_coturn_turn_udp_min_port` and `matrix_coturn_turn_udp_max_port`) experience a huge slowdown with how Docker publishes all these ports (setting up firewall forwarding rules), which leads to a very slow coturn service startup and shutdown." +msgid "Ask for help in our [support channels](README.md#support)" msgstr "" -#: ../../../CHANGELOG.md:1325 -msgid "Such deployments don't need to run coturn within a private container network anymore. coturn can now run with host-networking by using configuration like this:" +#: ../../../CHANGELOG.md:1324 +msgid "Try switching to Traefik again later" msgstr "" -#: ../../../CHANGELOG.md:1331 -msgid "With such a configuration, **Docker no longer needs to configure thousands of firewall forwarding rules** each time coturn starts and stops. This, however, means that **you will need to ensure these ports are open** in your firewall yourself." +#: ../../../CHANGELOG.md:1326 +msgid "**For users with a more special reverse-proxying setup** (another nginx server, Apache, Caddy, etc.), the migration may not be so smooth. Follow the [Using your own webserver](docs/configuring-playbook-own-webserver.md) guide. Ideally, your custom reverse-proxy will be configured in such a way that it **fronts the Traefik reverse-proxy** provided by the playbook. Other means of reverse-proxying are more fragile and may be deprecated in the future." msgstr "" -#: ../../../CHANGELOG.md:1333 -msgid "Thanks to us [tightening coturn security](#backward-compatibility-tightening-coturn-security-can-lead-to-connectivity-issues), running coturn with host-networking should be safe and not expose neither other services running on the host, nor other services running on the local network." +#: ../../../CHANGELOG.md:1328 +msgid "I already use my own Traefik server. How do I plug that in?" msgstr "" -#: ../../../CHANGELOG.md:1335 -msgid "(Backward Compatibility) Tightening coturn security can lead to connectivity issues" +#: ../../../CHANGELOG.md:1330 +msgid "See the [Traefik managed by the playbook](docs/configuring-playbook-own-webserver.md#traefik-managed-by-the-playbook) section." msgstr "" -#: ../../../CHANGELOG.md:1337 -msgid "**TLDR**: users who run and access their Matrix server on a private network (likely a small minority of users) may experience connectivity issues with our new default coturn blocklists. They may need to override `matrix_coturn_denied_peer_ips` and remove some IP ranges from it." +#: ../../../CHANGELOG.md:1332 +msgid "Why is matrix-nginx-proxy used even after switching to Traefik?" msgstr "" -#: ../../../CHANGELOG.md:1339 -msgid "Inspired by [this security article](https://www.rtcsec.com/article/cve-2020-26262-bypass-of-coturns-access-control-protection/), we've decided to make use of coturn's `denied-peer-ip` functionality to prevent relaying network traffic to certain private IP subnets. This ensures that your coturn server won't accidentally try to forward traffic to certain services running on your local networks. We run coturn in a container and in a private container network by default, which should prevent such access anyway, but having additional block layers in place is better." +#: ../../../CHANGELOG.md:1334 +msgid "This playbook manages many different services. All these services were initially integrated with `matrix-nginx-proxy`." msgstr "" -#: ../../../CHANGELOG.md:1341 -msgid "If you access your Matrix server from a local network and need coturn to relay to private IP addresses, you may observe that relaying is now blocked due to our new default `denied-peer-ip` lists (specified in `matrix_coturn_denied_peer_ips`). If you experience such connectivity problems, consider overriding this setting in your `vars.yml` file and removing certain networks from it." +#: ../../../CHANGELOG.md:1336 +msgid "While we migrate all these components to have native Traefik support, some still go through nginx internally (Traefik -> local `matrix-nginx-proxy` -> component). As time goes on, internal reliance on `matrix-nginx-proxy` will gradually decrease until it's completely removed." msgstr "" -#: ../../../CHANGELOG.md:1343 -msgid "We've also added `no-multicast-peers` to the default coturn configuration, but we don't expect this to cause trouble for most people." +#: ../../../CHANGELOG.md:1338 +msgid "How do I remain on matrix-nginx-proxy?" +msgstr "" + +#: ../../../CHANGELOG.md:1340 +msgid "Most new work and testing targets Traefik, so remaining on nginx is **not** \"the good old stable\" option, but rather the \"still available, but largely untested and likely to be broken very soon\" option." +msgstr "" + +#: ../../../CHANGELOG.md:1342 +msgid "To proceed regardless of this warning, add `matrix_playbook_reverse_proxy_type: playbook-managed-nginx` to your configuration." +msgstr "" + +#: ../../../CHANGELOG.md:1344 +msgid "At some point in the **near** future (days, or even weeks at most), we hope to completely get rid of `matrix-nginx-proxy` (or break it enough to make it unusable), so you **will soon be forced to migrate** anyway. Plan your migration accordingly." msgstr "" #: ../../../CHANGELOG.md:1346 -msgid "2023-01-21" +msgid "How do I keep using my own other reverse-proxy?" msgstr "" #: ../../../CHANGELOG.md:1348 -msgid "The matrix-prometheus-node-exporter role lives independently now" +msgid "We recommend that you follow the guide for [Fronting the integrated reverse-proxy webserver with another reverse-proxy](docs/configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy)." msgstr "" -#: ../../../CHANGELOG.md:1350 -msgid "**TLDR**: the `matrix-prometheus-node-exporter` role is now included from another repository. Some variables have been renamed. All functionality remains intact." +#: ../../../CHANGELOG.md:1351 +msgid "2023-02-25" msgstr "" -#: ../../../CHANGELOG.md:1352 -msgid "The `matrix-prometheus-node-exporter` role (which configures [Prometheus node exporter](https://github.com/prometheus/node_exporter)) has been extracted from the playbook and now lives in its own repository at https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-node-exporter" +#: ../../../CHANGELOG.md:1353 +msgid "rageshake support" msgstr "" -#: ../../../CHANGELOG.md:1354 -msgid "It's still part of the playbook, but is now installed via `ansible-galaxy` (by running `just roles` / `make roles`). Some variables have been renamed (`matrix_prometheus_node_exporter_` -> `prometheus_node_exporter_`, etc.). The playbook will report all variables that you need to rename to get upgraded. All functionality remains intact." +#: ../../../CHANGELOG.md:1355 +msgid "Thanks to [Benjamin Kampmann](https://github.com/gnunicorn), the playbook can now install and configure the [rageshake](https://github.com/matrix-org/rageshake) bug report server." msgstr "" -#: ../../../CHANGELOG.md:1356 -msgid "A new `matrix-prometheus-services-proxy-connect` role was added to the playbook to help integrate the new `prometheus_node_exporter` role with our own services (`matrix-nginx-proxy`)" +#: ../../../CHANGELOG.md:1357 +msgid "Additional details are available in [Setting up rageshake](docs/configuring-playbook-rageshake.md)." msgstr "" -#: ../../../CHANGELOG.md:1361 -msgid "2023-01-13" +#: ../../../CHANGELOG.md:1360 +msgid "2023-02-17" msgstr "" -#: ../../../CHANGELOG.md:1363 -msgid "Support for running commands via just" +#: ../../../CHANGELOG.md:1362 +msgid "Synapse templates customization support" msgstr "" -#: ../../../CHANGELOG.md:1365 -msgid "We've previously used [make](https://www.gnu.org/software/make/) for easily running some playbook commands (e.g. `make roles` which triggers `ansible-galaxy`, see [Makefile](Makefile)). Our `Makefile` is still around and you can still run these commands." +#: ../../../CHANGELOG.md:1364 +msgid "The playbook can now help you customize Synapse's templates." msgstr "" -#: ../../../CHANGELOG.md:1367 -msgid "In addition, we've added support for running commands via [just](https://github.com/casey/just) — a more modern command-runner alternative to `make`. Instead of `make roles`, you can now run `just roles` to accomplish the same." +#: ../../../CHANGELOG.md:1366 +msgid "Additional details are available in the [Customizing templates](docs/configuring-playbook-synapse.md#customizing-templates) section of our Synapse documentation." msgstr "" -#: ../../../CHANGELOG.md:1369 -msgid "Our [justfile](justfile) already defines some additional helpful **shortcut** commands that weren't part of our `Makefile`. Here are some examples:" +#: ../../../CHANGELOG.md:1368 +msgid "The matrix-redis role lives independently now" msgstr "" -#: ../../../CHANGELOG.md:1371 -msgid "`just install-all` to trigger the much longer `ansible-playbook -i inventory/hosts setup.yml --tags=install-all,ensure-matrix-users-created,start` command" +#: ../../../CHANGELOG.md:1370 +msgid "**TLDR**: the `matrix-redis` role is now included from another repository. Some variables have been renamed. All functionality remains intact." msgstr "" #: ../../../CHANGELOG.md:1372 -msgid "`just install-all --ask-vault-pass` — commands also support additional arguments (`--ask-vault-pass` will be appended to the above installation command)" -msgstr "" - -#: ../../../CHANGELOG.md:1373 -msgid "`just run-tags install-mautrix-slack,start` — to run specific playbook tags" +msgid "The `matrix-redis` role (which configures [Redis](https://redis.io/)) has been extracted from the playbook and now lives in its [own repository](https://github.com/mother-of-all-self-hosting/ansible-role-redis). This makes it possible to easily use it in other Ansible playbooks." msgstr "" #: ../../../CHANGELOG.md:1374 -msgid "`just start-all` — (re-)starts all services" -msgstr "" - -#: ../../../CHANGELOG.md:1375 -msgid "`just stop-group postgres` — to stop only the Postgres service" +msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're enabling Ntfy or not. If you're making use of Ntfy via this playbook, you will need to update variable references in your `vars.yml` file (`matrix_redis_` -> `redis_`)." msgstr "" #: ../../../CHANGELOG.md:1376 -msgid "`just register-user alice secret-password yes` — registers an `alice` user with the `secret-password` password and admin access (admin = `yes`)" +msgid "The matrix-ntfy role lives independently now" msgstr "" #: ../../../CHANGELOG.md:1378 -msgid "Additional helpful commands and shortcuts may be defined in the future." +msgid "**TLDR**: the `matrix-ntfy` role is now included from another repository. Some variables have been renamed. All functionality remains intact." msgstr "" #: ../../../CHANGELOG.md:1380 -msgid "This is all completely optional. If you find it difficult to [install `just`](https://github.com/casey/just#installation) or don't find any of this convenient, feel free to run all commands manually." +msgid "The `matrix-ntfy` role (which configures [Ntfy](https://ntfy.sh/)) has been extracted from the playbook and now lives in its [own repository](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy). This makes it possible to easily use it in other Ansible playbooks." msgstr "" -#: ../../../CHANGELOG.md:1383 -msgid "2023-01-11" +#: ../../../CHANGELOG.md:1382 +msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're enabling Ntfy or not. If you're making use of Ntfy via this playbook, you will need to update variable references in your `vars.yml` file (`matrix_ntfy_` -> `ntfy_`)." msgstr "" #: ../../../CHANGELOG.md:1385 -msgid "mautrix-slack support" +msgid "2023-02-15" msgstr "" #: ../../../CHANGELOG.md:1387 -msgid "Thanks to [Cody Neiman](https://github.com/xangelix)'s efforts, the playbook now supports bridging to [Slack](https://slack.com/) via the [mautrix-slack](https://mau.dev/mautrix/slack) bridge. See our [Setting up Mautrix Slack bridging](docs/configuring-playbook-bridge-mautrix-slack.md) documentation page for getting started." +msgid "The matrix-grafana role lives independently now" msgstr "" #: ../../../CHANGELOG.md:1389 -msgid "**Note**: this is a new Slack bridge. The playbook still retains Slack bridging via [matrix-appservice-slack](docs/configuring-playbook-bridge-appservice-slack.md) and [mx-puppet-slack](docs/configuring-playbook-bridge-mx-puppet-slack.md). You're free to use the bridge that serves you better, or even all three of them (for different users and use-cases)." +msgid "**TLDR**: the `matrix-grafana` role is now included from another repository. Some variables have been renamed. All functionality remains intact." msgstr "" -#: ../../../CHANGELOG.md:1392 -msgid "2023-01-10" +#: ../../../CHANGELOG.md:1391 +msgid "The `matrix-grafana` role (which configures [Grafana](docs/configuring-playbook-prometheus-grafana.md)) has been extracted from the playbook and now lives in its [own repository](https://github.com/mother-of-all-self-hosting/ansible-role-grafana). This makes it possible to easily use it in other Ansible playbooks." msgstr "" -#: ../../../CHANGELOG.md:1394 -msgid "ChatGPT support" +#: ../../../CHANGELOG.md:1393 +msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're enabling Grafana or not. If you're making use of Grafana via this playbook, you will need to update variable references in your `vars.yml` file (`matrix_grafana_` -> `grafana_`)." msgstr "" #: ../../../CHANGELOG.md:1396 -msgid "Thanks to [@bertybuttface](https://github.com/bertybuttface), the playbook can now help you set up [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) — a bot through which you can talk to the [ChatGPT](https://openai.com/blog/chatgpt/) model." +msgid "2023-02-13" msgstr "" #: ../../../CHANGELOG.md:1398 -msgid "See our [Setting up matrix-bot-chatgpt](docs/configuring-playbook-bot-chatgpt.md) documentation to get started." +msgid "The matrix-backup-borg role lives independently now" msgstr "" -#: ../../../CHANGELOG.md:1401 -msgid "2022-11-30" +#: ../../../CHANGELOG.md:1400 +msgid "**TLDR**: the `matrix-backup-borg` role is now included from another repository. Some variables have been renamed. All functionality remains intact." msgstr "" -#: ../../../CHANGELOG.md:1403 -msgid "matrix-postgres-backup has been replaced by the ansible-role-postgres-backup external role" +#: ../../../CHANGELOG.md:1402 +msgid "Thanks to [moan0s](https://github.com/moan0s), the `matrix-backup-borg` role (which configures [BorgBackup](docs/configuring-playbook-backup-borg.md)) has been extracted from the playbook and now lives in its [own repository](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg). This makes it possible to easily use it in other Ansible playbooks and will become part of [nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy) soon." msgstr "" -#: ../../../CHANGELOG.md:1405 -msgid "Just like we've [replaced Postgres with an external role](#matrix-postgres-has-been-replaced-by-the-comdevtureansiblerolepostgres-external-role) on 2022-11-28, we're now replacing `matrix-postgres-backup` with an external role — [com.devture.ansible.role.postgres_backup](https://github.com/mother-of-all-self-hosting/ansible-role-postgres_backup)." +#: ../../../CHANGELOG.md:1404 +msgid "You need to **update your roles** (`just roles` or `make roles`) regardless of whether you're enabling Borg's backup functionality or not. If you're making use of BorgBackup via this playbook, you will need to update variable references in your `vars.yml` file (`matrix_backup_borg_` -> `backup_borg_`)." msgstr "" #: ../../../CHANGELOG.md:1407 -msgid "You'll need to rename your `matrix_postgres_backup`-prefixed variables such that they use a `postgres_backup` prefix." +msgid "2023-02-12" msgstr "" -#: ../../../CHANGELOG.md:1410 -msgid "2022-11-28" +#: ../../../CHANGELOG.md:1409 +msgid "(Backward Compatibility) Reverse-proxy configuration changes and initial Traefik support" msgstr "" -#: ../../../CHANGELOG.md:1412 -msgid "matrix-postgres has been replaced by the ansible-role-postgres external role" +#: ../../../CHANGELOG.md:1411 +msgid "**TLDR**:" +msgstr "" + +#: ../../../CHANGELOG.md:1413 +msgid "there's a new `matrix_playbook_reverse_proxy_type` variable (see [roles/custom/matrix-base/defaults/main.yml](roles/custom/matrix-base/defaults/main.yml)), which lets you tell the playbook what reverse-proxy setup you'd like to have. This makes it easier for people who want to do reverse-proxying in other ways." msgstr "" #: ../../../CHANGELOG.md:1414 -msgid "**TLDR**: the tasks that install the integrated Postgres server now live in an external role — [ansible-role-postgres](https://github.com/mother-of-all-self-hosting/ansible-role-postgres). You'll need to run `make roles` to install it, and to also rename your `matrix_postgres`-prefixed variables to use a `devture_postgres` prefix (e.g. `matrix_postgres_connection_password` -> `postgres_connection_password`). All your data will still be there! Some scripts have moved (`/usr/local/bin/matrix-postgres-cli` -> `/matrix/postgres/bin/cli`)." +msgid "the default reverse-proxy (`matrix_playbook_reverse_proxy_type`) is still `playbook-managed-nginx` (via `matrix-nginx-proxy`), for now. **Existing `matrix-nginx-proxy` users should not observe any changes** and can stay on this for now." +msgstr "" + +#: ../../../CHANGELOG.md:1415 +msgid "**Users who use their [own other webserver](docs/configuring-playbook-own-webserver.md) (e.g. Apache, etc.) need to change** `matrix_playbook_reverse_proxy_type` to something like `other-on-same-host`, `other-on-another-host` or `other-nginx-non-container`" msgstr "" #: ../../../CHANGELOG.md:1416 -msgid "The `matrix-postgres` role that has been part of the playbook for a long time has been replaced with the [ansible-role-postgres](https://github.com/mother-of-all-self-hosting/ansible-role-postgres) role. This was done as part of our work to [use external roles for some things](#the-playbook-now-uses-external-roles-for-some-things) for better code re-use and maintainability." +msgid "we now have **optional [Traefik](https://traefik.io/) support**, so you could easily host Matrix and other Traefik-native services in containers on the same server. Traefik support is still experimental (albeit, good enough) and will improve over time. It does work, but certain esoteric features may not be there yet." msgstr "" -#: ../../../CHANGELOG.md:1418 -msgid "The new role is an upgraded version of the old `matrix-postgres` role with these notable differences:" +#: ../../../CHANGELOG.md:1417 +msgid "**Traefik will become the default reverse-proxy in the near future**. `matrix-nginx-proxy` will either remain as an option, or be completely removed to simplify the playbook" msgstr "" -#: ../../../CHANGELOG.md:1420 -msgid "it uses different names for its variables (`matrix_postgres` -> `devture_postgres`)" +#: ../../../CHANGELOG.md:1419 +msgid "Motivation for redoing our reverse-proxy setup" msgstr "" #: ../../../CHANGELOG.md:1421 -msgid "when [Vacuuming PostgreSQL](docs/maintenance-postgres.md#vacuuming-postgresql), it will vacuum all your databases, not just the Synapse one" +msgid "The playbook has supported various reverse-proxy setups for a long time. We have various configuration variables (`matrix_nginx_proxy_enabled`, various `_host_bind_port` variables, etc.) which allow the playbook to adapt to these different setups. The whole situation was messy though — hard to figure out and with lots of variables to toggle to make things work as you'd expect — huge **operational complexity**." msgstr "" #: ../../../CHANGELOG.md:1423 -msgid "You'll need to run `make roles` to install the new role. You would also need to rename your `matrix_postgres`-prefixed variables to use a `devture_postgres` prefix." +msgid "We love containers, proven by the fact that **everything** that this playbook manages runs in a container. Yet, we weren't allowing people to easily host other web-exposed containers alongside Matrix services on the same server. We were using `matrix-nginx-proxy` (our integrated [nginx](https://nginx.org/) server), which was handling web-exposure and SSL termination for our own services, but we **weren't helping you with all your other containers**." msgstr "" #: ../../../CHANGELOG.md:1425 -msgid "Note: the systemd service still remains the same — `matrix-postgres.service`. Your data will still be in `/matrix/postgres`, etc. Postgres-related scripts will be moved to `/matrix/postgres/bin` (`/usr/local/bin/matrix-postgres-cli` -> `/matrix/postgres/bin/cli`, etc). Also see [The playbook no longer installs scripts in /usr/local/bin](#the-playbook-no-longer-installs-scripts-in-usrlocalbin)." +msgid "People who were **using `matrix-nginx-proxy`** were on the happy path on which everything worked well by default (Matrix-wise), **but** could not easily run other web-exposed services on their Matrix server because `matrix-nginx-proxy` was occupying ports `80` and `443`. Other services which wanted to get web exposure either had to be plugged into `matrix-nginx-proxy` (somewhat difficult) or people had to forgo using `matrix-nginx-proxy` in favor of something else." msgstr "" #: ../../../CHANGELOG.md:1427 -msgid "The playbook no longer installs scripts to /usr/local/bin" +msgid "Of those that decided to forgo `matrix-nginx-proxy`, many were **using nginx** on the same server without a container. This was likely some ancient nginx version, depending on your choice of distro. The Matrix playbook was trying to be helpful and even with `matrix_nginx_proxy_enabled: false` was still generating nginx configuration in `/matrix/nginx-proxy/conf.d`. Those configuration files were adapted for inclusion into an nginx server running locally. Disabling the `matrix-nginx-proxy` role like this, yet still having it produce files is a bit disgusting, but it's what we've had since the early beginnings of this playbook." msgstr "" #: ../../../CHANGELOG.md:1429 -msgid "The locations of various scripts installed by the playbook have changed." +msgid "Others still, wanted to run Matrix locally (no SSL certificates), regardless of which web server technology this relied on, and then **reverse-proxy from another machine on the network** which was doing SSL termination. These people were:" msgstr "" #: ../../../CHANGELOG.md:1431 -msgid "The playbook no longer contaminates your `/usr/local/bin` directory. All scripts installed by the playbook now live in `bin/` directories under `/matrix`. Some examples are below:" +msgid "*either* relying on `matrix_nginx_proxy_enabled: false` as well, combined with exposing services manually (setting `_bind_port` variables)" msgstr "" -#: ../../../CHANGELOG.md:1433 -msgid "`/usr/local/bin/matrix-remove-all` -> `/matrix/bin/remove-all`" +#: ../../../CHANGELOG.md:1432 +msgid "*or* better yet, they were keeping `matrix-nginx-proxy` enabled, but in `http`-only mode (no SSL certificate retrieval)." msgstr "" #: ../../../CHANGELOG.md:1434 -msgid "`/usr/local/bin/matrix-postgres-cli` -> `/matrix/postgres/bin/cli`" -msgstr "" - -#: ../../../CHANGELOG.md:1435 -msgid "`/usr/local/bin/matrix-ssl-lets-encrypt-certificates-renew` -> `/matrix/ssl/bin/lets-encrypt-certificates-renew`" +msgid "Despite this operational complexity, things worked and were reasonably flexible to adapt to all these situations." msgstr "" #: ../../../CHANGELOG.md:1436 -msgid "`/usr/local/bin/matrix-synapse-register-user` -> `/matrix/synapse/bin/register-user`" +msgid "When using `matrix-nginx-proxy` as is, we still had another problem — one of **internal playbook complexity**. Too many services need to be web-exposed (port 80/443, SSL certificates). Because of this, they all had to integrate with the `matrix-nginx-proxy` role. Tens of different roles explicitly integrating with `matrix-nginx-proxy` is not what we call clean. The `matrix-nginx-proxy` role contains variables for many of these roles (yikes). Other roles were more decoupled from it and were injecting configuration into `matrix-nginx-proxy` at runtime — see all the `inject_into_nginx_proxy.yml` task files in this playbook (more decoupled, but still… yikes)." msgstr "" -#: ../../../CHANGELOG.md:1439 -msgid "2022-11-25" +#: ../../../CHANGELOG.md:1438 +msgid "The next problem is one of **efficiency, interoperability and cost-saving**. We're working on other playbooks:" +msgstr "" + +#: ../../../CHANGELOG.md:1440 +msgid "[vaultwarden-docker-ansible-deploy](https://github.com/spantaleev/vaultwarden-docker-ansible-deploy) for hosting the [Vaultwarden](https://github.com/dani-garcia/vaultwarden) server — an alternative implementation of the [Bitwarden](https://bitwarden.com/) password manager" msgstr "" #: ../../../CHANGELOG.md:1441 -msgid "2x-5x performance improvements in playbook runtime" +msgid "[gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy) — for hosting the [Gitea](https://gitea.io/) git source code hosting service" msgstr "" -#: ../../../CHANGELOG.md:1443 -msgid "**TLDR**: the playbook is 2x faster for running `--tags=setup-all` (and various other tags). It also has new `--tags=install-*` tags (like `--tags=install-all`), which skip uninstallation tasks and bring an additional 2.5x speedup. In total, the playbook can maintain your server 5 times faster." +#: ../../../CHANGELOG.md:1442 +msgid "[nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy) — for hosting the [Nextcloud](https://nextcloud.com/) groupware platform" msgstr "" -#: ../../../CHANGELOG.md:1445 -msgid "Our [etke.cc managed Matrix hosting service](https://etke.cc) runs maintenance against hundreds of servers, so the playbook being fast means a lot. The [etke.cc Ansible playbook](https://github.com/etkecc/ansible) (which is an extension of this one) is growing to support more and more services (besides just Matrix), so the Matrix playbook being leaner prevents runtimes from becoming too slow and improves the customer experience." +#: ../../../CHANGELOG.md:1444 +msgid "We'd love for users to be able to **seamlessly use all these playbooks (and others, even) against a single server**. We don't want `matrix-nginx-proxy` to have a monopoly on port `80`/`443` and make it hard for other services to join in on the party. Such a thing forces people into running multiple servers (one for each service), which does provide nice security benefits, but is costly and ineffiecient. We'd like to make self-hosting these services cheap and easy." msgstr "" -#: ../../../CHANGELOG.md:1447 -msgid "Even when running `ansible-playbook` manually (as most of us here do), it's beneficial not to waste time and CPU resources." +#: ../../../CHANGELOG.md:1446 +msgid "These other playbooks have been using [Traefik](https://traefik.io/) as their default reverse-proxy for a long time. They can all coexist nicely together (as an example, see the [Interoperability](https://github.com/spantaleev/nextcloud-docker-ansible-deploy/blob/master/docs/configuring-playbook-interoperability.md) documentation for the [Nextcloud playbook](https://github.com/spantaleev/nextcloud-docker-ansible-deploy)). Now that this playbook is gaining Traefik support, it will be able to interoperate with them. If you're going this way, make sure to have the Matrix playbook install Traefik and have the others use `*_reverse_proxy_type: other-traefik-container`." msgstr "" -#: ../../../CHANGELOG.md:1449 -msgid "Recently, a few large optimizations have been done to this playbook and its external roles (see [The playbook now uses external roles for some things](#the-playbook-now-uses-external-roles-for-some-things) and don't forget to run `make roles`):" +#: ../../../CHANGELOG.md:1448 +msgid "Finally, at [etke.cc — a managed Matrix server hosting service](https://etke.cc) (built on top of this playbook, and coincidentally [turning 2 years old today](https://etke.cc/news/upsyw4ykbtgmwhz8k7ukldx0zbbfq-fh0iqi3llixi0/) 🎉), we're allowing people to host some additional services besides Matrix components. Exposing these services to the web requires ugly hacks and configuration files being dropped into `/matrix/nginx-proxy/conf.d`. We believe that everything should run in independent containers and be exposed to the web via a Traefik server, without a huge Ansible role like `matrix-nginx-proxy` that everything else needs to integrate with." msgstr "" -#: ../../../CHANGELOG.md:1451 -msgid "Replacing Ansible `import_tasks` calls with `include_tasks`, which decreased runtime in half. Using `import_tasks` is slower and causes Ansible to go through and skip way too many tasks (tasks which could have been skipped altogether by not having Ansible include them in the first place). On an experimental VM, **deployment time was decreased from ~530 seconds to ~250 seconds**." +#: ../../../CHANGELOG.md:1450 +msgid "How do these changes fix all these problems?" msgstr "" -#: ../../../CHANGELOG.md:1453 -msgid "Introducing new `install-*` tags (`install-all` and `install-COMPONENT`, e.g. `install-synapse`, `install-bot-mjolnir`), which only run Ansible tasks pertaining to installation, while skipping uninstallation tasks. In most cases, people are maintaining the same setup or they're *adding* new components. Removing components is rare. Running thousands of uninstallation tasks each time is wasteful. On an experimental VM, **deployment time was decreased from ~250 seconds (`--tags=setup-all`) to ~100 seconds (`--tags=install-all`)**." +#: ../../../CHANGELOG.md:1452 +msgid "The new `matrix_playbook_reverse_proxy_type` lets you easily specify your preferred reverse-proxy type, including `other-on-same-host`, `other-on-another-host` and `none`, so people who'd like to reverse-proxy with their own web server have more options now." msgstr "" -#: ../../../CHANGELOG.md:1455 -msgid "You can still use `--tags=setup-all`. In fact, that's the best way to ensure your server is reconciled with the `vars.yml` configuration." +#: ../../../CHANGELOG.md:1454 +msgid "Using Traefik greatly simplifies things, so going forward we'll have a simpler and easier to maintain playbook, which is also interoperable with other services." msgstr "" -#: ../../../CHANGELOG.md:1457 -msgid "If you know you haven't uninstalled any services since the last time you ran the playbook, you could run `--tags=install-all` instead and benefit from quicker runtimes. It should be noted that a service may become \"eligible for uninstallation\" even if your `vars.yml` file remains the same. In rare cases, we toggle services from being auto-installed to being optional, like we did on the 17th of March 2022 when we made [ma1sd not get installed by default](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#compatibility-break-ma1sd-identity-server-no-longer-installed-by-default). In such rare cases, you'd also need to run `--tags=setup-all`." +#: ../../../CHANGELOG.md:1456 +msgid "Traefik is a web server, which has been specifically **designed for reverse-proxying to services running in containers**. It's ideal for usage in an Ansible playbook which runs everything in containers." +msgstr "" + +#: ../../../CHANGELOG.md:1458 +msgid "**Traefik obtains SSL certificates automatically**, so there's no need for plugging additional tools like [Certbot](https://certbot.eff.org/) into your web server (like we were doing in the `matrix-nginx-proxy` role). No more certificate renewal timers, web server reloading timers, etc. It's just simpler." msgstr "" #: ../../../CHANGELOG.md:1460 -msgid "2022-11-22" +msgid "Traefik is a **modern web server**. [HTTP/3](https://doc.traefik.io/traefik/routing/entrypoints/#http3) is supported already (experimentally) and will move to stable soon, in the upcoming Traefik v3 release." msgstr "" #: ../../../CHANGELOG.md:1462 -msgid "Automatic `matrix_architecture` determination" +msgid "Traefik does not lock important functionality we'd like to use into [plus packages like nginx does](https://www.nginx.com/products/nginx/), leading us to resolve to configuration workarounds. The default Traefik package is good enough as it is." msgstr "" #: ../../../CHANGELOG.md:1464 -msgid "From now on, the playbook automatically determines your server's architecture and sets the `matrix_architecture` variable accordingly. You no longer need to set this variable manually in your `vars.yml` file." +msgid "Where we're at right now?" msgstr "" #: ../../../CHANGELOG.md:1466 -msgid "Docker and the Docker SDK for Python are now installed via external roles" +msgid "`matrix_playbook_reverse_proxy_type` still defaults to a value of `playbook-managed-nginx`." +msgstr "" + +#: ../../../CHANGELOG.md:1468 +msgid "Unless we have some regression, **existing `matrix-nginx-proxy` users should be able to update their Matrix server and not observe any changes**. Their setup should still remain on nginx and everything should still work as expected." msgstr "" #: ../../../CHANGELOG.md:1470 -msgid "Docker will now be installed on the server via the [geerlingguy.docker](https://github.com/geerlingguy/ansible-role-docker) Ansible role. If you'd like to manage the Docker installation yourself, you can disable the playbook's installation of Docker by setting `matrix_playbook_docker_installation_enabled: false`." +msgid "**Users using [their own webservers](docs/configuring-playbook-own-webserver.md) will need to change `matrix_playbook_reverse_proxy_type`** to something like `other-on-same-host`, `other-on-another-host` or `other-nginx-non-container`. Previously, they could toggle `matrix_nginx_proxy_enabled` to `false`, and that made the playbook automatically expose services locally. Currently, we only do this if you change the reverse-proxy type to `other-on-same-host`, `other-on-another-host` or `other-nginx-non-container`." msgstr "" #: ../../../CHANGELOG.md:1472 -msgid "The Docker SDK for Python (named `docker-python`, `python-docker`, etc. on the different platforms) is now also installed by another role ([com.devture.ansible.role.docker_sdk_for_python](https://github.com/devture/com.devture.ansible.role.docker_sdk_for_python)). To disable this role and install the necessary tools yourself, use `devture_docker_sdk_for_python_installation_enabled: false`." +msgid "How do I explicitly switch to Traefik right now?" msgstr "" #: ../../../CHANGELOG.md:1474 -msgid "If you're hitting issues with Docker installation or Docker SDK for Python installation, consider reporting bugs or contributing to these other projects." +msgid "**Users who wish to migrate to Traefik** today, can do so by **adding** this to their configuration:" msgstr "" -#: ../../../CHANGELOG.md:1476 -msgid "These additional roles are downloaded into the playbook directory (to `roles/galaxy`) via an `ansible-galaxy …` command. `make roles` is an easy shortcut for invoking the `ansible-galaxy` command to download these roles." +#: ../../../CHANGELOG.md:1480 +msgid "You may still need to keep certain old `matrix_nginx_proxy_*` variables (like `matrix_nginx_proxy_base_domain_serving_enabled`), even when using Traefik. For now, we recommend keeping all `matrix_nginx_proxy_*` variables just in case. In the future, reliance on `matrix-nginx-proxy` will be removed." msgstr "" -#: ../../../CHANGELOG.md:1479 -msgid "2022-11-20" +#: ../../../CHANGELOG.md:1482 +msgid "Switching to Traefik will obtain new SSL certificates from Let's Encrypt (stored in `/matrix/traefik/ssl/acme.json`). **The switch is reversible**. You can always go back to `playbook-managed-nginx` if Traefik is causing you trouble." msgstr "" -#: ../../../CHANGELOG.md:1481 -msgid "(Backward Compatibility Break) Changing how reverse-proxying to Synapse works — now via a `matrix-synapse-reverse-proxy-companion` service" +#: ../../../CHANGELOG.md:1484 +msgid "**Note**: toggling `matrix_playbook_reverse_proxy_type` between Traefik and nginx will uninstall the Traefik role and all of its data (under `/matrix/traefik`), so you may run into a Let's Encrypt rate limit if you do it often." msgstr "" -#: ../../../CHANGELOG.md:1483 -msgid "**TLDR**: There's now a `matrix-synapse-reverse-proxy-companion` nginx service, which helps with reverse-proxying to Synapse and its various worker processes (if workers are enabled), so that `matrix-nginx-proxy` can be relieved of this role. `matrix-nginx-proxy` still remains as the public SSL-terminating reverse-proxy in the playbook. `matrix-synapse-reverse-proxy-companion` is just one more reverse-proxy thrown into the mix for convenience. People with a more custom reverse-proxying configuration may be affected — see [Webserver configuration](#webserver-configuration) below." +#: ../../../CHANGELOG.md:1486 +msgid "Treafik directly reverse-proxies to **some** services right now, but for most other services it goes through `matrix-nginx-proxy` (e.g. Traefik -> `matrix-nginx-proxy` -> [Ntfy](docs/configuring-playbook-ntfy.md)). So, even if you opt into Traefik, you'll still see `matrix-nginx-proxy` being installed in local-only mode. This will improve with time." msgstr "" -#: ../../../CHANGELOG.md:1485 -msgid "Background" +#: ../../../CHANGELOG.md:1488 +msgid "Some services (like [coturn](docs/configuring-playbook-turn.md) and [Postmoogle](docs/configuring-playbook-bridge-postmoogle.md)) cannot be reverse-proxied to directly from Traefik, so they require direct access to SSL certificate files extracted out of Traefik. The playbook does this automatically thanks to a new [com.devture.ansible.role.traefik_certs_dumper](https://github.com/devture/com.devture.ansible.role.traefik_certs_dumper) role utilizing the [traefik-certs-dumper](https://github.com/ldez/traefik-certs-dumper) tool." msgstr "" -#: ../../../CHANGELOG.md:1487 -msgid "Previously, `matrix-nginx-proxy` forwarded requests to Synapse directly. When Synapse is running in worker mode, the reverse-proxying configuration is more complicated (different requests need to go to different Synapse worker processes). `matrix-nginx-proxy` had configuration for sending each URL endpoint to the correct Synapse worker responsible for handling it. However, sometimes people like to disable `matrix-nginx-proxy` (for whatever reason) as detailed in [Using your own webserver, instead of this playbook's nginx proxy](docs/configuring-playbook-own-webserver.md)." +#: ../../../CHANGELOG.md:1490 +msgid "Our Traefik setup mostly works, but certain esoteric features may not work. If you have a default setup, we expect you to have a good experience." msgstr "" -#: ../../../CHANGELOG.md:1489 -msgid "Because `matrix-nginx-proxy` was so central to request forwarding, when it was disabled and Synapse was running with workers enabled, there was nothing which could forward requests to the correct place anymore… which caused [problems such as this one affecting Dimension](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2090)." +#: ../../../CHANGELOG.md:1492 +msgid "Where we're going in the near future?" msgstr "" -#: ../../../CHANGELOG.md:1491 -msgid "Solution" +#: ../../../CHANGELOG.md:1494 +msgid "The `matrix-nginx-proxy` role is quite messy. It manages both nginx and Certbot and its certificate renewal scripts and timers. It generates configuration even when the role is disabled (weird). Although it doesn't directly reach into variables from other roles, it has explicit awareness of various other services that it reverse-proxies to (`roles/custom/matrix-nginx-proxy/templates/nginx/conf.d/matrix-ntfy.conf.j2`, etc.). We'd like to clean this up. The only way is probably to just get rid of the whole thing at some point." msgstr "" -#: ../../../CHANGELOG.md:1493 -msgid "From now on, `matrix-nginx-proxy` is relieved of its function of reverse-proxying to Synapse and its various worker processes. This role is now handled by the new `matrix-synapse-reverse-proxy-companion` nginx service and works even if `matrix-nginx-proxy` is disabled. The purpose of the new `matrix-synapse-reverse-proxy-companion` service is to:" -msgstr "" - -#: ../../../CHANGELOG.md:1495 -msgid "serve as a companion to Synapse and know how to reverse-proxy to Synapse correctly (no matter if workers are enabled or not)" -msgstr "" - -#: ../../../CHANGELOG.md:1497 -msgid "provide a unified container address for reaching Synapse (no matter if workers are enabled or not)" +#: ../../../CHANGELOG.md:1496 +msgid "For now, `matrix-nginx-proxy` will stay around." msgstr "" #: ../../../CHANGELOG.md:1498 -msgid "`matrix-synapse-reverse-proxy-companion:8008` for Synapse Client-Server API traffic" +msgid "As mentioned above, Traefik still reverse-proxies to some (most) services by going through a local-only `matrix-nginx-proxy` server. This has allowed us to add Traefik support to the playbook early on (without having to rework all services), but is not the final goal. We'll **work on making each service support Traefik natively**, so that traffic will not need to go through `matrix-nginx-proxy` anymore. In the end, choosing Traefik should only give you a pure Traefik installation with no `matrix-nginx-proxy` in sight." msgstr "" -#: ../../../CHANGELOG.md:1499 -msgid "`matrix-synapse-reverse-proxy-companion:8048` for Synapse Server-Server (Federation) API traffic" +#: ../../../CHANGELOG.md:1500 +msgid "As Traefik support becomes complete and proves to be stable for a while, especially as a playbook default, we will **most likely remove `matrix-nginx-proxy` completely**. It will likely be some months before this happens though. Keeping support for both Traefik and nginx in the playbook will be a burden, especially with most of us running Traefik in the future. The Traefik role should do everything nginx does in a better and cleaner way. Users who use their own `nginx` server on the Matrix server will be inconvenienced, as nothing will generate ready-to-include nginx configuration for them. Still, we hope it won't be too hard to migrate their setup to another way of doing things, like:" msgstr "" -#: ../../../CHANGELOG.md:1501 -msgid "simplify `matrix-nginx-proxy` configuration — it now only needs to send requests to `matrix-synapse-reverse-proxy-companion` or `matrix-dendrite`, etc., without having to worry about workers" +#: ../../../CHANGELOG.md:1502 +msgid "not using nginx anymore. A common reason for using nginx until now was that you were running other containers and you need your own nginx to reverse-proxy to all of them. Just switch them to Traefik as well." msgstr "" #: ../../../CHANGELOG.md:1503 -msgid "allow reverse-proxying to Synapse, even if `matrix-nginx-proxy` is disabled" +msgid "running Traefik in local-only mode (`traefik_config_entrypoint_web_secure_enabled: false`) and using some nginx configuration which reverse-proxies to Traefik (we should introduce examples for this in `examples/nginx`)." msgstr "" #: ../../../CHANGELOG.md:1505 -msgid "`matrix-nginx-proxy` still remains as the public SSL-terminating reverse-proxy in the playbook. All traffic goes through it before reaching any of the services. It's just that now the Synapse traffic is routed through `matrix-synapse-reverse-proxy-companion` like this:" +msgid "How do I help?" msgstr "" #: ../../../CHANGELOG.md:1507 -msgid "(`matrix-nginx-proxy` -> `matrix-synapse-reverse-proxy-companion` -> (`matrix-synapse` or some Synapse worker))." +msgid "You can help by:" msgstr "" #: ../../../CHANGELOG.md:1509 -msgid "Various services (like Dimension, etc.) still talk to Synapse via `matrix-nginx-proxy` (e.g. `http://matrix-nginx-proxy:12080`) preferentially. They only talk to Synapse via the reverse-proxy companion (e.g. `http://matrix-synapse-reverse-proxy-companion:8008`) if `matrix-nginx-proxy` is disabled. Services should not be talking to Synapse (e.g. `https://matrix-synapse:8008` directly anymore), because when workers are enabled, that's the Synapse `master` process and may not be serving all URL endpoints needed by the service." +msgid "**explicitly switching your server to Traefik** right now (see example configuration in [How do I explicitly switch to Traefik right now?](#how-do-i-explicitly-switch-to-traefik-right-now) above), testing, reporting troubles" msgstr "" #: ../../../CHANGELOG.md:1511 -msgid "Webserver configuration" +msgid "**adding native Traefik support to a role** (requires adding Traefik labels, etc.) — for inspiration, see these roles ([prometheus_node_exporter](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-node-exporter), [prometheus_postgres_exporter](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-postgres-exporter)) and how they're hooked into the playbook via [group_vars/matrix_servers](group_vars/matrix_servers)." msgstr "" #: ../../../CHANGELOG.md:1513 -msgid "if you're using `matrix-nginx-proxy` (`matrix_nginx_proxy_enabled: true`, which is the default for the playbook), you don't need to do anything" +msgid "**adding reverse-proxying examples for nginx users** in `examples/nginx`. People who insist on using their own `nginx` server on the same Matrix host, can run Traefik in local-only mode (`traefik_config_entrypoint_web_secure_enabled: false`) and reverse-proxy to the Traefik server" msgstr "" -#: ../../../CHANGELOG.md:1515 -msgid "if you're using your own `nginx` webserver running on the server, you shouldn't be affected. The `/matrix/nginx/conf.d` configuration and exposed ports that you're relying on will automatically be updated in a way that should work" +#: ../../../CHANGELOG.md:1516 +msgid "2023-02-10" msgstr "" -#: ../../../CHANGELOG.md:1517 -msgid "if you're using another local webserver (e.g. Apache, etc.) and haven't changed any ports (`matrix_*_host_bind_port` definitions), you shouldn't be affected. You're likely sending Matrix traffic to `127.0.0.1:8008` and `127.0.0.1:8048`. These ports (`8008` and `8048`) will still be exposed on `127.0.0.1` by default — just not by the `matrix-synapse` container from now on, but by the `matrix-synapse-reverse-proxy-companion` container instead" +#: ../../../CHANGELOG.md:1518 +msgid "Matrix Authentication Support for Jitsi" msgstr "" -#: ../../../CHANGELOG.md:1519 -msgid "if you've been exposing `matrix-synapse` ports (`matrix_synapse_container_client_api_host_bind_port`, etc.) manually, you should consider exposing `matrix-synapse-reverse-proxy-companion` ports instead" +#: ../../../CHANGELOG.md:1520 +msgid "Thanks to [Jakob S.](https://github.com/jakicoll) ([zakk gGmbH](https://github.com/zakk-it)), Jitsi can now use Matrix for authentication (via [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service))." msgstr "" -#: ../../../CHANGELOG.md:1521 -msgid "if you're running Traefik and reverse-proxying directly to the `matrix-synapse` container, you should start reverse-proxying to the `matrix-synapse-reverse-proxy-companion` container instead. See [our updated Traefik example configuration](docs/configuring-playbook-own-webserver.md#sample-configuration-for-running-behind-traefik-20). Note: we now recommend calling the federation entry point `federation` (instead of `synapse`) and reverse-proxying the federation traffic via `matrix-nginx-proxy`, instead of sending it directly to Synapse (or `matrix-synapse-reverse-proxy-companion`). This makes the configuration simpler." +#: ../../../CHANGELOG.md:1522 +msgid "Additional details are available in the [Authenticate using Matrix OpenID (Auth-Type 'matrix')](docs/configuring-playbook-jitsi.md#authenticate-using-matrix-openid-auth-type-matrix)." msgstr "" #: ../../../CHANGELOG.md:1524 -msgid "2022-11-05" +msgid "Draupnir moderation tool (bot) support" msgstr "" #: ../../../CHANGELOG.md:1526 -msgid "(Backward Compatibility Break) A new default standalone mode for Etherpad" +msgid "Thanks to [FSG-Cat](https://github.com/FSG-Cat), the playbook can now install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool (bot). Draupnir is a fork of [Mjolnir](docs/configuring-playbook-bot-mjolnir.md) (which the playbook has supported for a long time) maintained by Mjolnir's former lead developer." msgstr "" #: ../../../CHANGELOG.md:1528 -msgid "Until now, [Etherpad](https://etherpad.org/) (which [the playbook could install for you](docs/configuring-playbook-etherpad.md)) required the [Dimension integration manager](docs/configuring-playbook-dimension.md) to also be installed, because Etherpad was hosted on the Dimension domain (at `dimension.example.com/etherpad`)." +msgid "Additional details are available in [Setting up Draupnir](docs/configuring-playbook-bot-draupnir.md)." msgstr "" -#: ../../../CHANGELOG.md:1530 -msgid "From now on, Etherpad can be installed in `standalone` mode on `etherpad.example.com` and used even without Dimension. This is much more versatile, so the playbook now defaults to this new mode (`etherpad_mode: standalone`)." +#: ../../../CHANGELOG.md:1531 +msgid "2023-02-05" msgstr "" -#: ../../../CHANGELOG.md:1532 -msgid "If you've already got both Etherpad and Dimension in use you could:" +#: ../../../CHANGELOG.md:1533 +msgid "The matrix-prometheus-postgres-exporter role lives independently now" msgstr "" -#: ../../../CHANGELOG.md:1534 -msgid "**either** keep hosting Etherpad under the Dimension domain by adding `etherpad_mode: dimension` to your `vars.yml` file. All your existing room widgets will continue working at the same URLs and no other changes will be necessary." +#: ../../../CHANGELOG.md:1535 +msgid "**TLDR**: the `matrix-prometheus-postgres-exporter` role is now included from another repository. Some variables have been renamed. All functionality remains intact." msgstr "" -#: ../../../CHANGELOG.md:1536 -msgid "**or**, you could change to hosting Etherpad separately on `etherpad.example.com`. You will need to [configure a DNS record](docs/configuring-dns.md) for this new domain. You will also need to reconfigure Dimension to use the new pad URLs (`https://etherpad.example.com/…`) going forward (refer to our [configuring Etherpad documentation](docs/configuring-playbook-etherpad.md)). All your existing room widgets (which still use `https://dimension.example.com/etherpad/…`) will break as Etherpad is not hosted there anymore. You will need to re-add them or to consider not using `standalone` mode" +#: ../../../CHANGELOG.md:1537 +msgid "The `matrix-prometheus-postgres-exporter` role (which configures [Prometheus Postgres Exporter](https://github.com/prometheus-community/postgres_exporter)) has been extracted from the playbook and now lives in its own repository at https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-postgres-exporter" msgstr "" #: ../../../CHANGELOG.md:1539 -msgid "2022-11-04" +msgid "It's still part of the playbook, but is now installed via `ansible-galaxy` (by running `just roles` / `make roles`). Some variables have been renamed (`matrix_prometheus_postgres_exporter_` -> `prometheus_postgres_exporter_`, etc.). The playbook will report all variables that you need to rename to get upgraded. All functionality remains intact." msgstr "" #: ../../../CHANGELOG.md:1541 -msgid "The playbook now uses external roles for some things" +msgid "The `matrix-prometheus-services-proxy-connect` role has bee adjusted to help integrate the new `prometheus_postgres_exporter` role with our own services (`matrix-nginx-proxy`)" msgstr "" #: ../../../CHANGELOG.md:1543 -msgid "**TLDR**: when updating the playbook and before running it, you'll need to run `make roles` to make [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) download dependency roles (see the [`requirements.yml` file](requirements.yml)) to the `roles/galaxy` directory. Without this, the playbook won't work." +#: ../../../CHANGELOG.md:1585 +msgid "Other roles which aren't strictly related to Matrix are likely to follow this fate of moving to their own repositories. Extracting them out allows other Ansible playbooks to make use of these roles easily." msgstr "" -#: ../../../CHANGELOG.md:1545 -msgid "We're in the process of trimming the playbook and making it reuse Ansible roles." +#: ../../../CHANGELOG.md:1546 +msgid "2023-01-26" msgstr "" -#: ../../../CHANGELOG.md:1547 -msgid "Starting now, the playbook is composed of 2 types of Ansible roles:" +#: ../../../CHANGELOG.md:1548 +msgid "coturn can now use host-networking" msgstr "" -#: ../../../CHANGELOG.md:1549 -msgid "those that live within the playbook itself (`roles/custom/*`)" +#: ../../../CHANGELOG.md:1550 +msgid "Large coturn deployments (with a huge range of ports specified via `matrix_coturn_turn_udp_min_port` and `matrix_coturn_turn_udp_max_port`) experience a huge slowdown with how Docker publishes all these ports (setting up firewall forwarding rules), which leads to a very slow coturn service startup and shutdown." msgstr "" -#: ../../../CHANGELOG.md:1551 -msgid "those downloaded from other sources (using [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) to `roles/galaxy`, based on the [`requirements.yml` file](requirements.yml)). These roles are maintained by us or by other people from the Ansible community." +#: ../../../CHANGELOG.md:1552 +msgid "Such deployments don't need to run coturn within a private container network anymore. coturn can now run with host-networking by using configuration like this:" msgstr "" -#: ../../../CHANGELOG.md:1553 -msgid "We're doing this for greater code-reuse (across Ansible playbooks, including our own related playbooks [gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy) and [nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy)) and decreased maintenance burden. Until now, certain features were copy-pasted across playbooks or were maintained separately in each one, with improvements often falling behind. We've also tended to do too much by ourselves — installing Docker on the server from our `matrix-base` role, etc. — something that we'd rather not do anymore by switching to the [geerlingguy.docker](https://galaxy.ansible.com/geerlingguy/docker) role." -msgstr "" - -#: ../../../CHANGELOG.md:1555 -msgid "Some variable names will change during the transition to having more and more external (galaxy) roles. There's a new `custom/matrix_playbook_migration` role added to the playbook which will tell you about these changes each time you run the playbook." -msgstr "" - -#: ../../../CHANGELOG.md:1557 -msgid "**From now on**, every time you update the playbook (well, every time the `requirements.yml` file changes), it's best to run `make roles` to update the roles downloaded from other sources. `make roles` is a shortcut (a `roles` target defined in [`Makefile`](Makefile) and executed by the [`make`](https://www.gnu.org/software/make/) utility) which ultimately runs [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) to download Ansible roles. If you don't have `make`, you can also manually run the commands seen in the `Makefile`." +#: ../../../CHANGELOG.md:1558 +msgid "With such a configuration, **Docker no longer needs to configure thousands of firewall forwarding rules** each time coturn starts and stops. This, however, means that **you will need to ensure these ports are open** in your firewall yourself." msgstr "" #: ../../../CHANGELOG.md:1560 -msgid "2022-10-14" +msgid "Thanks to us [tightening coturn security](#backward-compatibility-tightening-coturn-security-can-lead-to-connectivity-issues), running coturn with host-networking should be safe and not expose neither other services running on the host, nor other services running on the local network." msgstr "" #: ../../../CHANGELOG.md:1562 -msgid "synapse-s3-storage-provider support" +msgid "(Backward Compatibility) Tightening coturn security can lead to connectivity issues" msgstr "" #: ../../../CHANGELOG.md:1564 -msgid "**`synapse-s3-storage-provider` support is very new and still relatively untested. Using it may cause data loss.**" +msgid "**TLDR**: users who run and access their Matrix server on a private network (likely a small minority of users) may experience connectivity issues with our new default coturn blocklists. They may need to override `matrix_coturn_denied_peer_ips` and remove some IP ranges from it." msgstr "" #: ../../../CHANGELOG.md:1566 -msgid "You can now store your Synapse media repository files on Amazon S3 (or another S3-compatible object store) using [synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider) — a media provider for Synapse (Python module), which should work faster and more reliably than our previous [Goofys](docs/configuring-playbook-s3-goofys.md) implementation (Goofys will continue to work)." +msgid "Inspired by [this security article](https://www.rtcsec.com/article/cve-2020-26262-bypass-of-coturns-access-control-protection/), we've decided to make use of coturn's `denied-peer-ip` functionality to prevent relaying network traffic to certain private IP subnets. This ensures that your coturn server won't accidentally try to forward traffic to certain services running on your local networks. We run coturn in a container and in a private container network by default, which should prevent such access anyway, but having additional block layers in place is better." msgstr "" #: ../../../CHANGELOG.md:1568 -msgid "This is not just for initial installations. Users with existing files (stored in the local filesystem) can also migrate their files to `synapse-s3-storage-provider`." +msgid "If you access your Matrix server from a local network and need coturn to relay to private IP addresses, you may observe that relaying is now blocked due to our new default `denied-peer-ip` lists (specified in `matrix_coturn_denied_peer_ips`). If you experience such connectivity problems, consider overriding this setting in your `vars.yml` file and removing certain networks from it." msgstr "" #: ../../../CHANGELOG.md:1570 -msgid "To get started, see our [Storing Synapse media files on Amazon S3 with synapse-s3-storage-provider](docs/configuring-playbook-synapse-s3-storage-provider.md) documentation." +msgid "We've also added `no-multicast-peers` to the default coturn configuration, but we don't expect this to cause trouble for most people." msgstr "" -#: ../../../CHANGELOG.md:1572 -msgid "Synapse container image customization support" +#: ../../../CHANGELOG.md:1573 +msgid "2023-01-21" msgstr "" -#: ../../../CHANGELOG.md:1574 -msgid "We now support customizing the Synapse container image by adding additional build steps to its [`Dockerfile`](https://docs.docker.com/engine/reference/builder/)." +#: ../../../CHANGELOG.md:1575 +msgid "The matrix-prometheus-node-exporter role lives independently now" msgstr "" -#: ../../../CHANGELOG.md:1576 -msgid "Our [synapse-s3-storage-provider support](#synapse-s3-storage-provider-support) is actually built on this. When `s3-storage-provider` is enabled, we automatically add additional build steps to install its Python module into the Synapse image." +#: ../../../CHANGELOG.md:1577 +msgid "**TLDR**: the `matrix-prometheus-node-exporter` role is now included from another repository. Some variables have been renamed. All functionality remains intact." msgstr "" -#: ../../../CHANGELOG.md:1578 -msgid "Besides this kind of auto-added build steps (for components supported by the playbook), we also let you inject your own custom build steps using configuration like this:" +#: ../../../CHANGELOG.md:1579 +msgid "The `matrix-prometheus-node-exporter` role (which configures [Prometheus node exporter](https://github.com/prometheus/node_exporter)) has been extracted from the playbook and now lives in its own repository at https://github.com/mother-of-all-self-hosting/ansible-role-prometheus-node-exporter" msgstr "" -#: ../../../CHANGELOG.md:1589 -msgid "People who have needed to customize Synapse previously had to fork the git repository, make their changes to the `Dockerfile` there, point the playbook to the new repository (`matrix_synapse_container_image_self_build_repo`) and enable self-building from scratch (`matrix_synapse_container_image_self_build: true`). This is harder and slower." +#: ../../../CHANGELOG.md:1581 +msgid "It's still part of the playbook, but is now installed via `ansible-galaxy` (by running `just roles` / `make roles`). Some variables have been renamed (`matrix_prometheus_node_exporter_` -> `prometheus_node_exporter_`, etc.). The playbook will report all variables that you need to rename to get upgraded. All functionality remains intact." msgstr "" -#: ../../../CHANGELOG.md:1591 -msgid "With the new Synapse-customization feature in the playbook, we use the original upstream (pre-built, if available) Synapse image and only build on top of it, right on the Matrix server. This is much faster than building all of Synapse from scratch." +#: ../../../CHANGELOG.md:1583 +msgid "A new `matrix-prometheus-services-proxy-connect` role was added to the playbook to help integrate the new `prometheus_node_exporter` role with our own services (`matrix-nginx-proxy`)" +msgstr "" + +#: ../../../CHANGELOG.md:1588 +msgid "2023-01-13" +msgstr "" + +#: ../../../CHANGELOG.md:1590 +msgid "Support for running commands via just" +msgstr "" + +#: ../../../CHANGELOG.md:1592 +msgid "We've previously used [make](https://www.gnu.org/software/make/) for easily running some playbook commands (e.g. `make roles` which triggers `ansible-galaxy`, see [Makefile](Makefile)). Our `Makefile` is still around and you can still run these commands." msgstr "" #: ../../../CHANGELOG.md:1594 -msgid "2022-10-02" +msgid "In addition, we've added support for running commands via [just](https://github.com/casey/just) — a more modern command-runner alternative to `make`. Instead of `make roles`, you can now run `just roles` to accomplish the same." msgstr "" #: ../../../CHANGELOG.md:1596 -msgid "matrix-ldap-registration-proxy support" +msgid "Our [justfile](justfile) already defines some additional helpful **shortcut** commands that weren't part of our `Makefile`. Here are some examples:" msgstr "" #: ../../../CHANGELOG.md:1598 -msgid "Thanks to [@TheOneWithTheBraid](https://github.com/TheOneWithTheBraid), we now support installing [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) — a proxy which handles Matrix registration requests and forwards them to LDAP." +msgid "`just install-all` to trigger the much longer `ansible-playbook -i inventory/hosts setup.yml --tags=install-all,ensure-matrix-users-created,start` command" +msgstr "" + +#: ../../../CHANGELOG.md:1599 +msgid "`just install-all --ask-vault-pass` — commands also support additional arguments (`--ask-vault-pass` will be appended to the above installation command)" msgstr "" #: ../../../CHANGELOG.md:1600 -msgid "See our [Setting up matrix-ldap-registration-proxy](docs/configuring-playbook-matrix-ldap-registration-proxy.md) documentation to get started." +msgid "`just run-tags install-mautrix-slack,start` — to run specific playbook tags" +msgstr "" + +#: ../../../CHANGELOG.md:1601 +msgid "`just start-all` — (re-)starts all services" +msgstr "" + +#: ../../../CHANGELOG.md:1602 +msgid "`just stop-group postgres` — to stop only the Postgres service" msgstr "" #: ../../../CHANGELOG.md:1603 -msgid "2022-09-15" +msgid "`just register-user alice secret-password yes` — registers an `alice` user with the `secret-password` password and admin access (admin = `yes`)" msgstr "" #: ../../../CHANGELOG.md:1605 -msgid "(Potential Backward Compatibility Break) Major improvements to Synapse workers" +msgid "Additional helpful commands and shortcuts may be defined in the future." msgstr "" #: ../../../CHANGELOG.md:1607 -msgid "People who are interested in running a Synapse worker setup should know that **our Synapse worker implementation is much more powerful now**:" -msgstr "" - -#: ../../../CHANGELOG.md:1609 -msgid "we've added support for [Stream writers](#stream-writers-support)" +msgid "This is all completely optional. If you find it difficult to [install `just`](https://github.com/casey/just#installation) or don't find any of this convenient, feel free to run all commands manually." msgstr "" #: ../../../CHANGELOG.md:1610 -msgid "we've added support for [multiple federation sender workers](#multiple-federation-sender-workers-support)" -msgstr "" - -#: ../../../CHANGELOG.md:1611 -msgid "we've added support for [multiple pusher workers](#multiple-pusher-workers-support)" +msgid "2023-01-11" msgstr "" #: ../../../CHANGELOG.md:1612 -msgid "we've added support for [running background tasks on a worker](#background-tasks-can-run-on-a-worker)" -msgstr "" - -#: ../../../CHANGELOG.md:1613 -msgid "we've restored support for [`appservice` workers](#appservice-worker-support-is-back)" +msgid "mautrix-slack support" msgstr "" #: ../../../CHANGELOG.md:1614 -msgid "we've restored support for [`user_dir` workers](#user-directory-worker-support-is-back)" -msgstr "" - -#: ../../../CHANGELOG.md:1615 -msgid "we've made it possible to [reliably use more than 1 `media_repository` worker](#using-more-than-1-media-repository-worker-is-now-more-reliable)" +msgid "Thanks to [Cody Neiman](https://github.com/xangelix)'s efforts, the playbook now supports bridging to [Slack](https://slack.com/) via the [mautrix-slack](https://mau.dev/mautrix/slack) bridge. See our [Setting up Mautrix Slack bridging](docs/configuring-playbook-bridge-mautrix-slack.md) documentation page for getting started." msgstr "" #: ../../../CHANGELOG.md:1616 -msgid "see the [Potential Backward Incompatibilities after these Synapse worker changes](#potential-backward-incompatibilities-after-these-synapse-worker-changes)" +msgid "**Note**: this is a new Slack bridge. The playbook still retains Slack bridging via [matrix-appservice-slack](docs/configuring-playbook-bridge-appservice-slack.md) and [mx-puppet-slack](docs/configuring-playbook-bridge-mx-puppet-slack.md). You're free to use the bridge that serves you better, or even all three of them (for different users and use-cases)." msgstr "" -#: ../../../CHANGELOG.md:1618 -msgid "Stream writers support" +#: ../../../CHANGELOG.md:1619 +msgid "2023-01-10" msgstr "" -#: ../../../CHANGELOG.md:1620 -msgid "From now on, the playbook lets you easily set up various [stream writer workers](https://matrix-org.github.io/synapse/latest/workers.html#stream-writers) which can handle different streams (`events` stream; `typing` URL endpoints, `to_device` URL endpoints, `account_data` URL endpoints, `receipts` URL endpoints, `presence` URL endpoints). All of this work was previously handled by the main Synapse process, but can now be offloaded to stream writer worker processes." +#: ../../../CHANGELOG.md:1621 +msgid "ChatGPT support" msgstr "" -#: ../../../CHANGELOG.md:1622 -msgid "If you're using `matrix_synapse_workers_preset: one-of-each`, you'll automatically get 6 additional workers (one for each of the above stream types). Our `little-federation-helper` preset (meant to be quite minimal and focusing in improved federation performance) does not include stream writer workers." +#: ../../../CHANGELOG.md:1623 +msgid "Thanks to [@bertybuttface](https://github.com/bertybuttface), the playbook can now help you set up [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) — a bot through which you can talk to the [ChatGPT](https://openai.com/blog/chatgpt/) model." msgstr "" -#: ../../../CHANGELOG.md:1624 -msgid "If you'd like to customize the number of workers we also make that possible using these variables:" +#: ../../../CHANGELOG.md:1625 +msgid "See our [Setting up matrix-bot-chatgpt](docs/configuring-playbook-bot-chatgpt.md) documentation to get started." +msgstr "" + +#: ../../../CHANGELOG.md:1628 +msgid "2022-11-30" +msgstr "" + +#: ../../../CHANGELOG.md:1630 +msgid "matrix-postgres-backup has been replaced by the ansible-role-postgres-backup external role" +msgstr "" + +#: ../../../CHANGELOG.md:1632 +msgid "Just like we've [replaced Postgres with an external role](#matrix-postgres-has-been-replaced-by-the-comdevtureansiblerolepostgres-external-role) on 2022-11-28, we're now replacing `matrix-postgres-backup` with an external role — [com.devture.ansible.role.postgres_backup](https://github.com/mother-of-all-self-hosting/ansible-role-postgres_backup)." +msgstr "" + +#: ../../../CHANGELOG.md:1634 +msgid "You'll need to rename your `matrix_postgres_backup`-prefixed variables such that they use a `postgres_backup` prefix." msgstr "" #: ../../../CHANGELOG.md:1637 -msgid "Multiple federation sender workers support" +msgid "2022-11-28" msgstr "" #: ../../../CHANGELOG.md:1639 -msgid "Until now, we only supported a single `federation_sender` worker (`matrix_synapse_workers_federation_sender_workers_count` could either be `0` or `1`). From now on, you can have as many as you want to help with your federation traffic." +msgid "matrix-postgres has been replaced by the ansible-role-postgres external role" msgstr "" #: ../../../CHANGELOG.md:1641 -msgid "Multiple pusher workers support" +msgid "**TLDR**: the tasks that install the integrated Postgres server now live in an external role — [ansible-role-postgres](https://github.com/mother-of-all-self-hosting/ansible-role-postgres). You'll need to run `make roles` to install it, and to also rename your `matrix_postgres`-prefixed variables to use a `devture_postgres` prefix (e.g. `matrix_postgres_connection_password` -> `postgres_connection_password`). All your data will still be there! Some scripts have moved (`/usr/local/bin/matrix-postgres-cli` -> `/matrix/postgres/bin/cli`)." msgstr "" #: ../../../CHANGELOG.md:1643 -msgid "Until now, we only supported a single `pusher` worker (`matrix_synapse_workers_pusher_workers_count` could either be `0` or `1`). From now on, you can have as many as you want to help with pushing notifications out." +msgid "The `matrix-postgres` role that has been part of the playbook for a long time has been replaced with the [ansible-role-postgres](https://github.com/mother-of-all-self-hosting/ansible-role-postgres) role. This was done as part of our work to [use external roles for some things](#the-playbook-now-uses-external-roles-for-some-things) for better code re-use and maintainability." msgstr "" #: ../../../CHANGELOG.md:1645 -msgid "Background tasks can run on a worker" +msgid "The new role is an upgraded version of the old `matrix-postgres` role with these notable differences:" msgstr "" #: ../../../CHANGELOG.md:1647 -msgid "From now on, you can put [background task processing on a worker](https://matrix-org.github.io/synapse/latest/workers.html#background-tasks)." +msgid "it uses different names for its variables (`matrix_postgres` -> `devture_postgres`)" msgstr "" -#: ../../../CHANGELOG.md:1649 -msgid "With `matrix_synapse_workers_preset: one-of-each`, you'll get one `background` worker automatically. You can also control the `background` workers count with `matrix_synapse_workers_background_workers_count`. Only `0` or `1` workers of this type are supported by Synapse." +#: ../../../CHANGELOG.md:1648 +msgid "when [Vacuuming PostgreSQL](docs/maintenance-postgres.md#vacuuming-postgresql), it will vacuum all your databases, not just the Synapse one" msgstr "" -#: ../../../CHANGELOG.md:1651 -msgid "Appservice worker support is back" +#: ../../../CHANGELOG.md:1650 +msgid "You'll need to run `make roles` to install the new role. You would also need to rename your `matrix_postgres`-prefixed variables to use a `devture_postgres` prefix." msgstr "" -#: ../../../CHANGELOG.md:1653 -msgid "We previously had an `appservice` worker type, which [Synapse deprecated in v1.59.0](https://github.com/element-hq/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types). So did we, at the time." +#: ../../../CHANGELOG.md:1652 +msgid "Note: the systemd service still remains the same — `matrix-postgres.service`. Your data will still be in `/matrix/postgres`, etc. Postgres-related scripts will be moved to `/matrix/postgres/bin` (`/usr/local/bin/matrix-postgres-cli` -> `/matrix/postgres/bin/cli`, etc). Also see [The playbook no longer installs scripts in /usr/local/bin](#the-playbook-no-longer-installs-scripts-in-usrlocalbin)." msgstr "" -#: ../../../CHANGELOG.md:1655 -msgid "The new way to implement such workers is by using a `generic_worker` and dedicating it to the task of talking to Application Services. From now on, we have support for this." +#: ../../../CHANGELOG.md:1654 +msgid "The playbook no longer installs scripts to /usr/local/bin" msgstr "" -#: ../../../CHANGELOG.md:1657 -msgid "With `matrix_synapse_workers_preset: one-of-each`, you'll get one `appservice` worker automatically. You can also control the `appservice` workers count with `matrix_synapse_workers_appservice_workers_count`. Only `0` or `1` workers of this type are supported by Synapse." +#: ../../../CHANGELOG.md:1656 +msgid "The locations of various scripts installed by the playbook have changed." msgstr "" -#: ../../../CHANGELOG.md:1659 -msgid "User Directory worker support is back" +#: ../../../CHANGELOG.md:1658 +msgid "The playbook no longer contaminates your `/usr/local/bin` directory. All scripts installed by the playbook now live in `bin/` directories under `/matrix`. Some examples are below:" +msgstr "" + +#: ../../../CHANGELOG.md:1660 +msgid "`/usr/local/bin/matrix-remove-all` -> `/matrix/bin/remove-all`" msgstr "" #: ../../../CHANGELOG.md:1661 -msgid "We previously had a `user_dir` worker type, which [Synapse deprecated in v1.59.0](https://github.com/element-hq/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types). So did we, at the time." +msgid "`/usr/local/bin/matrix-postgres-cli` -> `/matrix/postgres/bin/cli`" +msgstr "" + +#: ../../../CHANGELOG.md:1662 +msgid "`/usr/local/bin/matrix-ssl-lets-encrypt-certificates-renew` -> `/matrix/ssl/bin/lets-encrypt-certificates-renew`" msgstr "" #: ../../../CHANGELOG.md:1663 -msgid "The new way to implement such workers is by using a `generic_worker` and dedicating it to the task of serving the user directory. From now on, we have support for this." +msgid "`/usr/local/bin/matrix-synapse-register-user` -> `/matrix/synapse/bin/register-user`" msgstr "" -#: ../../../CHANGELOG.md:1665 -msgid "With `matrix_synapse_workers_preset: one-of-each`, you'll get one `user_dir` worker automatically. You can also control the `user_dir` workers count with `matrix_synapse_workers_user_dir_workers_count`. Only `0` or `1` workers of this type are supported by Synapse." +#: ../../../CHANGELOG.md:1666 +msgid "2022-11-25" msgstr "" -#: ../../../CHANGELOG.md:1667 -msgid "Using more than 1 media repository worker is now more reliable" +#: ../../../CHANGELOG.md:1668 +msgid "2x-5x performance improvements in playbook runtime" msgstr "" -#: ../../../CHANGELOG.md:1669 -msgid "With `matrix_synapse_workers_preset: one-of-each`, we only launch one `media_repository` worker." +#: ../../../CHANGELOG.md:1670 +msgid "**TLDR**: the playbook is 2x faster for running `--tags=setup-all` (and various other tags). It also has new `--tags=install-*` tags (like `--tags=install-all`), which skip uninstallation tasks and bring an additional 2.5x speedup. In total, the playbook can maintain your server 5 times faster." msgstr "" -#: ../../../CHANGELOG.md:1671 -msgid "If you've been configuring `matrix_synapse_workers_media_repository_workers_count` manually, you may have increased that to more workers. When multiple media repository workers are in use, background tasks related to the media repository must always be configured to run on a single `media_repository` worker via `media_instance_running_background_jobs`. Until now, we weren't doing this correctly, but we now are." +#: ../../../CHANGELOG.md:1672 +msgid "Our [etke.cc managed Matrix hosting service](https://etke.cc) runs maintenance against hundreds of servers, so the playbook being fast means a lot. The [etke.cc Ansible playbook](https://github.com/etkecc/ansible) (which is an extension of this one) is growing to support more and more services (besides just Matrix), so the Matrix playbook being leaner prevents runtimes from becoming too slow and improves the customer experience." msgstr "" -#: ../../../CHANGELOG.md:1673 -msgid "Potential Backward Incompatibilities after these Synapse worker changes" +#: ../../../CHANGELOG.md:1674 +msgid "Even when running `ansible-playbook` manually (as most of us here do), it's beneficial not to waste time and CPU resources." msgstr "" -#: ../../../CHANGELOG.md:1675 -msgid "Below we'll discuss **potential backward incompatibilities**." +#: ../../../CHANGELOG.md:1676 +msgid "Recently, a few large optimizations have been done to this playbook and its external roles (see [The playbook now uses external roles for some things](#the-playbook-now-uses-external-roles-for-some-things) and don't forget to run `make roles`):" msgstr "" -#: ../../../CHANGELOG.md:1677 -msgid "**Worker names** (container names, systemd services, worker configuration files) **have changed**. Workers are now labeled sequentially (e.g. `matrix-synapse-worker_generic_worker-18111` -> `matrix-synapse-worker-generic-0`). The playbook will handle these changes automatically." +#: ../../../CHANGELOG.md:1678 +msgid "Replacing Ansible `import_tasks` calls with `include_tasks`, which decreased runtime in half. Using `import_tasks` is slower and causes Ansible to go through and skip way too many tasks (tasks which could have been skipped altogether by not having Ansible include them in the first place). On an experimental VM, **deployment time was decreased from ~530 seconds to ~250 seconds**." msgstr "" -#: ../../../CHANGELOG.md:1679 -msgid "Due to increased worker types support above, people who use `matrix_synapse_workers_preset: one-of-each` should be aware that with these changes, **the playbook will deploy 9 additional workers** (6 stream writers, 1 `appservice` worker, 1 `user_dir` worker, 1 background task worker). This **may increase RAM/CPU usage**, etc. If you find your server struggling, consider disabling some workers with the appropriate `matrix_synapse_workers_*_workers_count` variables." +#: ../../../CHANGELOG.md:1680 +msgid "Introducing new `install-*` tags (`install-all` and `install-COMPONENT`, e.g. `install-synapse`, `install-bot-mjolnir`), which only run Ansible tasks pertaining to installation, while skipping uninstallation tasks. In most cases, people are maintaining the same setup or they're *adding* new components. Removing components is rare. Running thousands of uninstallation tasks each time is wasteful. On an experimental VM, **deployment time was decreased from ~250 seconds (`--tags=setup-all`) to ~100 seconds (`--tags=install-all`)**." msgstr "" -#: ../../../CHANGELOG.md:1681 -msgid "**Metric endpoints have also changed** (`/metrics/synapse/worker/generic_worker-18111` -> `/metrics/synapse/worker/generic-worker-0`). If you're [collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server), consider revisiting our [Collecting Synapse worker metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-synapse-worker-metrics-to-an-external-prometheus-server) docs and updating your Prometheus configuration. **If you're collecting metrics to the integrated Prometheus server** (not enabled by default), **your Prometheus configuration will be updated automatically**. Old data (from before this change) may stick around though." +#: ../../../CHANGELOG.md:1682 +msgid "You can still use `--tags=setup-all`. In fact, that's the best way to ensure your server is reconciled with the `vars.yml` configuration." msgstr "" -#: ../../../CHANGELOG.md:1683 -msgid "**the format of `matrix_synapse_workers_enabled_list` has changed**. You were never advised to use this variable for directly creating workers (we advise people to control workers using `matrix_synapse_workers_preset` or by tweaking `matrix_synapse_workers_*_workers_count` variables only), but some people may have started using the `matrix_synapse_workers_enabled_list` variable to gain more control over workers. If you're one of them, you'll need to adjust its value. See `roles/custom/matrix-synapse/defaults/main.yml` for more information on the new format. The playbook will also do basic validation and complain if you got something wrong." +#: ../../../CHANGELOG.md:1684 +msgid "If you know you haven't uninstalled any services since the last time you ran the playbook, you could run `--tags=install-all` instead and benefit from quicker runtimes. It should be noted that a service may become \"eligible for uninstallation\" even if your `vars.yml` file remains the same. In rare cases, we toggle services from being auto-installed to being optional, like we did on the 17th of March 2022 when we made [ma1sd not get installed by default](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#compatibility-break-ma1sd-identity-server-no-longer-installed-by-default). In such rare cases, you'd also need to run `--tags=setup-all`." msgstr "" -#: ../../../CHANGELOG.md:1686 -msgid "2022-09-09" +#: ../../../CHANGELOG.md:1687 +msgid "2022-11-22" msgstr "" -#: ../../../CHANGELOG.md:1688 -msgid "Cactus Comments support" +#: ../../../CHANGELOG.md:1689 +msgid "Automatic `matrix_architecture` determination" msgstr "" -#: ../../../CHANGELOG.md:1690 -msgid "Thanks to [Julian-Samuel Gebühr (@moan0s)](https://github.com/moan0s), the playbook can now set up [Cactus Comments](https://cactus.chat) — federated comment system for the web based on Matrix." +#: ../../../CHANGELOG.md:1691 +msgid "From now on, the playbook automatically determines your server's architecture and sets the `matrix_architecture` variable accordingly. You no longer need to set this variable manually in your `vars.yml` file." msgstr "" -#: ../../../CHANGELOG.md:1692 -msgid "See our [Setting up Cactus Comments](docs/configuring-playbook-cactus-comments.md) documentation to get started." -msgstr "" - -#: ../../../CHANGELOG.md:1695 -msgid "2022-08-23" +#: ../../../CHANGELOG.md:1693 +msgid "Docker and the Docker SDK for Python are now installed via external roles" msgstr "" #: ../../../CHANGELOG.md:1697 -msgid "Postmoogle email bridge support" +msgid "Docker will now be installed on the server via the [geerlingguy.docker](https://github.com/geerlingguy/ansible-role-docker) Ansible role. If you'd like to manage the Docker installation yourself, you can disable the playbook's installation of Docker by setting `matrix_playbook_docker_installation_enabled: false`." msgstr "" #: ../../../CHANGELOG.md:1699 -msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up the new [Postmoogle](https://github.com/etkecc/postmoogle) email bridge. Postmoogle is like the [Email2Matrix bridge](https://github.com/devture/email2matrix) (also [already supported by the playbook](docs/configuring-playbook-email2matrix.md)), but more capable and with the intention to soon support *sending* emails, not just receiving." +msgid "The Docker SDK for Python (named `docker-python`, `python-docker`, etc. on the different platforms) is now also installed by another role ([com.devture.ansible.role.docker_sdk_for_python](https://github.com/devture/com.devture.ansible.role.docker_sdk_for_python)). To disable this role and install the necessary tools yourself, use `devture_docker_sdk_for_python_installation_enabled: false`." msgstr "" #: ../../../CHANGELOG.md:1701 -msgid "See our [Setting up Postmoogle email bridging](docs/configuring-playbook-bridge-postmoogle.md) documentation to get started." +msgid "If you're hitting issues with Docker installation or Docker SDK for Python installation, consider reporting bugs or contributing to these other projects." msgstr "" -#: ../../../CHANGELOG.md:1704 -msgid "2022-08-10" +#: ../../../CHANGELOG.md:1703 +msgid "These additional roles are downloaded into the playbook directory (to `roles/galaxy`) via an `ansible-galaxy …` command. `make roles` is an easy shortcut for invoking the `ansible-galaxy` command to download these roles." msgstr "" #: ../../../CHANGELOG.md:1706 -msgid "mautrix-whatsapp default configuration changes" +msgid "2022-11-20" msgstr "" #: ../../../CHANGELOG.md:1708 -msgid "In [Pull Request #2012](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2012), we've made some changes to the default configuration used by the `mautrix-whatsapp` bridge." +msgid "(Backward Compatibility Break) Changing how reverse-proxying to Synapse works — now via a `matrix-synapse-reverse-proxy-companion` service" msgstr "" #: ../../../CHANGELOG.md:1710 -msgid "If you're using this bridge, you should look into this PR and see if the new configuration suits you. If not, you can always change individual preferences in your `vars.yml` file." +msgid "**TLDR**: There's now a `matrix-synapse-reverse-proxy-companion` nginx service, which helps with reverse-proxying to Synapse and its various worker processes (if workers are enabled), so that `matrix-nginx-proxy` can be relieved of this role. `matrix-nginx-proxy` still remains as the public SSL-terminating reverse-proxy in the playbook. `matrix-synapse-reverse-proxy-companion` is just one more reverse-proxy thrown into the mix for convenience. People with a more custom reverse-proxying configuration may be affected — see [Webserver configuration](#webserver-configuration) below." msgstr "" #: ../../../CHANGELOG.md:1712 -msgid "Most notably, spaces support has been enabled by default. The bridge will now group rooms into a Matrix space. **If you've already bridged to Whatsapp** prior to this update, you will need to send `!wa sync space` to the bridge bot to make it create the space and put your existing rooms into it." +msgid "Background" msgstr "" -#: ../../../CHANGELOG.md:1715 -msgid "2022-08-09" +#: ../../../CHANGELOG.md:1714 +msgid "Previously, `matrix-nginx-proxy` forwarded requests to Synapse directly. When Synapse is running in worker mode, the reverse-proxying configuration is more complicated (different requests need to go to different Synapse worker processes). `matrix-nginx-proxy` had configuration for sending each URL endpoint to the correct Synapse worker responsible for handling it. However, sometimes people like to disable `matrix-nginx-proxy` (for whatever reason) as detailed in [Using your own webserver, instead of this playbook's nginx proxy](docs/configuring-playbook-own-webserver.md)." msgstr "" -#: ../../../CHANGELOG.md:1717 -msgid "Conduit support" +#: ../../../CHANGELOG.md:1716 +msgid "Because `matrix-nginx-proxy` was so central to request forwarding, when it was disabled and Synapse was running with workers enabled, there was nothing which could forward requests to the correct place anymore… which caused [problems such as this one affecting Dimension](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2090)." msgstr "" -#: ../../../CHANGELOG.md:1719 -msgid "Thanks to [Charles Wright](https://github.com/cvwright), we now have optional experimental [Conduit](https://conduit.rs) homeserver support for new installations. This comes as a follow-up to the playbook getting [Dendrite support](#dendrite-support) earlier this year." +#: ../../../CHANGELOG.md:1718 +msgid "Solution" msgstr "" -#: ../../../CHANGELOG.md:1721 -msgid "Existing Synapse or Dendrite installations do **not** need to be updated. **Synapse is still the default homeserver implementation** installed by the playbook." +#: ../../../CHANGELOG.md:1720 +msgid "From now on, `matrix-nginx-proxy` is relieved of its function of reverse-proxying to Synapse and its various worker processes. This role is now handled by the new `matrix-synapse-reverse-proxy-companion` nginx service and works even if `matrix-nginx-proxy` is disabled. The purpose of the new `matrix-synapse-reverse-proxy-companion` service is to:" msgstr "" -#: ../../../CHANGELOG.md:1723 -msgid "To try out Conduit, we recommend that you **use a new server** and the following `vars.yml` configuration:" +#: ../../../CHANGELOG.md:1722 +msgid "serve as a companion to Synapse and know how to reverse-proxy to Synapse correctly (no matter if workers are enabled or not)" msgstr "" -#: ../../../CHANGELOG.md:1729 -msgid "**The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse or Dendrite to Conduit) without data loss." +#: ../../../CHANGELOG.md:1724 +msgid "provide a unified container address for reaching Synapse (no matter if workers are enabled or not)" +msgstr "" + +#: ../../../CHANGELOG.md:1725 +msgid "`matrix-synapse-reverse-proxy-companion:8008` for Synapse Client-Server API traffic" +msgstr "" + +#: ../../../CHANGELOG.md:1726 +msgid "`matrix-synapse-reverse-proxy-companion:8048` for Synapse Server-Server (Federation) API traffic" +msgstr "" + +#: ../../../CHANGELOG.md:1728 +msgid "simplify `matrix-nginx-proxy` configuration — it now only needs to send requests to `matrix-synapse-reverse-proxy-companion` or `matrix-dendrite`, etc., without having to worry about workers" +msgstr "" + +#: ../../../CHANGELOG.md:1730 +msgid "allow reverse-proxying to Synapse, even if `matrix-nginx-proxy` is disabled" msgstr "" #: ../../../CHANGELOG.md:1732 -msgid "2022-07-29" +msgid "`matrix-nginx-proxy` still remains as the public SSL-terminating reverse-proxy in the playbook. All traffic goes through it before reaching any of the services. It's just that now the Synapse traffic is routed through `matrix-synapse-reverse-proxy-companion` like this:" msgstr "" #: ../../../CHANGELOG.md:1734 -msgid "mautrix-discord support" +msgid "(`matrix-nginx-proxy` -> `matrix-synapse-reverse-proxy-companion` -> (`matrix-synapse` or some Synapse worker))." msgstr "" #: ../../../CHANGELOG.md:1736 -msgid "Thanks to [MdotAmaan](https://github.com/MdotAmaan)'s efforts, the playbook now supports bridging to [Discord](https://discordapp.com/) via the [mautrix-discord](https://mau.dev/mautrix/discord) bridge. See our [Setting up Mautrix Discord bridging](docs/configuring-playbook-bridge-mautrix-discord.md) documentation page for getting started." +msgid "Various services (like Dimension, etc.) still talk to Synapse via `matrix-nginx-proxy` (e.g. `http://matrix-nginx-proxy:12080`) preferentially. They only talk to Synapse via the reverse-proxy companion (e.g. `http://matrix-synapse-reverse-proxy-companion:8008`) if `matrix-nginx-proxy` is disabled. Services should not be talking to Synapse (e.g. `https://matrix-synapse:8008` directly anymore), because when workers are enabled, that's the Synapse `master` process and may not be serving all URL endpoints needed by the service." msgstr "" #: ../../../CHANGELOG.md:1738 -msgid "**Note**: this is a new Discord bridge. The playbook still retains Discord bridging via [matrix-appservice-discord](docs/configuring-playbook-bridge-appservice-discord.md) and [mx-puppet-discord](docs/configuring-playbook-bridge-mx-puppet-discord.md). You're free to use the bridge that serves you better, or even all three of them (for different users and use-cases)." +msgid "Webserver configuration" msgstr "" -#: ../../../CHANGELOG.md:1741 -msgid "2022-07-27" +#: ../../../CHANGELOG.md:1740 +msgid "if you're using `matrix-nginx-proxy` (`matrix_nginx_proxy_enabled: true`, which is the default for the playbook), you don't need to do anything" msgstr "" -#: ../../../CHANGELOG.md:1743 -msgid "matrix-appservice-kakaotalk support" +#: ../../../CHANGELOG.md:1742 +msgid "if you're using your own `nginx` webserver running on the server, you shouldn't be affected. The `/matrix/nginx/conf.d` configuration and exposed ports that you're relying on will automatically be updated in a way that should work" msgstr "" -#: ../../../CHANGELOG.md:1745 -msgid "The playbook now supports bridging to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) via [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) — a bridge based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code. Thanks to [hnarjis](https://github.com/hnarjis) for helping us add support for this!" +#: ../../../CHANGELOG.md:1744 +msgid "if you're using another local webserver (e.g. Apache, etc.) and haven't changed any ports (`matrix_*_host_bind_port` definitions), you shouldn't be affected. You're likely sending Matrix traffic to `127.0.0.1:8008` and `127.0.0.1:8048`. These ports (`8008` and `8048`) will still be exposed on `127.0.0.1` by default — just not by the `matrix-synapse` container from now on, but by the `matrix-synapse-reverse-proxy-companion` container instead" msgstr "" -#: ../../../CHANGELOG.md:1747 -msgid "See our [Setting up Appservice Kakaotalk bridging](docs/configuring-playbook-bridge-appservice-kakaotalk.md) documentation to get started." +#: ../../../CHANGELOG.md:1746 +msgid "if you've been exposing `matrix-synapse` ports (`matrix_synapse_container_client_api_host_bind_port`, etc.) manually, you should consider exposing `matrix-synapse-reverse-proxy-companion` ports instead" msgstr "" -#: ../../../CHANGELOG.md:1750 -msgid "2022-07-20" +#: ../../../CHANGELOG.md:1748 +msgid "if you're running Traefik and reverse-proxying directly to the `matrix-synapse` container, you should start reverse-proxying to the `matrix-synapse-reverse-proxy-companion` container instead. See [our updated Traefik example configuration](docs/configuring-playbook-own-webserver.md#sample-configuration-for-running-behind-traefik-20). Note: we now recommend calling the federation entry point `federation` (instead of `synapse`) and reverse-proxying the federation traffic via `matrix-nginx-proxy`, instead of sending it directly to Synapse (or `matrix-synapse-reverse-proxy-companion`). This makes the configuration simpler." msgstr "" -#: ../../../CHANGELOG.md:1752 -msgid "maubot support" +#: ../../../CHANGELOG.md:1751 +msgid "2022-11-05" msgstr "" -#: ../../../CHANGELOG.md:1754 -msgid "Thanks to [Stuart Mumford (@Cadair)](https://github.com/cadair) for starting ([PR #373](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/373) and [PR #622](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/622)) and to [Julian-Samuel Gebühr (@moan0s)](https://github.com/moan0s) for finishing up (in [PR #1894](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1894)), the playbook can now help you set up [maubot](https://github.com/maubot/maubot) — a plugin-based Matrix bot system." +#: ../../../CHANGELOG.md:1753 +msgid "(Backward Compatibility Break) A new default standalone mode for Etherpad" msgstr "" -#: ../../../CHANGELOG.md:1756 -msgid "See our [Setting up maubot](docs/configuring-playbook-bot-maubot.md) documentation to get started." +#: ../../../CHANGELOG.md:1755 +msgid "Until now, [Etherpad](https://etherpad.org/) (which [the playbook could install for you](docs/configuring-playbook-etherpad.md)) required the [Dimension integration manager](docs/configuring-playbook-dimension.md) to also be installed, because Etherpad was hosted on the Dimension domain (at `dimension.example.com/etherpad`)." +msgstr "" + +#: ../../../CHANGELOG.md:1757 +msgid "From now on, Etherpad can be installed in `standalone` mode on `etherpad.example.com` and used even without Dimension. This is much more versatile, so the playbook now defaults to this new mode (`etherpad_mode: standalone`)." msgstr "" #: ../../../CHANGELOG.md:1759 -msgid "2022-07-14" +msgid "If you've already got both Etherpad and Dimension in use you could:" msgstr "" #: ../../../CHANGELOG.md:1761 -msgid "mx-puppet-skype removal" +msgid "**either** keep hosting Etherpad under the Dimension domain by adding `etherpad_mode: dimension` to your `vars.yml` file. All your existing room widgets will continue working at the same URLs and no other changes will be necessary." msgstr "" #: ../../../CHANGELOG.md:1763 -msgid "The playbook no longer includes the [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype) bridge, because it has been broken and unmaintained for a long time. Users that have `matrix_mx_puppet_skype_enabled` in their configuration files will encounter an error when running the playbook until they remove references to this bridge from their configuration." +msgid "**or**, you could change to hosting Etherpad separately on `etherpad.example.com`. You will need to [configure a DNS record](docs/configuring-dns.md) for this new domain. You will also need to reconfigure Dimension to use the new pad URLs (`https://etherpad.example.com/…`) going forward (refer to our [configuring Etherpad documentation](docs/configuring-playbook-etherpad.md)). All your existing room widgets (which still use `https://dimension.example.com/etherpad/…`) will break as Etherpad is not hosted there anymore. You will need to re-add them or to consider not using `standalone` mode" msgstr "" -#: ../../../CHANGELOG.md:1765 -msgid "To completely clean up your server from `mx-puppet-skype`'s presence on it:" -msgstr "" - -#: ../../../CHANGELOG.md:1767 -msgid "ensure your Ansible configuration (`vars.yml` file) no longer contains `matrix_mx_puppet_skype_*` references" +#: ../../../CHANGELOG.md:1766 +msgid "2022-11-04" msgstr "" #: ../../../CHANGELOG.md:1768 -msgid "stop and disable the systemd service (run `systemctl disable --now matrix-mx-puppet-skype` on the server)" -msgstr "" - -#: ../../../CHANGELOG.md:1769 -msgid "delete the systemd service (run `rm /etc/systemd/system/matrix-mx-puppet-skype.service` on the server)" +msgid "The playbook now uses external roles for some things" msgstr "" #: ../../../CHANGELOG.md:1770 -msgid "delete `/matrix/mx-puppet-skype` (run `rm -rf /matrix/mx-puppet-skype` on the server)" +msgid "**TLDR**: when updating the playbook and before running it, you'll need to run `make roles` to make [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) download dependency roles (see the [`requirements.yml` file](requirements.yml)) to the `roles/galaxy` directory. Without this, the playbook won't work." msgstr "" -#: ../../../CHANGELOG.md:1771 -msgid "drop the `matrix_mx_puppet_skype` database (run `/usr/local/bin/matrix-postgres-cli` on the server, and execute the `DROP DATABASE matrix_mx_puppet_skype;` query there)" +#: ../../../CHANGELOG.md:1772 +msgid "We're in the process of trimming the playbook and making it reuse Ansible roles." msgstr "" -#: ../../../CHANGELOG.md:1773 -msgid "If you still need bridging to [Skype](https://www.skype.com/), consider switching to [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) instead. See [Setting up Go Skype Bridge bridging](docs/configuring-playbook-bridge-go-skype-bridge.md)." +#: ../../../CHANGELOG.md:1774 +msgid "Starting now, the playbook is composed of 2 types of Ansible roles:" msgstr "" -#: ../../../CHANGELOG.md:1775 -msgid "If you think this is a mistake and `mx-puppet-skype` works for you (or you get it to work somehow), let us know and we may reconsider this removal." +#: ../../../CHANGELOG.md:1776 +msgid "those that live within the playbook itself (`roles/custom/*`)" msgstr "" -#: ../../../CHANGELOG.md:1777 -msgid "signald (0.19.0+) upgrade requires data migration" +#: ../../../CHANGELOG.md:1778 +msgid "those downloaded from other sources (using [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) to `roles/galaxy`, based on the [`requirements.yml` file](requirements.yml)). These roles are maintained by us or by other people from the Ansible community." msgstr "" -#: ../../../CHANGELOG.md:1779 -msgid "In [Pull Request #1921](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1921) we upgraded [signald](https://signald.org/) (used by the mautrix-signal bridge) from `v0.18.5` to `v0.20.0`." +#: ../../../CHANGELOG.md:1780 +msgid "We're doing this for greater code-reuse (across Ansible playbooks, including our own related playbooks [gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy) and [nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy)) and decreased maintenance burden. Until now, certain features were copy-pasted across playbooks or were maintained separately in each one, with improvements often falling behind. We've also tended to do too much by ourselves — installing Docker on the server from our `matrix-base` role, etc. — something that we'd rather not do anymore by switching to the [geerlingguy.docker](https://galaxy.ansible.com/geerlingguy/docker) role." msgstr "" -#: ../../../CHANGELOG.md:1781 -msgid "Back in the [`v0.19.0` released of signald](https://gitlab.com/signald/signald/-/blob/main/releases/0.19.0.md) (which we skipped and migrated straight to `v0.20.0`), a new `--migrate-data` command had been added that migrates avatars, group images, attachments, etc., into the database (those were previously stored in the filesystem)." +#: ../../../CHANGELOG.md:1782 +msgid "Some variable names will change during the transition to having more and more external (galaxy) roles. There's a new `custom/matrix_playbook_migration` role added to the playbook which will tell you about these changes each time you run the playbook." msgstr "" -#: ../../../CHANGELOG.md:1783 -msgid "If you've been using the mautrix-signal bridge for a while, you may have files stored in the local filesystem, which will need to be upgraded." -msgstr "" - -#: ../../../CHANGELOG.md:1785 -msgid "We attempt to do this data migration automatically every time Signald starts (`matrix-mautrix-signal-daemon.service`) using a `ExecStartPre` systemd unit definition." +#: ../../../CHANGELOG.md:1784 +msgid "**From now on**, every time you update the playbook (well, every time the `requirements.yml` file changes), it's best to run `make roles` to update the roles downloaded from other sources. `make roles` is a shortcut (a `roles` target defined in [`Makefile`](Makefile) and executed by the [`make`](https://www.gnu.org/software/make/) utility) which ultimately runs [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) to download Ansible roles. If you don't have `make`, you can also manually run the commands seen in the `Makefile`." msgstr "" #: ../../../CHANGELOG.md:1787 -msgid "Keep an eye on your Signal bridge and let us know (in our [support room](README.md#support) or in [Pull Request #1921](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1921)) if you experience any trouble!" +msgid "2022-10-14" msgstr "" -#: ../../../CHANGELOG.md:1790 -msgid "2022-07-05" +#: ../../../CHANGELOG.md:1789 +msgid "synapse-s3-storage-provider support" msgstr "" -#: ../../../CHANGELOG.md:1792 -msgid "Ntfy push notifications support" +#: ../../../CHANGELOG.md:1791 +msgid "**`synapse-s3-storage-provider` support is very new and still relatively untested. Using it may cause data loss.**" msgstr "" -#: ../../../CHANGELOG.md:1794 -msgid "Thanks to [Julian Foad](https://matrix.to/#/@julian:foad.me.uk), the playbook can now install a [ntfy](https://ntfy.sh/) push notifications server for you." +#: ../../../CHANGELOG.md:1793 +msgid "You can now store your Synapse media repository files on Amazon S3 (or another S3-compatible object store) using [synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider) — a media provider for Synapse (Python module), which should work faster and more reliably than our previous [Goofys](docs/configuring-playbook-s3-goofys.md) implementation (Goofys will continue to work)." msgstr "" -#: ../../../CHANGELOG.md:1796 -msgid "See our [Setting up the ntfy push notifications server](docs/configuring-playbook-ntfy.md) documentation to get started." +#: ../../../CHANGELOG.md:1795 +msgid "This is not just for initial installations. Users with existing files (stored in the local filesystem) can also migrate their files to `synapse-s3-storage-provider`." +msgstr "" + +#: ../../../CHANGELOG.md:1797 +msgid "To get started, see our [Storing Synapse media files on Amazon S3 with synapse-s3-storage-provider](docs/configuring-playbook-synapse-s3-storage-provider.md) documentation." msgstr "" #: ../../../CHANGELOG.md:1799 -msgid "2022-06-23" +msgid "Synapse container image customization support" msgstr "" #: ../../../CHANGELOG.md:1801 -msgid "(Potential Backward Compatibility Break) Changes around metrics collection" +msgid "We now support customizing the Synapse container image by adding additional build steps to its [`Dockerfile`](https://docs.docker.com/engine/reference/builder/)." msgstr "" #: ../../../CHANGELOG.md:1803 -msgid "**TLDR**: we've made extensive **changes to metrics exposure/collection, which concern people using an external Prometheus server**. If you don't know what that is, you don't need to read below." +msgid "Our [synapse-s3-storage-provider support](#synapse-s3-storage-provider-support) is actually built on this. When `s3-storage-provider` is enabled, we automatically add additional build steps to install its Python module into the Synapse image." msgstr "" #: ../../../CHANGELOG.md:1805 -msgid "**Why do major changes to metrics**? Because various services were exposing metrics in different, hacky, ways. Synapse was exposing metrics at `/_synapse/metrics` and `/_synapse-worker-…/metrics` on the `matrix.example.com`. The Hookshot role was **repurposing** the Granana web UI domain (`stats.example.com`) for exposing its metrics on `stats.example.com/hookshot/metrics`, while protecting these routes using Basic Authentication **normally used for Synapse** (`/_synapse/metrics`). Node-exporter and Postgres-exporter roles were advising for more `stats.example.com` usage in manual ways. Each role was doing things differently and mixing variables from other roles. Each metrics endpoint was ending up in a different place, protected by who knows what Basic Authentication credentials (if protected at all)." -msgstr "" - -#: ../../../CHANGELOG.md:1807 -msgid "**The solution**: a completely revamped way to expose metrics to an external Prometheus server. We are **introducing new `https://matrix.example.com/metrics/*` endpoints**, where various services *can* expose their metrics, for collection by external Prometheus servers. To enable the `/metrics/*` endpoints, use `matrix_nginx_proxy_proxy_matrix_metrics_enabled: true`. There's also a way to protect access using [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). See the `matrix-nginx-proxy` role or our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation for additional variables around `matrix_nginx_proxy_proxy_matrix_metrics_enabled`." -msgstr "" - -#: ../../../CHANGELOG.md:1809 -msgid "**If you are using the [Hookshot bridge](docs/configuring-playbook-bridge-hookshot.md)**, you may find that:" -msgstr "" - -#: ../../../CHANGELOG.md:1810 -msgid "**Metrics may not be enabled by default anymore**:" -msgstr "" - -#: ../../../CHANGELOG.md:1811 -msgid "If Prometheus is enabled (`prometheus_enabled: true`), then Hookshot metrics will be enabled automatically (`matrix_hookshot_metrics_enabled: true`). These metrics will be collected from the local (in-container) Prometheus over the container network." -msgstr "" - -#: ../../../CHANGELOG.md:1812 -msgid "**If Prometheus is not enabled** (you are either not using Prometheus or are using an external one), **Hookshot metrics will not be enabled by default anymore**. Feel free to enable them by setting `matrix_hookshot_metrics_enabled: true`. Also, see below." -msgstr "" - -#: ../../../CHANGELOG.md:1813 -msgid "When metrics are meant to be **consumed by an external Prometheus server**, `matrix_hookshot_metrics_proxying_enabled` needs to be set to `true`, so that metrics would be exposed (proxied) \"publicly\" on `https://matrix.example.com/metrics/hookshot`. To make use of this, you'll also need to enable the new `https://matrix.example.com/metrics/*` endpoints mentioned above, using `matrix_nginx_proxy_proxy_matrix_metrics_enabled`. Learn more in our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation." -msgstr "" - -#: ../../../CHANGELOG.md:1814 -msgid "**We've changed the URL we're exposing Hookshot metrics at** for external Prometheus servers. Until now, you were advised to consume Hookshot metrics from `https://stats.example.com/hookshot/metrics` (working in conjunction with `matrix_nginx_proxy_proxy_synapse_metrics`). From now on, **this no longer works**. As described above, you need to start consuming metrics from `https://matrix.example.com/metrics/hookshot`." +msgid "Besides this kind of auto-added build steps (for components supported by the playbook), we also let you inject your own custom build steps using configuration like this:" msgstr "" #: ../../../CHANGELOG.md:1816 -msgid "**If you're using node-exporter** (`matrix_prometheus_node_exporter_enabled: true`) and would like to collect its metrics from an external Prometheus server, see `matrix_prometheus_node_exporter_metrics_proxying_enabled` described in our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation. You will be able to collect its metrics from `https://matrix.example.com/metrics/node-exporter`." +msgid "People who have needed to customize Synapse previously had to fork the git repository, make their changes to the `Dockerfile` there, point the playbook to the new repository (`matrix_synapse_container_image_self_build_repo`) and enable self-building from scratch (`matrix_synapse_container_image_self_build: true`). This is harder and slower." msgstr "" #: ../../../CHANGELOG.md:1818 -msgid "**If you're using [postgres-exporter](docs/configuring-playbook-prometheus-postgres.md)** (`prometheus_postgres_exporter_enabled: true`) and would like to collect its metrics from an external Prometheus server, see `matrix_prometheus_services_proxy_connect_prometheus_postgres_exporter_metrics_proxying_enabled` described in our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation. You will be able to collect its metrics from `https://matrix.example.com/metrics/postgres-exporter`." +msgid "With the new Synapse-customization feature in the playbook, we use the original upstream (pre-built, if available) Synapse image and only build on top of it, right on the Matrix server. This is much faster than building all of Synapse from scratch." msgstr "" -#: ../../../CHANGELOG.md:1820 -msgid "**If you're using Synapse** and would like to collect its metrics from an external Prometheus server, you may find that:" -msgstr "" - -#: ../../../CHANGELOG.md:1822 -msgid "Exposing metrics is now done using `matrix_synapse_metrics_proxying_enabled`, not `matrix_nginx_proxy_proxy_synapse_metrics: true`. You may still need to enable metrics using `matrix_synapse_metrics_enabled: true` before exposing them." +#: ../../../CHANGELOG.md:1821 +msgid "2022-10-02" msgstr "" #: ../../../CHANGELOG.md:1823 -msgid "Protecting metrics endpoints using [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) is now done in another way. See our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation" -msgstr "" - -#: ../../../CHANGELOG.md:1824 -msgid "If Synapse metrics are exposed, they will be made available at `https://matrix.example.com/metrics/synapse/main-process` or `https://matrix.example.com/metrics/synapse/worker/TYPE-ID` (when workers are enabled), not at `https://matrix.example.com/_synapse/metrics` and `https://matrix.example.com/_synapse-worker-…/metrics`" +msgid "matrix-ldap-registration-proxy support" msgstr "" #: ../../../CHANGELOG.md:1825 -msgid "The playbook still generates an `external_prometheus.yml.example` sample file for scraping Synapse from Prometheus as described in [Collecting Synapse worker metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-synapse-worker-metrics-to-an-external-prometheus-server), but it's now saved under `/matrix/synapse` (not `/matrix`)." +msgid "Thanks to [@TheOneWithTheBraid](https://github.com/TheOneWithTheBraid), we now support installing [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) — a proxy which handles Matrix registration requests and forwards them to LDAP." msgstr "" #: ../../../CHANGELOG.md:1827 -msgid "**If you where already using a external Prometheus server** before this change, and you gave a hashed version of the password as a variable, the playbook will now take care of hashing the password for you. Thus, you need to provide the non-hashed version now." +msgid "See our [Setting up matrix-ldap-registration-proxy](docs/configuring-playbook-matrix-ldap-registration-proxy.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:1829 -msgid "2022-06-13" +#: ../../../CHANGELOG.md:1830 +msgid "2022-09-15" msgstr "" -#: ../../../CHANGELOG.md:1831 -msgid "go-skype-bridge bridging support" +#: ../../../CHANGELOG.md:1832 +msgid "(Potential Backward Compatibility Break) Major improvements to Synapse workers" msgstr "" -#: ../../../CHANGELOG.md:1833 -msgid "Thanks to [CyberShadow](https://github.com/CyberShadow), the playbook can now install the [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) bridge for bridging Matrix to [Skype](https://www.skype.com/)." +#: ../../../CHANGELOG.md:1834 +msgid "People who are interested in running a Synapse worker setup should know that **our Synapse worker implementation is much more powerful now**:" msgstr "" -#: ../../../CHANGELOG.md:1835 -msgid "See our [Setting up Go Skype Bridge bridging](docs/configuring-playbook-bridge-go-skype-bridge.md) documentation to get started." +#: ../../../CHANGELOG.md:1836 +msgid "we've added support for [Stream writers](#stream-writers-support)" msgstr "" #: ../../../CHANGELOG.md:1837 -msgid "The playbook has supported [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype) bridging (see [Setting up MX Puppet Skype bridging](docs/configuring-playbook-bridge-mx-puppet-skype.md)) since [2020-04-09](#2020-04-09), but `mx-puppet-skype` is reportedly broken." +msgid "we've added support for [multiple federation sender workers](#multiple-federation-sender-workers-support)" +msgstr "" + +#: ../../../CHANGELOG.md:1838 +msgid "we've added support for [multiple pusher workers](#multiple-pusher-workers-support)" +msgstr "" + +#: ../../../CHANGELOG.md:1839 +msgid "we've added support for [running background tasks on a worker](#background-tasks-can-run-on-a-worker)" msgstr "" #: ../../../CHANGELOG.md:1840 -msgid "2022-06-09" +msgid "we've restored support for [`appservice` workers](#appservice-worker-support-is-back)" +msgstr "" + +#: ../../../CHANGELOG.md:1841 +msgid "we've restored support for [`user_dir` workers](#user-directory-worker-support-is-back)" msgstr "" #: ../../../CHANGELOG.md:1842 -msgid "Running Ansible in a container can now happen on the Matrix server itself" +msgid "we've made it possible to [reliably use more than 1 `media_repository` worker](#using-more-than-1-media-repository-worker-is-now-more-reliable)" msgstr "" -#: ../../../CHANGELOG.md:1844 -msgid "If you're tired of being on an old and problematic Ansible version, you can now run [run Ansible in a container on the Matrix server itself](docs/ansible.md#running-ansible-in-a-container-on-the-matrix-server-itself)." +#: ../../../CHANGELOG.md:1843 +msgid "see the [Potential Backward Incompatibilities after these Synapse worker changes](#potential-backward-incompatibilities-after-these-synapse-worker-changes)" +msgstr "" + +#: ../../../CHANGELOG.md:1845 +msgid "Stream writers support" msgstr "" #: ../../../CHANGELOG.md:1847 -msgid "2022-05-31" +msgid "From now on, the playbook lets you easily set up various [stream writer workers](https://matrix-org.github.io/synapse/latest/workers.html#stream-writers) which can handle different streams (`events` stream; `typing` URL endpoints, `to_device` URL endpoints, `account_data` URL endpoints, `receipts` URL endpoints, `presence` URL endpoints). All of this work was previously handled by the main Synapse process, but can now be offloaded to stream writer worker processes." msgstr "" #: ../../../CHANGELOG.md:1849 -msgid "Synapse v1.60 upgrade may cause trouble and require manual intervention" +msgid "If you're using `matrix_synapse_workers_preset: one-of-each`, you'll automatically get 6 additional workers (one for each of the above stream types). Our `little-federation-helper` preset (meant to be quite minimal and focusing in improved federation performance) does not include stream writer workers." msgstr "" #: ../../../CHANGELOG.md:1851 -msgid "Synapse v1.60 will try to add a new unique index to `state_group_edges` upon startup and could fail if your database is corrupted." +msgid "If you'd like to customize the number of workers we also make that possible using these variables:" msgstr "" -#: ../../../CHANGELOG.md:1853 -msgid "We haven't observed this problem yet, but [the Synapse v1.60.0 upgrade notes](https://github.com/element-hq/synapse/blob/v1.60.0/docs/upgrade.md#adding-a-new-unique-index-to-state_group_edges-could-fail-if-your-database-is-corrupted) mention it, so we're giving you a heads up here in case you're unlucky." +#: ../../../CHANGELOG.md:1864 +msgid "Multiple federation sender workers support" msgstr "" -#: ../../../CHANGELOG.md:1855 -msgid "**If Synapse fails to start** after your next playbook run, you'll need to:" +#: ../../../CHANGELOG.md:1866 +msgid "Until now, we only supported a single `federation_sender` worker (`matrix_synapse_workers_federation_sender_workers_count` could either be `0` or `1`). From now on, you can have as many as you want to help with your federation traffic." msgstr "" -#: ../../../CHANGELOG.md:1857 -msgid "SSH into the Matrix server" +#: ../../../CHANGELOG.md:1868 +msgid "Multiple pusher workers support" msgstr "" -#: ../../../CHANGELOG.md:1858 -msgid "launch `/usr/local/bin/matrix-postgres-cli`" +#: ../../../CHANGELOG.md:1870 +msgid "Until now, we only supported a single `pusher` worker (`matrix_synapse_workers_pusher_workers_count` could either be `0` or `1`). From now on, you can have as many as you want to help with pushing notifications out." msgstr "" -#: ../../../CHANGELOG.md:1859 -msgid "switch to the `synapse` database: `\\c synapse`" +#: ../../../CHANGELOG.md:1872 +msgid "Background tasks can run on a worker" msgstr "" -#: ../../../CHANGELOG.md:1860 -msgid "run the following SQL query:" +#: ../../../CHANGELOG.md:1874 +msgid "From now on, you can put [background task processing on a worker](https://matrix-org.github.io/synapse/latest/workers.html#background-tasks)." msgstr "" -#: ../../../CHANGELOG.md:1879 -msgid "You could then restart services: `ansible-playbook -i inventory/hosts setup.yml --tags=start`" +#: ../../../CHANGELOG.md:1876 +msgid "With `matrix_synapse_workers_preset: one-of-each`, you'll get one `background` worker automatically. You can also control the `background` workers count with `matrix_synapse_workers_background_workers_count`. Only `0` or `1` workers of this type are supported by Synapse." +msgstr "" + +#: ../../../CHANGELOG.md:1878 +msgid "Appservice worker support is back" +msgstr "" + +#: ../../../CHANGELOG.md:1880 +msgid "We previously had an `appservice` worker type, which [Synapse deprecated in v1.59.0](https://github.com/element-hq/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types). So did we, at the time." msgstr "" #: ../../../CHANGELOG.md:1882 -msgid "2022-04-25" +msgid "The new way to implement such workers is by using a `generic_worker` and dedicating it to the task of talking to Application Services. From now on, we have support for this." msgstr "" #: ../../../CHANGELOG.md:1884 -msgid "Buscarron bot support" +msgid "With `matrix_synapse_workers_preset: one-of-each`, you'll get one `appservice` worker automatically. You can also control the `appservice` workers count with `matrix_synapse_workers_appservice_workers_count`. Only `0` or `1` workers of this type are supported by Synapse." msgstr "" #: ../../../CHANGELOG.md:1886 -msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [the Buscarron bot](https://github.com/etkecc/buscarron). It's a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room" +msgid "User Directory worker support is back" msgstr "" #: ../../../CHANGELOG.md:1888 -msgid "See our [Setting up Buscarron](docs/configuring-playbook-bot-buscarron.md) documentation to get started." +msgid "We previously had a `user_dir` worker type, which [Synapse deprecated in v1.59.0](https://github.com/element-hq/synapse/blob/v1.59.0/docs/upgrade.md#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types). So did we, at the time." msgstr "" -#: ../../../CHANGELOG.md:1891 -msgid "2022-04-21" +#: ../../../CHANGELOG.md:1890 +msgid "The new way to implement such workers is by using a `generic_worker` and dedicating it to the task of serving the user directory. From now on, we have support for this." msgstr "" -#: ../../../CHANGELOG.md:1893 -msgid "matrix-registration-bot support" +#: ../../../CHANGELOG.md:1892 +msgid "With `matrix_synapse_workers_preset: one-of-each`, you'll get one `user_dir` worker automatically. You can also control the `user_dir` workers count with `matrix_synapse_workers_user_dir_workers_count`. Only `0` or `1` workers of this type are supported by Synapse." msgstr "" -#: ../../../CHANGELOG.md:1895 -msgid "Thanks to [Julian-Samuel Gebühr (@moan0s)](https://github.com/moan0s), the playbook can now help you set up [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) — a bot that is used to create and manage registration tokens for a Matrix server." +#: ../../../CHANGELOG.md:1894 +msgid "Using more than 1 media repository worker is now more reliable" msgstr "" -#: ../../../CHANGELOG.md:1897 -msgid "See our [Setting up matrix-registration-bot](docs/configuring-playbook-bot-matrix-registration-bot.md) documentation to get started." +#: ../../../CHANGELOG.md:1896 +msgid "With `matrix_synapse_workers_preset: one-of-each`, we only launch one `media_repository` worker." +msgstr "" + +#: ../../../CHANGELOG.md:1898 +msgid "If you've been configuring `matrix_synapse_workers_media_repository_workers_count` manually, you may have increased that to more workers. When multiple media repository workers are in use, background tasks related to the media repository must always be configured to run on a single `media_repository` worker via `media_instance_running_background_jobs`. Until now, we weren't doing this correctly, but we now are." msgstr "" #: ../../../CHANGELOG.md:1900 -msgid "2022-04-19" +msgid "Potential Backward Incompatibilities after these Synapse worker changes" msgstr "" #: ../../../CHANGELOG.md:1902 -msgid "BorgBackup support" +msgid "Below we'll discuss **potential backward incompatibilities**." msgstr "" #: ../../../CHANGELOG.md:1904 -msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [Borg](https://www.borgbackup.org/) backups with [borgmatic](https://torsion.org/borgmatic/) of your Matrix server." +msgid "**Worker names** (container names, systemd services, worker configuration files) **have changed**. Workers are now labeled sequentially (e.g. `matrix-synapse-worker_generic_worker-18111` -> `matrix-synapse-worker-generic-0`). The playbook will handle these changes automatically." msgstr "" #: ../../../CHANGELOG.md:1906 -msgid "See our [Setting up BorgBackup](docs/configuring-playbook-backup-borg.md) documentation to get started." +msgid "Due to increased worker types support above, people who use `matrix_synapse_workers_preset: one-of-each` should be aware that with these changes, **the playbook will deploy 9 additional workers** (6 stream writers, 1 `appservice` worker, 1 `user_dir` worker, 1 background task worker). This **may increase RAM/CPU usage**, etc. If you find your server struggling, consider disabling some workers with the appropriate `matrix_synapse_workers_*_workers_count` variables." msgstr "" #: ../../../CHANGELOG.md:1908 -msgid "(Compatibility Break) Upgrading to Synapse v1.57 on setups using workers may require manual action" +msgid "**Metric endpoints have also changed** (`/metrics/synapse/worker/generic_worker-18111` -> `/metrics/synapse/worker/generic-worker-0`). If you're [collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server), consider revisiting our [Collecting Synapse worker metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-synapse-worker-metrics-to-an-external-prometheus-server) docs and updating your Prometheus configuration. **If you're collecting metrics to the integrated Prometheus server** (not enabled by default), **your Prometheus configuration will be updated automatically**. Old data (from before this change) may stick around though." msgstr "" #: ../../../CHANGELOG.md:1910 -msgid "If you're running a worker setup for Synapse (`matrix_synapse_workers_enabled: true`), the [Synapse v1.57 upgrade notes](https://github.com/element-hq/synapse/blob/v1.57.0rc1/docs/upgrade.md#changes-to-database-schema-for-application-services) say that you may need to take special care when upgrading:" +msgid "**the format of `matrix_synapse_workers_enabled_list` has changed**. You were never advised to use this variable for directly creating workers (we advise people to control workers using `matrix_synapse_workers_preset` or by tweaking `matrix_synapse_workers_*_workers_count` variables only), but some people may have started using the `matrix_synapse_workers_enabled_list` variable to gain more control over workers. If you're one of them, you'll need to adjust its value. See `roles/custom/matrix-synapse/defaults/main.yml` for more information on the new format. The playbook will also do basic validation and complain if you got something wrong." msgstr "" -#: ../../../CHANGELOG.md:1912 -msgid "Synapse v1.57.0 includes a change to the way transaction IDs are managed for application services. If your deployment uses a dedicated worker for application service traffic, **it must be stopped** when the database is upgraded (which normally happens when the main process is upgraded), to ensure the change is made safely without any risk of reusing transaction IDs." +#: ../../../CHANGELOG.md:1913 +msgid "2022-09-09" msgstr "" -#: ../../../CHANGELOG.md:1914 -msgid "If you're not running an `appservice` worker (`matrix_synapse_workers_preset: little-federation-helper` or `matrix_synapse_workers_appservice_workers_count: 0`), you are probably safe to upgrade as per normal, without taking any special care." +#: ../../../CHANGELOG.md:1915 +msgid "Cactus Comments support" msgstr "" -#: ../../../CHANGELOG.md:1916 -msgid "If you are running a setup with an `appservice` worker, or otherwise want to be on the safe side, we recommend the following upgrade path:" -msgstr "" - -#: ../../../CHANGELOG.md:1918 -msgid "Pull the latest playbook changes" +#: ../../../CHANGELOG.md:1917 +msgid "Thanks to [Julian-Samuel Gebühr (@moan0s)](https://github.com/moan0s), the playbook can now set up [Cactus Comments](https://cactus.chat) — federated comment system for the web based on Matrix." msgstr "" #: ../../../CHANGELOG.md:1919 -msgid "Stop all services (`ansible-playbook -i inventory/hosts setup.yml --tags=stop`)" -msgstr "" - -#: ../../../CHANGELOG.md:1920 -msgid "Re-run the playbook (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-all`)" -msgstr "" - -#: ../../../CHANGELOG.md:1921 -msgid "Start Postgres (`systemctl start matrix-postgres` on the server)" +msgid "See our [Setting up Cactus Comments](docs/configuring-playbook-cactus-comments.md) documentation to get started." msgstr "" #: ../../../CHANGELOG.md:1922 -msgid "Start the main Synapse process (`systemctl start matrix-synapse` on the server)" -msgstr "" - -#: ../../../CHANGELOG.md:1923 -msgid "Wait a while so that Synapse can start and complete the database migrations. You can use `journalctl -fu matrix-synapse` on the server to get a clue. Waiting a few minutes should also be enough." +msgid "2022-08-23" msgstr "" #: ../../../CHANGELOG.md:1924 -msgid "It should now be safe to start all other services. `ansible-playbook -i inventory/hosts setup.yml --tags=start` will do it for you" +msgid "Postmoogle email bridge support" msgstr "" -#: ../../../CHANGELOG.md:1927 -msgid "2022-04-14" +#: ../../../CHANGELOG.md:1926 +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up the new [Postmoogle](https://github.com/etkecc/postmoogle) email bridge. Postmoogle is like the [Email2Matrix bridge](https://github.com/devture/email2matrix) (also [already supported by the playbook](docs/configuring-playbook-email2matrix.md)), but more capable and with the intention to soon support *sending* emails, not just receiving." msgstr "" -#: ../../../CHANGELOG.md:1929 -msgid "(Compatibility Break) Changes to `docker-src` permissions necessitating manual action" +#: ../../../CHANGELOG.md:1928 +msgid "See our [Setting up Postmoogle email bridging](docs/configuring-playbook-bridge-postmoogle.md) documentation to get started." msgstr "" #: ../../../CHANGELOG.md:1931 -msgid "Users who build container images from source will need to manually correct file permissions of some directories on the server." +msgid "2022-08-10" msgstr "" #: ../../../CHANGELOG.md:1933 -msgid "When self-building, the playbook used to `git clone` repositories (into `/matrix/SERVICE/docker-src`) using the `root` user, but now uses `matrix` instead to work around [the following issue with git 2.35.2](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1749)." +msgid "mautrix-whatsapp default configuration changes" msgstr "" #: ../../../CHANGELOG.md:1935 -msgid "If you're on a non-`amd64` architecture (that is, you're overriding `matrix_architecture` in your `vars.yml` file) or you have enabled self-building for some service (e.g. `matrix_*_self_build: true`), you're certainly building some container images from source and have `docker-src` directories with mixed permissions lying around in various `/matrix/SERVICE` directories." +msgid "In [Pull Request #2012](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2012), we've made some changes to the default configuration used by the `mautrix-whatsapp` bridge." msgstr "" #: ../../../CHANGELOG.md:1937 -msgid "The playbook *could* correct these permissions automatically, but that requires additional Ansible tasks in some ~45 different places — something that takes considerable effort. So we ask users observing errors related to `docker-src` directories to correct the problem manually by **running this command on the Matrix server** (which deletes all `/matrix/*/docker-src` directories): `find /matrix -maxdepth 2 -name 'docker-src' | xargs rm -rf`" +msgid "If you're using this bridge, you should look into this PR and see if the new configuration suits you. If not, you can always change individual preferences in your `vars.yml` file." msgstr "" -#: ../../../CHANGELOG.md:1940 -msgid "2022-03-17" +#: ../../../CHANGELOG.md:1939 +msgid "Most notably, spaces support has been enabled by default. The bridge will now group rooms into a Matrix space. **If you've already bridged to Whatsapp** prior to this update, you will need to send `!wa sync space` to the bridge bot to make it create the space and put your existing rooms into it." msgstr "" #: ../../../CHANGELOG.md:1942 -msgid "(Compatibility Break) ma1sd identity server no longer installed by default" +msgid "2022-08-09" msgstr "" #: ../../../CHANGELOG.md:1944 -msgid "The playbook no longer installs the [ma1sd](https://github.com/ma1uta/ma1sd) identity server by default. The next time you run the playbook, ma1sd will be uninstalled from your server, unless you explicitly enable the ma1sd service (see how below)." +msgid "Conduit support" msgstr "" #: ../../../CHANGELOG.md:1946 -msgid "The main reason we used to install ma1sd by default in the past was to prevent Element clients from talking to the `matrix.org` / `vector.im` identity servers, by forcing it to talk to our own self-hosted (but otherwise useless) identity server instead, thus preventing contact list leaks." +msgid "Thanks to [Charles Wright](https://github.com/cvwright), we now have optional experimental [Conduit](https://conduit.rs) homeserver support for new installations. This comes as a follow-up to the playbook getting [Dendrite support](#dendrite-support) earlier this year." msgstr "" #: ../../../CHANGELOG.md:1948 -msgid "Since Element clients no longer default to using a public identity server if another one is not provided, we can stop installing ma1sd." +msgid "Existing Synapse or Dendrite installations do **not** need to be updated. **Synapse is still the default homeserver implementation** installed by the playbook." msgstr "" #: ../../../CHANGELOG.md:1950 -msgid "If you need to install the ma1sd identity server for some reason, you can explicitly enable it by adding this to your `vars.yml` file:" +msgid "To try out Conduit, we recommend that you **use a new server** and the following `vars.yml` configuration:" msgstr "" -#: ../../../CHANGELOG.md:1957 -msgid "2022-02-12" +#: ../../../CHANGELOG.md:1956 +msgid "**The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse or Dendrite to Conduit) without data loss." msgstr "" #: ../../../CHANGELOG.md:1959 -msgid "matrix_encryption_disabler support" +msgid "2022-07-29" msgstr "" #: ../../../CHANGELOG.md:1961 -msgid "We now support installing the [matrix_encryption_disabler](https://github.com/digitalentity/matrix_encryption_disabler) Synapse module, which lets you prevent End-to-End-Encryption from being enabled by users on your homeserver. The popular opinion is that this is dangerous and shouldn't be done, but there are valid use cases for disabling encryption discussed [here](https://github.com/matrix-org/synapse/issues/4401)." +msgid "mautrix-discord support" msgstr "" #: ../../../CHANGELOG.md:1963 -msgid "To enable this module (and prevent encryption from being used on your homserver), add `matrix_synapse_ext_encryption_disabler_enabled: true` to your configuration. This module provides further customization. Check its other configuration settings (and defaults) in `roles/custom/matrix-synapse/defaults/main.yml`." +msgid "Thanks to [MdotAmaan](https://github.com/MdotAmaan)'s efforts, the playbook now supports bridging to [Discord](https://discordapp.com/) via the [mautrix-discord](https://mau.dev/mautrix/discord) bridge. See our [Setting up Mautrix Discord bridging](docs/configuring-playbook-bridge-mautrix-discord.md) documentation page for getting started." msgstr "" -#: ../../../CHANGELOG.md:1966 -msgid "2022-02-01" +#: ../../../CHANGELOG.md:1965 +msgid "**Note**: this is a new Discord bridge. The playbook still retains Discord bridging via [matrix-appservice-discord](docs/configuring-playbook-bridge-appservice-discord.md) and [mx-puppet-discord](docs/configuring-playbook-bridge-mx-puppet-discord.md). You're free to use the bridge that serves you better, or even all three of them (for different users and use-cases)." msgstr "" #: ../../../CHANGELOG.md:1968 -msgid "matrix-hookshot bridging support" +msgid "2022-07-27" msgstr "" #: ../../../CHANGELOG.md:1970 -msgid "Thanks to [HarHarLinks](https://github.com/HarHarLinks), the playbook can now install the [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) bridge for bridging Matrix to multiple project management services, such as GitHub, GitLab and JIRA. See our [Setting up matrix-hookshot](docs/configuring-playbook-bridge-hookshot.md) documentation to get started." +msgid "matrix-appservice-kakaotalk support" msgstr "" -#: ../../../CHANGELOG.md:1973 -msgid "2022-01-31" +#: ../../../CHANGELOG.md:1972 +msgid "The playbook now supports bridging to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) via [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) — a bridge based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code. Thanks to [hnarjis](https://github.com/hnarjis) for helping us add support for this!" msgstr "" -#: ../../../CHANGELOG.md:1975 -msgid "ARM support for matrix-corporal" +#: ../../../CHANGELOG.md:1974 +msgid "See our [Setting up Appservice Kakaotalk bridging](docs/configuring-playbook-bridge-appservice-kakaotalk.md) documentation to get started." msgstr "" #: ../../../CHANGELOG.md:1977 -msgid "[matrix-corporal](https://github.com/devture/matrix-corporal) (as of version `2.2.3`) is now published to Docker Hub (see [devture/matrix-corporal](https://hub.docker.com/r/devture/matrix-corporal)) as a multi-arch container image with support for all these platforms: `linux/amd64`, `linux/arm64/v8` and `linux/arm/v7`. The playbook no longer resorts to self-building matrix-corporal on these ARM architectures." +msgid "2022-07-20" msgstr "" -#: ../../../CHANGELOG.md:1980 -msgid "2022-01-07" +#: ../../../CHANGELOG.md:1979 +msgid "maubot support" msgstr "" -#: ../../../CHANGELOG.md:1982 -msgid "Dendrite support" +#: ../../../CHANGELOG.md:1981 +msgid "Thanks to [Stuart Mumford (@Cadair)](https://github.com/cadair) for starting ([PR #373](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/373) and [PR #622](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/622)) and to [Julian-Samuel Gebühr (@moan0s)](https://github.com/moan0s) for finishing up (in [PR #1894](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1894)), the playbook can now help you set up [maubot](https://github.com/maubot/maubot) — a plugin-based Matrix bot system." msgstr "" -#: ../../../CHANGELOG.md:1984 -msgid "**TLDR**: We now have optional experimental [Dendrite](https://github.com/matrix-org/dendrite) homeserver support for new installations. **Existing (Synapse) installations need to be updated**, because some internals changed. See [Adapting the configuration for existing Synapse installations](#adapting-the-configuration-for-existing-synapse-installations)." +#: ../../../CHANGELOG.md:1983 +msgid "See our [Setting up maubot](docs/configuring-playbook-bot-maubot.md) documentation to get started." msgstr "" #: ../../../CHANGELOG.md:1986 -msgid "[Jip J. Dekker](https://github.com/Dekker1) did the [initial work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/818) of adding [Dendrite](https://github.com/matrix-org/dendrite) support to the playbook back in January 2021. Lots of work (and time) later, Dendrite support is finally ready for testing." +msgid "2022-07-14" msgstr "" #: ../../../CHANGELOG.md:1988 -msgid "We believe that 2022 will be the year of the non-Synapse Matrix server!" +msgid "mx-puppet-skype removal" msgstr "" #: ../../../CHANGELOG.md:1990 -msgid "The playbook was previously quite [Synapse](https://github.com/element-hq/synapse)-centric, but can now accommodate multiple homeserver implementations. Only one homeserver implementation can be active (installed) at a given time." +msgid "The playbook no longer includes the [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype) bridge, because it has been broken and unmaintained for a long time. Users that have `matrix_mx_puppet_skype_enabled` in their configuration files will encounter an error when running the playbook until they remove references to this bridge from their configuration." msgstr "" #: ../../../CHANGELOG.md:1992 -msgid "**Synapse is still the default homeserver implementation** installed by the playbook. A new variable (`matrix_homeserver_implementation`) controls which server implementation is enabled (`synapse` or `dendrite` at the given moment)." +msgid "To completely clean up your server from `mx-puppet-skype`'s presence on it:" msgstr "" #: ../../../CHANGELOG.md:1994 -msgid "Adapting the configuration for existing Synapse installations" +msgid "ensure your Ansible configuration (`vars.yml` file) no longer contains `matrix_mx_puppet_skype_*` references" +msgstr "" + +#: ../../../CHANGELOG.md:1995 +msgid "stop and disable the systemd service (run `systemctl disable --now matrix-mx-puppet-skype` on the server)" msgstr "" #: ../../../CHANGELOG.md:1996 -msgid "Because the playbook is not so Synapse-centric anymore, a small configuration change is necessary for existing installations to bring them up to date." +msgid "delete the systemd service (run `rm /etc/systemd/system/matrix-mx-puppet-skype.service` on the server)" +msgstr "" + +#: ../../../CHANGELOG.md:1997 +msgid "delete `/matrix/mx-puppet-skype` (run `rm -rf /matrix/mx-puppet-skype` on the server)" msgstr "" #: ../../../CHANGELOG.md:1998 -msgid "The `vars.yml` file for **existing installations will need to be updated** by adding this **additional configuration**:" +msgid "drop the `matrix_mx_puppet_skype` database (run `/usr/local/bin/matrix-postgres-cli` on the server, and execute the `DROP DATABASE matrix_mx_puppet_skype;` query there)" +msgstr "" + +#: ../../../CHANGELOG.md:2000 +msgid "If you still need bridging to [Skype](https://www.skype.com/), consider switching to [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) instead. See [Setting up Go Skype Bridge bridging](docs/configuring-playbook-bridge-go-skype-bridge.md)." +msgstr "" + +#: ../../../CHANGELOG.md:2002 +msgid "If you think this is a mistake and `mx-puppet-skype` works for you (or you get it to work somehow), let us know and we may reconsider this removal." +msgstr "" + +#: ../../../CHANGELOG.md:2004 +msgid "signald (0.19.0+) upgrade requires data migration" +msgstr "" + +#: ../../../CHANGELOG.md:2006 +msgid "In [Pull Request #1921](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1921) we upgraded [signald](https://signald.org/) (used by the mautrix-signal bridge) from `v0.18.5` to `v0.20.0`." +msgstr "" + +#: ../../../CHANGELOG.md:2008 +msgid "Back in the [`v0.19.0` released of signald](https://gitlab.com/signald/signald/-/blob/main/releases/0.19.0.md) (which we skipped and migrated straight to `v0.20.0`), a new `--migrate-data` command had been added that migrates avatars, group images, attachments, etc., into the database (those were previously stored in the filesystem)." msgstr "" #: ../../../CHANGELOG.md:2010 -msgid "Trying out Dendrite" +msgid "If you've been using the mautrix-signal bridge for a while, you may have files stored in the local filesystem, which will need to be upgraded." msgstr "" #: ../../../CHANGELOG.md:2012 -msgid "Finally, **to try out Dendrite**, we recommend that you **use a new server** and the following addition to your `vars.yml` configuration:" +msgid "We attempt to do this data migration automatically every time Signald starts (`matrix-mautrix-signal-daemon.service`) using a `ExecStartPre` systemd unit definition." msgstr "" -#: ../../../CHANGELOG.md:2018 -msgid "**The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse to Dendrite) without data loss." +#: ../../../CHANGELOG.md:2014 +msgid "Keep an eye on your Signal bridge and let us know (in our [support room](README.md#support) or in [Pull Request #1921](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1921)) if you experience any trouble!" msgstr "" -#: ../../../CHANGELOG.md:2020 -msgid "We're excited to gain support for other homeserver implementations, like [Conduit](https://conduit.rs/), etc!" +#: ../../../CHANGELOG.md:2017 +msgid "2022-07-05" msgstr "" -#: ../../../CHANGELOG.md:2022 -msgid "Honoroit bot support" +#: ../../../CHANGELOG.md:2019 +msgid "Ntfy push notifications support" msgstr "" -#: ../../../CHANGELOG.md:2024 -msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now help you set up [Honoroit](https://github.com/etkecc/honoroit) — a helpdesk bot." +#: ../../../CHANGELOG.md:2021 +msgid "Thanks to [Julian Foad](https://matrix.to/#/@julian:foad.me.uk), the playbook can now install a [ntfy](https://ntfy.sh/) push notifications server for you." +msgstr "" + +#: ../../../CHANGELOG.md:2023 +msgid "See our [Setting up the ntfy push notifications server](docs/configuring-playbook-ntfy.md) documentation to get started." msgstr "" #: ../../../CHANGELOG.md:2026 -msgid "See our [Setting up Honoroit](docs/configuring-playbook-bot-honoroit.md) documentation to get started." +msgid "2022-06-23" msgstr "" -#: ../../../CHANGELOG.md:2029 -msgid "2022-01-06" +#: ../../../CHANGELOG.md:2028 +msgid "(Potential Backward Compatibility Break) Changes around metrics collection" msgstr "" -#: ../../../CHANGELOG.md:2031 -msgid "Cinny support" +#: ../../../CHANGELOG.md:2030 +msgid "**TLDR**: we've made extensive **changes to metrics exposure/collection, which concern people using an external Prometheus server**. If you don't know what that is, you don't need to read below." msgstr "" -#: ../../../CHANGELOG.md:2033 -msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook now supports [Cinny](https://cinny.in/) — a new simple, elegant and secure Matrix client." +#: ../../../CHANGELOG.md:2032 +msgid "**Why do major changes to metrics**? Because various services were exposing metrics in different, hacky, ways. Synapse was exposing metrics at `/_synapse/metrics` and `/_synapse-worker-…/metrics` on the `matrix.example.com`. The Hookshot role was **repurposing** the Granana web UI domain (`stats.example.com`) for exposing its metrics on `stats.example.com/hookshot/metrics`, while protecting these routes using Basic Authentication **normally used for Synapse** (`/_synapse/metrics`). Node-exporter and Postgres-exporter roles were advising for more `stats.example.com` usage in manual ways. Each role was doing things differently and mixing variables from other roles. Each metrics endpoint was ending up in a different place, protected by who knows what Basic Authentication credentials (if protected at all)." msgstr "" -#: ../../../CHANGELOG.md:2035 -msgid "By default, we still install Element Web. Still, people who'd like to try Cinny out can now install it via the playbook." +#: ../../../CHANGELOG.md:2034 +msgid "**The solution**: a completely revamped way to expose metrics to an external Prometheus server. We are **introducing new `https://matrix.example.com/metrics/*` endpoints**, where various services *can* expose their metrics, for collection by external Prometheus servers. To enable the `/metrics/*` endpoints, use `matrix_nginx_proxy_proxy_matrix_metrics_enabled: true`. There's also a way to protect access using [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). See the `matrix-nginx-proxy` role or our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation for additional variables around `matrix_nginx_proxy_proxy_matrix_metrics_enabled`." +msgstr "" + +#: ../../../CHANGELOG.md:2036 +msgid "**If you are using the [Hookshot bridge](docs/configuring-playbook-bridge-hookshot.md)**, you may find that:" msgstr "" #: ../../../CHANGELOG.md:2037 -msgid "Additional details are available in [Setting up Cinny](docs/configuring-playbook-client-cinny.md)." +msgid "**Metrics may not be enabled by default anymore**:" +msgstr "" + +#: ../../../CHANGELOG.md:2038 +msgid "If Prometheus is enabled (`prometheus_enabled: true`), then Hookshot metrics will be enabled automatically (`matrix_hookshot_metrics_enabled: true`). These metrics will be collected from the local (in-container) Prometheus over the container network." +msgstr "" + +#: ../../../CHANGELOG.md:2039 +msgid "**If Prometheus is not enabled** (you are either not using Prometheus or are using an external one), **Hookshot metrics will not be enabled by default anymore**. Feel free to enable them by setting `matrix_hookshot_metrics_enabled: true`. Also, see below." msgstr "" #: ../../../CHANGELOG.md:2040 -msgid "2021-12-22" +msgid "When metrics are meant to be **consumed by an external Prometheus server**, `matrix_hookshot_metrics_proxying_enabled` needs to be set to `true`, so that metrics would be exposed (proxied) \"publicly\" on `https://matrix.example.com/metrics/hookshot`. To make use of this, you'll also need to enable the new `https://matrix.example.com/metrics/*` endpoints mentioned above, using `matrix_nginx_proxy_proxy_matrix_metrics_enabled`. Learn more in our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation." msgstr "" -#: ../../../CHANGELOG.md:2042 -msgid "Twitter bridging support via mautrix-twitter" +#: ../../../CHANGELOG.md:2041 +msgid "**We've changed the URL we're exposing Hookshot metrics at** for external Prometheus servers. Until now, you were advised to consume Hookshot metrics from `https://stats.example.com/hookshot/metrics` (working in conjunction with `matrix_nginx_proxy_proxy_synapse_metrics`). From now on, **this no longer works**. As described above, you need to start consuming metrics from `https://matrix.example.com/metrics/hookshot`." msgstr "" -#: ../../../CHANGELOG.md:2044 -msgid "Thanks to [Matthew Cengia](https://github.com/mattcen) and [Shreyas Ajjarapu](https://github.com/shreyasajj), besides [mx-puppet-twitter](docs/configuring-playbook-bridge-mx-puppet-twitter.md), bridging to [Twitter](https://twitter.com/) can now also happen with [mautrix-twitter](docs/configuring-playbook-bridge-mautrix-twitter.md)." +#: ../../../CHANGELOG.md:2043 +msgid "**If you're using node-exporter** (`matrix_prometheus_node_exporter_enabled: true`) and would like to collect its metrics from an external Prometheus server, see `matrix_prometheus_node_exporter_metrics_proxying_enabled` described in our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation. You will be able to collect its metrics from `https://matrix.example.com/metrics/node-exporter`." +msgstr "" + +#: ../../../CHANGELOG.md:2045 +msgid "**If you're using [postgres-exporter](docs/configuring-playbook-prometheus-grafana.md#enable-metrics-and-graphs-for-postgres-optional)** (`prometheus_postgres_exporter_enabled: true`) and would like to collect its metrics from an external Prometheus server, see `matrix_prometheus_services_proxy_connect_prometheus_postgres_exporter_metrics_proxying_enabled` described in our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation. You will be able to collect its metrics from `https://matrix.example.com/metrics/postgres-exporter`." msgstr "" #: ../../../CHANGELOG.md:2047 -msgid "2021-12-14" +msgid "**If you're using Synapse** and would like to collect its metrics from an external Prometheus server, you may find that:" msgstr "" #: ../../../CHANGELOG.md:2049 -msgid "(Security) Users of the Signal bridge may wish to upgrade it to work around log4j vulnerability" +msgid "Exposing metrics is now done using `matrix_synapse_metrics_proxying_enabled`, not `matrix_nginx_proxy_proxy_synapse_metrics: true`. You may still need to enable metrics using `matrix_synapse_metrics_enabled: true` before exposing them." +msgstr "" + +#: ../../../CHANGELOG.md:2050 +msgid "Protecting metrics endpoints using [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) is now done in another way. See our [Collecting metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) documentation" msgstr "" #: ../../../CHANGELOG.md:2051 -msgid "Recently, a security vulnerability affecting the Java logging package `log4j` [has been discovered](https://www.huntress.com/blog/rapid-response-critical-rce-vulnerability-is-affecting-java). Software that uses this Java package is potentially vulnerable." +msgid "If Synapse metrics are exposed, they will be made available at `https://matrix.example.com/metrics/synapse/main-process` or `https://matrix.example.com/metrics/synapse/worker/TYPE-ID` (when workers are enabled), not at `https://matrix.example.com/_synapse/metrics` and `https://matrix.example.com/_synapse-worker-…/metrics`" msgstr "" -#: ../../../CHANGELOG.md:2053 -msgid "One such piece of software that is part of the playbook is the [mautrix-signal bridge](./docs/configuring-playbook-bridge-mautrix-signal.md), which [has been patched already](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1452). If you're running this bridge, you may wish to [upgrade](./docs/maintenance-upgrading-services.md)." +#: ../../../CHANGELOG.md:2052 +msgid "The playbook still generates an `external_prometheus.yml.example` sample file for scraping Synapse from Prometheus as described in [Collecting Synapse worker metrics to an external Prometheus server](docs/configuring-playbook-prometheus-grafana.md#collecting-synapse-worker-metrics-to-an-external-prometheus-server), but it's now saved under `/matrix/synapse` (not `/matrix`)." +msgstr "" + +#: ../../../CHANGELOG.md:2054 +msgid "**If you where already using a external Prometheus server** before this change, and you gave a hashed version of the password as a variable, the playbook will now take care of hashing the password for you. Thus, you need to provide the non-hashed version now." msgstr "" #: ../../../CHANGELOG.md:2056 -msgid "2021-11-11" +msgid "2022-06-13" msgstr "" #: ../../../CHANGELOG.md:2058 -msgid "Dropped support for Postgres v9.6" +msgid "go-skype-bridge bridging support" msgstr "" #: ../../../CHANGELOG.md:2060 -msgid "Postgres v9.6 reached its end of life today, so the playbook will refuse to run for you if you're still on that version." +msgid "Thanks to [CyberShadow](https://github.com/CyberShadow), the playbook can now install the [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) bridge for bridging Matrix to [Skype](https://www.skype.com/)." msgstr "" #: ../../../CHANGELOG.md:2062 -msgid "Synapse still supports v9.6 (for now), but we're retiring support for it early, to avoid having to maintain support for so many Postgres versions. Users that are still on Postgres v9.6 can easily [upgrade Postgres](docs/maintenance-postgres.md#upgrading-postgresql) via the playbook." +msgid "See our [Setting up Go Skype Bridge bridging](docs/configuring-playbook-bridge-go-skype-bridge.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:2065 -msgid "2021-10-23" +#: ../../../CHANGELOG.md:2064 +msgid "The playbook has supported [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype) bridging (see [Setting up MX Puppet Skype bridging](docs/configuring-playbook-bridge-mx-puppet-skype.md)) since [2020-04-09](#2020-04-09), but `mx-puppet-skype` is reportedly broken." msgstr "" #: ../../../CHANGELOG.md:2067 -msgid "Hangouts bridge no longer updated, superseded by a Googlechat bridge" +msgid "2022-06-09" msgstr "" #: ../../../CHANGELOG.md:2069 -msgid "The mautrix-hangouts bridge is no longer receiving updates upstream and is likely to stop working in the future. We still retain support for this bridge in the playbook, but you're encouraged to switch away from it." +msgid "Running Ansible in a container can now happen on the Matrix server itself" msgstr "" #: ../../../CHANGELOG.md:2071 -msgid "There's a new [mautrix-googlechat](https://github.com/mautrix/googlechat) bridge that you can [install using the playbook](docs/configuring-playbook-bridge-mautrix-googlechat.md). Your **Hangouts bridge data will not be migrated**, however. You need to start fresh with the new bridge." +msgid "If you're tired of being on an old and problematic Ansible version, you can now run [run Ansible in a container on the Matrix server itself](docs/ansible.md#running-ansible-in-a-container-on-the-matrix-server-itself)." msgstr "" #: ../../../CHANGELOG.md:2074 -msgid "2021-08-23" +msgid "2022-05-31" msgstr "" #: ../../../CHANGELOG.md:2076 -msgid "LinkedIn bridging support via beeper-linkedin" +msgid "Synapse v1.60 upgrade may cause trouble and require manual intervention" msgstr "" #: ../../../CHANGELOG.md:2078 -msgid "Thanks to [Alexandar Mechev](https://github.com/apmechev), the playbook can now install the [beeper-linkedin](https://gitlab.com/beeper/linkedin) bridge for bridging to [LinkedIn](https://www.linkedin.com/) Messaging." +msgid "Synapse v1.60 will try to add a new unique index to `state_group_edges` upon startup and could fail if your database is corrupted." msgstr "" #: ../../../CHANGELOG.md:2080 -msgid "This brings the total number of bridges supported by the playbook up to 20. See all supported bridges [here](docs/configuring-playbook.md#bridging-other-networks)." +msgid "We haven't observed this problem yet, but [the Synapse v1.60.0 upgrade notes](https://github.com/element-hq/synapse/blob/v1.60.0/docs/upgrade.md#adding-a-new-unique-index-to-state_group_edges-could-fail-if-your-database-is-corrupted) mention it, so we're giving you a heads up here in case you're unlucky." msgstr "" #: ../../../CHANGELOG.md:2082 -msgid "To get started with bridging to LinkedIn, see [Setting up Beeper LinkedIn bridging](docs/configuring-playbook-bridge-beeper-linkedin.md)." +msgid "**If Synapse fails to start** after your next playbook run, you'll need to:" +msgstr "" + +#: ../../../CHANGELOG.md:2084 +msgid "SSH into the Matrix server" msgstr "" #: ../../../CHANGELOG.md:2085 -msgid "2021-08-20" +msgid "launch `/usr/local/bin/matrix-postgres-cli`" +msgstr "" + +#: ../../../CHANGELOG.md:2086 +msgid "switch to the `synapse` database: `\\c synapse`" msgstr "" #: ../../../CHANGELOG.md:2087 -msgid "Sygnal upgraded — ARM support and no longer requires a database" -msgstr "" - -#: ../../../CHANGELOG.md:2089 -msgid "The [Sygnal](docs/configuring-playbook-sygnal.md) push gateway has been upgraded from `v0.9.0` to `v0.10.1`." -msgstr "" - -#: ../../../CHANGELOG.md:2091 -msgid "This is an optional component for the playbook, so most of our users wouldn't care about this announcement." -msgstr "" - -#: ../../../CHANGELOG.md:2093 -msgid "Since this feels like a relatively big (and untested, as of yet) Sygnal change, we're putting up this changelog entry." -msgstr "" - -#: ../../../CHANGELOG.md:2095 -msgid "The new version is also available for the ARM architecture. It also no longer requires a database anymore. If you need to downgrade to the previous version, changing `matrix_sygnal_version` or `matrix_sygnal_docker_image` will not be enough, as we've removed the `database` configuration completely. You'd need to switch to an earlier playbook commit." -msgstr "" - -#: ../../../CHANGELOG.md:2098 -msgid "2021-05-21" -msgstr "" - -#: ../../../CHANGELOG.md:2100 -msgid "Hydrogen support" -msgstr "" - -#: ../../../CHANGELOG.md:2102 -msgid "Thanks to [Aaron Raimist](https://github.com/aaronraimist), the playbook now supports [Hydrogen](https://github.com/vector-im/hydrogen-web) — a new lightweight Matrix client with legacy and mobile browser support." -msgstr "" - -#: ../../../CHANGELOG.md:2104 -msgid "By default, we still install Element Web, as Hydrogen is still not fully-featured. Still, people who'd like to try Hydrogen out can now install it via the playbook." +msgid "run the following SQL query:" msgstr "" #: ../../../CHANGELOG.md:2106 -msgid "Additional details are available in [Setting up Hydrogen](docs/configuring-playbook-client-hydrogen.md)." +msgid "You could then restart services: `ansible-playbook -i inventory/hosts setup.yml --tags=start`" msgstr "" #: ../../../CHANGELOG.md:2109 -msgid "2021-05-19" +msgid "2022-04-25" msgstr "" #: ../../../CHANGELOG.md:2111 -msgid "Heisenbridge support" +msgid "Buscarron bot support" msgstr "" #: ../../../CHANGELOG.md:2113 -msgid "Thanks to [Toni Spets (hifi)](https://github.com/hifi), the playbook now supports bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) using yet another bridge (besides matrix-appservice-irc), called [Heisenbridge](https://github.com/hifi/heisenbridge)." +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [the Buscarron bot](https://github.com/etkecc/buscarron). It's a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room" msgstr "" #: ../../../CHANGELOG.md:2115 -msgid "Additional details are available in [Setting up Heisenbridge bouncer-style IRC bridging](docs/configuring-playbook-bridge-heisenbridge.md)." +msgid "See our [Setting up Buscarron](docs/configuring-playbook-bot-buscarron.md) documentation to get started." msgstr "" #: ../../../CHANGELOG.md:2118 -msgid "2021-04-16" +msgid "2022-04-21" msgstr "" #: ../../../CHANGELOG.md:2120 -msgid "Disabling TLSv1 and TLSv1.1 for coturn" +msgid "matrix-registration-bot support" msgstr "" #: ../../../CHANGELOG.md:2122 -msgid "To improve security, we've [removed TLSv1 and TLSv1.1 support](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/999) from our default [coturn](https://github.com/coturn/coturn) configuration." +msgid "Thanks to [Julian-Samuel Gebühr (@moan0s)](https://github.com/moan0s), the playbook can now help you set up [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) — a bot that is used to create and manage registration tokens for a Matrix server." msgstr "" #: ../../../CHANGELOG.md:2124 -msgid "If you need to support old clients, you can re-enable both (or whichever one you need) with the following configuration:" +msgid "See our [Setting up matrix-registration-bot](docs/configuring-playbook-bot-matrix-registration-bot.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:2132 -msgid "2021-04-05" +#: ../../../CHANGELOG.md:2127 +msgid "2022-04-19" msgstr "" -#: ../../../CHANGELOG.md:2134 -msgid "Automated local Postgres backup support" +#: ../../../CHANGELOG.md:2129 +msgid "BorgBackup support" msgstr "" -#: ../../../CHANGELOG.md:2136 -msgid "Thanks to [foxcris](https://github.com/foxcris), the playbook can now make automated local Postgres backups on a fixed schedule using [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local)." +#: ../../../CHANGELOG.md:2131 +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [Borg](https://www.borgbackup.org/) backups with [borgmatic](https://torsion.org/borgmatic/) of your Matrix server." msgstr "" -#: ../../../CHANGELOG.md:2138 -msgid "Additional details are available in [Setting up postgres backup](docs/configuring-playbook-postgres-backup.md)." +#: ../../../CHANGELOG.md:2133 +msgid "See our [Setting up BorgBackup](docs/configuring-playbook-backup-borg.md) documentation to get started." +msgstr "" + +#: ../../../CHANGELOG.md:2135 +msgid "(Compatibility Break) Upgrading to Synapse v1.57 on setups using workers may require manual action" +msgstr "" + +#: ../../../CHANGELOG.md:2137 +msgid "If you're running a worker setup for Synapse (`matrix_synapse_workers_enabled: true`), the [Synapse v1.57 upgrade notes](https://github.com/element-hq/synapse/blob/v1.57.0rc1/docs/upgrade.md#changes-to-database-schema-for-application-services) say that you may need to take special care when upgrading:" +msgstr "" + +#: ../../../CHANGELOG.md:2139 +msgid "Synapse v1.57.0 includes a change to the way transaction IDs are managed for application services. If your deployment uses a dedicated worker for application service traffic, **it must be stopped** when the database is upgraded (which normally happens when the main process is upgraded), to ensure the change is made safely without any risk of reusing transaction IDs." msgstr "" #: ../../../CHANGELOG.md:2141 -msgid "2021-04-03" +msgid "If you're not running an `appservice` worker (`matrix_synapse_workers_preset: little-federation-helper` or `matrix_synapse_workers_appservice_workers_count: 0`), you are probably safe to upgrade as per normal, without taking any special care." msgstr "" #: ../../../CHANGELOG.md:2143 -msgid "Mjolnir moderation tool (bot) support" +msgid "If you are running a setup with an `appservice` worker, or otherwise want to be on the safe side, we recommend the following upgrade path:" msgstr "" #: ../../../CHANGELOG.md:2145 -msgid "Thanks to [Aaron Raimist](https://github.com/aaronraimist), the playbook can now install and configure the [Mjolnir](https://github.com/matrix-org/mjolnir) moderation tool (bot)." +msgid "Pull the latest playbook changes" +msgstr "" + +#: ../../../CHANGELOG.md:2146 +msgid "Stop all services (`ansible-playbook -i inventory/hosts setup.yml --tags=stop`)" msgstr "" #: ../../../CHANGELOG.md:2147 -msgid "Additional details are available in [Setting up Mjolnir](docs/configuring-playbook-bot-mjolnir.md)." +msgid "Re-run the playbook (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-all`)" +msgstr "" + +#: ../../../CHANGELOG.md:2148 +msgid "Start Postgres (`systemctl start matrix-postgres` on the server)" +msgstr "" + +#: ../../../CHANGELOG.md:2149 +msgid "Start the main Synapse process (`systemctl start matrix-synapse` on the server)" msgstr "" #: ../../../CHANGELOG.md:2150 -msgid "2021-03-20" +msgid "Wait a while so that Synapse can start and complete the database migrations. You can use `journalctl -fu matrix-synapse` on the server to get a clue. Waiting a few minutes should also be enough." msgstr "" -#: ../../../CHANGELOG.md:2152 -msgid "Sygnal push gateway support" +#: ../../../CHANGELOG.md:2151 +msgid "It should now be safe to start all other services. `ansible-playbook -i inventory/hosts setup.yml --tags=start` will do it for you" msgstr "" #: ../../../CHANGELOG.md:2154 -msgid "The playbook can now install the [Sygnal](https://github.com/matrix-org/sygnal) push gateway for you." +msgid "2022-04-14" msgstr "" #: ../../../CHANGELOG.md:2156 -msgid "This is only useful to people who develop/build their own Matrix client applications." +msgid "(Compatibility Break) Changes to `docker-src` permissions necessitating manual action" msgstr "" #: ../../../CHANGELOG.md:2158 -msgid "Additional details are available in our [Setting up the Sygnal push gateway](docs/configuring-playbook-sygnal.md) docs." +msgid "Users who build container images from source will need to manually correct file permissions of some directories on the server." msgstr "" -#: ../../../CHANGELOG.md:2161 -msgid "2021-03-16" +#: ../../../CHANGELOG.md:2160 +msgid "When self-building, the playbook used to `git clone` repositories (into `/matrix/SERVICE/docker-src`) using the `root` user, but now uses `matrix` instead to work around [the following issue with git 2.35.2](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1749)." msgstr "" -#: ../../../CHANGELOG.md:2163 -msgid "Go-NEB support" +#: ../../../CHANGELOG.md:2162 +msgid "If you're on a non-`amd64` architecture (that is, you're overriding `matrix_architecture` in your `vars.yml` file) or you have enabled self-building for some service (e.g. `matrix_*_self_build: true`), you're certainly building some container images from source and have `docker-src` directories with mixed permissions lying around in various `/matrix/SERVICE` directories." msgstr "" -#: ../../../CHANGELOG.md:2165 -msgid "Thanks to [Zir0h](https://github.com/Zir0h), the playbook can now install and configure the [Go-NEB](https://github.com/matrix-org/go-neb) bot." +#: ../../../CHANGELOG.md:2164 +msgid "The playbook *could* correct these permissions automatically, but that requires additional Ansible tasks in some ~45 different places — something that takes considerable effort. So we ask users observing errors related to `docker-src` directories to correct the problem manually by **running this command on the Matrix server** (which deletes all `/matrix/*/docker-src` directories): `find /matrix -maxdepth 2 -name 'docker-src' | xargs rm -rf`" msgstr "" #: ../../../CHANGELOG.md:2167 -msgid "Additional details are available in [Setting up Go-NEB](docs/configuring-playbook-bot-go-neb.md)." +msgid "2022-03-17" msgstr "" -#: ../../../CHANGELOG.md:2170 -msgid "2021-02-19" +#: ../../../CHANGELOG.md:2169 +msgid "(Compatibility Break) ma1sd identity server no longer installed by default" msgstr "" -#: ../../../CHANGELOG.md:2172 -msgid "GroupMe bridging support via mx-puppet-groupme" +#: ../../../CHANGELOG.md:2171 +msgid "The playbook no longer installs the [ma1sd](https://github.com/ma1uta/ma1sd) identity server by default. The next time you run the playbook, ma1sd will be uninstalled from your server, unless you explicitly enable the ma1sd service (see how below)." msgstr "" -#: ../../../CHANGELOG.md:2174 -msgid "Thanks to [Cody Neiman](https://github.com/xangelix), the playbook can now install the [mx-puppet-groupme](https://gitlab.com/robintown/mx-puppet-groupme) bridge for bridging to [GroupMe](https://groupme.com)." +#: ../../../CHANGELOG.md:2173 +msgid "The main reason we used to install ma1sd by default in the past was to prevent Element clients from talking to the `matrix.org` / `vector.im` identity servers, by forcing it to talk to our own self-hosted (but otherwise useless) identity server instead, thus preventing contact list leaks." msgstr "" -#: ../../../CHANGELOG.md:2176 -msgid "This brings the total number of bridges supported by the playbook up to 18. See all supported bridges [here](docs/configuring-playbook.md#bridging-other-networks)." +#: ../../../CHANGELOG.md:2175 +msgid "Since Element clients no longer default to using a public identity server if another one is not provided, we can stop installing ma1sd." msgstr "" -#: ../../../CHANGELOG.md:2178 -msgid "To get started, follow our [Setting up MX Puppet GroupMe](docs/configuring-playbook-bridge-mx-puppet-groupme.md) docs." -msgstr "" - -#: ../../../CHANGELOG.md:2180 -msgid "Mautrix Instagram bridging support" -msgstr "" - -#: ../../../CHANGELOG.md:2182 -msgid "The playbook now supports bridging with [Instagram](https://www.instagram.com/) by installing the [mautrix-instagram](https://github.com/tulir/mautrix-instagram) bridge. This playbook functionality is available thanks to [@MarcProe](https://github.com/MarcProe)." +#: ../../../CHANGELOG.md:2177 +msgid "If you need to install the ma1sd identity server for some reason, you can explicitly enable it by adding this to your `vars.yml` file:" msgstr "" #: ../../../CHANGELOG.md:2184 -msgid "Additional details are available in [Setting up Mautrix Instagram bridging](docs/configuring-playbook-bridge-mautrix-instagram.md)." +msgid "2022-02-12" msgstr "" #: ../../../CHANGELOG.md:2186 -msgid "Synapse workers support" +msgid "matrix_encryption_disabler support" msgstr "" #: ../../../CHANGELOG.md:2188 -msgid "After [lots and lots of work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/456) (done over many months by [Marcel Partap](https://github.com/eMPee584), [Max Klenk](https://github.com/maxklenk), a few others from the [Technical University of Dresden, Germany](https://tu-dresden.de/) and various other contributors), support for Synapse workers has finally landed." +msgid "We now support installing the [matrix_encryption_disabler](https://github.com/digitalentity/matrix_encryption_disabler) Synapse module, which lets you prevent End-to-End-Encryption from being enabled by users on your homeserver. The popular opinion is that this is dangerous and shouldn't be done, but there are valid use cases for disabling encryption discussed [here](https://github.com/matrix-org/synapse/issues/4401)." msgstr "" #: ../../../CHANGELOG.md:2190 -msgid "Having support for workers makes the playbook suitable for larger homeserver deployments." +msgid "To enable this module (and prevent encryption from being used on your homserver), add `matrix_synapse_ext_encryption_disabler_enabled: true` to your configuration. This module provides further customization. Check its other configuration settings (and defaults) in `roles/custom/matrix-synapse/defaults/main.yml`." msgstr "" -#: ../../../CHANGELOG.md:2192 -msgid "Our setup is not yet perfect (we don't support all types of workers; scaling some of them (like `pusher`, `federation_sender`) beyond a single instance is not yet supported). Still, it's a great start and can already power homeservers with thousands of users, like the [Matrix deployment at TU Dresden](https://doc.matrix.tu-dresden.de/en/) discussed in [Matrix Live S06E09 — TU Dresden on their Matrix deployment](https://www.youtube.com/watch?v=UHJX2pmT2gk)." +#: ../../../CHANGELOG.md:2193 +msgid "2022-02-01" msgstr "" -#: ../../../CHANGELOG.md:2194 -msgid "By default, workers are disabled and Synapse runs as a single process (homeservers don't necessarily need the complexity and increased memory requirements of running a worker-based setup)." +#: ../../../CHANGELOG.md:2195 +msgid "matrix-hookshot bridging support" msgstr "" -#: ../../../CHANGELOG.md:2196 -msgid "To enable Synapse workers, follow our [Load balancing with workers](docs/configuring-playbook-synapse.md#load-balancing-with-workers) documentation." +#: ../../../CHANGELOG.md:2197 +msgid "Thanks to [HarHarLinks](https://github.com/HarHarLinks), the playbook can now install the [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) bridge for bridging Matrix to multiple project management services, such as GitHub, GitLab and JIRA. See our [Setting up matrix-hookshot](docs/configuring-playbook-bridge-hookshot.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:2199 -msgid "2021-02-12" +#: ../../../CHANGELOG.md:2200 +msgid "2022-01-31" msgstr "" -#: ../../../CHANGELOG.md:2201 -msgid "(Potential Breaking Change) Monitoring/metrics support using Prometheus and Grafana" +#: ../../../CHANGELOG.md:2202 +msgid "ARM support for matrix-corporal" msgstr "" -#: ../../../CHANGELOG.md:2203 -msgid "Thanks to [@Peetz0r](https://github.com/Peetz0r), the playbook can now install a bunch of tools for monitoring your Matrix server: the [Prometheus](https://prometheus.io) time-series database server, the Prometheus [node-exporter](https://prometheus.io/docs/guides/node-exporter/) host metrics exporter, and the [Grafana](https://grafana.com/) web UI." -msgstr "" - -#: ../../../CHANGELOG.md:2205 -msgid "To get get these installed, follow our [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](docs/configuring-playbook-prometheus-grafana.md) docs page." +#: ../../../CHANGELOG.md:2204 +msgid "[matrix-corporal](https://github.com/devture/matrix-corporal) (as of version `2.2.3`) is now published to Docker Hub (see [devture/matrix-corporal](https://hub.docker.com/r/devture/matrix-corporal)) as a multi-arch container image with support for all these platforms: `linux/amd64`, `linux/arm64/v8` and `linux/arm/v7`. The playbook no longer resorts to self-building matrix-corporal on these ARM architectures." msgstr "" #: ../../../CHANGELOG.md:2207 -msgid "This update comes with a **potential breaking change** for people who were already exposing Synapse metrics (for consumption via another Prometheus installation). From now on, `matrix_synapse_metrics_enabled: true` no longer exposes metrics publicly via matrix-nginx-proxy (at `https://matrix.example.com/_synapse/metrics`). To do so, you'd need to explicitly set `matrix_nginx_proxy_proxy_synapse_metrics: true`." +msgid "2022-01-07" msgstr "" -#: ../../../CHANGELOG.md:2210 -msgid "2021-01-31" +#: ../../../CHANGELOG.md:2209 +msgid "Dendrite support" msgstr "" -#: ../../../CHANGELOG.md:2212 -msgid "Etherpad support" +#: ../../../CHANGELOG.md:2211 +msgid "**TLDR**: We now have optional experimental [Dendrite](https://github.com/matrix-org/dendrite) homeserver support for new installations. **Existing (Synapse) installations need to be updated**, because some internals changed. See [Adapting the configuration for existing Synapse installations](#adapting-the-configuration-for-existing-synapse-installations)." msgstr "" -#: ../../../CHANGELOG.md:2214 -msgid "Thanks to [@pushytoxin](https://github.com/pushytoxin), the playbook can now install the [Etherpad](https://etherpad.org) realtime collaborative text editor. It can be used in a [Jitsi](https://jitsi.org/) audio/video call or integrated as a widget into Matrix chat rooms via the [Dimension](https://dimension.t2bot.io) integration manager." +#: ../../../CHANGELOG.md:2213 +msgid "[Jip J. Dekker](https://github.com/Dekker1) did the [initial work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/818) of adding [Dendrite](https://github.com/matrix-org/dendrite) support to the playbook back in January 2021. Lots of work (and time) later, Dendrite support is finally ready for testing." msgstr "" -#: ../../../CHANGELOG.md:2216 -msgid "To get it installed, follow [our Etherpad docs page](docs/configuring-playbook-etherpad.md)." +#: ../../../CHANGELOG.md:2215 +msgid "We believe that 2022 will be the year of the non-Synapse Matrix server!" +msgstr "" + +#: ../../../CHANGELOG.md:2217 +msgid "The playbook was previously quite [Synapse](https://github.com/element-hq/synapse)-centric, but can now accommodate multiple homeserver implementations. Only one homeserver implementation can be active (installed) at a given time." msgstr "" #: ../../../CHANGELOG.md:2219 -msgid "2021-01-22" +msgid "**Synapse is still the default homeserver implementation** installed by the playbook. A new variable (`matrix_homeserver_implementation`) controls which server implementation is enabled (`synapse` or `dendrite` at the given moment)." msgstr "" #: ../../../CHANGELOG.md:2221 -msgid "(Breaking Change) Postgres changes that require manual intervention" +msgid "Adapting the configuration for existing Synapse installations" msgstr "" #: ../../../CHANGELOG.md:2223 -msgid "We've made a lot of changes to our Postgres setup and some manual action is required (described below). Sorry about the hassle." +msgid "Because the playbook is not so Synapse-centric anymore, a small configuration change is necessary for existing installations to bring them up to date." msgstr "" #: ../../../CHANGELOG.md:2225 -msgid "**TLDR**: people running an [external Postgres server](docs/configuring-playbook-external-postgres.md) don't need to change anything for now. Everyone else (the common/default case) is affected and manual intervention is required." +msgid "The `vars.yml` file for **existing installations will need to be updated** by adding this **additional configuration**:" msgstr "" -#: ../../../CHANGELOG.md:2227 -msgid "Why?" +#: ../../../CHANGELOG.md:2237 +msgid "Trying out Dendrite" msgstr "" -#: ../../../CHANGELOG.md:2229 -msgid "we had a default Postgres password (`matrix_postgres_connection_password: synapse-password`), which we think is **not ideal for security anymore**. We now ask you to generate/provide a strong password yourself. Postgres is normally not exposed outside the container network, making it relatively secure, but still:" -msgstr "" - -#: ../../../CHANGELOG.md:2230 -msgid "by tweaking the configuration, you may end up intentionally or unintentionally exposing your Postgres server to the local network (or even publicly), while still using the default default credentials (`synapse` + `synapse-password`)" -msgstr "" - -#: ../../../CHANGELOG.md:2231 -msgid "we can't be sure we trust all these services (bridges, etc). Some of them may try to talk to or attack `matrix-postgres` using the default credentials (`synapse` + `synapse-password`)" -msgstr "" - -#: ../../../CHANGELOG.md:2232 -msgid "you may have other containers running on the same Docker network, which may try to talk to or attack `matrix-postgres` using the default credentials (`synapse` + `synapse-password`)" -msgstr "" - -#: ../../../CHANGELOG.md:2233 -msgid "our Postgres usage **was overly-focused on Synapse** (default username of `synapse` and default/main database of `homeserver`). Additional homeserver options are likely coming in the future ([Dendrite](https://matrix.org/docs/projects/server/dendrite), [Conduit](https://matrix.org/docs/projects/server/conduit), [The Construct](https://matrix.org/docs/projects/server/construct)), so being too focused on `matrix-synapse` is not great. From now on, Synapse is just another component of this playbook, which happens to have an *additional database* (called `synapse`) on the Postgres server." -msgstr "" - -#: ../../../CHANGELOG.md:2234 -msgid "we try to reorganize things a bit, to make the playbook even friendlier to people running an [external Postgres server](docs/configuring-playbook-external-postgres.md). Work on this will proceed in the future." -msgstr "" - -#: ../../../CHANGELOG.md:2236 -msgid "So, this is some **effort to improve security** and to **prepare for a brighter future of having more homeserver options** than just Synapse." -msgstr "" - -#: ../../../CHANGELOG.md:2238 -msgid "What has really changed?" -msgstr "" - -#: ../../../CHANGELOG.md:2240 -msgid "the default superuser Postgres username is now `matrix` (used to be `synapse`)" -msgstr "" - -#: ../../../CHANGELOG.md:2241 -msgid "the default Postgres database is now `matrix` (used to be `homeserver`)" -msgstr "" - -#: ../../../CHANGELOG.md:2242 -msgid "Synapse's database is now `synapse` (used to be `homeserver`). This is now just another \"additional database\" that the playbook manages for you" -msgstr "" - -#: ../../../CHANGELOG.md:2243 -msgid "Synapse's user called `synapse` is just a regular user that can only use the `synapse` database (not a superuser anymore)" +#: ../../../CHANGELOG.md:2239 +msgid "Finally, **to try out Dendrite**, we recommend that you **use a new server** and the following addition to your `vars.yml` configuration:" msgstr "" #: ../../../CHANGELOG.md:2245 -msgid "What do I do if I'm using the integrated Postgres server (default)?" +msgid "**The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse to Dendrite) without data loss." msgstr "" #: ../../../CHANGELOG.md:2247 -msgid "By default, the playbook runs an integrated Postgres server for you in a container (`matrix-postgres`). Unless you've explicitly configured an [external Postgres server](docs/configuring-playbook-external-postgres.md), these steps are meant for you." +msgid "We're excited to gain support for other homeserver implementations, like [Conduit](https://conduit.rs/), etc!" msgstr "" #: ../../../CHANGELOG.md:2249 -msgid "To migrate to the new setup, expect a few minutes of downtime, while you follow these steps:" +msgid "Honoroit bot support" msgstr "" #: ../../../CHANGELOG.md:2251 -msgid "We believe the steps below are safe and you won't encounter any data loss, but consider [making a Postgres backup](docs/maintenance-postgres.md#backing-up-postgresql) anyway. If you've never backed up Postgres, now would be a good time to try it." +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now help you set up [Honoroit](https://github.com/etkecc/honoroit) — a helpdesk bot." msgstr "" #: ../../../CHANGELOG.md:2253 -msgid "Generate a strong password to be used for your superuser Postgres user (called `matrix`). You can create one with a command like `pwgen -s 64 1`. The **maximum length** for a Postgres password is 100 bytes (characters). Don't go crazy!" +msgid "See our [Setting up Honoroit](docs/configuring-playbook-bot-honoroit.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:2255 -msgid "Update your playbook's `inventory/host_vars/matrix.example.com/vars.yml` file, adding a line like this:" +#: ../../../CHANGELOG.md:2256 +msgid "2022-01-06" +msgstr "" + +#: ../../../CHANGELOG.md:2258 +msgid "Cinny support" msgstr "" #: ../../../CHANGELOG.md:2260 -#: ../../../CHANGELOG.md:2272 -msgid "… where `YOUR_POSTGRES_PASSWORD_HERE` is to be replaced with the password you generated during step #2." +msgid "Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook now supports [Cinny](https://cinny.in/) — a new simple, elegant and secure Matrix client." msgstr "" #: ../../../CHANGELOG.md:2262 -msgid "Stop all services: `ansible-playbook -i inventory/hosts setup.yml --tags=stop`" -msgstr "" - -#: ../../../CHANGELOG.md:2263 -msgid "Log in to the server via SSH. The next commands will be performed there." +msgid "By default, we still install Element Web. Still, people who'd like to try Cinny out can now install it via the playbook." msgstr "" #: ../../../CHANGELOG.md:2264 -msgid "Start the Postgres database server: `systemctl start matrix-postgres`" +msgid "Additional details are available in [Setting up Cinny](docs/configuring-playbook-client-cinny.md)." msgstr "" -#: ../../../CHANGELOG.md:2265 -msgid "Open a Postgres shell: `/usr/local/bin/matrix-postgres-cli`" +#: ../../../CHANGELOG.md:2267 +msgid "2021-12-22" msgstr "" -#: ../../../CHANGELOG.md:2266 -msgid "Execute the following query, while making sure to **change the password inside** (**don't forget the ending `;`**):" +#: ../../../CHANGELOG.md:2269 +msgid "Twitter bridging support via mautrix-twitter" +msgstr "" + +#: ../../../CHANGELOG.md:2271 +msgid "Thanks to [Matthew Cengia](https://github.com/mattcen) and [Shreyas Ajjarapu](https://github.com/shreyasajj), besides [mx-puppet-twitter](docs/configuring-playbook-bridge-mx-puppet-twitter.md), bridging to [Twitter](https://twitter.com/) can now also happen with [mautrix-twitter](docs/configuring-playbook-bridge-mautrix-twitter.md)." msgstr "" #: ../../../CHANGELOG.md:2274 -msgid "Execute the following queries as you see them (no modifications necessary, so you can just **paste them all at once**):" +msgid "2021-12-14" +msgstr "" + +#: ../../../CHANGELOG.md:2276 +msgid "(Security) Users of the Signal bridge may wish to upgrade it to work around log4j vulnerability" +msgstr "" + +#: ../../../CHANGELOG.md:2278 +msgid "Recently, a security vulnerability affecting the Java logging package `log4j` [has been discovered](https://www.huntress.com/blog/rapid-response-critical-rce-vulnerability-is-affecting-java). Software that uses this Java package is potentially vulnerable." +msgstr "" + +#: ../../../CHANGELOG.md:2280 +msgid "One such piece of software that is part of the playbook is the [mautrix-signal bridge](./docs/configuring-playbook-bridge-mautrix-signal.md), which [has been patched already](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1452). If you're running this bridge, you may wish to [upgrade](./docs/maintenance-upgrading-services.md)." +msgstr "" + +#: ../../../CHANGELOG.md:2283 +msgid "2021-11-11" +msgstr "" + +#: ../../../CHANGELOG.md:2285 +msgid "Dropped support for Postgres v9.6" +msgstr "" + +#: ../../../CHANGELOG.md:2287 +msgid "Postgres v9.6 reached its end of life today, so the playbook will refuse to run for you if you're still on that version." +msgstr "" + +#: ../../../CHANGELOG.md:2289 +msgid "Synapse still supports v9.6 (for now), but we're retiring support for it early, to avoid having to maintain support for so many Postgres versions. Users that are still on Postgres v9.6 can easily [upgrade Postgres](docs/maintenance-postgres.md#upgrading-postgresql) via the playbook." msgstr "" #: ../../../CHANGELOG.md:2292 -msgid "You may need to press *Enter* after pasting the lines above." +msgid "2021-10-23" msgstr "" #: ../../../CHANGELOG.md:2294 -msgid "Re-run the playbook normally: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`" +msgid "Hangouts bridge no longer updated, superseded by a Googlechat bridge" msgstr "" #: ../../../CHANGELOG.md:2296 -msgid "What do I do if I'm using an external Postgres server?" +msgid "The mautrix-hangouts bridge is no longer receiving updates upstream and is likely to stop working in the future. We still retain support for this bridge in the playbook, but you're encouraged to switch away from it." msgstr "" #: ../../../CHANGELOG.md:2298 -msgid "If you've explicitly configured an [external Postgres server](docs/configuring-playbook-external-postgres.md), there are **no changes** that you need to do at this time." +msgid "There's a new [mautrix-googlechat](https://github.com/mautrix/googlechat) bridge that you can [install using the playbook](docs/configuring-playbook-bridge-mautrix-googlechat.md). Your **Hangouts bridge data will not be migrated**, however. You need to start fresh with the new bridge." msgstr "" -#: ../../../CHANGELOG.md:2300 -msgid "The fact that we've renamed Synapse's database from `homeserver` to `synapse` (in our defaults) should not affect you, as you're already explicitly defining `matrix_synapse_database_database` (if you've followed our guide, that is). If you're not explicitly defining this variable, you may wish to do so (`matrix_synapse_database_database: homeserver`), to avoid the new `synapse` default and keep things as they were." +#: ../../../CHANGELOG.md:2301 +msgid "2021-08-23" msgstr "" #: ../../../CHANGELOG.md:2303 -msgid "2021-01-20" +msgid "LinkedIn bridging support via beeper-linkedin" msgstr "" #: ../../../CHANGELOG.md:2305 -msgid "(Breaking Change) The mautrix-facebook bridge now requires a Postgres database" +msgid "Thanks to [Alexandar Mechev](https://github.com/apmechev), the playbook can now install the [beeper-linkedin](https://gitlab.com/beeper/linkedin) bridge for bridging to [LinkedIn](https://www.linkedin.com/) Messaging." msgstr "" #: ../../../CHANGELOG.md:2307 -msgid "**Update from 2021-11-15**: SQLite support has been re-added to the mautrix-facebook bridge in [v0.3.2](https://github.com/mautrix/facebook/releases/tag/v0.3.2). You can ignore this changelog entry." +msgid "This brings the total number of bridges supported by the playbook up to 20. See all supported bridges [here](docs/configuring-playbook.md#bridging-other-networks)." msgstr "" #: ../../../CHANGELOG.md:2309 -msgid "A new version of the [mautrix-facebook](https://github.com/tulir/mautrix-facebook) bridge has been released. It's a full rewrite of its backend and the bridge now requires Postgres. New versions of the bridge can no longer run on SQLite." +msgid "To get started with bridging to LinkedIn, see [Setting up Beeper LinkedIn bridging](docs/configuring-playbook-bridge-beeper-linkedin.md)." msgstr "" -#: ../../../CHANGELOG.md:2311 -msgid "**TLDR**: if you're NOT using an [external Postgres server](docs/configuring-playbook-external-postgres.md) and have NOT forcefully kept the bridge on SQLite during [The big move to all-on-Postgres (potentially dangerous)](#the-big-move-to-all-on-postgres-potentially-dangerous), you will be automatically upgraded without manual intervention. All you need to do is send a `login` message to the Facebook bridge bot again." -msgstr "" - -#: ../../../CHANGELOG.md:2313 -msgid "Whether this change requires your intervention depends mostly on:" +#: ../../../CHANGELOG.md:2312 +msgid "2021-08-20" msgstr "" #: ../../../CHANGELOG.md:2314 -msgid "whether you're using an [external Postgres server](docs/configuring-playbook-external-postgres.md). If yes, then [you need to do something](#upgrade-path-for-people-running-an-external-postgres-server)." +msgid "Sygnal upgraded — ARM support and no longer requires a database" msgstr "" -#: ../../../CHANGELOG.md:2315 -msgid "or whether you've force-changed the bridge's database engine to SQLite (`matrix_mautrix_facebook_database_engine: 'sqlite'` in your `vars.yml`) some time in the past (likely during [The big move to all-on-Postgres (potentially dangerous)](#the-big-move-to-all-on-postgres-potentially-dangerous))." +#: ../../../CHANGELOG.md:2316 +msgid "The [Sygnal](docs/configuring-playbook-sygnal.md) push gateway has been upgraded from `v0.9.0` to `v0.10.1`." msgstr "" -#: ../../../CHANGELOG.md:2317 -msgid "As already mentioned above, you most likely don't need to do anything. If you rerun the playbook and don't get an error, you've been automatically upgraded. Just send a `login` message to the Facebook bridge bot again. Otherwise, read below for a solution." +#: ../../../CHANGELOG.md:2318 +msgid "This is an optional component for the playbook, so most of our users wouldn't care about this announcement." msgstr "" -#: ../../../CHANGELOG.md:2319 -msgid "Upgrade path for people NOT running an external Postgres server (default for the playbook)" +#: ../../../CHANGELOG.md:2320 +msgid "Since this feels like a relatively big (and untested, as of yet) Sygnal change, we're putting up this changelog entry." msgstr "" -#: ../../../CHANGELOG.md:2321 -msgid "If you're **not running an external Postgres server**, then this bridge either already works on Postgres for you, or you've intentionally kept it back on SQLite with custom configuration (`matrix_mautrix_facebook_database_engine: 'sqlite'` in your `vars.yml`) ." -msgstr "" - -#: ../../../CHANGELOG.md:2323 -msgid "Simply remove that custom configuration from your `vars.yml` file (if it's there) and re-run the playbook. It should upgrade you automatically. You'll need to send a `login` message to the Facebook bridge bot again." +#: ../../../CHANGELOG.md:2322 +msgid "The new version is also available for the ARM architecture. It also no longer requires a database anymore. If you need to downgrade to the previous version, changing `matrix_sygnal_version` or `matrix_sygnal_docker_image` will not be enough, as we've removed the `database` configuration completely. You'd need to switch to an earlier playbook commit." msgstr "" #: ../../../CHANGELOG.md:2325 -msgid "Alternatively, [you can stay on SQLite for a little longer](#staying-on-sqlite-for-a-little-longer-temporary-solution)." +msgid "2021-05-21" msgstr "" #: ../../../CHANGELOG.md:2327 -msgid "Upgrade path for people running an external Postgres server" +msgid "Hydrogen support" msgstr "" #: ../../../CHANGELOG.md:2329 -msgid "For people using the internal Postgres server (the default for the playbook):" -msgstr "" - -#: ../../../CHANGELOG.md:2330 -msgid "we automatically create an additional `matrix_mautrix_facebook` Postgres database and credentials to access it" +msgid "Thanks to [Aaron Raimist](https://github.com/aaronraimist), the playbook now supports [Hydrogen](https://github.com/vector-im/hydrogen-web) — a new lightweight Matrix client with legacy and mobile browser support." msgstr "" #: ../../../CHANGELOG.md:2331 -msgid "we automatically adjust the bridge's `matrix_mautrix_facebook_database_*` variables to point the bridge to that Postgres database" +msgid "By default, we still install Element Web, as Hydrogen is still not fully-featured. Still, people who'd like to try Hydrogen out can now install it via the playbook." msgstr "" -#: ../../../CHANGELOG.md:2332 -msgid "we use [pgloader](https://pgloader.io/) to automatically import the existing SQLite data for the bridge into the `matrix_mautrix_facebook` Postgres database" -msgstr "" - -#: ../../../CHANGELOG.md:2334 -msgid "If you are using an [external Postgres server](docs/configuring-playbook-external-postgres.md), unfortunately we currently can't do any of that for you." +#: ../../../CHANGELOG.md:2333 +msgid "Additional details are available in [Setting up Hydrogen](docs/configuring-playbook-client-hydrogen.md)." msgstr "" #: ../../../CHANGELOG.md:2336 -msgid "You have 3 ways to proceed:" +msgid "2021-05-19" msgstr "" #: ../../../CHANGELOG.md:2338 -msgid "contribute to the playbook to make this possible (difficult)" -msgstr "" - -#: ../../../CHANGELOG.md:2339 -msgid "or, do the migration \"steps\" manually:" +msgid "Heisenbridge support" msgstr "" #: ../../../CHANGELOG.md:2340 -msgid "stop the bridge (`systemctl stop matrix-mautrix-facebook`)" -msgstr "" - -#: ../../../CHANGELOG.md:2341 -msgid "create a new `matrix_mautrix_facebook` Postgres database for it" +msgid "Thanks to [Toni Spets (hifi)](https://github.com/hifi), the playbook now supports bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) using yet another bridge (besides matrix-appservice-irc), called [Heisenbridge](https://github.com/hifi/heisenbridge)." msgstr "" #: ../../../CHANGELOG.md:2342 -msgid "run [pgloader](https://pgloader.io/) manually (we import this bridge's data using default settings and it works well)" -msgstr "" - -#: ../../../CHANGELOG.md:2343 -msgid "define `matrix_mautrix_facebook_database_*` variables in your `vars.yml` file (credentials, etc.) — you can find their defaults in `roles/custom/matrix-mautrix-facebook/defaults/main.yml`" -msgstr "" - -#: ../../../CHANGELOG.md:2344 -msgid "switch the bridge to Postgres (`matrix_mautrix_facebook_database_engine: 'postgres'` in your `vars.yml` file)" +msgid "Additional details are available in [Setting up Heisenbridge bouncer-style IRC bridging](docs/configuring-playbook-bridge-heisenbridge.md)." msgstr "" #: ../../../CHANGELOG.md:2345 -msgid "re-run the playbook (`--tags=setup-all,start`) and ensure the bridge works (`systemctl status matrix-mautrix-facebook` and `journalctl -fu matrix-mautrix-facebook`)" -msgstr "" - -#: ../../../CHANGELOG.md:2346 -msgid "send a `login` message to the Facebook bridge bot again" +msgid "2021-04-16" msgstr "" #: ../../../CHANGELOG.md:2347 -msgid "or, [stay on SQLite for a little longer (temporary solution)](#staying-on-sqlite-for-a-little-longer-temporary-solution)" +msgid "Disabling TLSv1 and TLSv1.1 for coturn" msgstr "" #: ../../../CHANGELOG.md:2349 -msgid "Staying on SQLite for a little longer (temporary solution)" +msgid "To improve security, we've [removed TLSv1 and TLSv1.1 support](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/999) from our default [coturn](https://github.com/coturn/coturn) configuration." msgstr "" #: ../../../CHANGELOG.md:2351 -msgid "To keep using this bridge with SQLite for a little longer (**not recommended**), use the following configuration in your `vars.yml` file:" +msgid "If you need to support old clients, you can re-enable both (or whichever one you need) with the following configuration:" +msgstr "" + +#: ../../../CHANGELOG.md:2359 +msgid "2021-04-05" msgstr "" #: ../../../CHANGELOG.md:2361 -msgid "If you do this, keep in mind that **you can't run this forever**. This SQLite-supporting bridge version is not getting any updates and will break sooner or later. The playbook will also drop support for SQLite at some point in the future." +msgid "Automated local Postgres backup support" msgstr "" -#: ../../../CHANGELOG.md:2364 -msgid "2021-01-17" +#: ../../../CHANGELOG.md:2363 +msgid "Thanks to [foxcris](https://github.com/foxcris), the playbook can now make automated local Postgres backups on a fixed schedule using [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local)." msgstr "" -#: ../../../CHANGELOG.md:2366 -msgid "matrix-corporal goes 2.0" +#: ../../../CHANGELOG.md:2365 +msgid "Additional details are available in [Setting up Postgres backup](docs/configuring-playbook-postgres-backup.md)." msgstr "" #: ../../../CHANGELOG.md:2368 -msgid "[matrix-corporal v2 has been released](https://github.com/devture/matrix-corporal/releases/tag/2.0.0) and the playbook also supports it now." +msgid "2021-04-03" msgstr "" #: ../../../CHANGELOG.md:2370 -msgid "No manual intervention is required in the common case." +msgid "Mjolnir moderation tool (bot) support" msgstr "" #: ../../../CHANGELOG.md:2372 -msgid "The new [matrix-corporal](https://github.com/devture/matrix-corporal) version is also the first one to support Interactive Authentication. If you wish to enable that (hint: you should), you'll need to set up the [REST auth password provider](docs/configuring-playbook-rest-auth.md). There's more information in [our matrix-corporal docs](docs/configuring-playbook-matrix-corporal.md)." +msgid "Thanks to [Aaron Raimist](https://github.com/aaronraimist), the playbook can now install and configure the [Mjolnir](https://github.com/matrix-org/mjolnir) moderation tool (bot)." msgstr "" -#: ../../../CHANGELOG.md:2375 -msgid "2021-01-14" +#: ../../../CHANGELOG.md:2374 +msgid "Additional details are available in [Setting up Mjolnir](docs/configuring-playbook-bot-mjolnir.md)." msgstr "" #: ../../../CHANGELOG.md:2377 -msgid "Moving from cronjobs to systemd timers" +msgid "2021-03-20" msgstr "" #: ../../../CHANGELOG.md:2379 -msgid "We no longer use cronjobs for Let's Encrypt SSL renewal and `matrix-nginx-proxy`/`matrix-coturn` reloading. Instead, we've switched to systemd timers." +msgid "Sygnal push gateway support" msgstr "" #: ../../../CHANGELOG.md:2381 -msgid "The largest benefit of this is that we no longer require you to install a cron daemon, thus simplifying our install procedure." +msgid "The playbook can now install the [Sygnal](https://github.com/matrix-org/sygnal) push gateway for you." msgstr "" #: ../../../CHANGELOG.md:2383 -msgid "The playbook will migrate you from cronjobs to systemd timers automatically. This is just a heads up." +msgid "This is only useful to people who develop/build their own Matrix client applications." msgstr "" -#: ../../../CHANGELOG.md:2386 -msgid "2021-01-08" +#: ../../../CHANGELOG.md:2385 +msgid "Additional details are available in our [Setting up the Sygnal push gateway](docs/configuring-playbook-sygnal.md) docs." msgstr "" #: ../../../CHANGELOG.md:2388 -msgid "(Breaking Change) New SSL configuration" +msgid "2021-03-16" msgstr "" #: ../../../CHANGELOG.md:2390 -msgid "SSL configuration (protocols, ciphers) can now be more easily controlled thanks to us making use of configuration presets." +msgid "Go-NEB support" msgstr "" #: ../../../CHANGELOG.md:2392 -msgid "We define a few presets (old, intermediate, modern), following the [Mozilla SSL Configuration Generator](https://ssl-config.mozilla.org/#server=nginx)." +msgid "Thanks to [Zir0h](https://github.com/Zir0h), the playbook can now install and configure the [Go-NEB](https://github.com/matrix-org/go-neb) bot." msgstr "" #: ../../../CHANGELOG.md:2394 -msgid "A new variable `matrix_nginx_proxy_ssl_preset` controls which preset is used (defaults to `\"intermediate\"`)." +msgid "Additional details are available in [Setting up Go-NEB](docs/configuring-playbook-bot-go-neb.md)." msgstr "" -#: ../../../CHANGELOG.md:2396 -msgid "Compared to before, this changes nginx's `ssl_prefer_server_ciphers` to `off` (used to default to `on`). It also add some more ciphers to the list, giving better performance on mobile devices, and removes some weak ciphers. More information in the [documentation](docs/configuring-playbook-nginx.md)." +#: ../../../CHANGELOG.md:2397 +msgid "2021-02-19" msgstr "" -#: ../../../CHANGELOG.md:2398 -msgid "To revert to the old behaviour, set the following variables:" +#: ../../../CHANGELOG.md:2399 +msgid "GroupMe bridging support via mx-puppet-groupme" +msgstr "" + +#: ../../../CHANGELOG.md:2401 +msgid "Thanks to [Cody Neiman](https://github.com/xangelix), the playbook can now install the [mx-puppet-groupme](https://gitlab.com/robintown/mx-puppet-groupme) bridge for bridging to [GroupMe](https://groupme.com)." +msgstr "" + +#: ../../../CHANGELOG.md:2403 +msgid "This brings the total number of bridges supported by the playbook up to 18. See all supported bridges [here](docs/configuring-playbook.md#bridging-other-networks)." msgstr "" #: ../../../CHANGELOG.md:2405 -msgid "Just like before, you can still use your own custom protocols by specifying them in `matrix_nginx_proxy_ssl_protocols`. Doing so overrides the values coming from the preset." +msgid "To get started, follow our [Setting up MX Puppet GroupMe](docs/configuring-playbook-bridge-mx-puppet-groupme.md) docs." msgstr "" -#: ../../../CHANGELOG.md:2408 -msgid "2021-01-03" +#: ../../../CHANGELOG.md:2407 +msgid "Mautrix Instagram bridging support" msgstr "" -#: ../../../CHANGELOG.md:2410 -msgid "Signal bridging support via mautrix-signal" +#: ../../../CHANGELOG.md:2409 +msgid "The playbook now supports bridging with [Instagram](https://www.instagram.com/) by installing the [mautrix-instagram](https://github.com/tulir/mautrix-instagram) bridge. This playbook functionality is available thanks to [@MarcProe](https://github.com/MarcProe)." msgstr "" -#: ../../../CHANGELOG.md:2412 -msgid "Thanks to [laszabine](https://github.com/laszabine)'s efforts, the playbook now supports bridging to [Signal](https://www.signal.org/) via the [mautrix-signal](https://github.com/tulir/mautrix-signal) bridge. See our [Setting up Mautrix Signal bridging](docs/configuring-playbook-bridge-mautrix-signal.md) documentation page for getting started." +#: ../../../CHANGELOG.md:2411 +msgid "Additional details are available in [Setting up Mautrix Instagram bridging](docs/configuring-playbook-bridge-mautrix-instagram.md)." msgstr "" -#: ../../../CHANGELOG.md:2414 -msgid "If you had installed the mautrix-signal bridge while its Pull Request was still work-in-progress, you can migrate your data to the new and final setup by referring to [this comment](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/686#issuecomment-753510789)." +#: ../../../CHANGELOG.md:2413 +msgid "Synapse workers support" +msgstr "" + +#: ../../../CHANGELOG.md:2415 +msgid "After [lots and lots of work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/456) (done over many months by [Marcel Partap](https://github.com/eMPee584), [Max Klenk](https://github.com/maxklenk), a few others from the [Technical University of Dresden, Germany](https://tu-dresden.de/) and various other contributors), support for Synapse workers has finally landed." msgstr "" #: ../../../CHANGELOG.md:2417 -msgid "2020-12-23" +msgid "Having support for workers makes the playbook suitable for larger homeserver deployments." msgstr "" #: ../../../CHANGELOG.md:2419 -msgid "The big move to all-on-Postgres (potentially dangerous)" +msgid "Our setup is not yet perfect (we don't support all types of workers; scaling some of them (like `pusher`, `federation_sender`) beyond a single instance is not yet supported). Still, it's a great start and can already power homeservers with thousands of users, like the [Matrix deployment at TU Dresden](https://doc.matrix.tu-dresden.de/en/) discussed in [Matrix Live S06E09 — TU Dresden on their Matrix deployment](https://www.youtube.com/watch?v=UHJX2pmT2gk)." msgstr "" #: ../../../CHANGELOG.md:2421 -msgid "**TLDR**: all your bridges (and other services) will likely be auto-migrated from SQLite/nedb to Postgres, hopefully without trouble. You can opt-out (see how below), if too worried about breakage." +msgid "By default, workers are disabled and Synapse runs as a single process (homeservers don't necessarily need the complexity and increased memory requirements of running a worker-based setup)." msgstr "" #: ../../../CHANGELOG.md:2423 -msgid "Until now, we've only used Postgres as a database for Synapse. All other services (bridges, bots, etc.) were kept simple and used a file-based database (SQLite or nedb)." +msgid "To enable Synapse workers, follow our [Load balancing with workers](docs/configuring-playbook-synapse.md#load-balancing-with-workers) documentation." msgstr "" -#: ../../../CHANGELOG.md:2425 -msgid "Since [this huge pull request](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/740), **all of our services now use Postgres by default**. Thanks to [Johanna Dorothea Reichmann](https://github.com/jdreichmann) for starting the work on it and for providing great input!" +#: ../../../CHANGELOG.md:2426 +msgid "2021-02-12" msgstr "" -#: ../../../CHANGELOG.md:2427 -msgid "Moving all services to Postgres brings a few **benefits** to us:" -msgstr "" - -#: ../../../CHANGELOG.md:2429 -msgid "**improved performance**" +#: ../../../CHANGELOG.md:2428 +msgid "(Potential Breaking Change) Monitoring/metrics support using Prometheus and Grafana" msgstr "" #: ../../../CHANGELOG.md:2430 -msgid "**improved compatibility**. Most bridges are deprecating SQLite/nedb support or offer less features when not on Postgres." -msgstr "" - -#: ../../../CHANGELOG.md:2431 -msgid "**easier backups**. It's still some effort to take a proper backup (Postgres dump + various files, keys), but a Postgres dump now takes you much further." +msgid "Thanks to [@Peetz0r](https://github.com/Peetz0r), the playbook can now install a bunch of tools for monitoring your Matrix server: the [Prometheus](https://prometheus.io) time-series database server, the Prometheus [node-exporter](https://prometheus.io/docs/guides/node-exporter/) host metrics exporter, and the [Grafana](https://grafana.com/) web UI." msgstr "" #: ../../../CHANGELOG.md:2432 -msgid "we're now **more prepared to introduce other services** that need a Postgres database — [Dendrite](https://github.com/matrix-org/dendrite), the [mautrix-signal](https://github.com/tulir/mautrix-signal) bridge (existing [pull request](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/686)), etc." +msgid "To get get these installed, follow our [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](docs/configuring-playbook-prometheus-grafana.md) docs page." msgstr "" #: ../../../CHANGELOG.md:2434 -msgid "Key takeway" +msgid "This update comes with a **potential breaking change** for people who were already exposing Synapse metrics (for consumption via another Prometheus installation). From now on, `matrix_synapse_metrics_enabled: true` no longer exposes metrics publicly via matrix-nginx-proxy (at `https://matrix.example.com/_synapse/metrics`). To do so, you'd need to explicitly set `matrix_nginx_proxy_proxy_synapse_metrics: true`." msgstr "" -#: ../../../CHANGELOG.md:2436 -msgid "existing installations that use an [external Postgres](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/configuring-playbook-external-postgres.md) server should be unaffected (they remain on SQLite/nedb for all services, except Synapse)" +#: ../../../CHANGELOG.md:2437 +msgid "2021-01-31" msgstr "" -#: ../../../CHANGELOG.md:2438 -msgid "for existing installations which use our integrated Postgres database server (`matrix-postgres`, which is the default), **we automatically migrate data** from SQLite/nedb to Postgres and **archive the database files** (`something.db` -> `something.db.backup`), so you can restore them if you need to go back (see how below)." +#: ../../../CHANGELOG.md:2439 +msgid "Etherpad support" msgstr "" -#: ../../../CHANGELOG.md:2440 -msgid "Opting-out of the Postgres migration" +#: ../../../CHANGELOG.md:2441 +msgid "Thanks to [@pushytoxin](https://github.com/pushytoxin), the playbook can now install the [Etherpad](https://etherpad.org) realtime collaborative text editor. It can be used in a [Jitsi](https://jitsi.org/) audio/video call or integrated as a widget into Matrix chat rooms via the [Dimension](https://dimension.t2bot.io) integration manager." msgstr "" -#: ../../../CHANGELOG.md:2442 -msgid "This is a **very large and somewhat untested change** (potentially dangerous), so **if you're not feeling confident/experimental, opt-out** of it for now. Still, it's the new default and what we (and various bridges) will focus on going forward, so don't stick to old ways for too long." -msgstr "" - -#: ../../../CHANGELOG.md:2444 -msgid "You can remain on SQLite/nedb (at least for now) by adding a variable like this to your `vars.yml` file for each service you use: `matrix_COMPONENT_database_engine: sqlite` (e.g. `matrix_mautrix_facebook_database_engine: sqlite`)." +#: ../../../CHANGELOG.md:2443 +msgid "To get it installed, follow [our Etherpad docs page](docs/configuring-playbook-etherpad.md)." msgstr "" #: ../../../CHANGELOG.md:2446 -msgid "Some services (like `appservice-irc` and `appservice-slack`) don't use SQLite, so use `nedb`, instead of `sqlite` for them." +msgid "2021-01-22" msgstr "" #: ../../../CHANGELOG.md:2448 -msgid "Going back to SQLite/nedb if things went wrong" +msgid "(Breaking Change) Postgres changes that require manual intervention" msgstr "" #: ../../../CHANGELOG.md:2450 -msgid "If you went with the Postgres migration and it went badly for you (some bridge not working as expected or not working at all), do this:" +msgid "We've made a lot of changes to our Postgres setup and some manual action is required (described below). Sorry about the hassle." msgstr "" #: ../../../CHANGELOG.md:2452 -msgid "stop all services (`ansible-playbook -i inventory/hosts setup.yml --tags=stop`)" -msgstr "" - -#: ../../../CHANGELOG.md:2453 -msgid "SSH into the server and rename the old database files (`something.db.backup` -> `something.db`). Example: `mv /matrix/mautrix-facebook/data/mautrix-facebook.db.backup /matrix/mautrix-facebook/data/mautrix-facebook.db`" +msgid "**TLDR**: people running an [external Postgres server](docs/configuring-playbook-external-postgres.md) don't need to change anything for now. Everyone else (the common/default case) is affected and manual intervention is required." msgstr "" #: ../../../CHANGELOG.md:2454 -msgid "switch the affected service back to SQLite (e.g. `matrix_mautrix_facebook_database_engine: sqlite`). Some services (like `appservice-irc` and `appservice-slack`) don't use SQLite, so use `nedb`, instead of `sqlite` for them." -msgstr "" - -#: ../../../CHANGELOG.md:2455 -msgid "re-run the playbook (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`)" +msgid "Why?" msgstr "" #: ../../../CHANGELOG.md:2456 -msgid "[get in touch](README.md#support) with us" +msgid "we had a default Postgres password (`matrix_postgres_connection_password: synapse-password`), which we think is **not ideal for security anymore**. We now ask you to generate/provide a strong password yourself. Postgres is normally not exposed outside the container network, making it relatively secure, but still:" +msgstr "" + +#: ../../../CHANGELOG.md:2457 +msgid "by tweaking the configuration, you may end up intentionally or unintentionally exposing your Postgres server to the local network (or even publicly), while still using the default default credentials (`synapse` + `synapse-password`)" msgstr "" #: ../../../CHANGELOG.md:2458 -msgid "2020-12-11" +msgid "we can't be sure we trust all these services (bridges, etc). Some of them may try to talk to or attack `matrix-postgres` using the default credentials (`synapse` + `synapse-password`)" +msgstr "" + +#: ../../../CHANGELOG.md:2459 +msgid "you may have other containers running on the same Docker network, which may try to talk to or attack `matrix-postgres` using the default credentials (`synapse` + `synapse-password`)" msgstr "" #: ../../../CHANGELOG.md:2460 -msgid "synapse-janitor support removed" +msgid "our Postgres usage **was overly-focused on Synapse** (default username of `synapse` and default/main database of `homeserver`). Additional homeserver options are likely coming in the future ([Dendrite](https://matrix.org/docs/projects/server/dendrite), [Conduit](https://matrix.org/docs/projects/server/conduit), [The Construct](https://matrix.org/docs/projects/server/construct)), so being too focused on `matrix-synapse` is not great. From now on, Synapse is just another component of this playbook, which happens to have an *additional database* (called `synapse`) on the Postgres server." msgstr "" -#: ../../../CHANGELOG.md:2462 -msgid "We've removed support for the unmaintained [synapse-janitor](https://github.com/xwiki-labs/synapse_scripts) script. There's been past reports of it corrupting the Synapse database. Since there hasn't been any new development on it and it doesn't seem too useful nowadays, there's no point in including it in the playbook." +#: ../../../CHANGELOG.md:2461 +msgid "we try to reorganize things a bit, to make the playbook even friendlier to people running an [external Postgres server](docs/configuring-playbook-external-postgres.md). Work on this will proceed in the future." msgstr "" -#: ../../../CHANGELOG.md:2464 -msgid "If you need to clean up or compact your database, consider using the Synapse Admin APIs directly. See our [Synapse maintenance](docs/maintenance-synapse.md) and [Postgres maintenance](docs/maintenance-postgres.md) documentation pages for more details." +#: ../../../CHANGELOG.md:2463 +msgid "So, this is some **effort to improve security** and to **prepare for a brighter future of having more homeserver options** than just Synapse." msgstr "" -#: ../../../CHANGELOG.md:2466 -msgid "Docker 20.10 is here" +#: ../../../CHANGELOG.md:2465 +msgid "What has really changed?" +msgstr "" + +#: ../../../CHANGELOG.md:2467 +msgid "the default superuser Postgres username is now `matrix` (used to be `synapse`)" msgstr "" #: ../../../CHANGELOG.md:2468 -msgid "(No need to do anything special in relation to this. Just something to keep in mind)" +msgid "the default Postgres database is now `matrix` (used to be `homeserver`)" +msgstr "" + +#: ../../../CHANGELOG.md:2469 +msgid "Synapse's database is now `synapse` (used to be `homeserver`). This is now just another \"additional database\" that the playbook manages for you" msgstr "" #: ../../../CHANGELOG.md:2470 -msgid "Docker 20.10 got released recently and your server will likely get it the next time you update." +msgid "Synapse's user called `synapse` is just a regular user that can only use the `synapse` database (not a superuser anymore)" msgstr "" #: ../../../CHANGELOG.md:2472 -msgid "This is the first major Docker update in a long time and it packs a lot of changes. Some of them introduced some breakage for us initially (see [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/d08b27784f222effcbce2abf924bf07bbe0893be) and [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/7593d969e316cc0144bce378a5be58c76c2c37ee)), but it should be all good now." +msgid "What do I do if I'm using the integrated Postgres server (default)?" msgstr "" -#: ../../../CHANGELOG.md:2475 -msgid "2020-12-08" +#: ../../../CHANGELOG.md:2474 +msgid "By default, the playbook runs an integrated Postgres server for you in a container (`matrix-postgres`). Unless you've explicitly configured an [external Postgres server](docs/configuring-playbook-external-postgres.md), these steps are meant for you." msgstr "" -#: ../../../CHANGELOG.md:2477 -msgid "openid APIs exposed by default on the federation port when federation disabled" +#: ../../../CHANGELOG.md:2476 +msgid "To migrate to the new setup, expect a few minutes of downtime, while you follow these steps:" msgstr "" -#: ../../../CHANGELOG.md:2479 -msgid "We've changed some defaults. People running with our default configuration (federation enabled), are not affected at all." +#: ../../../CHANGELOG.md:2478 +msgid "We believe the steps below are safe and you won't encounter any data loss, but consider [making a Postgres backup](docs/maintenance-postgres.md#backing-up-postgresql) anyway. If you've never backed up Postgres, now would be a good time to try it." msgstr "" -#: ../../../CHANGELOG.md:2481 -msgid "If you are running an unfederated server (`matrix_synapse_federation_enabled: false`), this may be of interest to you." +#: ../../../CHANGELOG.md:2480 +msgid "Generate a strong password to be used for your superuser Postgres user (called `matrix`). You can create one with a command like `pwgen -s 64 1`. The **maximum length** for a Postgres password is 100 bytes (characters). Don't go crazy!" msgstr "" -#: ../../../CHANGELOG.md:2483 -msgid "When federation is disabled, but ma1sd or Dimension are enabled, we'll now expose the `openid` APIs on the federation port. These APIs are necessary for some ma1sd features to work. If you'd like to prevent this, you can: `matrix_synapse_federation_port_openid_resource_required: false`." +#: ../../../CHANGELOG.md:2482 +msgid "Update your playbook's `inventory/host_vars/matrix.example.com/vars.yml` file, adding a line like this:" msgstr "" -#: ../../../CHANGELOG.md:2486 -msgid "2020-11-27" +#: ../../../CHANGELOG.md:2487 +#: ../../../CHANGELOG.md:2499 +msgid "… where `YOUR_POSTGRES_PASSWORD_HERE` is to be replaced with the password you generated during step #2." msgstr "" -#: ../../../CHANGELOG.md:2488 -msgid "Recent Jitsi updates may require configuration changes" +#: ../../../CHANGELOG.md:2489 +msgid "Stop all services: `ansible-playbook -i inventory/hosts setup.yml --tags=stop`" msgstr "" #: ../../../CHANGELOG.md:2490 -msgid "We've recently [updated from Jitsi build 4857 to build 5142](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/719), which brings a lot of configuration changes." +msgid "Log in to the server via SSH. The next commands will be performed there." +msgstr "" + +#: ../../../CHANGELOG.md:2491 +msgid "Start the Postgres database server: `systemctl start matrix-postgres`" msgstr "" #: ../../../CHANGELOG.md:2492 -msgid "**If you use our default Jitsi settings, you won't have to do anything.**" +msgid "Open a Postgres shell: `/usr/local/bin/matrix-postgres-cli`" msgstr "" -#: ../../../CHANGELOG.md:2494 -msgid "People who have [fine-tuned Jitsi](docs/configuring-playbook-jitsi.md#optional-fine-tune-jitsi) may find that some options got renamed now, others are gone and yet others still need to be defined in another way." -msgstr "" - -#: ../../../CHANGELOG.md:2496 -msgid "The next time you run the playbook [installation](docs/installing.md) command, our validation logic will tell you if you're using some variables like that and will recommend a migration path for each one." -msgstr "" - -#: ../../../CHANGELOG.md:2498 -msgid "Additionally, we've recently disabled transcriptions (`jitsi_enable_transcriptions: false`) and recording (`jitsi_enable_recording: false`) by default. These features did not work anyway, because we don't install the required dependencies for them (Jigasi and Jibri, respectively). If you've been somehow pointing your Jitsi installation to some manually installed Jigasi/Jibri service, you may need to toggle these flags back to enabled to have transcriptions and recordings working." +#: ../../../CHANGELOG.md:2493 +msgid "Execute the following query, while making sure to **change the password inside** (**don't forget the ending `;`**):" msgstr "" #: ../../../CHANGELOG.md:2501 -msgid "2020-11-23" -msgstr "" - -#: ../../../CHANGELOG.md:2503 -#: ../../../CHANGELOG.md:2511 -msgid "Breaking change matrix-sms-bridge" -msgstr "" - -#: ../../../CHANGELOG.md:2505 -msgid "Because of many problems using gammu as SMS provider, matrix-sms-bridge now uses (https://github.com/RebekkaMa/android-sms-gateway-server) by default. See (the docs)[./docs/configuring-playbook-bridge-matrix-bridge-sms.md] which new vars you need to add." -msgstr "" - -#: ../../../CHANGELOG.md:2507 -msgid "If you are using this playbook to deploy matrix-sms-bridge and still really want to use gammu as SMS provider, we could possibly add support for both android-sms-gateway-server and gammu." -msgstr "" - -#: ../../../CHANGELOG.md:2509 -msgid "2020-11-13" -msgstr "" - -#: ../../../CHANGELOG.md:2513 -msgid "The new version of [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) changed its database from neo4j to h2. You need to sync the bridge at the first start. Note that this only will sync rooms where the @smsbot:yourServer is member. For rooms without @smsbot:yourServer you need to kick and invite the telephone number **or** invite @smsbot:yourServer." -msgstr "" - -#: ../../../CHANGELOG.md:2515 -msgid "Add the following to your `vars.yml` file: `matrix_sms_bridge_container_extra_arguments=['--env SPRING_PROFILES_ACTIVE=initialsync']`" -msgstr "" - -#: ../../../CHANGELOG.md:2516 -msgid "Login to your host shell and remove old systemd file from your host: `rm /etc/systemd/system/matrix-sms-bridge-database.service`" -msgstr "" - -#: ../../../CHANGELOG.md:2517 -msgid "Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-matrix-sms-bridge,start`" -msgstr "" - -#: ../../../CHANGELOG.md:2518 -msgid "Login to your host shell and check the logs with `journalctl -u matrix-sms-bridge` until the sync finished." +msgid "Execute the following queries as you see them (no modifications necessary, so you can just **paste them all at once**):" msgstr "" #: ../../../CHANGELOG.md:2519 -msgid "Remove the var from the first step." +msgid "You may need to press *Enter* after pasting the lines above." msgstr "" -#: ../../../CHANGELOG.md:2520 -msgid "Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`." +#: ../../../CHANGELOG.md:2521 +msgid "Re-run the playbook normally: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`" msgstr "" -#: ../../../CHANGELOG.md:2522 -msgid "2020-11-10" +#: ../../../CHANGELOG.md:2523 +msgid "What do I do if I'm using an external Postgres server?" msgstr "" -#: ../../../CHANGELOG.md:2524 -msgid "Dynamic DNS support" +#: ../../../CHANGELOG.md:2525 +msgid "If you've explicitly configured an [external Postgres server](docs/configuring-playbook-external-postgres.md), there are **no changes** that you need to do at this time." msgstr "" -#: ../../../CHANGELOG.md:2526 -msgid "Thanks to [Scott Crossen](https://github.com/scottcrossen), the playbook can now manage Dynamic DNS for you using [ddclient](https://ddclient.net/)." +#: ../../../CHANGELOG.md:2527 +msgid "The fact that we've renamed Synapse's database from `homeserver` to `synapse` (in our defaults) should not affect you, as you're already explicitly defining `matrix_synapse_database_database` (if you've followed our guide, that is). If you're not explicitly defining this variable, you may wish to do so (`matrix_synapse_database_database: homeserver`), to avoid the new `synapse` default and keep things as they were." msgstr "" -#: ../../../CHANGELOG.md:2528 -msgid "To learn more, follow our [Dynamic DNS docs page](docs/configuring-playbook-dynamic-dns.md)." +#: ../../../CHANGELOG.md:2530 +msgid "2021-01-20" msgstr "" -#: ../../../CHANGELOG.md:2531 -msgid "2020-10-28" +#: ../../../CHANGELOG.md:2532 +msgid "(Breaking Change) The mautrix-facebook bridge now requires a Postgres database" msgstr "" -#: ../../../CHANGELOG.md:2533 -msgid "(Compatibility Break) https://matrix.example.com/ now redirects to https://element.example.com/" +#: ../../../CHANGELOG.md:2534 +msgid "**Update from 2021-11-15**: SQLite support has been re-added to the mautrix-facebook bridge in [v0.3.2](https://github.com/mautrix/facebook/releases/tag/v0.3.2). You can ignore this changelog entry." msgstr "" -#: ../../../CHANGELOG.md:2535 -msgid "Until now, we used to serve a static page coming from Synapse at `https://matrix.example.com/`. This page was not very useful to anyone." +#: ../../../CHANGELOG.md:2536 +msgid "A new version of the [mautrix-facebook](https://github.com/tulir/mautrix-facebook) bridge has been released. It's a full rewrite of its backend and the bridge now requires Postgres. New versions of the bridge can no longer run on SQLite." msgstr "" -#: ../../../CHANGELOG.md:2537 -msgid "Since `matrix.example.com` may be accessed by regular users in certain conditions, it's probably better to redirect them to a better place (e.g. to [Element Web](docs/configuring-playbook-client-element-web.md))." +#: ../../../CHANGELOG.md:2538 +msgid "**TLDR**: if you're NOT using an [external Postgres server](docs/configuring-playbook-external-postgres.md) and have NOT forcefully kept the bridge on SQLite during [The big move to all-on-Postgres (potentially dangerous)](#the-big-move-to-all-on-postgres-potentially-dangerous), you will be automatically upgraded without manual intervention. All you need to do is send a `login` message to the Facebook bridge bot again." msgstr "" -#: ../../../CHANGELOG.md:2539 -msgid "If Element Web is installed (`matrix_client_element_enabled: true`, which it is by default), we now redirect people to it, instead of showing them a Synapse static page." +#: ../../../CHANGELOG.md:2540 +msgid "Whether this change requires your intervention depends mostly on:" msgstr "" #: ../../../CHANGELOG.md:2541 -msgid "If you'd like to control where the redirect goes, use the `matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain` variable. To restore the old behavior of not redirecting anywhere and serving the Synapse static page, set it to an empty value (`matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: \"\"`)." +msgid "whether you're using an [external Postgres server](docs/configuring-playbook-external-postgres.md). If yes, then [you need to do something](#upgrade-path-for-people-running-an-external-postgres-server)." +msgstr "" + +#: ../../../CHANGELOG.md:2542 +msgid "or whether you've force-changed the bridge's database engine to SQLite (`matrix_mautrix_facebook_database_engine: 'sqlite'` in your `vars.yml`) some time in the past (likely during [The big move to all-on-Postgres (potentially dangerous)](#the-big-move-to-all-on-postgres-potentially-dangerous))." msgstr "" #: ../../../CHANGELOG.md:2544 -msgid "2020-10-26" +msgid "As already mentioned above, you most likely don't need to do anything. If you rerun the playbook and don't get an error, you've been automatically upgraded. Just send a `login` message to the Facebook bridge bot again. Otherwise, read below for a solution." msgstr "" #: ../../../CHANGELOG.md:2546 -msgid "(Compatibility Break) /_synapse/admin is no longer publicly exposed by default" +msgid "Upgrade path for people NOT running an external Postgres server (default for the playbook)" msgstr "" #: ../../../CHANGELOG.md:2548 -msgid "We used to expose the Synapse Admin APIs publicly (at `https://matrix.example.com/_synapse/admin`). These APIs require authentication with a valid access token, so it's not that big a deal to expose them." +msgid "If you're **not running an external Postgres server**, then this bridge either already works on Postgres for you, or you've intentionally kept it back on SQLite with custom configuration (`matrix_mautrix_facebook_database_engine: 'sqlite'` in your `vars.yml`) ." msgstr "" #: ../../../CHANGELOG.md:2550 -msgid "However, following [official Synapse's reverse-proxying recommendations](https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md#synapse-administration-endpoints), we're no longer exposing `/_synapse/admin` by default." +msgid "Simply remove that custom configuration from your `vars.yml` file (if it's there) and re-run the playbook. It should upgrade you automatically. You'll need to send a `login` message to the Facebook bridge bot again." msgstr "" #: ../../../CHANGELOG.md:2552 -msgid "If you'd like to restore restore the old behavior and expose `/_synapse/admin` publicly, you can use the following configuration (in your `vars.yml`):" +msgid "Alternatively, [you can stay on SQLite for a little longer](#staying-on-sqlite-for-a-little-longer-temporary-solution)." +msgstr "" + +#: ../../../CHANGELOG.md:2554 +msgid "Upgrade path for people running an external Postgres server" +msgstr "" + +#: ../../../CHANGELOG.md:2556 +msgid "For people using the internal Postgres server (the default for the playbook):" +msgstr "" + +#: ../../../CHANGELOG.md:2557 +msgid "we automatically create an additional `matrix_mautrix_facebook` Postgres database and credentials to access it" +msgstr "" + +#: ../../../CHANGELOG.md:2558 +msgid "we automatically adjust the bridge's `matrix_mautrix_facebook_database_*` variables to point the bridge to that Postgres database" msgstr "" #: ../../../CHANGELOG.md:2559 -msgid "2020-10-02" +msgid "we use [pgloader](https://pgloader.io/) to automatically import the existing SQLite data for the bridge into the `matrix_mautrix_facebook` Postgres database" msgstr "" #: ../../../CHANGELOG.md:2561 -msgid "Minimum Ansible version raised to v2.7.0" +msgid "If you are using an [external Postgres server](docs/configuring-playbook-external-postgres.md), unfortunately we currently can't do any of that for you." msgstr "" #: ../../../CHANGELOG.md:2563 -msgid "We were claiming to support [Ansible](https://www.ansible.com/) v2.5.2 and higher, but issues like [#662](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/662) demonstrate that we need at least v2.7.0." +msgid "You have 3 ways to proceed:" msgstr "" #: ../../../CHANGELOG.md:2565 -msgid "If you've been using the playbook without getting any errors until now, you're probably on a version higher than that already (or you're not using the `matrix-ma1sd` and `matrix-client-element` roles)." +msgid "contribute to the playbook to make this possible (difficult)" +msgstr "" + +#: ../../../CHANGELOG.md:2566 +msgid "or, do the migration \"steps\" manually:" msgstr "" #: ../../../CHANGELOG.md:2567 -msgid "Our [Ansible docs page](docs/ansible.md) contains information on how to run a more up-to-date version of Ansible." +msgid "stop the bridge (`systemctl stop matrix-mautrix-facebook`)" +msgstr "" + +#: ../../../CHANGELOG.md:2568 +msgid "create a new `matrix_mautrix_facebook` Postgres database for it" +msgstr "" + +#: ../../../CHANGELOG.md:2569 +msgid "run [pgloader](https://pgloader.io/) manually (we import this bridge's data using default settings and it works well)" msgstr "" #: ../../../CHANGELOG.md:2570 -msgid "2020-10-01" +msgid "define `matrix_mautrix_facebook_database_*` variables in your `vars.yml` file (credentials, etc.) — you can find their defaults in `roles/custom/matrix-mautrix-facebook/defaults/main.yml`" +msgstr "" + +#: ../../../CHANGELOG.md:2571 +msgid "switch the bridge to Postgres (`matrix_mautrix_facebook_database_engine: 'postgres'` in your `vars.yml` file)" msgstr "" #: ../../../CHANGELOG.md:2572 -msgid "Postgres 13 support" +msgid "re-run the playbook (`--tags=setup-all,start`) and ensure the bridge works (`systemctl status matrix-mautrix-facebook` and `journalctl -fu matrix-mautrix-facebook`)" +msgstr "" + +#: ../../../CHANGELOG.md:2573 +msgid "send a `login` message to the Facebook bridge bot again" msgstr "" #: ../../../CHANGELOG.md:2574 -msgid "The playbook now installs [Postgres 13](https://www.postgresql.org/about/news/postgresql-13-released-2077/) by default." +msgid "or, [stay on SQLite for a little longer (temporary solution)](#staying-on-sqlite-for-a-little-longer-temporary-solution)" msgstr "" #: ../../../CHANGELOG.md:2576 -msgid "If you have have an existing setup, it's likely running on an older Postgres version (9.x, 10.x, 11.x or 12.x). You can easily upgrade by following the [upgrading PostgreSQL guide](docs/maintenance-postgres.md#upgrading-postgresql)." +msgid "Staying on SQLite for a little longer (temporary solution)" msgstr "" #: ../../../CHANGELOG.md:2578 -msgid "2020-09-01" +msgid "To keep using this bridge with SQLite for a little longer (**not recommended**), use the following configuration in your `vars.yml` file:" msgstr "" -#: ../../../CHANGELOG.md:2580 -msgid "matrix-registration support" -msgstr "" - -#: ../../../CHANGELOG.md:2582 -msgid "The playbook can now help you set up [matrix-registration](https://github.com/ZerataX/matrix-registration) — an application that lets you keep your Matrix server's registration private, but still allow certain users (those having a unique registration link) to register by themselves." -msgstr "" - -#: ../../../CHANGELOG.md:2584 -msgid "See our [Setting up matrix-registration](docs/configuring-playbook-matrix-registration.md) documentation page to get started." -msgstr "" - -#: ../../../CHANGELOG.md:2587 -msgid "2020-08-21" -msgstr "" - -#: ../../../CHANGELOG.md:2589 -msgid "rust-synapse-compress-state support" +#: ../../../CHANGELOG.md:2588 +msgid "If you do this, keep in mind that **you can't run this forever**. This SQLite-supporting bridge version is not getting any updates and will break sooner or later. The playbook will also drop support for SQLite at some point in the future." msgstr "" #: ../../../CHANGELOG.md:2591 -msgid "The playbook can now help you use [rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state) to compress the state groups in your Synapse database." +msgid "2021-01-17" msgstr "" #: ../../../CHANGELOG.md:2593 -msgid "See our [Compressing state with rust-synapse-compress-state](docs/maintenance-synapse.md#compressing-state-with-rust-synapse-compress-state) documentation page to get started." +msgid "matrix-corporal goes 2.0" msgstr "" -#: ../../../CHANGELOG.md:2596 -msgid "2020-07-22" +#: ../../../CHANGELOG.md:2595 +msgid "[matrix-corporal v2 has been released](https://github.com/devture/matrix-corporal/releases/tag/2.0.0) and the playbook also supports it now." msgstr "" -#: ../../../CHANGELOG.md:2598 -msgid "Synapse Admin support" +#: ../../../CHANGELOG.md:2597 +msgid "No manual intervention is required in the common case." msgstr "" -#: ../../../CHANGELOG.md:2600 -msgid "The playbook can now help you set up [synapse-admin](https://github.com/Awesome-Technologies/synapse-admin)." +#: ../../../CHANGELOG.md:2599 +msgid "The new [matrix-corporal](https://github.com/devture/matrix-corporal) version is also the first one to support Interactive Authentication. If you wish to enable that (hint: you should), you'll need to set up the [REST auth password provider](docs/configuring-playbook-rest-auth.md). There's more information in [our matrix-corporal docs](docs/configuring-playbook-matrix-corporal.md)." msgstr "" #: ../../../CHANGELOG.md:2602 -msgid "See our [Setting up Synapse Admin](docs/configuring-playbook-synapse-admin.md) documentation to get started." +msgid "2021-01-14" msgstr "" -#: ../../../CHANGELOG.md:2605 -msgid "2020-07-20" +#: ../../../CHANGELOG.md:2604 +msgid "Moving from cronjobs to systemd timers" msgstr "" -#: ../../../CHANGELOG.md:2607 -msgid "matrix-reminder-bot support" +#: ../../../CHANGELOG.md:2606 +msgid "We no longer use cronjobs for Let's Encrypt SSL renewal and `matrix-nginx-proxy`/`matrix-coturn` reloading. Instead, we've switched to systemd timers." msgstr "" -#: ../../../CHANGELOG.md:2609 -msgid "The playbook can now help you set up [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot)." +#: ../../../CHANGELOG.md:2608 +msgid "The largest benefit of this is that we no longer require you to install a cron daemon, thus simplifying our install procedure." msgstr "" -#: ../../../CHANGELOG.md:2611 -msgid "See our [Setting up matrix-reminder-bot](docs/configuring-playbook-bot-matrix-reminder-bot.md) documentation to get started." +#: ../../../CHANGELOG.md:2610 +msgid "The playbook will migrate you from cronjobs to systemd timers automatically. This is just a heads up." msgstr "" -#: ../../../CHANGELOG.md:2614 -msgid "2020-07-17" +#: ../../../CHANGELOG.md:2613 +msgid "2021-01-08" msgstr "" -#: ../../../CHANGELOG.md:2616 -msgid "(Compatibility Break) Riot is now Element" +#: ../../../CHANGELOG.md:2615 +msgid "(Breaking Change) New SSL configuration" msgstr "" -#: ../../../CHANGELOG.md:2618 -msgid "As per the official announcement, [Riot has been rebraned to Element](https://element.io/blog/welcome-to-element/)." +#: ../../../CHANGELOG.md:2617 +msgid "SSL configuration (protocols, ciphers) can now be more easily controlled thanks to us making use of configuration presets." msgstr "" -#: ../../../CHANGELOG.md:2620 -msgid "The playbook follows suit. Existing installations have a few options for how to handle this." +#: ../../../CHANGELOG.md:2619 +msgid "We define a few presets (old, intermediate, modern), following the [Mozilla SSL Configuration Generator](https://ssl-config.mozilla.org/#server=nginx)." msgstr "" -#: ../../../CHANGELOG.md:2622 -msgid "See our [Migrating to Element Web](docs/configuring-playbook-riot-web.md#migrating-to-element) documentation page for more details." +#: ../../../CHANGELOG.md:2621 +msgid "A new variable `matrix_nginx_proxy_ssl_preset` controls which preset is used (defaults to `\"intermediate\"`)." +msgstr "" + +#: ../../../CHANGELOG.md:2623 +msgid "Compared to before, this changes nginx's `ssl_prefer_server_ciphers` to `off` (used to default to `on`). It also add some more ciphers to the list, giving better performance on mobile devices, and removes some weak ciphers. More information in the [documentation](docs/configuring-playbook-nginx.md)." msgstr "" #: ../../../CHANGELOG.md:2625 -msgid "2020-07-03" -msgstr "" - -#: ../../../CHANGELOG.md:2627 -msgid "Steam bridging support via mx-puppet-steam" -msgstr "" - -#: ../../../CHANGELOG.md:2629 -msgid "Thanks to [Hugues Morisset](https://github.com/izissise)'s efforts, the playbook now supports bridging to [Steam](https://steamapp.com/) via the [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) bridge. See our [Setting up MX Puppet Steam bridging](docs/configuring-playbook-bridge-mx-puppet-steam.md) documentation page for getting started." +msgid "To revert to the old behaviour, set the following variables:" msgstr "" #: ../../../CHANGELOG.md:2632 -msgid "2020-07-01" +msgid "Just like before, you can still use your own custom protocols by specifying them in `matrix_nginx_proxy_ssl_protocols`. Doing so overrides the values coming from the preset." msgstr "" -#: ../../../CHANGELOG.md:2634 -msgid "Discord bridging support via mx-puppet-discord" +#: ../../../CHANGELOG.md:2635 +msgid "2021-01-03" msgstr "" -#: ../../../CHANGELOG.md:2636 -msgid "Thanks to [Hugues Morisset](https://github.com/izissise)'s efforts, the playbook now supports bridging to [Discord](https://discordapp.com/) via the [mx-puppet-discord](https://github.com/Sorunome/mx-puppet-discord) bridge. See our [Setting up MX Puppet Discord bridging](docs/configuring-playbook-bridge-mx-puppet-discord.md) documentation page for getting started." +#: ../../../CHANGELOG.md:2637 +msgid "Signal bridging support via mautrix-signal" msgstr "" -#: ../../../CHANGELOG.md:2638 -msgid "**Note**: this is a new Discord bridge. The playbook still retains Discord bridging via [matrix-appservice-discord](docs/configuring-playbook-bridge-appservice-discord.md). You're free too use the bridge that serves you better, or even both (for different users and use-cases)." +#: ../../../CHANGELOG.md:2639 +msgid "Thanks to [laszabine](https://github.com/laszabine)'s efforts, the playbook now supports bridging to [Signal](https://www.signal.org/) via the [mautrix-signal](https://github.com/tulir/mautrix-signal) bridge. See our [Setting up Mautrix Signal bridging](docs/configuring-playbook-bridge-mautrix-signal.md) documentation page for getting started." msgstr "" #: ../../../CHANGELOG.md:2641 -msgid "2020-06-30" +msgid "If you had installed the mautrix-signal bridge while its Pull Request was still work-in-progress, you can migrate your data to the new and final setup by referring to [this comment](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/686#issuecomment-753510789)." msgstr "" -#: ../../../CHANGELOG.md:2643 -msgid "Instagram and Twitter bridging support" +#: ../../../CHANGELOG.md:2644 +msgid "2020-12-23" msgstr "" -#: ../../../CHANGELOG.md:2645 -msgid "Thanks to [Johanna Dorothea Reichmann](https://github.com/jdreichmann)'s efforts, the playbook now supports bridging to [Instagram](https://www.instagram.com/) via the [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) bridge. See our [Setting up MX Puppet Instagram bridging](docs/configuring-playbook-bridge-mx-puppet-instagram.md) documentation page for getting started." +#: ../../../CHANGELOG.md:2646 +msgid "The big move to all-on-Postgres (potentially dangerous)" msgstr "" -#: ../../../CHANGELOG.md:2647 -msgid "Thanks to [Tulir Asokan](https://github.com/tulir)'s efforts, the playbook now supports bridging to [Twitter](https://twitter.com/) via the [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) bridge. See our [Setting up MX Puppet Twitter bridging](docs/configuring-playbook-bridge-mx-puppet-twitter.md) documentation page for getting started." +#: ../../../CHANGELOG.md:2648 +msgid "**TLDR**: all your bridges (and other services) will likely be auto-migrated from SQLite/nedb to Postgres, hopefully without trouble. You can opt-out (see how below), if too worried about breakage." msgstr "" #: ../../../CHANGELOG.md:2650 -msgid "2020-06-28" +msgid "Until now, we've only used Postgres as a database for Synapse. All other services (bridges, bots, etc.) were kept simple and used a file-based database (SQLite or nedb)." msgstr "" #: ../../../CHANGELOG.md:2652 -msgid "(Post Mortem / fixed Security Issue) Re-enabling User Directory search powered by the ma1sd Identity Server" +msgid "Since [this huge pull request](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/740), **all of our services now use Postgres by default**. Thanks to [Johanna Dorothea Reichmann](https://github.com/jdreichmann) for starting the work on it and for providing great input!" msgstr "" #: ../../../CHANGELOG.md:2654 -#: ../../../CHANGELOG.md:2683 -msgid "User Directory search requests used to go to the ma1sd identity server by default, which queried its own stores and the Synapse database." +msgid "Moving all services to Postgres brings a few **benefits** to us:" msgstr "" #: ../../../CHANGELOG.md:2656 -msgid "ma1sd's [security issue](https://github.com/ma1uta/ma1sd/issues/44) has been fixed in version `2.4.0`, with [this commit](ma1uta/ma1sd@2bb5a734d11662b06471113cf3d6b4cee5e33a85). `ma1sd 2.4.0` is now the default version for this playbook. For more information on what happened, please check the mentioned issue." +msgid "**improved performance**" +msgstr "" + +#: ../../../CHANGELOG.md:2657 +msgid "**improved compatibility**. Most bridges are deprecating SQLite/nedb support or offer less features when not on Postgres." msgstr "" #: ../../../CHANGELOG.md:2658 -msgid "We are re-enabling user directory search with this update. Those who would like to keep it disabled can use this configuration: `matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: false`" +msgid "**easier backups**. It's still some effort to take a proper backup (Postgres dump + various files, keys), but a Postgres dump now takes you much further." msgstr "" -#: ../../../CHANGELOG.md:2660 -msgid "As always, re-running the playbook is enough to get the updated bits." +#: ../../../CHANGELOG.md:2659 +msgid "we're now **more prepared to introduce other services** that need a Postgres database — [Dendrite](https://github.com/matrix-org/dendrite), the [mautrix-signal](https://github.com/tulir/mautrix-signal) bridge (existing [pull request](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/686)), etc." msgstr "" -#: ../../../CHANGELOG.md:2662 -msgid "2020-06-11" +#: ../../../CHANGELOG.md:2661 +msgid "Key takeway" msgstr "" -#: ../../../CHANGELOG.md:2664 -msgid "SMS bridging requires db reset" +#: ../../../CHANGELOG.md:2663 +msgid "existing installations that use an [external Postgres](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/configuring-playbook-external-postgres.md) server should be unaffected (they remain on SQLite/nedb for all services, except Synapse)" msgstr "" -#: ../../../CHANGELOG.md:2666 -msgid "The current version of [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) needs you to delete the database to work as expected. Just remove `/matrix/matrix-sms-bridge/database/*`. It also adds a new requried var `matrix_sms_bridge_default_region`." +#: ../../../CHANGELOG.md:2665 +msgid "for existing installations which use our integrated Postgres database server (`matrix-postgres`, which is the default), **we automatically migrate data** from SQLite/nedb to Postgres and **archive the database files** (`something.db` -> `something.db.backup`), so you can restore them if you need to go back (see how below)." msgstr "" -#: ../../../CHANGELOG.md:2668 -msgid "To reuse your existing rooms, invite `@smsbot:yourServer` to the room or write a message. You are also able to use automated room creation with telephonenumers by writing `sms send -t 01749292923 \"Hello World\"` in a room with `@smsbot:yourServer`. See [the docs](https://github.com/benkuly/matrix-sms-bridge) for more information." +#: ../../../CHANGELOG.md:2667 +msgid "Opting-out of the Postgres migration" msgstr "" -#: ../../../CHANGELOG.md:2670 -msgid "2020-06-05" +#: ../../../CHANGELOG.md:2669 +msgid "This is a **very large and somewhat untested change** (potentially dangerous), so **if you're not feeling confident/experimental, opt-out** of it for now. Still, it's the new default and what we (and various bridges) will focus on going forward, so don't stick to old ways for too long." msgstr "" -#: ../../../CHANGELOG.md:2672 -msgid "SMS bridging support" +#: ../../../CHANGELOG.md:2671 +msgid "You can remain on SQLite/nedb (at least for now) by adding a variable like this to your `vars.yml` file for each service you use: `matrix_COMPONENT_database_engine: sqlite` (e.g. `matrix_mautrix_facebook_database_engine: sqlite`)." msgstr "" -#: ../../../CHANGELOG.md:2674 -msgid "Thanks to [benkuly](https://github.com/benkuly)'s efforts, the playbook now supports bridging to SMS (with one telephone number only) via [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge)." +#: ../../../CHANGELOG.md:2673 +msgid "Some services (like `appservice-irc` and `appservice-slack`) don't use SQLite, so use `nedb`, instead of `sqlite` for them." msgstr "" -#: ../../../CHANGELOG.md:2676 -msgid "See our [Setting up Matrix SMS bridging](docs/configuring-playbook-bridge-matrix-bridge-sms.md) documentation page for getting started." +#: ../../../CHANGELOG.md:2675 +msgid "Going back to SQLite/nedb if things went wrong" +msgstr "" + +#: ../../../CHANGELOG.md:2677 +msgid "If you went with the Postgres migration and it went badly for you (some bridge not working as expected or not working at all), do this:" msgstr "" #: ../../../CHANGELOG.md:2679 -msgid "2020-05-19" +msgid "stop all services (`ansible-playbook -i inventory/hosts setup.yml --tags=stop`)" +msgstr "" + +#: ../../../CHANGELOG.md:2680 +msgid "SSH into the server and rename the old database files (`something.db.backup` -> `something.db`). Example: `mv /matrix/mautrix-facebook/data/mautrix-facebook.db.backup /matrix/mautrix-facebook/data/mautrix-facebook.db`" msgstr "" #: ../../../CHANGELOG.md:2681 -msgid "(Compatibility Break / Security Issue) Disabling User Directory search powered by the ma1sd Identity Server" +msgid "switch the affected service back to SQLite (e.g. `matrix_mautrix_facebook_database_engine: sqlite`). Some services (like `appservice-irc` and `appservice-slack`) don't use SQLite, so use `nedb`, instead of `sqlite` for them." +msgstr "" + +#: ../../../CHANGELOG.md:2682 +msgid "re-run the playbook (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`)" +msgstr "" + +#: ../../../CHANGELOG.md:2683 +msgid "[get in touch](README.md#support) with us" msgstr "" #: ../../../CHANGELOG.md:2685 -msgid "ma1sd current has [a security issue](https://github.com/ma1uta/ma1sd/issues/44), which made it leak information about all users — including users created by bridges, etc." +msgid "2020-12-11" msgstr "" #: ../../../CHANGELOG.md:2687 -msgid "Until the issue gets fixed, we're making User Directory search not go to ma1sd by default. You **need to re-run the playbook and restart services to apply this workaround**." +msgid "synapse-janitor support removed" msgstr "" #: ../../../CHANGELOG.md:2689 -msgid "*If you insist on restoring the old behavior* (**which has a security issue!**), you *might* use this configuration: `matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: \"{{ matrix_ma1sd_enabled }}\"`" +msgid "We've removed support for the unmaintained [synapse-janitor](https://github.com/xwiki-labs/synapse_scripts) script. There's been past reports of it corrupting the Synapse database. Since there hasn't been any new development on it and it doesn't seem too useful nowadays, there's no point in including it in the playbook." msgstr "" -#: ../../../CHANGELOG.md:2692 -msgid "2020-04-28" +#: ../../../CHANGELOG.md:2691 +msgid "If you need to clean up or compact your database, consider using the Synapse Admin APIs directly. See our [Synapse maintenance](docs/maintenance-synapse.md) and [Postgres maintenance](docs/maintenance-postgres.md) documentation pages for more details." msgstr "" -#: ../../../CHANGELOG.md:2694 -msgid "Newer IRC bridge (with potential breaking change)" +#: ../../../CHANGELOG.md:2693 +msgid "Docker 20.10 is here" msgstr "" -#: ../../../CHANGELOG.md:2696 -msgid "This upgrades matrix-appservice-irc from 0.14.1 to 0.16.0. Upstream made a change to how you define manual mappings. If you added a `mapping` to your configuration, you will need to update it accoring to the [upstream instructions](https://github.com/matrix-org/matrix-appservice-irc/blob/master/CHANGELOG.md#0150-2020-02-05). If you did not include `mappings` in your configuration for IRC, no change is necessary. `mappings` is not part of the default configuration." +#: ../../../CHANGELOG.md:2695 +msgid "(No need to do anything special in relation to this. Just something to keep in mind)" msgstr "" -#: ../../../CHANGELOG.md:2705 -msgid "2020-04-23" +#: ../../../CHANGELOG.md:2697 +msgid "Docker 20.10 got released recently and your server will likely get it the next time you update." msgstr "" -#: ../../../CHANGELOG.md:2707 -#: ../../../CHANGELOG.md:2938 -msgid "Slack bridging support" +#: ../../../CHANGELOG.md:2699 +msgid "This is the first major Docker update in a long time and it packs a lot of changes. Some of them introduced some breakage for us initially (see [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/d08b27784f222effcbce2abf924bf07bbe0893be) and [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/7593d969e316cc0144bce378a5be58c76c2c37ee)), but it should be all good now." msgstr "" -#: ../../../CHANGELOG.md:2709 -msgid "Thanks to [Rodrigo Belem](https://github.com/rbelem)'s efforts, the playbook now supports bridging to [Slack](https://slack.com) via the [mx-puppet-slack](https://github.com/Sorunome/mx-puppet-slack) bridge." +#: ../../../CHANGELOG.md:2702 +msgid "2020-12-08" msgstr "" -#: ../../../CHANGELOG.md:2711 -msgid "See our [Setting up MX Puppet Slack bridging](docs/configuring-playbook-bridge-mx-puppet-slack.md) documentation page for getting started." +#: ../../../CHANGELOG.md:2704 +msgid "openid APIs exposed by default on the federation port when federation disabled" msgstr "" -#: ../../../CHANGELOG.md:2714 -msgid "2020-04-09" +#: ../../../CHANGELOG.md:2706 +msgid "We've changed some defaults. People running with our default configuration (federation enabled), are not affected at all." msgstr "" -#: ../../../CHANGELOG.md:2716 -msgid "Skype bridging support" +#: ../../../CHANGELOG.md:2708 +msgid "If you are running an unfederated server (`matrix_synapse_federation_enabled: false`), this may be of interest to you." msgstr "" -#: ../../../CHANGELOG.md:2718 -msgid "Thanks to [Rodrigo Belem](https://github.com/rbelem)'s efforts, the playbook now supports bridging to [Skype](https://www.skype.com) via the [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype) bridge." +#: ../../../CHANGELOG.md:2710 +msgid "When federation is disabled, but ma1sd or Dimension are enabled, we'll now expose the `openid` APIs on the federation port. These APIs are necessary for some ma1sd features to work. If you'd like to prevent this, you can: `matrix_synapse_federation_port_openid_resource_required: false`." msgstr "" -#: ../../../CHANGELOG.md:2720 -msgid "See our [Setting up MX Puppet Skype bridging](docs/configuring-playbook-bridge-mx-puppet-skype.md) documentation page for getting started." +#: ../../../CHANGELOG.md:2713 +msgid "2020-11-27" +msgstr "" + +#: ../../../CHANGELOG.md:2715 +msgid "Recent Jitsi updates may require configuration changes" +msgstr "" + +#: ../../../CHANGELOG.md:2717 +msgid "We've recently [updated from Jitsi build 4857 to build 5142](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/719), which brings a lot of configuration changes." +msgstr "" + +#: ../../../CHANGELOG.md:2719 +msgid "**If you use our default Jitsi settings, you won't have to do anything.**" +msgstr "" + +#: ../../../CHANGELOG.md:2721 +msgid "People who have [fine-tuned Jitsi](docs/configuring-playbook-jitsi.md#optional-fine-tune-jitsi) may find that some options got renamed now, others are gone and yet others still need to be defined in another way." msgstr "" #: ../../../CHANGELOG.md:2723 -msgid "2020-04-05" +msgid "The next time you run the playbook [installation](docs/installing.md) command, our validation logic will tell you if you're using some variables like that and will recommend a migration path for each one." msgstr "" #: ../../../CHANGELOG.md:2725 -msgid "Private Jitsi support" +msgid "Additionally, we've recently disabled transcriptions (`jitsi_enable_transcriptions: false`) and recording (`jitsi_enable_recording: false`) by default. These features did not work anyway, because we don't install the required dependencies for them (Jigasi and Jibri, respectively). If you've been somehow pointing your Jitsi installation to some manually installed Jigasi/Jibri service, you may need to toggle these flags back to enabled to have transcriptions and recordings working." msgstr "" -#: ../../../CHANGELOG.md:2727 -msgid "The [Jitsi support](#jitsi-support) we had landed a few weeks ago was working well, but it was always open to the whole world." +#: ../../../CHANGELOG.md:2728 +msgid "2020-11-23" msgstr "" -#: ../../../CHANGELOG.md:2729 -msgid "Running such an open instance is not desirable to most people, so [teutat3s](https://github.com/teutat3s) has contributed support for making Jitsi use authentication." +#: ../../../CHANGELOG.md:2730 +#: ../../../CHANGELOG.md:2738 +msgid "Breaking change matrix-sms-bridge" msgstr "" -#: ../../../CHANGELOG.md:2731 -msgid "To make your Jitsi server more private, see the [configure internal Jitsi authentication and guests mode](docs/configuring-playbook-jitsi.md#optional-configure-internal-jitsi-authentication-and-guests-mode) section in our Jitsi documentation." +#: ../../../CHANGELOG.md:2732 +msgid "Because of many problems using gammu as SMS provider, matrix-sms-bridge now uses (https://github.com/RebekkaMa/android-sms-gateway-server) by default. See (the docs)[./docs/configuring-playbook-bridge-matrix-bridge-sms.md] which new vars you need to add." msgstr "" #: ../../../CHANGELOG.md:2734 -msgid "2020-04-03" +msgid "If you are using this playbook to deploy matrix-sms-bridge and still really want to use gammu as SMS provider, we could possibly add support for both android-sms-gateway-server and gammu." msgstr "" #: ../../../CHANGELOG.md:2736 -msgid "(Potential Backward Compatibility Break) ma1sd replaces mxisd" -msgstr "" - -#: ../../../CHANGELOG.md:2738 -msgid "Thanks to [Marcel Partap](https://github.com/eMPee584)'s efforts, the [mxisd](https://github.com/kamax-io/mxisd) identity server, which has been deprecated for a long time, has finally been replaced by [ma1sd](https://github.com/ma1uta/ma1sd), a compatible fork." +msgid "2020-11-13" msgstr "" #: ../../../CHANGELOG.md:2740 -msgid "**If you're using the default playbook configuration**, you don't need to do anything — your mxisd installation will be replaced with ma1sd and all existing data will be migrated automatically the next time you run the playbook." +msgid "The new version of [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) changed its database from neo4j to h2. You need to sync the bridge at the first start. Note that this only will sync rooms where the @smsbot:yourServer is member. For rooms without @smsbot:yourServer you need to kick and invite the telephone number **or** invite @smsbot:yourServer." msgstr "" #: ../../../CHANGELOG.md:2742 -msgid "**If you're doing something more special** (defining custom `matrix_mxisd_*` variables), the playbook will ask you to rename them to `matrix_ma1sd_*`. You're also encouraged to test that ma1sd works well for such a more custom setup." +msgid "Add the following to your `vars.yml` file: `matrix_sms_bridge_container_extra_arguments=['--env SPRING_PROFILES_ACTIVE=initialsync']`" +msgstr "" + +#: ../../../CHANGELOG.md:2743 +msgid "Login to your host shell and remove old systemd file from your host: `rm /etc/systemd/system/matrix-sms-bridge-database.service`" +msgstr "" + +#: ../../../CHANGELOG.md:2744 +msgid "Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-matrix-sms-bridge,start`" msgstr "" #: ../../../CHANGELOG.md:2745 -msgid "2020-03-29" +msgid "Login to your host shell and check the logs with `journalctl -u matrix-sms-bridge` until the sync finished." +msgstr "" + +#: ../../../CHANGELOG.md:2746 +msgid "Remove the var from the first step." msgstr "" #: ../../../CHANGELOG.md:2747 -msgid "Archlinux support" +msgid "Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`." msgstr "" #: ../../../CHANGELOG.md:2749 -msgid "Thanks to [Christian Lupus](https://github.com/christianlupus)'s efforts, the playbook now supports installing to an [Archlinux](https://www.archlinux.org/) server." +msgid "2020-11-10" msgstr "" -#: ../../../CHANGELOG.md:2752 -msgid "2020-03-24" +#: ../../../CHANGELOG.md:2751 +msgid "Dynamic DNS support" msgstr "" -#: ../../../CHANGELOG.md:2754 -msgid "Jitsi support" +#: ../../../CHANGELOG.md:2753 +msgid "Thanks to [Scott Crossen](https://github.com/scottcrossen), the playbook can now manage Dynamic DNS for you using [ddclient](https://ddclient.net/)." msgstr "" -#: ../../../CHANGELOG.md:2756 -msgid "The playbook can now (optionally) install the [Jitsi](https://jitsi.org/) video-conferencing platform and integrate it with [Riot](docs/configuring-playbook-riot-web.md)." +#: ../../../CHANGELOG.md:2755 +msgid "To learn more, follow our [Dynamic DNS docs page](docs/configuring-playbook-dynamic-dns.md)." msgstr "" #: ../../../CHANGELOG.md:2758 -msgid "See our [Jitsi documentation page](docs/configuring-playbook-jitsi.md) to get started." +msgid "2020-10-28" msgstr "" -#: ../../../CHANGELOG.md:2761 -msgid "2020-03-15" +#: ../../../CHANGELOG.md:2760 +msgid "(Compatibility Break) https://matrix.example.com/ now redirects to https://element.example.com/" msgstr "" -#: ../../../CHANGELOG.md:2763 -msgid "Raspberry Pi support" +#: ../../../CHANGELOG.md:2762 +msgid "Until now, we used to serve a static page coming from Synapse at `https://matrix.example.com/`. This page was not very useful to anyone." msgstr "" -#: ../../../CHANGELOG.md:2765 -msgid "Thanks to [Gergely Horváth](https://github.com/hooger)'s effort, the playbook supports installing to a Raspberry Pi server, for at least some of the services." +#: ../../../CHANGELOG.md:2764 +msgid "Since `matrix.example.com` may be accessed by regular users in certain conditions, it's probably better to redirect them to a better place (e.g. to [Element Web](docs/configuring-playbook-client-element-web.md))." msgstr "" -#: ../../../CHANGELOG.md:2767 -msgid "Since most ready-made container images do not support that architecture, we achieve this by building images locally on the device itself. See our [Self-building documentation page](docs/self-building.md) for how to get started." +#: ../../../CHANGELOG.md:2766 +msgid "If Element Web is installed (`matrix_client_element_enabled: true`, which it is by default), we now redirect people to it, instead of showing them a Synapse static page." msgstr "" -#: ../../../CHANGELOG.md:2770 -msgid "2020-02-26" +#: ../../../CHANGELOG.md:2768 +msgid "If you'd like to control where the redirect goes, use the `matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain` variable. To restore the old behavior of not redirecting anywhere and serving the Synapse static page, set it to an empty value (`matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain: \"\"`)." msgstr "" -#: ../../../CHANGELOG.md:2772 -msgid "Riot-web themes are here" +#: ../../../CHANGELOG.md:2771 +msgid "2020-10-26" msgstr "" -#: ../../../CHANGELOG.md:2774 -msgid "The playbook now makes it easy to install custom riot-web themes." +#: ../../../CHANGELOG.md:2773 +msgid "(Compatibility Break) /_synapse/admin is no longer publicly exposed by default" msgstr "" -#: ../../../CHANGELOG.md:2776 -msgid "To learn more, take a look at our [riot-web documentation on Themes](docs/configuring-playbook-riot-web.md#themes)." +#: ../../../CHANGELOG.md:2775 +msgid "We used to expose the Synapse Admin APIs publicly (at `https://matrix.example.com/_synapse/admin`). These APIs require authentication with a valid access token, so it's not that big a deal to expose them." +msgstr "" + +#: ../../../CHANGELOG.md:2777 +msgid "However, following [official Synapse's reverse-proxying recommendations](https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md#synapse-administration-endpoints), we're no longer exposing `/_synapse/admin` by default." msgstr "" #: ../../../CHANGELOG.md:2779 -msgid "2020-02-24" +msgid "If you'd like to restore restore the old behavior and expose `/_synapse/admin` publicly, you can use the following configuration (in your `vars.yml`):" msgstr "" -#: ../../../CHANGELOG.md:2781 -msgid "Customize the server name in Riot's login page" +#: ../../../CHANGELOG.md:2786 +msgid "2020-10-02" msgstr "" -#: ../../../CHANGELOG.md:2783 -msgid "You can now customize the server name string that Riot-web displays in its login page." +#: ../../../CHANGELOG.md:2788 +msgid "Minimum Ansible version raised to v2.7.0" msgstr "" -#: ../../../CHANGELOG.md:2785 -msgid "These playbook variables, with these default values, have been added:" +#: ../../../CHANGELOG.md:2790 +msgid "We were claiming to support [Ansible](https://www.ansible.com/) v2.5.2 and higher, but issues like [#662](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/662) demonstrate that we need at least v2.7.0." msgstr "" -#: ../../../CHANGELOG.md:2791 -msgid "The login page previously said \"Sign in to your Matrix account on matrix.example.org\" (the homeserver's domain name). It will now say \"Sign in … on example.org\" (the server name) by default, or \"Sign in … on Our Server\" if you set the variable to \"Our Server\"." +#: ../../../CHANGELOG.md:2792 +msgid "If you've been using the playbook without getting any errors until now, you're probably on a version higher than that already (or you're not using the `matrix-ma1sd` and `matrix-client-element` roles)." msgstr "" -#: ../../../CHANGELOG.md:2793 -msgid "To support this, the config.json template is changed to use the configuration key `default_server_config` for setting the default HS/IS, and the new configuration key `server_name` is added in there." +#: ../../../CHANGELOG.md:2794 +msgid "Our [Ansible docs page](docs/ansible.md) contains information on how to run a more up-to-date version of Ansible." msgstr "" -#: ../../../CHANGELOG.md:2796 -msgid "2020-01-30" +#: ../../../CHANGELOG.md:2797 +msgid "2020-10-01" msgstr "" -#: ../../../CHANGELOG.md:2798 -msgid "Disabling TLSv1.1" +#: ../../../CHANGELOG.md:2799 +msgid "Postgres 13 support" msgstr "" -#: ../../../CHANGELOG.md:2800 -msgid "To improve security, we've removed TLSv1.1 support from our default matrix-nginx-proxy configuration." +#: ../../../CHANGELOG.md:2801 +msgid "The playbook now installs [Postgres 13](https://www.postgresql.org/about/news/postgresql-13-released-2077/) by default." msgstr "" -#: ../../../CHANGELOG.md:2802 -msgid "If you need to support old clients, you can re-enable it with the following configuration: `matrix_nginx_proxy_ssl_protocols: \"TLSv1.1 TLSv1.2 TLSv1.3\"`" +#: ../../../CHANGELOG.md:2803 +msgid "If you have have an existing setup, it's likely running on an older Postgres version (9.x, 10.x, 11.x or 12.x). You can easily upgrade by following the [upgrading PostgreSQL guide](docs/maintenance-postgres.md#upgrading-postgresql)." msgstr "" #: ../../../CHANGELOG.md:2805 -msgid "2020-01-21" +msgid "2020-09-01" msgstr "" #: ../../../CHANGELOG.md:2807 -msgid "Postgres collation changes (action required!)" +msgid "matrix-registration support" msgstr "" #: ../../../CHANGELOG.md:2809 -msgid "By default, we've been using a UTF-8 collation for Postgres. This is known to cause Synapse some troubles (see the [relevant issue](https://github.com/matrix-org/synapse/issues/6722)) on systems that use [glibc](https://www.gnu.org/software/libc/). We run Postgres in an [Alpine Linux](https://alpinelinux.org/) container (which uses [musl](https://www.musl-libc.org/), and not glibc), so our users are likely not affected by the index corruption problem observed by others." +msgid "The playbook can now help you set up [matrix-registration](https://github.com/ZerataX/matrix-registration) — an application that lets you keep your Matrix server's registration private, but still allow certain users (those having a unique registration link) to register by themselves." msgstr "" #: ../../../CHANGELOG.md:2811 -msgid "Still, we might become affected in the future. In any case, it's imminent that Synapse will complain about databases which do not use a C collation." +msgid "See our [Setting up matrix-registration](docs/configuring-playbook-matrix-registration.md) documentation page to get started." msgstr "" -#: ../../../CHANGELOG.md:2813 -msgid "To avoid future problems, we recommend that you run the following command:" +#: ../../../CHANGELOG.md:2814 +msgid "2020-08-21" msgstr "" -#: ../../../CHANGELOG.md:2819 -msgid "It forces a [Postgres database upgrade](docs/maintenance-postgres.md#upgrading-postgresql), which would recreate your Postgres database using the proper (`C`) collation. If you are low on disk space, or run into trouble, refer to the Postgres database upgrade documentation page." +#: ../../../CHANGELOG.md:2816 +msgid "rust-synapse-compress-state support" msgstr "" -#: ../../../CHANGELOG.md:2822 -msgid "2020-01-14" +#: ../../../CHANGELOG.md:2818 +msgid "The playbook can now help you use [rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state) to compress the state groups in your Synapse database." msgstr "" -#: ../../../CHANGELOG.md:2824 -msgid "Added support for Appservice Webhooks" +#: ../../../CHANGELOG.md:2820 +msgid "See our [Compressing state with rust-synapse-compress-state](docs/maintenance-synapse.md#compressing-state-with-rust-synapse-compress-state) documentation page to get started." msgstr "" -#: ../../../CHANGELOG.md:2826 -msgid "Thanks to a contribution from [Björn Marten](https://github.com/tripleawwy) from [netresearch](https://www.netresearch.de/), the playbook can now install and configure [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) for you. This bridge provides support for Slack-compatible webhooks." +#: ../../../CHANGELOG.md:2823 +msgid "2020-07-22" msgstr "" -#: ../../../CHANGELOG.md:2828 -msgid "Learn more in [Setting up Appservice Webhooks bridging](docs/configuring-playbook-bridge-appservice-webhooks.md)." +#: ../../../CHANGELOG.md:2825 +msgid "Synapse Admin support" msgstr "" -#: ../../../CHANGELOG.md:2831 -msgid "2020-01-12" +#: ../../../CHANGELOG.md:2827 +msgid "The playbook can now help you set up [synapse-admin](https://github.com/Awesome-Technologies/synapse-admin)." msgstr "" -#: ../../../CHANGELOG.md:2833 -msgid "Added support for automatic Double Puppeting for all Mautrix bridges" +#: ../../../CHANGELOG.md:2829 +msgid "See our [Setting up Synapse Admin](docs/configuring-playbook-synapse-admin.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:2835 -msgid "Double Puppeting can now be easily enabled for all Mautrix bridges supported by the playbook (Facebook, Hangouts, Whatsapp, Telegram)." +#: ../../../CHANGELOG.md:2832 +msgid "2020-07-20" msgstr "" -#: ../../../CHANGELOG.md:2837 -msgid "This is possible due to those bridges' integration with [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) — yet another component that this playbook can install for you." +#: ../../../CHANGELOG.md:2834 +msgid "matrix-reminder-bot support" msgstr "" -#: ../../../CHANGELOG.md:2839 -msgid "To get started, following the playbook's documentation for the bridge you'd like to configure." +#: ../../../CHANGELOG.md:2836 +msgid "The playbook can now help you set up [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot)." msgstr "" -#: ../../../CHANGELOG.md:2842 -msgid "2019-12-06" +#: ../../../CHANGELOG.md:2838 +msgid "See our [Setting up matrix-reminder-bot](docs/configuring-playbook-bot-matrix-reminder-bot.md) documentation to get started." msgstr "" -#: ../../../CHANGELOG.md:2844 -msgid "Added support for an alternative method for using another webserver" +#: ../../../CHANGELOG.md:2841 +msgid "2020-07-17" msgstr "" -#: ../../../CHANGELOG.md:2846 -msgid "We have added support for making `matrix-nginx-proxy` not being so invasive, so that it would be easier to [use your own webserver](docs/configuring-playbook-own-webserver.md)." +#: ../../../CHANGELOG.md:2843 +msgid "(Compatibility Break) Riot is now Element" msgstr "" -#: ../../../CHANGELOG.md:2848 -msgid "The documentation has been updated with a **Method 2**, which might make \"own webserver\" setup easier in some cases (such as [reverse-proxying using Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/296))." +#: ../../../CHANGELOG.md:2845 +msgid "As per the official announcement, [Riot has been rebraned to Element](https://element.io/blog/welcome-to-element/)." msgstr "" -#: ../../../CHANGELOG.md:2850 -msgid "**Existing users** are not affected by this and **don't need to change anything**. The defaults are still the same (`matrix-nginx-proxy` obtaining SSL certificates and doing everything for you automatically)." +#: ../../../CHANGELOG.md:2847 +msgid "The playbook follows suit. Existing installations have a few options for how to handle this." msgstr "" -#: ../../../CHANGELOG.md:2853 -msgid "2019-11-10" +#: ../../../CHANGELOG.md:2849 +msgid "See our [Migrating to Element Web](docs/configuring-playbook-riot-web.md#migrating-to-element) documentation page for more details." msgstr "" -#: ../../../CHANGELOG.md:2855 -msgid "Tightened security around room directory publishing" +#: ../../../CHANGELOG.md:2852 +msgid "2020-07-03" msgstr "" -#: ../../../CHANGELOG.md:2857 -msgid "As per this [advisory blog post](https://matrix.org/blog/2019/11/09/avoiding-unwelcome-visitors-on-private-matrix-servers), we've decided to change the default publishing rules for the Matrix room directory." +#: ../../../CHANGELOG.md:2854 +msgid "Steam bridging support via mx-puppet-steam" +msgstr "" + +#: ../../../CHANGELOG.md:2856 +msgid "Thanks to [Hugues Morisset](https://github.com/izissise)'s efforts, the playbook now supports bridging to [Steam](https://steamapp.com/) via the [mx-puppet-steam](https://codeberg.org/icewind/mx-puppet-steam) bridge. See our [Setting up MX Puppet Steam bridging](docs/configuring-playbook-bridge-mx-puppet-steam.md) documentation page for getting started." msgstr "" #: ../../../CHANGELOG.md:2859 -msgid "Our general goal is to favor privacy and security when running personal (family & friends) and corporate homeservers. Both of these likely benefit from having a more secure default of **not showing the room directory without authentication** and **not publishing the room directory over federation**." +msgid "2020-07-01" msgstr "" #: ../../../CHANGELOG.md:2861 -msgid "As with anything else, these new defaults can be overriden by changing the `matrix_synapse_allow_public_rooms_without_auth` and `matrix_synapse_allow_public_rooms_over_federation` variables, respectively." +msgid "Discord bridging support via mx-puppet-discord" msgstr "" -#: ../../../CHANGELOG.md:2864 -msgid "2019-10-05" +#: ../../../CHANGELOG.md:2863 +msgid "Thanks to [Hugues Morisset](https://github.com/izissise)'s efforts, the playbook now supports bridging to [Discord](https://discordapp.com/) via the [mx-puppet-discord](https://github.com/Sorunome/mx-puppet-discord) bridge. See our [Setting up MX Puppet Discord bridging](docs/configuring-playbook-bridge-mx-puppet-discord.md) documentation page for getting started." msgstr "" -#: ../../../CHANGELOG.md:2866 -msgid "Improved Postgres upgrading/importing" +#: ../../../CHANGELOG.md:2865 +msgid "**Note**: this is a new Discord bridge. The playbook still retains Discord bridging via [matrix-appservice-discord](docs/configuring-playbook-bridge-appservice-discord.md). You're free too use the bridge that serves you better, or even both (for different users and use-cases)." msgstr "" #: ../../../CHANGELOG.md:2868 -msgid "Postgres [upgrading](docs/maintenance-postgres.md#upgrading-postgresql) and [importing](docs/importing-postgres.md) have been improved to add support for multiple databases and roles." +msgid "2020-06-30" msgstr "" #: ../../../CHANGELOG.md:2870 -msgid "Previously, the playbook would only take care of the `homeserver` database and `synapse` user. We now back up and restore all databases and users on the Postgres server." +msgid "Instagram and Twitter bridging support" msgstr "" #: ../../../CHANGELOG.md:2872 -msgid "For now, the playbook only uses that one database (`homeserver`) and that one single user (`synapse`), so it's all the same. However, in the future, additional components besides Synapse may also make use the Postgres database server. One such example is the [matrix-appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) bridge, which strongly encourages use of Postgres in its v1.0 release. We are yet to upgrade to it." +msgid "Thanks to [Johanna Dorothea Reichmann](https://github.com/jdreichmann)'s efforts, the playbook now supports bridging to [Instagram](https://www.instagram.com/) via the [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) bridge. See our [Setting up MX Puppet Instagram bridging](docs/configuring-playbook-bridge-mx-puppet-instagram.md) documentation page for getting started." msgstr "" #: ../../../CHANGELOG.md:2874 -msgid "Additionally, Postgres [upgrading](docs/maintenance-postgres.md#upgrading-postgresql) now uses gzipped dump files by default, to minimize disk space usage." +msgid "Thanks to [Tulir Asokan](https://github.com/tulir)'s efforts, the playbook now supports bridging to [Twitter](https://twitter.com/) via the [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) bridge. See our [Setting up MX Puppet Twitter bridging](docs/configuring-playbook-bridge-mx-puppet-twitter.md) documentation page for getting started." msgstr "" #: ../../../CHANGELOG.md:2877 -msgid "2019-10-04" +msgid "2020-06-28" msgstr "" #: ../../../CHANGELOG.md:2879 -msgid "Postgres 12 support" +msgid "(Post Mortem / fixed Security Issue) Re-enabling User Directory search powered by the ma1sd Identity Server" msgstr "" #: ../../../CHANGELOG.md:2881 -msgid "The playbook now installs [Postgres 12](https://www.postgresql.org/about/news/1976/) by default." +#: ../../../CHANGELOG.md:2910 +msgid "User Directory search requests used to go to the ma1sd identity server by default, which queried its own stores and the Synapse database." msgstr "" #: ../../../CHANGELOG.md:2883 -msgid "If you have have an existing setup, it's likely running on an older Postgres version (9.x, 10.x or 11.x). You can easily upgrade by following the [upgrading PostgreSQL guide](docs/maintenance-postgres.md#upgrading-postgresql)." +msgid "ma1sd's [security issue](https://github.com/ma1uta/ma1sd/issues/44) has been fixed in version `2.4.0`, with [this commit](ma1uta/ma1sd@2bb5a734d11662b06471113cf3d6b4cee5e33a85). `ma1sd 2.4.0` is now the default version for this playbook. For more information on what happened, please check the mentioned issue." msgstr "" -#: ../../../CHANGELOG.md:2886 -msgid "2019-10-03" +#: ../../../CHANGELOG.md:2885 +msgid "We are re-enabling user directory search with this update. Those who would like to keep it disabled can use this configuration: `matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: false`" msgstr "" -#: ../../../CHANGELOG.md:2888 -msgid "Synapse 1.4.0" +#: ../../../CHANGELOG.md:2887 +msgid "As always, re-running the playbook is enough to get the updated bits." msgstr "" -#: ../../../CHANGELOG.md:2890 -msgid "Synapse 1.4.0 [is out](https://matrix.org/blog/2019/10/03/synapse-1-4-0-released) with lots of changes related to privacy." +#: ../../../CHANGELOG.md:2889 +msgid "2020-06-11" msgstr "" -#: ../../../CHANGELOG.md:2892 -msgid "Its new defaults (which we adopt as well) mean that certain old data will automatically get purged after a certain number of days. 1.4.0 automatically garbage collects redacted messages (defaults to 7 days) and removes unused IP and user agent information stored in the user_ips table (defaults to 30 days). If you'd like to preserve this data, we encourage you to look at the `redaction_retention_period` and `user_ips_max_age` options (controllable by the `matrix_synapse_redaction_retention_period` and `matrix_synapse_user_ips_max_age` playbook variables, respectively) before doing the upgrade. If you'd like to keep data indefinitely, set these variables to `null` (e.g. `matrix_synapse_redaction_retention_period: ~`)." +#: ../../../CHANGELOG.md:2891 +msgid "SMS bridging requires db reset" msgstr "" -#: ../../../CHANGELOG.md:2894 -msgid "From now on the `trusted_key_servers` setting for Synapse is configurable. It still defaults to `matrix.org` just like it always has, but in a more explicit way now. If you'd like to use another trusted key server, adjust the `matrix_synapse_trusted_key_servers` playbook variable." +#: ../../../CHANGELOG.md:2893 +msgid "The current version of [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) needs you to delete the database to work as expected. Just remove `/matrix/matrix-sms-bridge/database/*`. It also adds a new required var `matrix_sms_bridge_default_region`." msgstr "" -#: ../../../CHANGELOG.md:2896 -msgid "Synapse 1.4.0 also changes lots of things related to identity server integration. Because Synapse will now by default be responsible for validating email addresses for user accounts, running without an identity server looks more feasible. We still [have concerns](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/275/files#r331104117) over disabling the identity server by default, so for now it remains enabled." +#: ../../../CHANGELOG.md:2895 +msgid "To reuse your existing rooms, invite `@smsbot:yourServer` to the room or write a message. You are also able to use automated room creation with telephonenumers by writing `sms send -t 01749292923 \"Hello World\"` in a room with `@smsbot:yourServer`. See [the docs](https://github.com/benkuly/matrix-sms-bridge) for more information." +msgstr "" + +#: ../../../CHANGELOG.md:2897 +msgid "2020-06-05" msgstr "" #: ../../../CHANGELOG.md:2899 -msgid "2019-09-09" +msgid "SMS bridging support" msgstr "" #: ../../../CHANGELOG.md:2901 -msgid "Synapse Simple Antispam support" +msgid "Thanks to [benkuly](https://github.com/benkuly)'s efforts, the playbook now supports bridging to SMS (with one telephone number only) via [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge)." msgstr "" #: ../../../CHANGELOG.md:2903 -msgid "There have been lots of invite-spam attacks lately and [Travis](https://github.com/t2bot) has created a Synapse module ([synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam)) to let people protect themselves." +msgid "See our [Setting up Matrix SMS bridging](docs/configuring-playbook-bridge-matrix-bridge-sms.md) documentation page for getting started." msgstr "" -#: ../../../CHANGELOG.md:2905 -msgid "From now on, you can easily install and configure this spam checker module through the playbook." +#: ../../../CHANGELOG.md:2906 +msgid "2020-05-19" msgstr "" -#: ../../../CHANGELOG.md:2907 -msgid "Learn more in [Setting up Synapse Simple Antispam](docs/configuring-playbook-synapse-simple-antispam.md)." -msgstr "" - -#: ../../../CHANGELOG.md:2910 -msgid "2019-08-25" +#: ../../../CHANGELOG.md:2908 +msgid "(Compatibility Break / Security Issue) Disabling User Directory search powered by the ma1sd Identity Server" msgstr "" #: ../../../CHANGELOG.md:2912 -msgid "Extensible Riot-web configuration" +msgid "ma1sd current has [a security issue](https://github.com/ma1uta/ma1sd/issues/44), which made it leak information about all users — including users created by bridges, etc." msgstr "" #: ../../../CHANGELOG.md:2914 -msgid "Similarly to [Extensible Synapse configuration](#extensible-synapse-configuration) (below), Riot-web configuration is also extensible now." +msgid "Until the issue gets fixed, we're making User Directory search not go to ma1sd by default. You **need to re-run the playbook and restart services to apply this workaround**." msgstr "" #: ../../../CHANGELOG.md:2916 -msgid "From now on, you can extend/override Riot-web's configuration by making use of the `matrix_riot_web_configuration_extension_json` variable. This should be enough for most customization needs." +msgid "*If you insist on restoring the old behavior* (**which has a security issue!**), you *might* use this configuration: `matrix_nginx_proxy_proxy_matrix_user_directory_search_enabled: \"{{ matrix_ma1sd_enabled }}\"`" msgstr "" -#: ../../../CHANGELOG.md:2918 -msgid "If you need even more power, you can now also take full control and override `matrix_riot_web_configuration_default` (or `matrix_riot_web_configuration`) directly." +#: ../../../CHANGELOG.md:2919 +msgid "2020-04-28" msgstr "" -#: ../../../CHANGELOG.md:2920 -msgid "Learn more in [Configuring Riot-web](docs/configuring-playbook-riot-web.md)." +#: ../../../CHANGELOG.md:2921 +msgid "Newer IRC bridge (with potential breaking change)" msgstr "" #: ../../../CHANGELOG.md:2923 -msgid "2019-08-22" +msgid "This upgrades matrix-appservice-irc from 0.14.1 to 0.16.0. Upstream made a change to how you define manual mappings. If you added a `mapping` to your configuration, you will need to update it according to the [upstream instructions](https://github.com/matrix-org/matrix-appservice-irc/blob/master/CHANGELOG.md#0150-2020-02-05). If you did not include `mappings` in your configuration for IRC, no change is necessary. `mappings` is not part of the default configuration." msgstr "" -#: ../../../CHANGELOG.md:2925 -msgid "Extensible Synapse configuration" +#: ../../../CHANGELOG.md:2932 +msgid "2020-04-23" msgstr "" -#: ../../../CHANGELOG.md:2927 -msgid "Previously, we had to create custom Ansible variables for each and every Synapse setting. This lead to too much effort (and configuration ugliness) to all of Synapse's settings, so naturally, not all features of Synapse could be controlled through the playbook." -msgstr "" - -#: ../../../CHANGELOG.md:2929 -msgid "From now on, you can extend/override the Synapse server's configuration by making use of the `matrix_synapse_configuration_extension_yaml` variable. This should be enough for most customization needs." -msgstr "" - -#: ../../../CHANGELOG.md:2931 -msgid "If you need even more power, you can now also take full control and override `matrix_synapse_configuration` (or `matrix_synapse_configuration_yaml`) directly." -msgstr "" - -#: ../../../CHANGELOG.md:2933 -msgid "Learn more here in [Configuring Synapse](docs/configuring-playbook-synapse.md)." +#: ../../../CHANGELOG.md:2934 +#: ../../../CHANGELOG.md:3165 +msgid "Slack bridging support" msgstr "" #: ../../../CHANGELOG.md:2936 -msgid "2019-08-21" +msgid "Thanks to [Rodrigo Belem](https://github.com/rbelem)'s efforts, the playbook now supports bridging to [Slack](https://slack.com) via the [mx-puppet-slack](https://github.com/Sorunome/mx-puppet-slack) bridge." msgstr "" -#: ../../../CHANGELOG.md:2940 -msgid "Thanks to the [great work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/205) of [kingoftheconnors](https://github.com/kingoftheconnors) and [Stuart Mumford (Cadair)](https://github.com/Cadair), the playbook now supports bridging to [Slack](https://slack.com) via the [appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) bridge." +#: ../../../CHANGELOG.md:2938 +msgid "See our [Setting up MX Puppet Slack bridging](docs/configuring-playbook-bridge-mx-puppet-slack.md) documentation page for getting started." msgstr "" -#: ../../../CHANGELOG.md:2942 -msgid "Additional details are available in [Setting up Appservice Slack bridging](docs/configuring-playbook-bridge-appservice-slack.md)." +#: ../../../CHANGELOG.md:2941 +msgid "2020-04-09" msgstr "" -#: ../../../CHANGELOG.md:2944 -msgid "Google Hangouts bridging support" +#: ../../../CHANGELOG.md:2943 +msgid "Skype bridging support" msgstr "" -#: ../../../CHANGELOG.md:2946 -msgid "Thanks to the [great work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/251) of [Eduardo Beltrame (Munfred)](https://github.com/Munfred) and [Robbie D (microchipster)](https://github.com/microchipster), the playbook now supports bridging to [Google Hangouts](https://hangouts.google.com/) via the [mautrix-hangouts](https://mau.dev/tulir/mautrix-hangouts) bridge." +#: ../../../CHANGELOG.md:2945 +msgid "Thanks to [Rodrigo Belem](https://github.com/rbelem)'s efforts, the playbook now supports bridging to [Skype](https://www.skype.com) via the [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype) bridge." msgstr "" -#: ../../../CHANGELOG.md:2948 -msgid "Additional details are available in [Setting up Mautrix Hangouts bridging](docs/configuring-playbook-bridge-mautrix-hangouts.md)." +#: ../../../CHANGELOG.md:2947 +msgid "See our [Setting up MX Puppet Skype bridging](docs/configuring-playbook-bridge-mx-puppet-skype.md) documentation page for getting started." msgstr "" -#: ../../../CHANGELOG.md:2951 -msgid "2019-08-05" +#: ../../../CHANGELOG.md:2950 +msgid "2020-04-05" msgstr "" -#: ../../../CHANGELOG.md:2953 -msgid "Email2Matrix support" +#: ../../../CHANGELOG.md:2952 +msgid "Private Jitsi support" msgstr "" -#: ../../../CHANGELOG.md:2955 -msgid "Support for [Email2Matrix](https://github.com/devture/email2matrix) has been added." +#: ../../../CHANGELOG.md:2954 +msgid "The [Jitsi support](#jitsi-support) we had landed a few weeks ago was working well, but it was always open to the whole world." msgstr "" -#: ../../../CHANGELOG.md:2957 -msgid "It's an optional feature that you can enable via the playbook." +#: ../../../CHANGELOG.md:2956 +msgid "Running such an open instance is not desirable to most people, so [teutat3s](https://github.com/teutat3s) has contributed support for making Jitsi use authentication." msgstr "" -#: ../../../CHANGELOG.md:2959 -msgid "To learn more, see the [playbook's documentation on Email2Matrix](./docs/configuring-playbook-email2matrix.md)." +#: ../../../CHANGELOG.md:2958 +msgid "To make your Jitsi server more private, see the [configure internal Jitsi authentication and guests mode](docs/configuring-playbook-jitsi.md#optional-configure-internal-jitsi-authentication-and-guests-mode) section in our Jitsi documentation." msgstr "" -#: ../../../CHANGELOG.md:2962 -msgid "2019-08-03" +#: ../../../CHANGELOG.md:2961 +msgid "2020-04-03" msgstr "" -#: ../../../CHANGELOG.md:2964 -msgid "Synapse logging level has been reduced to WARNING" +#: ../../../CHANGELOG.md:2963 +msgid "(Potential Backward Compatibility Break) ma1sd replaces mxisd" msgstr "" -#: ../../../CHANGELOG.md:2966 -msgid "After [some discussion in our support room](https://matrix.to/#/!PukFFdIcHgtaaHZflT:devture.com/$156476852524179TBeKy:matrix.org?via=devture.com&via=matrix.org&via=librem.one), we've decided to change the default logging level for Synapse from `INFO` to `WARNING`." +#: ../../../CHANGELOG.md:2965 +msgid "Thanks to [Marcel Partap](https://github.com/eMPee584)'s efforts, the [mxisd](https://github.com/kamax-io/mxisd) identity server, which has been deprecated for a long time, has finally been replaced by [ma1sd](https://github.com/ma1uta/ma1sd), a compatible fork." msgstr "" -#: ../../../CHANGELOG.md:2968 -msgid "This greatly reduces the number of log messages that are being logged, leading to:" +#: ../../../CHANGELOG.md:2967 +msgid "**If you're using the default playbook configuration**, you don't need to do anything — your mxisd installation will be replaced with ma1sd and all existing data will be migrated automatically the next time you run the playbook." msgstr "" -#: ../../../CHANGELOG.md:2970 -msgid "much less disk space dedicated to Synapse and thus, logs kept for longer" +#: ../../../CHANGELOG.md:2969 +msgid "**If you're doing something more special** (defining custom `matrix_mxisd_*` variables), the playbook will ask you to rename them to `matrix_ma1sd_*`. You're also encouraged to test that ma1sd works well for such a more custom setup." msgstr "" -#: ../../../CHANGELOG.md:2971 -msgid "easier to find some important `WARNING`, `ERROR` and `CRITICAL` messages, as they're not longer buried in thousands of non-important `INFO` messages" +#: ../../../CHANGELOG.md:2972 +msgid "2020-03-29" msgstr "" -#: ../../../CHANGELOG.md:2973 -msgid "If you'd like to track down an issue, you [can always increase the logging level as described here](./docs/maintenance-and-troubleshooting.md#increasing-synapse-logging)." +#: ../../../CHANGELOG.md:2974 +msgid "Archlinux support" msgstr "" #: ../../../CHANGELOG.md:2976 -msgid "2019-07-08" +msgid "Thanks to [Christian Lupus](https://github.com/christianlupus)'s efforts, the playbook now supports installing to an [Archlinux](https://www.archlinux.org/) server." msgstr "" -#: ../../../CHANGELOG.md:2978 -msgid "Synapse Maintenance docs and synapse-janitor support are available" +#: ../../../CHANGELOG.md:2979 +msgid "2020-03-24" msgstr "" -#: ../../../CHANGELOG.md:2980 -msgid "The playbook can now help you with Synapse's maintenance." +#: ../../../CHANGELOG.md:2981 +msgid "Jitsi support" msgstr "" -#: ../../../CHANGELOG.md:2982 -msgid "There's a new documentation page about [Synapse maintenance](./docs/maintenance-synapse.md) and another section on [Postgres vacuuming](./docs/maintenance-postgres.md#vacuuming-postgresql)." +#: ../../../CHANGELOG.md:2983 +msgid "The playbook can now (optionally) install the [Jitsi](https://jitsi.org/) video-conferencing platform and integrate it with [Riot](docs/configuring-playbook-riot-web.md)." msgstr "" -#: ../../../CHANGELOG.md:2984 -msgid "Among other things, if your Postgres database has grown significantly over time, you may wish to [ask the playbook to purge unused data with synapse-janitor](./docs/maintenance-synapse.md#purging-unused-data-with-synapse-janitor) for you." -msgstr "" - -#: ../../../CHANGELOG.md:2986 -msgid "(BC Break) Rename run control variables" +#: ../../../CHANGELOG.md:2985 +msgid "See our [Jitsi documentation page](docs/configuring-playbook-jitsi.md) to get started." msgstr "" #: ../../../CHANGELOG.md:2988 -msgid "Some internal playbook control variables have been renamed." +msgid "2020-03-15" msgstr "" #: ../../../CHANGELOG.md:2990 -msgid "This change **only affects people who run this playbook's roles from another playbook**. If you're using this playbook as-is, you're not affected and don't need to do anything." +msgid "Raspberry Pi support" msgstr "" #: ../../../CHANGELOG.md:2992 -msgid "The following variables have been renamed:" +msgid "Thanks to [Gergely Horváth](https://github.com/hooger)'s effort, the playbook supports installing to a Raspberry Pi server, for at least some of the services." msgstr "" #: ../../../CHANGELOG.md:2994 -msgid "from `run_import_postgres` to `run_postgres_import`" -msgstr "" - -#: ../../../CHANGELOG.md:2995 -msgid "from `run_import_sqlite_db` to `run_postgres_import_sqlite_db`" -msgstr "" - -#: ../../../CHANGELOG.md:2996 -msgid "from `run_upgrade_postgres` to `run_postgres_upgrade`" +msgid "Since most ready-made container images do not support that architecture, we achieve this by building images locally on the device itself. See our [Self-building documentation page](docs/self-building.md) for how to get started." msgstr "" #: ../../../CHANGELOG.md:2997 -msgid "from `run_import_media_store` to `run_synapse_import_media_store`" -msgstr "" - -#: ../../../CHANGELOG.md:2998 -msgid "from `run_register_user` to `run_synapse_register_user`" +msgid "2020-02-26" msgstr "" #: ../../../CHANGELOG.md:2999 -msgid "from `run_update_user_password` to `run_synapse_update_user_password`" +msgid "Riot-web themes are here" msgstr "" -#: ../../../CHANGELOG.md:3002 -msgid "2019-07-04" +#: ../../../CHANGELOG.md:3001 +msgid "The playbook now makes it easy to install custom riot-web themes." msgstr "" -#: ../../../CHANGELOG.md:3004 -msgid "Synapse no longer logs to text files" +#: ../../../CHANGELOG.md:3003 +msgid "To learn more, take a look at our [riot-web documentation on Themes](docs/configuring-playbook-riot-web.md#themes)." msgstr "" #: ../../../CHANGELOG.md:3006 -msgid "Following what the official Synapse Docker image is doing ([#5565](https://github.com/matrix-org/synapse/pull/5565)) and what we've been doing for mostly everything installed by this playbook, **Synapse no longer logs to text files** (`/matrix/synapse/run/homeserver.log*`)." +msgid "2020-02-24" msgstr "" #: ../../../CHANGELOG.md:3008 -msgid "From now on, Synapse would only log to console, which goes to systemd's journald. To see Synapse's logs, execute: `journalctl -fu matrix-synapse`" +msgid "Customize the server name in Riot's login page" msgstr "" #: ../../../CHANGELOG.md:3010 -msgid "Because of this, the following variables have become obsolete and were removed:" +msgid "You can now customize the server name string that Riot-web displays in its login page." msgstr "" #: ../../../CHANGELOG.md:3012 -msgid "`matrix_synapse_max_log_file_size_mb`" +msgid "These playbook variables, with these default values, have been added:" msgstr "" -#: ../../../CHANGELOG.md:3013 -msgid "`matrix_synapse_max_log_files_count`" -msgstr "" - -#: ../../../CHANGELOG.md:3015 -msgid "To prevent confusion, it'd be better if you delete all old files manually after you've upgraded (`rm -f /matrix/synapse/run/homeserver.log*`)." -msgstr "" - -#: ../../../CHANGELOG.md:3017 -msgid "Because Synapse is incredibly chatty when it comes to logging (here's [one such issue](https://github.com/matrix-org/synapse/issues/4751) describing the problem), if you're running an ancient distribution (like CentOS 7.0), be advised that systemd's journald default logging restrictions may not be high enough to capture all log messages generated by Synapse. This is especially true if you've got a busy (Synapse) server. We advise that you manually add `RateLimitInterval=0` and `RateLimitBurst=0` under `[Storage]` in the `/etc/systemd/journald.conf` file, followed by restarting the logging service (`systemctl restart systemd-journald`)." +#: ../../../CHANGELOG.md:3018 +msgid "The login page previously said \"Sign in to your Matrix account on matrix.example.org\" (the homeserver's domain name). It will now say \"Sign in … on example.org\" (the server name) by default, or \"Sign in … on Our Server\" if you set the variable to \"Our Server\"." msgstr "" #: ../../../CHANGELOG.md:3020 -msgid "2019-06-27" +msgid "To support this, the config.json template is changed to use the configuration key `default_server_config` for setting the default HS/IS, and the new configuration key `server_name` is added in there." msgstr "" -#: ../../../CHANGELOG.md:3022 -msgid "(BC Break) Discord bridge configuration is now entirely managed by the playbook" +#: ../../../CHANGELOG.md:3023 +msgid "2020-01-30" msgstr "" -#: ../../../CHANGELOG.md:3024 -msgid "Until now, the `config.yaml` file for the [Discord bridge](docs/configuring-playbook-bridge-appservice-discord.md) was managed by the playbook, but the `registration.yaml` file was not." +#: ../../../CHANGELOG.md:3025 +msgid "Disabling TLSv1.1" msgstr "" -#: ../../../CHANGELOG.md:3026 -msgid "From now on, the playbook will keep both configuration files sync for you." +#: ../../../CHANGELOG.md:3027 +msgid "To improve security, we've removed TLSv1.1 support from our default matrix-nginx-proxy configuration." msgstr "" -#: ../../../CHANGELOG.md:3028 -msgid "This means that if you were making manual changes to the `/matrix/appservice-discord/discord-registration.yaml` configuration file, those would be lost the next time you run the playbook." -msgstr "" - -#: ../../../CHANGELOG.md:3030 -msgid "The bridge now stores configuration in a subdirectory (`/matrix/appservice-discord/config`)." +#: ../../../CHANGELOG.md:3029 +msgid "If you need to support old clients, you can re-enable it with the following configuration: `matrix_nginx_proxy_ssl_protocols: \"TLSv1.1 TLSv1.2 TLSv1.3\"`" msgstr "" #: ../../../CHANGELOG.md:3032 -msgid "Likewise, data is now also stored in a subdirectory (`/matrix/appservice-discord/data`). When you run the playbook with an existing database file (`/matrix/appservice-discord/discord.db`), the playbook will stop the bridge and relocate the database file to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." +msgid "2020-01-21" msgstr "" #: ../../../CHANGELOG.md:3034 -msgid "The main directory (`/matrix/appservice-discord`) may contain some leftover files (`user-store.db`, `room-store.db`, `config.yaml`, `discord-registration.yaml`, `invite_link`). These are no longer necessary and can be deleted manually." +msgid "Postgres collation changes (action required!)" msgstr "" #: ../../../CHANGELOG.md:3036 -msgid "We're now following the default sample configuration for the Discord bridge. If you need to override some values, define them in `matrix_appservice_discord_configuration_extension_yaml`." +msgid "By default, we've been using a UTF-8 collation for Postgres. This is known to cause Synapse some troubles (see the [relevant issue](https://github.com/matrix-org/synapse/issues/6722)) on systems that use [glibc](https://www.gnu.org/software/libc/). We run Postgres in an [Alpine Linux](https://alpinelinux.org/) container (which uses [musl](https://www.musl-libc.org/), and not glibc), so our users are likely not affected by the index corruption problem observed by others." msgstr "" -#: ../../../CHANGELOG.md:3039 -msgid "2019-06-24" +#: ../../../CHANGELOG.md:3038 +msgid "Still, we might become affected in the future. In any case, it's imminent that Synapse will complain about databases which do not use a C collation." msgstr "" -#: ../../../CHANGELOG.md:3041 -msgid "(BC Break) WhatsApp bridge configuration is now entirely managed by the playbook" +#: ../../../CHANGELOG.md:3040 +msgid "To avoid future problems, we recommend that you run the following command:" msgstr "" -#: ../../../CHANGELOG.md:3043 -msgid "Until now, configuration files for the [WhatsApp bridge](docs/configuring-playbook-bridge-mautrix-whatsapp.md) were created by the playbook initially, but never modified later on." -msgstr "" - -#: ../../../CHANGELOG.md:3045 -#: ../../../CHANGELOG.md:3062 -#: ../../../CHANGELOG.md:3081 -#: ../../../CHANGELOG.md:3120 -msgid "From now on, the playbook will keep the configuration in sync for you." -msgstr "" - -#: ../../../CHANGELOG.md:3047 -msgid "This means that if you were making manual changes to the `/matrix/mautrix-whatsapp/config.yaml` or `/matrix/mautrix-whatsapp/registration.yaml` configuration files, those would be lost the next time you run the playbook." +#: ../../../CHANGELOG.md:3046 +msgid "It forces a [Postgres database upgrade](docs/maintenance-postgres.md#upgrading-postgresql), which would recreate your Postgres database using the proper (`C`) collation. If you are low on disk space, or run into trouble, refer to the Postgres database upgrade documentation page." msgstr "" #: ../../../CHANGELOG.md:3049 -msgid "The bridge now stores configuration in a subdirectory (`/matrix/mautrix-whatsapp/config`), so your old configuration remains in the base directory (`/matrix/mautrix-whatsapp`). You need to migrate any manual changes over to the new `matrix_mautrix_whatsapp_configuration_extension_yaml` variable, so that the playbook would apply them for you." +msgid "2020-01-14" msgstr "" #: ../../../CHANGELOG.md:3051 -msgid "Likewise, data is now also stored in a subdirectory (`/matrix/mautrix-whatsapp/data`). When you run the playbook with an existing database file (`/matrix/mautrix-whatsapp/mautrix-whatsapp.db`), the playbook will stop the bridge and relocate the database file to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." +msgid "Added support for Appservice Webhooks" msgstr "" #: ../../../CHANGELOG.md:3053 -msgid "We're now following the default configuration for the WhatsApp bridge." +msgid "Thanks to a contribution from [Björn Marten](https://github.com/tripleawwy) from [netresearch](https://www.netresearch.de/), the playbook can now install and configure [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) for you. This bridge provides support for Slack-compatible webhooks." msgstr "" -#: ../../../CHANGELOG.md:3056 -msgid "2019-06-20" +#: ../../../CHANGELOG.md:3055 +msgid "Learn more in [Setting up Appservice Webhooks bridging](docs/configuring-playbook-bridge-appservice-webhooks.md)." msgstr "" #: ../../../CHANGELOG.md:3058 -msgid "(BC Break) IRC bridge configuration is now entirely managed by the playbook" +msgid "2020-01-12" msgstr "" #: ../../../CHANGELOG.md:3060 -msgid "Until now, configuration files for the [IRC bridge](docs/configuring-playbook-bridge-appservice-irc.md) were created by the playbook initially, but never modified later on." +msgid "Added support for automatic Double Puppeting for all Mautrix bridges" +msgstr "" + +#: ../../../CHANGELOG.md:3062 +msgid "Double Puppeting can now be easily enabled for all Mautrix bridges supported by the playbook (Facebook, Hangouts, Whatsapp, Telegram)." msgstr "" #: ../../../CHANGELOG.md:3064 -msgid "This means that if you were making manual changes to the `/matrix/appservice-irc/config.yaml` or `/matrix/appservice-irc/registration.yaml` configuration files, those would be lost the next time you run the playbook." +msgid "This is possible due to those bridges' integration with [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) — yet another component that this playbook can install for you." msgstr "" #: ../../../CHANGELOG.md:3066 -msgid "The bridge now stores configuration in a subdirectory (`/matrix/appservice-irc/config`), so your old configuration remains in the base directory (`/matrix/appservice-irc`)." +msgid "To get started, following the playbook's documentation for the bridge you'd like to configure." msgstr "" -#: ../../../CHANGELOG.md:3068 -msgid "Previously, we asked people to configure bridged IRC servers by extending the bridge configuration (`matrix_appservice_irc_configuration_extension_yaml`). While this is still possible and will continue working forever, **we now recommend defining IRC servers in the easier to use `matrix_appservice_irc_ircService_servers` variable**. See [our IRC bridge documentation page](docs/configuring-playbook-bridge-appservice-irc.md) for an example." +#: ../../../CHANGELOG.md:3069 +msgid "2019-12-06" msgstr "" -#: ../../../CHANGELOG.md:3070 -msgid "If you decide to continue using `matrix_appservice_irc_configuration_extension_yaml`, you might be interested to know that `ircService.databaseUri` and a few other keys now have default values in the base configuration (`matrix_appservice_irc_configuration_yaml`). You may wish to stop redefining those keys, unless you really intend to override them. You most likely only need to override `ircService.servers`." +#: ../../../CHANGELOG.md:3071 +msgid "Added support for an alternative method for using another webserver" msgstr "" -#: ../../../CHANGELOG.md:3072 -msgid "Bridge data (`passkey.pem` and database files) is now also stored in a subdirectory (`/matrix/appservice-irc/data`). When you run the playbook with an existing `/matrix/appservice-irc/passkey.pem` file, the playbook will stop the bridge and relocate the passkey and database files (`rooms.db` and `users.db`) to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." +#: ../../../CHANGELOG.md:3073 +msgid "We have added support for making `matrix-nginx-proxy` not being so invasive, so that it would be easier to [use your own webserver](docs/configuring-playbook-own-webserver.md)." msgstr "" #: ../../../CHANGELOG.md:3075 -msgid "2019-06-15" +msgid "The documentation has been updated with a **Method 2**, which might make \"own webserver\" setup easier in some cases (such as [reverse-proxying using Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/296))." msgstr "" #: ../../../CHANGELOG.md:3077 -msgid "(BC Break) Telegram bridge configuration is now entirely managed by the playbook" +msgid "**Existing users** are not affected by this and **don't need to change anything**. The defaults are still the same (`matrix-nginx-proxy` obtaining SSL certificates and doing everything for you automatically)." msgstr "" -#: ../../../CHANGELOG.md:3079 -msgid "Until now, configuration files for the [Telegram bridge](docs/configuring-playbook-bridge-mautrix-telegram.md) were created by the playbook initially, but never modified later on." +#: ../../../CHANGELOG.md:3080 +msgid "2019-11-10" msgstr "" -#: ../../../CHANGELOG.md:3083 -msgid "This means that if you were making manual changes to the `/matrix/mautrix-telegram/config.yaml` or `/matrix/mautrix-telegram/registration.yaml` configuration files, those would be lost the next time you run the playbook." +#: ../../../CHANGELOG.md:3082 +msgid "Tightened security around room directory publishing" msgstr "" -#: ../../../CHANGELOG.md:3085 -msgid "The bridge now stores configuration in a subdirectory (`/matrix/mautrix-telegram/config`), so your old configuration remains in the base directory (`/matrix/mautrix-telegram`). You need to migrate any manual changes over to the new `matrix_mautrix_telegram_configuration_extension_yaml` variable, so that the playbook would apply them for you." +#: ../../../CHANGELOG.md:3084 +msgid "As per this [advisory blog post](https://matrix.org/blog/2019/11/09/avoiding-unwelcome-visitors-on-private-matrix-servers), we've decided to change the default publishing rules for the Matrix room directory." msgstr "" -#: ../../../CHANGELOG.md:3087 -msgid "Likewise, data is now also stored in a subdirectory (`/matrix/mautrix-telegram/data`). When you run the playbook with an existing database file (`/matrix/mautrix-telegram/mautrix-telegram.db`), the playbook will stop the bridge and relocate the database file to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." +#: ../../../CHANGELOG.md:3086 +msgid "Our general goal is to favor privacy and security when running personal (family & friends) and corporate homeservers. Both of these likely benefit from having a more secure default of **not showing the room directory without authentication** and **not publishing the room directory over federation**." msgstr "" -#: ../../../CHANGELOG.md:3089 -msgid "Also, we're now following the default configuration for the Telegram bridge, so some default configuration values are different:" +#: ../../../CHANGELOG.md:3088 +msgid "As with anything else, these new defaults can be overridden by changing the `matrix_synapse_allow_public_rooms_without_auth` and `matrix_synapse_allow_public_rooms_over_federation` variables, respectively." msgstr "" #: ../../../CHANGELOG.md:3091 -msgid "`edits_as_replies` (used to be `false`, now `true`) — previously replies were not sent over to Matrix at all; ow they are sent over as a reply to the original message" -msgstr "" - -#: ../../../CHANGELOG.md:3092 -msgid "`inline_images` (used to be `true`, now `false`) — this has to do with captioned images. Inline-image (included caption) are said to exhibit troubles on Riot iOS. When `false`, the caption arrives on the Matrix side as a separate message." +msgid "2019-10-05" msgstr "" #: ../../../CHANGELOG.md:3093 -msgid "`authless_portals` (used to be `false`, now `true`) — creating portals from the Telegram side is now possible" +msgid "Improved Postgres upgrading/importing" msgstr "" -#: ../../../CHANGELOG.md:3094 -msgid "`whitelist_group_admins` (used to be `false`, now `true`) — allows Telegram group admins to use the bot commands" +#: ../../../CHANGELOG.md:3095 +msgid "Postgres [upgrading](docs/maintenance-postgres.md#upgrading-postgresql) and [importing](docs/importing-postgres.md) have been improved to add support for multiple databases and roles." msgstr "" -#: ../../../CHANGELOG.md:3096 -msgid "If the new values are not to your liking, use `matrix_mautrix_telegram_configuration_extension_yaml` to specify an override (refer to `matrix_mautrix_telegram_configuration_yaml` to figure out which variable goes where)." +#: ../../../CHANGELOG.md:3097 +msgid "Previously, the playbook would only take care of the `homeserver` database and `synapse` user. We now back up and restore all databases and users on the Postgres server." msgstr "" #: ../../../CHANGELOG.md:3099 -msgid "2019-06-12" +msgid "For now, the playbook only uses that one database (`homeserver`) and that one single user (`synapse`), so it's all the same. However, in the future, additional components besides Synapse may also make use the Postgres database server. One such example is the [matrix-appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) bridge, which strongly encourages use of Postgres in its v1.0 release. We are yet to upgrade to it." msgstr "" #: ../../../CHANGELOG.md:3101 -msgid "Synapse v1.0" +msgid "Additionally, Postgres [upgrading](docs/maintenance-postgres.md#upgrading-postgresql) now uses gzipped dump files by default, to minimize disk space usage." msgstr "" -#: ../../../CHANGELOG.md:3103 -msgid "With [Synapse v1.0 now available](https://matrix.org/blog/2019/06/11/introducing-matrix-1-0-and-the-matrix-org-foundation) and most people being on at least Synapse v0.99, it's time to remove the `_matrix._tcp` DNS SRV record that we've been keeping for compatibility with old Synapse versions (<= 0.34)." +#: ../../../CHANGELOG.md:3104 +msgid "2019-10-04" msgstr "" -#: ../../../CHANGELOG.md:3105 -msgid "According to the [Server Discovery specification](https://matrix.org/docs/spec/server_server/r0.1.2.html#server-discovery), it's no harm to keep the DNS SRV record. But since it's not necessary for federating with the larger Matrix network anymore, you should be safe to get rid of it." +#: ../../../CHANGELOG.md:3106 +msgid "Postgres 12 support" msgstr "" -#: ../../../CHANGELOG.md:3107 -msgid "**Note**: don't confuse the `_matrix._tcp` and `_matrix-identity._tcp` DNS SRV records. The latter, **must not** be removed." +#: ../../../CHANGELOG.md:3108 +msgid "The playbook now installs [Postgres 12](https://www.postgresql.org/about/news/1976/) by default." msgstr "" -#: ../../../CHANGELOG.md:3109 -msgid "For completeness, we must say that using a `_matrix._tcp` [SRV record for Server Delegation](docs/howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced) is still valid and useful for certain deployments. It's just that our guide recommends the [`/.well-known/matrix/server` Server Delegation method](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file), due to its easier implementation when using this playbook." +#: ../../../CHANGELOG.md:3110 +msgid "If you have have an existing setup, it's likely running on an older Postgres version (9.x, 10.x or 11.x). You can easily upgrade by following the [upgrading PostgreSQL guide](docs/maintenance-postgres.md#upgrading-postgresql)." msgstr "" -#: ../../../CHANGELOG.md:3111 -msgid "Besides this optional/non-urgent DNS change, assuming you're already on Synapse v0.99, upgrading to Synapse v1.0 should be as simple as [re-running the playbook](docs/maintenance-upgrading-services.md)." +#: ../../../CHANGELOG.md:3113 +msgid "2019-10-03" msgstr "" -#: ../../../CHANGELOG.md:3114 -msgid "2019-06-07" +#: ../../../CHANGELOG.md:3115 +msgid "Synapse 1.4.0" msgstr "" -#: ../../../CHANGELOG.md:3116 -msgid "(BC Break) Facebook bridge configuration is now entirely managed by the playbook" +#: ../../../CHANGELOG.md:3117 +msgid "Synapse 1.4.0 [is out](https://matrix.org/blog/2019/10/03/synapse-1-4-0-released) with lots of changes related to privacy." msgstr "" -#: ../../../CHANGELOG.md:3118 -msgid "Until now, configuration files for the [Facebook bridge](docs/configuring-playbook-bridge-mautrix-facebook.md) were created by the playbook initially, but never modified later on." +#: ../../../CHANGELOG.md:3119 +msgid "Its new defaults (which we adopt as well) mean that certain old data will automatically get purged after a certain number of days. 1.4.0 automatically garbage collects redacted messages (defaults to 7 days) and removes unused IP and user agent information stored in the user_ips table (defaults to 30 days). If you'd like to preserve this data, we encourage you to look at the `redaction_retention_period` and `user_ips_max_age` options (controllable by the `matrix_synapse_redaction_retention_period` and `matrix_synapse_user_ips_max_age` playbook variables, respectively) before doing the upgrade. If you'd like to keep data indefinitely, set these variables to `null` (e.g. `matrix_synapse_redaction_retention_period: ~`)." msgstr "" -#: ../../../CHANGELOG.md:3122 -msgid "This means that if you were making manual changes to the `/matrix/mautrix-facebook/config.yaml` or `/matrix/mautrix-facebook/registration.yaml` configuration files, those would be lost the next time you run the playbook." +#: ../../../CHANGELOG.md:3121 +msgid "From now on the `trusted_key_servers` setting for Synapse is configurable. It still defaults to `matrix.org` just like it always has, but in a more explicit way now. If you'd like to use another trusted key server, adjust the `matrix_synapse_trusted_key_servers` playbook variable." msgstr "" -#: ../../../CHANGELOG.md:3124 -msgid "The bridge now stores configuration in a subdirectory (`/matrix/mautrix-facebook/config`), so your old configuration remains in the base directory (`/matrix/mautrix-facebook`). You need to migrate any manual changes over to the new `matrix_mautrix_facebook_configuration_extension_yaml` variable, so that the playbook would apply them for you." +#: ../../../CHANGELOG.md:3123 +msgid "Synapse 1.4.0 also changes lots of things related to identity server integration. Because Synapse will now by default be responsible for validating email addresses for user accounts, running without an identity server looks more feasible. We still [have concerns](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/275/files#r331104117) over disabling the identity server by default, so for now it remains enabled." msgstr "" #: ../../../CHANGELOG.md:3126 -msgid "Likewise, data is now also stored in a subdirectory (`/matrix/mautrix-facebook/data`). When you run the playbook with an existing database file (`/matrix/mautrix-facebook/mautrix-facebook.db`), the playbook will stop the bridge and relocate the database file to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." +msgid "2019-09-09" msgstr "" -#: ../../../CHANGELOG.md:3129 -msgid "2019-05-25" +#: ../../../CHANGELOG.md:3128 +msgid "Synapse Simple Antispam support" msgstr "" -#: ../../../CHANGELOG.md:3131 -msgid "Support for exposing container ports publicly (not just to the host)" +#: ../../../CHANGELOG.md:3130 +msgid "There have been lots of invite-spam attacks lately and [Travis](https://github.com/t2bot) has created a Synapse module ([synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam)) to let people protect themselves." msgstr "" -#: ../../../CHANGELOG.md:3133 -msgid "Until now, various roles supported a `matrix_*_expose_port` variable, which would expose their container's port to the host. This was mostly useful for reverse-proxying manually (in case `matrix-nginx-proxy` was disabled). It could also be used for installing some playbook services (e.g. bridges, etc.) and wiring them to a separate (manual) Matrix setup." +#: ../../../CHANGELOG.md:3132 +msgid "From now on, you can easily install and configure this spam checker module through the playbook." msgstr "" -#: ../../../CHANGELOG.md:3135 -msgid "`matrix_*_expose_port` variables were not granular enough — sometimes they would expose one port, other times multiple. They also didn't provide control over **where** to expose (to which port number and to which network interface), because they would usually hardcode something like `127.0.0.1:8080`." +#: ../../../CHANGELOG.md:3134 +msgid "Learn more in [Setting up Synapse Simple Antispam](docs/configuring-playbook-synapse-simple-antispam.md)." msgstr "" #: ../../../CHANGELOG.md:3137 -msgid "All such variables have been superseded by a better (more flexible) way to do it." +msgid "2019-08-25" msgstr "" #: ../../../CHANGELOG.md:3139 -msgid "**Most** people (including those not using `matrix-nginx-proxy`), **don't need** to bother with this." +msgid "Extensible Riot-web configuration" msgstr "" #: ../../../CHANGELOG.md:3141 -msgid "Porting examples follow for people having more customized setups:" +msgid "Similarly to [Extensible Synapse configuration](#extensible-synapse-configuration) (below), Riot-web configuration is also extensible now." msgstr "" #: ../../../CHANGELOG.md:3143 -msgid "**from** `matrix_synapse_container_expose_client_api_port: true` **to** `matrix_synapse_container_client_api_host_bind_port: '127.0.0.1:8008'`" +msgid "From now on, you can extend/override Riot-web's configuration by making use of the `matrix_riot_web_configuration_extension_json` variable. This should be enough for most customization needs." msgstr "" #: ../../../CHANGELOG.md:3145 -msgid "**from** `matrix_synapse_container_expose_federation_api_port: true` **to** `matrix_synapse_container_federation_api_plain_host_bind_port: '127.0.0.1:8048'` and possibly `matrix_synapse_container_federation_api_tls_host_bind_port: '8448'`" +msgid "If you need even more power, you can now also take full control and override `matrix_riot_web_configuration_default` (or `matrix_riot_web_configuration`) directly." msgstr "" #: ../../../CHANGELOG.md:3147 -msgid "**from** `matrix_synapse_container_expose_metrics_port: true` **to** `matrix_synapse_container_metrics_api_host_bind_port: '127.0.0.1:9100'`" +msgid "Learn more in [Configuring Riot-web](docs/configuring-playbook-riot-web.md)." msgstr "" -#: ../../../CHANGELOG.md:3149 -msgid "**from** `matrix_riot_web_container_expose_port: true` **to** `matrix_riot_web_container_http_host_bind_port: '127.0.0.1:8765'`" +#: ../../../CHANGELOG.md:3150 +msgid "2019-08-22" msgstr "" -#: ../../../CHANGELOG.md:3151 -msgid "**from** `matrix_mxisd_container_expose_port: true` **to** `matrix_mxisd_container_http_host_bind_port: '127.0.0.1:8090'`" +#: ../../../CHANGELOG.md:3152 +msgid "Extensible Synapse configuration" msgstr "" -#: ../../../CHANGELOG.md:3153 -msgid "**from** `matrix_dimension_container_expose_port: true` **to** `matrix_dimension_container_http_host_bind_port: '127.0.0.1:8184'`" +#: ../../../CHANGELOG.md:3154 +msgid "Previously, we had to create custom Ansible variables for each and every Synapse setting. This lead to too much effort (and configuration ugliness) to all of Synapse's settings, so naturally, not all features of Synapse could be controlled through the playbook." msgstr "" -#: ../../../CHANGELOG.md:3155 -msgid "**from** `matrix_corporal_container_expose_ports: true` **to** `matrix_corporal_container_http_gateway_host_bind_port: '127.0.0.1:41080'` and possibly `matrix_corporal_container_http_api_host_bind_port: '127.0.0.1:41081'`" +#: ../../../CHANGELOG.md:3156 +msgid "From now on, you can extend/override the Synapse server's configuration by making use of the `matrix_synapse_configuration_extension_yaml` variable. This should be enough for most customization needs." msgstr "" -#: ../../../CHANGELOG.md:3157 -msgid "**from** `matrix_appservice_irc_container_expose_client_server_api_port: true` **to** `matrix_appservice_irc_container_http_host_bind_port: '127.0.0.1:9999'`" +#: ../../../CHANGELOG.md:3158 +msgid "If you need even more power, you can now also take full control and override `matrix_synapse_configuration` (or `matrix_synapse_configuration_yaml`) directly." msgstr "" -#: ../../../CHANGELOG.md:3159 -msgid "**from** `matrix_appservice_discord_container_expose_client_server_api_port: true` **to** `matrix_appservice_discord_container_http_host_bind_port: '127.0.0.1:9005'`" +#: ../../../CHANGELOG.md:3160 +msgid "Learn more here in [Configuring Synapse](docs/configuring-playbook-synapse.md)." msgstr "" -#: ../../../CHANGELOG.md:3161 -msgid "As always, if you forget to remove usage of some outdated variable, the playbook will warn you." +#: ../../../CHANGELOG.md:3163 +msgid "2019-08-21" msgstr "" -#: ../../../CHANGELOG.md:3164 -msgid "2019-05-23" +#: ../../../CHANGELOG.md:3167 +msgid "Thanks to the [great work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/205) of [kingoftheconnors](https://github.com/kingoftheconnors) and [Stuart Mumford (Cadair)](https://github.com/Cadair), the playbook now supports bridging to [Slack](https://slack.com) via the [appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) bridge." msgstr "" -#: ../../../CHANGELOG.md:3166 -msgid "(BC Break) Ansible 2.8 compatibility" +#: ../../../CHANGELOG.md:3169 +msgid "Additional details are available in [Setting up Appservice Slack bridging](docs/configuring-playbook-bridge-appservice-slack.md)." msgstr "" -#: ../../../CHANGELOG.md:3168 -msgid "Thanks to [@danbob](https://github.com/danbob), the playbook now [supports the new Ansible 2.8](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/187)." -msgstr "" - -#: ../../../CHANGELOG.md:3170 -msgid "A manual change is required to the `inventory/hosts` file, changing the group name from `matrix-servers` to `matrix_servers` (dash to underscore)." -msgstr "" - -#: ../../../CHANGELOG.md:3172 -msgid "To avoid doing it manually, run this:" +#: ../../../CHANGELOG.md:3171 +msgid "Google Hangouts bridging support" msgstr "" #: ../../../CHANGELOG.md:3173 -msgid "Linux: `sed -i 's/matrix-servers/matrix_servers/g' inventory/hosts`" +msgid "Thanks to the [great work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/251) of [Eduardo Beltrame (Munfred)](https://github.com/Munfred) and [Robbie D (microchipster)](https://github.com/microchipster), the playbook now supports bridging to [Google Hangouts](https://hangouts.google.com/) via the [mautrix-hangouts](https://mau.dev/tulir/mautrix-hangouts) bridge." msgstr "" -#: ../../../CHANGELOG.md:3174 -msgid "Mac: `sed -i '' 's/matrix-servers/matrix_servers/g' inventory/hosts`" +#: ../../../CHANGELOG.md:3175 +msgid "Additional details are available in [Setting up Mautrix Hangouts bridging](docs/configuring-playbook-bridge-mautrix-hangouts.md)." msgstr "" -#: ../../../CHANGELOG.md:3177 -msgid "2019-05-21" +#: ../../../CHANGELOG.md:3178 +msgid "2019-08-05" msgstr "" -#: ../../../CHANGELOG.md:3179 -msgid "Synapse no longer required" +#: ../../../CHANGELOG.md:3180 +msgid "Email2Matrix support" msgstr "" -#: ../../../CHANGELOG.md:3181 -msgid "The playbook no longer insists on installing [Synapse](https://github.com/element-hq/synapse) via the `matrix-synapse` role." +#: ../../../CHANGELOG.md:3182 +msgid "Support for [Email2Matrix](https://github.com/devture/email2matrix) has been added." msgstr "" -#: ../../../CHANGELOG.md:3183 -msgid "If you would prefer to install Synapse another way and just use the playbook to install other services, it should be possible (`matrix_synapse_enabled: false`)." +#: ../../../CHANGELOG.md:3184 +msgid "It's an optional feature that you can enable via the playbook." msgstr "" -#: ../../../CHANGELOG.md:3185 -msgid "Note that it won't necessarily be the best experience, since the playbook wires things to Synapse by default. If you're using your own Synapse instance (especially one not running in a container), you may have to override many variables to point them to the correct place." -msgstr "" - -#: ../../../CHANGELOG.md:3187 -msgid "Having Synapse not be a required component potentially opens the door for installing alternative Matrix homeservers." +#: ../../../CHANGELOG.md:3186 +msgid "To learn more, see the [playbook's documentation on Email2Matrix](./docs/configuring-playbook-email2matrix.md)." msgstr "" #: ../../../CHANGELOG.md:3189 -msgid "Bridges are now separate from the Synapse role" +msgid "2019-08-03" msgstr "" #: ../../../CHANGELOG.md:3191 -msgid "Bridges are no longer part of the `matrix-synapse` role. Each bridge now lives in its own separate role (`roles/custom/matrix-bridge-*`)." +msgid "Synapse logging level has been reduced to WARNING" msgstr "" #: ../../../CHANGELOG.md:3193 -msgid "These bridge roles are independent of the `matrix-synapse` role, so it should be possible to use them with a Synapse instance installed another way (not through the playbook)." +msgid "After [some discussion in our support room](https://matrix.to/#/!PukFFdIcHgtaaHZflT:devture.com/$156476852524179TBeKy:matrix.org?via=devture.com&via=matrix.org&via=librem.one), we've decided to change the default logging level for Synapse from `INFO` to `WARNING`." msgstr "" #: ../../../CHANGELOG.md:3195 -msgid "Renaming inconsistently-named Synapse variables" +msgid "This greatly reduces the number of log messages that are being logged, leading to:" msgstr "" #: ../../../CHANGELOG.md:3197 -msgid "For better consistency, the following variables have been renamed:" +msgid "much less disk space dedicated to Synapse and thus, logs kept for longer" msgstr "" -#: ../../../CHANGELOG.md:3199 -msgid "`matrix_enable_room_list_search` was renamed to `matrix_synapse_enable_room_list_search`" +#: ../../../CHANGELOG.md:3198 +msgid "easier to find some important `WARNING`, `ERROR` and `CRITICAL` messages, as they're not longer buried in thousands of non-important `INFO` messages" msgstr "" #: ../../../CHANGELOG.md:3200 -msgid "`matrix_alias_creation_rules` was renamed to `matrix_synapse_alias_creation_rules`" +msgid "If you'd like to track down an issue, you [can always increase the logging level as described here](./docs/maintenance-and-troubleshooting.md#increasing-synapse-logging)." msgstr "" -#: ../../../CHANGELOG.md:3201 -msgid "`matrix_nginx_proxy_matrix_room_list_publication_rulesdata_path` was renamed to `matrix_synapse_room_list_publication_rules`" +#: ../../../CHANGELOG.md:3203 +msgid "2019-07-08" msgstr "" -#: ../../../CHANGELOG.md:3204 -msgid "2019-05-09" +#: ../../../CHANGELOG.md:3205 +msgid "Synapse Maintenance docs and synapse-janitor support are available" msgstr "" -#: ../../../CHANGELOG.md:3206 -msgid "Besides a myriad of bug fixes and minor improvements, here are the more notable (bigger) features we can announce today." +#: ../../../CHANGELOG.md:3207 +msgid "The playbook can now help you with Synapse's maintenance." msgstr "" -#: ../../../CHANGELOG.md:3208 -msgid "Mautrix Facebook/Messenger bridging support" +#: ../../../CHANGELOG.md:3209 +msgid "There's a new documentation page about [Synapse maintenance](./docs/maintenance-synapse.md) and another section on [Postgres vacuuming](./docs/maintenance-postgres.md#vacuuming-postgresql)." msgstr "" -#: ../../../CHANGELOG.md:3210 -msgid "The playbook now supports bridging with [Facebook](https://www.facebook.com/) by installing the [mautrix-facebook](https://github.com/tulir/mautrix-facebook) bridge. This playbook functionality is available thanks to [@izissise](https://github.com/izissise)." +#: ../../../CHANGELOG.md:3211 +msgid "Among other things, if your Postgres database has grown significantly over time, you may wish to [ask the playbook to purge unused data with synapse-janitor](./docs/maintenance-synapse.md#purging-unused-data-with-synapse-janitor) for you." msgstr "" -#: ../../../CHANGELOG.md:3212 -msgid "Additional details are available in [Setting up Mautrix Facebook bridging](docs/configuring-playbook-bridge-mautrix-facebook.md)." +#: ../../../CHANGELOG.md:3213 +msgid "(BC Break) Rename run control variables" msgstr "" -#: ../../../CHANGELOG.md:3214 -msgid "mxisd Registration feature integration" +#: ../../../CHANGELOG.md:3215 +msgid "Some internal playbook control variables have been renamed." msgstr "" -#: ../../../CHANGELOG.md:3216 -msgid "The playbook can now help you integrate with mxisd's [Registration](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/registration.md) feature." +#: ../../../CHANGELOG.md:3217 +msgid "This change **only affects people who run this playbook's roles from another playbook**. If you're using this playbook as-is, you're not affected and don't need to do anything." msgstr "" -#: ../../../CHANGELOG.md:3218 -msgid "Learn more in [mxisd-controlled Registration](docs/configuring-playbook-mxisd.md#mxisd-controlled-registration)." +#: ../../../CHANGELOG.md:3219 +msgid "The following variables have been renamed:" msgstr "" #: ../../../CHANGELOG.md:3221 -msgid "2019-04-16" +msgid "from `run_import_postgres` to `run_postgres_import`" +msgstr "" + +#: ../../../CHANGELOG.md:3222 +msgid "from `run_import_sqlite_db` to `run_postgres_import_sqlite_db`" msgstr "" #: ../../../CHANGELOG.md:3223 -msgid "Caddy webserver examples" +msgid "from `run_upgrade_postgres` to `run_postgres_upgrade`" +msgstr "" + +#: ../../../CHANGELOG.md:3224 +msgid "from `run_import_media_store` to `run_synapse_import_media_store`" msgstr "" #: ../../../CHANGELOG.md:3225 -msgid "If you prefer using the [Caddy](https://caddyserver.com/) webserver instead of our own integrated nginx, we now have examples for it in the [`examples/caddy`](examples/caddy) directory" +msgid "from `run_register_user` to `run_synapse_register_user`" msgstr "" -#: ../../../CHANGELOG.md:3227 -msgid "2019-04-10" +#: ../../../CHANGELOG.md:3226 +msgid "from `run_update_user_password` to `run_synapse_update_user_password`" msgstr "" #: ../../../CHANGELOG.md:3229 -msgid "Goofys support for other S3-compatible object stores" +msgid "2019-07-04" msgstr "" #: ../../../CHANGELOG.md:3231 -msgid "Until now, you could optionally host Synapse's media repository on Amazon S3, but we now also support [using other S3-compatible object stores](docs/configuring-playbook-s3.md)," +msgid "Synapse no longer logs to text files" msgstr "" -#: ../../../CHANGELOG.md:3234 -msgid "2019-04-03" +#: ../../../CHANGELOG.md:3233 +msgid "Following what the official Synapse Docker image is doing ([#5565](https://github.com/matrix-org/synapse/pull/5565)) and what we've been doing for mostly everything installed by this playbook, **Synapse no longer logs to text files** (`/matrix/synapse/run/homeserver.log*`)." msgstr "" -#: ../../../CHANGELOG.md:3236 -msgid "Ansible >= 2.5 is required" +#: ../../../CHANGELOG.md:3235 +msgid "From now on, Synapse would only log to console, which goes to systemd's journald. To see Synapse's logs, execute: `journalctl -fu matrix-synapse`" msgstr "" -#: ../../../CHANGELOG.md:3238 -msgid "Due to recent playbook improvements and the fact that the world keeps turning, we're bumping the [version requirement for Ansible](docs/ansible.md#supported-ansible-versions) (2.4 -> 2.5)." +#: ../../../CHANGELOG.md:3237 +msgid "Because of this, the following variables have become obsolete and were removed:" +msgstr "" + +#: ../../../CHANGELOG.md:3239 +msgid "`matrix_synapse_max_log_file_size_mb`" msgstr "" #: ../../../CHANGELOG.md:3240 -msgid "We've also started building our own Docker image of Ansible ([devture/ansible](https://hub.docker.com/r/devture/ansible/)), which is useful for people who can't upgrade their local Ansible installation (see [Using Ansible via Docker](docs/ansible.md#using-ansible-via-docker))." +msgid "`matrix_synapse_max_log_files_count`" msgstr "" -#: ../../../CHANGELOG.md:3243 -msgid "2019-03-19" +#: ../../../CHANGELOG.md:3242 +msgid "To prevent confusion, it'd be better if you delete all old files manually after you've upgraded (`rm -f /matrix/synapse/run/homeserver.log*`)." msgstr "" -#: ../../../CHANGELOG.md:3245 -msgid "TLS support for coturn" +#: ../../../CHANGELOG.md:3244 +msgid "Because Synapse is incredibly chatty when it comes to logging (here's [one such issue](https://github.com/matrix-org/synapse/issues/4751) describing the problem), if you're running an ancient distribution (like CentOS 7.0), be advised that systemd's journald default logging restrictions may not be high enough to capture all log messages generated by Synapse. This is especially true if you've got a busy (Synapse) server. We advise that you manually add `RateLimitInterval=0` and `RateLimitBurst=0` under `[Storage]` in the `/etc/systemd/journald.conf` file, followed by restarting the logging service (`systemctl restart systemd-journald`)." msgstr "" #: ../../../CHANGELOG.md:3247 -msgid "We've added TLS support to the coturn TURN server installed by the playbook by default. The certificates from the Matrix domain will be used for the coturn server." +msgid "2019-06-27" msgstr "" #: ../../../CHANGELOG.md:3249 -msgid "This feature is enabled by default for new installations. To make use of TLS support for your existing Matrix server's coturn, make sure to rebuild both coturn and Synapse:" +msgid "(BC Break) Discord bridge configuration is now entirely managed by the playbook" +msgstr "" + +#: ../../../CHANGELOG.md:3251 +msgid "Until now, the `config.yaml` file for the [Discord bridge](docs/configuring-playbook-bridge-appservice-discord.md) was managed by the playbook, but the `registration.yaml` file was not." +msgstr "" + +#: ../../../CHANGELOG.md:3253 +msgid "From now on, the playbook will keep both configuration files sync for you." msgstr "" #: ../../../CHANGELOG.md:3255 -msgid "People who have an extra firewall (besides the iptables firewall, which Docker manages automatically), will need to open these additional firewall ports: `5349/tcp` (TURN over TCP) and `5349/udp` (TURN over UDP)." +msgid "This means that if you were making manual changes to the `/matrix/appservice-discord/discord-registration.yaml` configuration file, those would be lost the next time you run the playbook." msgstr "" #: ../../../CHANGELOG.md:3257 -msgid "People who build their own custom playbook from our roles should be aware that:" +msgid "The bridge now stores configuration in a subdirectory (`/matrix/appservice-discord/config`)." msgstr "" #: ../../../CHANGELOG.md:3259 -msgid "the `matrix-coturn` role and actually starting coturn (e.g. `--tags=start`), requires that certificates are already put in place. For this reason, it's usually a good idea to have the `matrix-coturn` role execute after `matrix-nginx-proxy` (which retrieves the certificates)." +msgid "Likewise, data is now also stored in a subdirectory (`/matrix/appservice-discord/data`). When you run the playbook with an existing database file (`/matrix/appservice-discord/discord.db`), the playbook will stop the bridge and relocate the database file to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." msgstr "" #: ../../../CHANGELOG.md:3261 -msgid "there are a few variables that can help you enable TLS support for coturn. See the `matrix-coturn` section in [group_vars/matrix-servers](./group_vars/matrix-servers)." +msgid "The main directory (`/matrix/appservice-discord`) may contain some leftover files (`user-store.db`, `room-store.db`, `config.yaml`, `discord-registration.yaml`, `invite_link`). These are no longer necessary and can be deleted manually." msgstr "" -#: ../../../CHANGELOG.md:3264 -msgid "2019-03-12" +#: ../../../CHANGELOG.md:3263 +msgid "We're now following the default sample configuration for the Discord bridge. If you need to override some values, define them in `matrix_appservice_discord_configuration_extension_yaml`." msgstr "" #: ../../../CHANGELOG.md:3266 -msgid "matrix-nginx-proxy support for serving the base domain" +msgid "2019-06-24" msgstr "" #: ../../../CHANGELOG.md:3268 -msgid "If you don't have a dedicated server for your base domain and want to set up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file), the playbook has got you covered now." +msgid "(BC Break) WhatsApp bridge configuration is now entirely managed by the playbook" msgstr "" #: ../../../CHANGELOG.md:3270 -msgid "It's now possible for the playbook to obtain an SSL certificate and serve the necessary files for Matrix Server Delegation on your base domain. Take a look at the new [Serving the base domain](docs/configuring-playbook-base-domain-serving.md) documentation page." +msgid "Until now, configuration files for the [WhatsApp bridge](docs/configuring-playbook-bridge-mautrix-whatsapp.md) were created by the playbook initially, but never modified later on." msgstr "" #: ../../../CHANGELOG.md:3272 -msgid "(BC break) matrix-nginx-proxy data variable renamed" +#: ../../../CHANGELOG.md:3289 +#: ../../../CHANGELOG.md:3308 +#: ../../../CHANGELOG.md:3347 +msgid "From now on, the playbook will keep the configuration in sync for you." msgstr "" #: ../../../CHANGELOG.md:3274 -msgid "`matrix_nginx_proxy_data_path` was renamed to `matrix_nginx_proxy_base_path`." +msgid "This means that if you were making manual changes to the `/matrix/mautrix-whatsapp/config.yaml` or `/matrix/mautrix-whatsapp/registration.yaml` configuration files, those would be lost the next time you run the playbook." msgstr "" #: ../../../CHANGELOG.md:3276 -msgid "There's a new `matrix_nginx_proxy_data_path` variable, which has a different use-purpose now (it's a subdirectory of `matrix_nginx_proxy_base_path` and is meant for storing various data files)." +msgid "The bridge now stores configuration in a subdirectory (`/matrix/mautrix-whatsapp/config`), so your old configuration remains in the base directory (`/matrix/mautrix-whatsapp`). You need to migrate any manual changes over to the new `matrix_mautrix_whatsapp_configuration_extension_yaml` variable, so that the playbook would apply them for you." msgstr "" -#: ../../../CHANGELOG.md:3279 -msgid "2019-03-10" +#: ../../../CHANGELOG.md:3278 +msgid "Likewise, data is now also stored in a subdirectory (`/matrix/mautrix-whatsapp/data`). When you run the playbook with an existing database file (`/matrix/mautrix-whatsapp/mautrix-whatsapp.db`), the playbook will stop the bridge and relocate the database file to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." msgstr "" -#: ../../../CHANGELOG.md:3281 -msgid "Dimension integration manager support" +#: ../../../CHANGELOG.md:3280 +msgid "We're now following the default configuration for the WhatsApp bridge." msgstr "" #: ../../../CHANGELOG.md:3283 -msgid "Thanks to [NullIsNot0](https://github.com/NullIsNot0), the playbook can now (optionally) install the [Dimension](https://dimension.t2bot.io/) integration manager. To learn more, see the [Setting up Dimension](docs/configuring-playbook-dimension.md) documentation page." +msgid "2019-06-20" msgstr "" -#: ../../../CHANGELOG.md:3286 -msgid "2019-03-07" +#: ../../../CHANGELOG.md:3285 +msgid "(BC Break) IRC bridge configuration is now entirely managed by the playbook" msgstr "" -#: ../../../CHANGELOG.md:3288 -msgid "Ability to customize mxisd's email templates" +#: ../../../CHANGELOG.md:3287 +msgid "Until now, configuration files for the [IRC bridge](docs/configuring-playbook-bridge-appservice-irc.md) were created by the playbook initially, but never modified later on." msgstr "" -#: ../../../CHANGELOG.md:3290 -msgid "Thanks to [Sylvia van Os](https://github.com/TheLastProject), mxisd's email templates can now be customized easily. To learn more, see the [Customizing email templates](docs/configuring-playbook-mxisd.md#customizing-email-templates) documentation page." +#: ../../../CHANGELOG.md:3291 +msgid "This means that if you were making manual changes to the `/matrix/appservice-irc/config.yaml` or `/matrix/appservice-irc/registration.yaml` configuration files, those would be lost the next time you run the playbook." msgstr "" #: ../../../CHANGELOG.md:3293 -msgid "2019-03-05" +msgid "The bridge now stores configuration in a subdirectory (`/matrix/appservice-irc/config`), so your old configuration remains in the base directory (`/matrix/appservice-irc`)." msgstr "" #: ../../../CHANGELOG.md:3295 -msgid "Discord bridging support" +msgid "Previously, we asked people to configure bridged IRC servers by extending the bridge configuration (`matrix_appservice_irc_configuration_extension_yaml`). While this is still possible and will continue working forever, **we now recommend defining IRC servers in the easier to use `matrix_appservice_irc_ircService_servers` variable**. See [our IRC bridge documentation page](docs/configuring-playbook-bridge-appservice-irc.md) for an example." msgstr "" #: ../../../CHANGELOG.md:3297 -msgid "[@Lionstiger](https://github.com/Lionstiger) has done some great work adding Discord bridging support via [matrix-appservice-discord](https://github.com/matrix-org/matrix-appservice-discord). To learn more, see the [Setting up Appservice Discord bridging](docs/configuring-playbook-bridge-appservice-discord.md) documentation page." +msgid "If you decide to continue using `matrix_appservice_irc_configuration_extension_yaml`, you might be interested to know that `ircService.databaseUri` and a few other keys now have default values in the base configuration (`matrix_appservice_irc_configuration_yaml`). You may wish to stop redefining those keys, unless you really intend to override them. You most likely only need to override `ircService.servers`." msgstr "" -#: ../../../CHANGELOG.md:3300 -msgid "2019-02-19" +#: ../../../CHANGELOG.md:3299 +msgid "Bridge data (`passkey.pem` and database files) is now also stored in a subdirectory (`/matrix/appservice-irc/data`). When you run the playbook with an existing `/matrix/appservice-irc/passkey.pem` file, the playbook will stop the bridge and relocate the passkey and database files (`rooms.db` and `users.db`) to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." msgstr "" #: ../../../CHANGELOG.md:3302 -msgid "Renaming variables" +msgid "2019-06-15" msgstr "" #: ../../../CHANGELOG.md:3304 -#: ../../../CHANGELOG.md:3621 -#: ../../../CHANGELOG.md:3706 -#: ../../../CHANGELOG.md:3826 -msgid "The following playbook variables were renamed:" +msgid "(BC Break) Telegram bridge configuration is now entirely managed by the playbook" msgstr "" #: ../../../CHANGELOG.md:3306 -msgid "from `host_specific_hostname_identity` to `matrix_domain`" -msgstr "" - -#: ../../../CHANGELOG.md:3307 -msgid "from `hostname_identity` to `matrix_domain`" -msgstr "" - -#: ../../../CHANGELOG.md:3308 -msgid "from `hostname_matrix` to `matrix_server_fqn_matrix`" -msgstr "" - -#: ../../../CHANGELOG.md:3309 -msgid "from `hostname_riot` to `matrix_server_fqn_riot`" +msgid "Until now, configuration files for the [Telegram bridge](docs/configuring-playbook-bridge-mautrix-telegram.md) were created by the playbook initially, but never modified later on." msgstr "" #: ../../../CHANGELOG.md:3310 -msgid "from `host_specific_matrix_ssl_lets_encrypt_support_email` to `matrix_ssl_lets_encrypt_support_email`" +msgid "This means that if you were making manual changes to the `/matrix/mautrix-telegram/config.yaml` or `/matrix/mautrix-telegram/registration.yaml` configuration files, those would be lost the next time you run the playbook." msgstr "" #: ../../../CHANGELOG.md:3312 -msgid "Doing that, we've simplified things, made names less confusing (hopefully) and moved all variable names under the `matrix_` prefix." +msgid "The bridge now stores configuration in a subdirectory (`/matrix/mautrix-telegram/config`), so your old configuration remains in the base directory (`/matrix/mautrix-telegram`). You need to migrate any manual changes over to the new `matrix_mautrix_telegram_configuration_extension_yaml` variable, so that the playbook would apply them for you." msgstr "" -#: ../../../CHANGELOG.md:3315 -msgid "2019-02-16" +#: ../../../CHANGELOG.md:3314 +msgid "Likewise, data is now also stored in a subdirectory (`/matrix/mautrix-telegram/data`). When you run the playbook with an existing database file (`/matrix/mautrix-telegram/mautrix-telegram.db`), the playbook will stop the bridge and relocate the database file to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." msgstr "" -#: ../../../CHANGELOG.md:3317 -msgid "Riot v1.0.1 support" +#: ../../../CHANGELOG.md:3316 +msgid "Also, we're now following the default configuration for the Telegram bridge, so some default configuration values are different:" +msgstr "" + +#: ../../../CHANGELOG.md:3318 +msgid "`edits_as_replies` (used to be `false`, now `true`) — previously replies were not sent over to Matrix at all; ow they are sent over as a reply to the original message" msgstr "" #: ../../../CHANGELOG.md:3319 -msgid "You can now use the brand new and redesigned Riot." +msgid "`inline_images` (used to be `true`, now `false`) — this has to do with captioned images. Inline-image (included caption) are said to exhibit troubles on Riot iOS. When `false`, the caption arrives on the Matrix side as a separate message." +msgstr "" + +#: ../../../CHANGELOG.md:3320 +msgid "`authless_portals` (used to be `false`, now `true`) — creating portals from the Telegram side is now possible" msgstr "" #: ../../../CHANGELOG.md:3321 -msgid "The new version no longer has a homepage by default, so we've also removed the custom homepage that we've been installing." +msgid "`whitelist_group_admins` (used to be `false`, now `true`) — allows Telegram group admins to use the bot commands" msgstr "" #: ../../../CHANGELOG.md:3323 -msgid "However, we still provide you with hooks to install your own `home.html` file by specifying the `matrix_riot_web_embedded_pages_home_path` variable (used to be called `matrix_riot_web_homepage_template` before)." +msgid "If the new values are not to your liking, use `matrix_mautrix_telegram_configuration_extension_yaml` to specify an override (refer to `matrix_mautrix_telegram_configuration_yaml` to figure out which variable goes where)." msgstr "" #: ../../../CHANGELOG.md:3326 -msgid "2019-02-14" +msgid "2019-06-12" msgstr "" #: ../../../CHANGELOG.md:3328 -msgid "Synapse v0.99.1" +msgid "Synapse v1.0" msgstr "" #: ../../../CHANGELOG.md:3330 -msgid "As we're moving toward Synapse v1.0, things are beginning to stabilize. Upgrading from v0.99.0 to v0.99.1 should be painless." +msgid "With [Synapse v1.0 now available](https://matrix.org/blog/2019/06/11/introducing-matrix-1-0-and-the-matrix-org-foundation) and most people being on at least Synapse v0.99, it's time to remove the `_matrix._tcp` DNS SRV record that we've been keeping for compatibility with old Synapse versions (<= 0.34)." msgstr "" #: ../../../CHANGELOG.md:3332 -msgid "If you've been overriding the default configuration so that you can terminate TLS at the Synapse side (`matrix_synapse_no_tls: false`), you'll now have to replace this custom configuration with `matrix_synapse_tls_federation_listener_enabled: true`. The `matrix_synapse_no_tls` variable is no more." +msgid "According to the [Server Discovery specification](https://matrix.org/docs/spec/server_server/r0.1.2.html#server-discovery), it's no harm to keep the DNS SRV record. But since it's not necessary for federating with the larger Matrix network anymore, you should be safe to get rid of it." msgstr "" -#: ../../../CHANGELOG.md:3335 -msgid "2019-02-06" +#: ../../../CHANGELOG.md:3334 +msgid "**Note**: don't confuse the `_matrix._tcp` and `_matrix-identity._tcp` DNS SRV records. The latter, **must not** be removed." msgstr "" -#: ../../../CHANGELOG.md:3337 -msgid "Synapse v0.99 support and preparation for Synapse v1.0" +#: ../../../CHANGELOG.md:3336 +msgid "For completeness, we must say that using a `_matrix._tcp` [SRV record for Server Delegation](docs/howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced) is still valid and useful for certain deployments. It's just that our guide recommends the [`/.well-known/matrix/server` Server Delegation method](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file), due to its easier implementation when using this playbook." msgstr "" -#: ../../../CHANGELOG.md:3339 -msgid "Matrix is undergoing a lot of changes as it matures towards Synapse v1.0. The first step is the Synapse v0.99 transitional release, which this playbook now supports." +#: ../../../CHANGELOG.md:3338 +msgid "Besides this optional/non-urgent DNS change, assuming you're already on Synapse v0.99, upgrading to Synapse v1.0 should be as simple as [re-running the playbook](docs/maintenance-upgrading-services.md)." msgstr "" #: ../../../CHANGELOG.md:3341 -msgid "If you've been using this playbook successfully until now, you'd be aware that we've been doing [Server Delegation](docs/howto-server-delegation.md) using a `_matrix._tcp` DNS SRV record (as per [Configuring DNS](docs/configuring-dns.md))." +msgid "2019-06-07" msgstr "" #: ../../../CHANGELOG.md:3343 -msgid "Due to changes related to certificate file requirements that will affect us at Synapse v1.0, we'll have to stop using a **`_matrix._tcp` DNS SRV record in the future** (when Synapse goes to v1.0 — around 5th of March 2019). We **still need to keep the SRV record for now**, for backward compatibility with older Synapse versions (lower than v0.99)." +msgid "(BC Break) Facebook bridge configuration is now entirely managed by the playbook" msgstr "" #: ../../../CHANGELOG.md:3345 -msgid "**What you need to do now** is make use of this transitional Synapse v0.99 release to **prepare your federation settings for the future**. You have 2 choices to prepare yourself for compatibility with the future Synapse v1.0:" -msgstr "" - -#: ../../../CHANGELOG.md:3347 -msgid "(recommended) set up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file), unless you are affected by the [Downsides of well-known-based Server Delegation](docs/howto-server-delegation.md#downsides-of-well-known-based-server-delegation). If you had previously set up the well-known `client` file, depending on how you've done it, it may be that there is nothing new required of you (besides [upgrading](docs/maintenance-upgrading-services.md)). After upgrading, you can [run a self-check](docs/maintenance-checking-services.md), which will tell you if you need to do anything extra with regard to setting up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file). After some time, when most people have upgraded to Synapse v0.99 and older releases have disappeared, be prepared to drop your `_matrix._tcp` SRV record." +msgid "Until now, configuration files for the [Facebook bridge](docs/configuring-playbook-bridge-mautrix-facebook.md) were created by the playbook initially, but never modified later on." msgstr "" #: ../../../CHANGELOG.md:3349 -msgid "(more advanced) if the [Downsides of well-known-based Server Delegation](docs/howto-server-delegation.md#downsides-of-well-known-based-server-delegation) are not to your liking, **as an alternative**, you can set up [Server Delegation via a DNS SRV record](docs/howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced). In such a case, you get to keep using your existing `_matrix._tcp` DNS SRV record forever and need to NOT set up a `/.well-known/matrix/server` file. Don't forget that you need to do certificate changes though. Follow the guide at [Server Delegation via a DNS SRV record](docs/howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced)." +msgid "This means that if you were making manual changes to the `/matrix/mautrix-facebook/config.yaml` or `/matrix/mautrix-facebook/registration.yaml` configuration files, those would be lost the next time you run the playbook." msgstr "" -#: ../../../CHANGELOG.md:3352 -msgid "2019-02-01" +#: ../../../CHANGELOG.md:3351 +msgid "The bridge now stores configuration in a subdirectory (`/matrix/mautrix-facebook/config`), so your old configuration remains in the base directory (`/matrix/mautrix-facebook`). You need to migrate any manual changes over to the new `matrix_mautrix_facebook_configuration_extension_yaml` variable, so that the playbook would apply them for you." msgstr "" -#: ../../../CHANGELOG.md:3354 -msgid "TLS v1.3 support" +#: ../../../CHANGELOG.md:3353 +msgid "Likewise, data is now also stored in a subdirectory (`/matrix/mautrix-facebook/data`). When you run the playbook with an existing database file (`/matrix/mautrix-facebook/mautrix-facebook.db`), the playbook will stop the bridge and relocate the database file to the `./data` directory. There's no data-loss involved. You'll need to restart the bridge manually though (`--tags=start`)." msgstr "" #: ../../../CHANGELOG.md:3356 -msgid "Now that the [nginx Docker image](https://hub.docker.com/_/nginx) has [added support for TLS v1.3](https://github.com/nginxinc/docker-nginx/issues/190), we have enabled that protocol by default." +msgid "2019-05-25" msgstr "" #: ../../../CHANGELOG.md:3358 -msgid "When using:" +msgid "Support for exposing container ports publicly (not just to the host)" msgstr "" #: ../../../CHANGELOG.md:3360 -msgid "the **integrated nginx server**: TLS v1.3 support might not kick in immediately, because the nginx version hasn't been bumped and you may have an older build of the nginx Docker image (currently `nginx:1.15.8-alpine`). Typically, we do not re-pull images that you already have. When the nginx version gets bumped in the future, everyone will get the update. Until then, you could manually force-pull the rebuilt Docker image by running this on the server: `docker pull nginx:1.15.8-alpine`." +msgid "Until now, various roles supported a `matrix_*_expose_port` variable, which would expose their container's port to the host. This was mostly useful for reverse-proxying manually (in case `matrix-nginx-proxy` was disabled). It could also be used for installing some playbook services (e.g. bridges, etc.) and wiring them to a separate (manual) Matrix setup." msgstr "" #: ../../../CHANGELOG.md:3362 -msgid "**your own external nginx server**: if your external nginx server is too old, the new configuration we generate for you in `/matrix/nginx-proxy/conf.d/` might not work anymore, because it mentions `TLSv1.3` and your nginx version might not support that. You can adjust the SSL protocol list by overriding the `matrix_nginx_proxy_ssl_protocols` variable. Learn more in the documentation page for [Using your own webserver, instead of this playbook's nginx proxy](docs/configuring-playbook-own-webserver.md)" +msgid "`matrix_*_expose_port` variables were not granular enough — sometimes they would expose one port, other times multiple. They also didn't provide control over **where** to expose (to which port number and to which network interface), because they would usually hardcode something like `127.0.0.1:8080`." msgstr "" #: ../../../CHANGELOG.md:3364 -msgid "**another web server**: you don't need to do anything to accommodate this change" +msgid "All such variables have been superseded by a better (more flexible) way to do it." msgstr "" -#: ../../../CHANGELOG.md:3367 -msgid "2019-01-31" +#: ../../../CHANGELOG.md:3366 +msgid "**Most** people (including those not using `matrix-nginx-proxy`), **don't need** to bother with this." msgstr "" -#: ../../../CHANGELOG.md:3369 -msgid "IRC bridging support" +#: ../../../CHANGELOG.md:3368 +msgid "Porting examples follow for people having more customized setups:" msgstr "" -#: ../../../CHANGELOG.md:3371 -msgid "[Devon Maloney (@Plailect)](https://github.com/Plailect) has done some great work bringing IRC bridging support via [matrix-appservice-irc](https://github.com/TeDomum/matrix-appservice-irc). To learn more, see the [Setting up Appservice IRC bridging](docs/configuring-playbook-bridge-appservice-irc.md) documentation page." +#: ../../../CHANGELOG.md:3370 +msgid "**from** `matrix_synapse_container_expose_client_api_port: true` **to** `matrix_synapse_container_client_api_host_bind_port: '127.0.0.1:8008'`" +msgstr "" + +#: ../../../CHANGELOG.md:3372 +msgid "**from** `matrix_synapse_container_expose_federation_api_port: true` **to** `matrix_synapse_container_federation_api_plain_host_bind_port: '127.0.0.1:8048'` and possibly `matrix_synapse_container_federation_api_tls_host_bind_port: '8448'`" msgstr "" #: ../../../CHANGELOG.md:3374 -msgid "2019-01-29" +msgid "**from** `matrix_synapse_container_expose_metrics_port: true` **to** `matrix_synapse_container_metrics_api_host_bind_port: '127.0.0.1:9100'`" msgstr "" #: ../../../CHANGELOG.md:3376 -msgid "Running container processes as non-root, without capabilities and read-only" +msgid "**from** `matrix_riot_web_container_expose_port: true` **to** `matrix_riot_web_container_http_host_bind_port: '127.0.0.1:8765'`" msgstr "" #: ../../../CHANGELOG.md:3378 -msgid "To improve security, this playbook no longer starts container processes as the `root` user. Most containers were dropping privileges anyway, but we were trusting them with `root` privileges until they would do that. Not anymore — container processes now start as a non-root user (usually `matrix`) from the get-go." +msgid "**from** `matrix_mxisd_container_expose_port: true` **to** `matrix_mxisd_container_http_host_bind_port: '127.0.0.1:8090'`" msgstr "" #: ../../../CHANGELOG.md:3380 -msgid "For additional security, various capabilities are also dropped (see [why it's important](https://github.com/projectatomic/atomic-site/issues/203)) for all containers." +msgid "**from** `matrix_dimension_container_expose_port: true` **to** `matrix_dimension_container_http_host_bind_port: '127.0.0.1:8184'`" msgstr "" #: ../../../CHANGELOG.md:3382 -msgid "Additionally, most containers now use a read-only filesystem (see [why it's important](https://www.projectatomic.io/blog/2015/12/making-docker-images-write-only-in-production/)). Containers are given write access only to the directories they need to write to." +msgid "**from** `matrix_corporal_container_expose_ports: true` **to** `matrix_corporal_container_http_gateway_host_bind_port: '127.0.0.1:41080'` and possibly `matrix_corporal_container_http_api_host_bind_port: '127.0.0.1:41081'`" msgstr "" #: ../../../CHANGELOG.md:3384 -msgid "A minor breaking change is the `matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size` variable having being renamed to `matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb` (note the `_mb` suffix). The new variable expects a number value (e.g. `25M` -> `25`). If you weren't customizing this variable, this wouldn't affect you." +msgid "**from** `matrix_appservice_irc_container_expose_client_server_api_port: true` **to** `matrix_appservice_irc_container_http_host_bind_port: '127.0.0.1:9999'`" msgstr "" #: ../../../CHANGELOG.md:3386 -msgid "matrix-mailer is now based on Exim, not Postfix" +msgid "**from** `matrix_appservice_discord_container_expose_client_server_api_port: true` **to** `matrix_appservice_discord_container_http_host_bind_port: '127.0.0.1:9005'`" msgstr "" #: ../../../CHANGELOG.md:3388 -msgid "While we would have preferred to stay with [Postfix](http://www.postfix.org/), we found out that it cannot run as a non-root user. We've had to replace it with [Exim](https://www.exim.org/) (via the [devture/exim-relay](https://hub.docker.com/r/devture/exim-relay) container image)." +msgid "As always, if you forget to remove usage of some outdated variable, the playbook will warn you." msgstr "" -#: ../../../CHANGELOG.md:3390 -msgid "The internal `matrix-mailer` service (running in a container) now listens on port `8025` (used to be `587` before). The playbook will update your Synapse and mxisd email settings to match (`matrix-mailer:587` -> `matrix-mailer:8025`)." +#: ../../../CHANGELOG.md:3391 +msgid "2019-05-23" msgstr "" -#: ../../../CHANGELOG.md:3392 -msgid "Using the [devture/exim-relay](https://hub.docker.com/r/devture/exim-relay) container image instead of [panubo/postfix](https://hub.docker.com/r/panubo/postfix/) also gives us a nice disk usage reduction (~200MB -> 8MB)." +#: ../../../CHANGELOG.md:3393 +msgid "(BC Break) Ansible 2.8 compatibility" msgstr "" #: ../../../CHANGELOG.md:3395 -msgid "2019-01-17" +msgid "Thanks to [@danbob](https://github.com/danbob), the playbook now [supports the new Ansible 2.8](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/187)." msgstr "" #: ../../../CHANGELOG.md:3397 -msgid "(BC Break) Making the playbook's roles more independent of one another" +msgid "A manual change is required to the `inventory/hosts` file, changing the group name from `matrix-servers` to `matrix_servers` (dash to underscore)." msgstr "" #: ../../../CHANGELOG.md:3399 -msgid "The following change **affects people running a more non-standard setup** — external Postgres or using our roles in their own other playbook. **Most users don't need to do anything**, besides becoming aware of the new glue variables file [`group_vars/matrix-servers`](group_vars/matrix-servers)." +msgid "To avoid doing it manually, run this:" msgstr "" -#: ../../../CHANGELOG.md:3402 -msgid "Because people like using the playbook's components independently (outside of this playbook) and because it's much better for maintainability, we've continued working on separating them. Still, we'd like to offer a turnkey solution for running a fully-featured Matrix server, so this playbook remains important for wiring up the various components." +#: ../../../CHANGELOG.md:3400 +msgid "Linux: `sed -i 's/matrix-servers/matrix_servers/g' inventory/hosts`" +msgstr "" + +#: ../../../CHANGELOG.md:3401 +msgid "Mac: `sed -i '' 's/matrix-servers/matrix_servers/g' inventory/hosts`" msgstr "" #: ../../../CHANGELOG.md:3404 -msgid "With the new changes, **all roles are now only dependent on the minimal `matrix-base` role**. They are no longer dependent among themselves." +msgid "2019-05-21" msgstr "" #: ../../../CHANGELOG.md:3406 -msgid "In addition, the following components can now be completely disabled (for those who want/need to):" -msgstr "" - -#: ../../../CHANGELOG.md:3407 -msgid "`matrix-coturn` by using `matrix_coturn_enabled: false`" +msgid "Synapse no longer required" msgstr "" #: ../../../CHANGELOG.md:3408 -msgid "`matrix-mailer` by using `matrix_mailer_enabled: false`" +msgid "The playbook no longer insists on installing [Synapse](https://github.com/element-hq/synapse) via the `matrix-synapse` role." msgstr "" -#: ../../../CHANGELOG.md:3409 -msgid "`matrix-postgres` by using `matrix_postgres_enabled: false`" +#: ../../../CHANGELOG.md:3410 +msgid "If you would prefer to install Synapse another way and just use the playbook to install other services, it should be possible (`matrix_synapse_enabled: false`)." msgstr "" -#: ../../../CHANGELOG.md:3411 -msgid "The following changes had to be done:" +#: ../../../CHANGELOG.md:3412 +msgid "Note that it won't necessarily be the best experience, since the playbook wires things to Synapse by default. If you're using your own Synapse instance (especially one not running in a container), you may have to override many variables to point them to the correct place." msgstr "" -#: ../../../CHANGELOG.md:3413 -msgid "glue variables had to be introduced to the playbook, so it can wire together the various components. Those glue vars are stored in the [`group_vars/matrix-servers`](group_vars/matrix-servers) file. When overriding variables for a given component (role), you need to be aware of both the role defaults (`role/ROLE/defaults/main.yml`) and the role's corresponding section in the [`group_vars/matrix-servers`](group_vars/matrix-servers) file." +#: ../../../CHANGELOG.md:3414 +msgid "Having Synapse not be a required component potentially opens the door for installing alternative Matrix homeservers." msgstr "" -#: ../../../CHANGELOG.md:3415 -msgid "`matrix_postgres_use_external` has been superceeded by the more consistently named `matrix_postgres_enabled` variable and a few other `matrix_synapse_database_` variables. See the [Using an external PostgreSQL server (optional)](docs/configuring-playbook-external-postgres.md) documentation page for an up-to-date replacement." +#: ../../../CHANGELOG.md:3416 +msgid "Bridges are now separate from the Synapse role" msgstr "" -#: ../../../CHANGELOG.md:3417 -msgid "Postgres tools (`matrix-postgres-cli` and `matrix-make-user-admin`) are no longer installed if you're not enabling the `matrix-postgres` role (`matrix_postgres_enabled: false`)" +#: ../../../CHANGELOG.md:3418 +msgid "Bridges are no longer part of the `matrix-synapse` role. Each bridge now lives in its own separate role (`roles/custom/matrix-bridge-*`)." msgstr "" -#: ../../../CHANGELOG.md:3419 -msgid "roles, being more independent now, are more minimal and do not do so much magic for you. People that are building their own playbook using our roles will definitely need to take a look at the [`group_vars/matrix-servers`](group_vars/matrix-servers) file and adapt their playbooks with the same (or similar) wiring logic." +#: ../../../CHANGELOG.md:3420 +msgid "These bridge roles are independent of the `matrix-synapse` role, so it should be possible to use them with a Synapse instance installed another way (not through the playbook)." msgstr "" #: ../../../CHANGELOG.md:3422 -msgid "2019-01-16" +msgid "Renaming inconsistently-named Synapse variables" msgstr "" #: ../../../CHANGELOG.md:3424 -msgid "Splitting the playbook into multiple roles" +msgid "For better consistency, the following variables have been renamed:" msgstr "" #: ../../../CHANGELOG.md:3426 -msgid "For better maintainability, the playbook logic (which all used to reside in a single `matrix-server` role) has been split out into a number of different roles: `matrix-synapse`, `matrix-postgres`, `matrix-riot-web`, `matrix-mxisd`, etc. (see the `roles/` directory)." +msgid "`matrix_enable_room_list_search` was renamed to `matrix_synapse_enable_room_list_search`" msgstr "" -#: ../../../CHANGELOG.md:3429 -msgid "To keep the filesystem more consistent with this separation, the **Postgres data had to be relocated**." +#: ../../../CHANGELOG.md:3427 +msgid "`matrix_alias_creation_rules` was renamed to `matrix_synapse_alias_creation_rules`" +msgstr "" + +#: ../../../CHANGELOG.md:3428 +msgid "`matrix_nginx_proxy_matrix_room_list_publication_rulesdata_path` was renamed to `matrix_synapse_room_list_publication_rules`" msgstr "" #: ../../../CHANGELOG.md:3431 -msgid "The default value of `matrix_postgres_data_path` was changed from `/matrix/postgres` to `/matrix/postgres/data`. The `/matrix/postgres` directory is what we consider a base path now (new variable `matrix_postgres_base_path`). **Your Postgres data files will automatically be relocated by the playbook** (`/matrix/postgres/*` -> `/matrix/postgres/data/`) when you run with `--tags=setup-all` (or `--tags=setup-postgres`). While this shouldn't cause data-loss, **it's better if you do a Postgres backup just in case**. You'd need to restart all services after this migration (`--tags=start`)." +msgid "2019-05-09" msgstr "" -#: ../../../CHANGELOG.md:3434 -msgid "2019-01-11" +#: ../../../CHANGELOG.md:3433 +msgid "Besides a myriad of bug fixes and minor improvements, here are the more notable (bigger) features we can announce today." msgstr "" -#: ../../../CHANGELOG.md:3436 -msgid "(BC Break) mxisd configuration changes" +#: ../../../CHANGELOG.md:3435 +msgid "Mautrix Facebook/Messenger bridging support" msgstr "" -#: ../../../CHANGELOG.md:3438 -msgid "To be more flexible and to support the upcoming [mxisd](https://github.com/kamax-io/mxisd) 1.3.0 (when it gets released), we've had to redo how mxisd gets configured." +#: ../../../CHANGELOG.md:3437 +msgid "The playbook now supports bridging with [Facebook](https://www.facebook.com/) by installing the [mautrix-facebook](https://github.com/tulir/mautrix-facebook) bridge. This playbook functionality is available thanks to [@izissise](https://github.com/izissise)." +msgstr "" + +#: ../../../CHANGELOG.md:3439 +msgid "Additional details are available in [Setting up Mautrix Facebook bridging](docs/configuring-playbook-bridge-mautrix-facebook.md)." msgstr "" #: ../../../CHANGELOG.md:3441 -msgid "The following variables are no longer supported by this playbook:" +msgid "mxisd Registration feature integration" msgstr "" #: ../../../CHANGELOG.md:3443 -msgid "`matrix_mxisd_ldap_enabled`" -msgstr "" - -#: ../../../CHANGELOG.md:3444 -msgid "`matrix_mxisd_ldap_connection_host`" +msgid "The playbook can now help you integrate with mxisd's [Registration](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/registration.md) feature." msgstr "" #: ../../../CHANGELOG.md:3445 -msgid "`matrix_mxisd_ldap_connection_tls`" -msgstr "" - -#: ../../../CHANGELOG.md:3446 -msgid "`matrix_mxisd_ldap_connection_port`" -msgstr "" - -#: ../../../CHANGELOG.md:3447 -msgid "`matrix_mxisd_ldap_connection_baseDn`" +msgid "Learn more in [mxisd-controlled Registration](docs/configuring-playbook-mxisd.md#mxisd-controlled-registration)." msgstr "" #: ../../../CHANGELOG.md:3448 -msgid "`matrix_mxisd_ldap_connection_baseDns`" +msgid "2019-04-16" msgstr "" -#: ../../../CHANGELOG.md:3449 #: ../../../CHANGELOG.md:3450 -msgid "`matrix_mxisd_ldap_connection_bindDn`" -msgstr "" - -#: ../../../CHANGELOG.md:3451 -#: ../../../CHANGELOG.md:3455 -msgid "`matrix_mxisd_ldap_connection_bindPassword`" +msgid "Caddy webserver examples" msgstr "" #: ../../../CHANGELOG.md:3452 -msgid "`matrix_mxisd_ldap_filter`" -msgstr "" - -#: ../../../CHANGELOG.md:3453 -msgid "`matrix_mxisd_ldap_attribute_uid_type`" +msgid "If you prefer using the [Caddy](https://caddyserver.com/) webserver instead of our own integrated nginx, we now have examples for it in the [`examples/caddy`](examples/caddy) directory" msgstr "" #: ../../../CHANGELOG.md:3454 -msgid "`matrix_mxisd_ldap_attribute_uid_value`" +msgid "2019-04-10" msgstr "" #: ../../../CHANGELOG.md:3456 -msgid "`matrix_mxisd_ldap_attribute_name`" -msgstr "" - -#: ../../../CHANGELOG.md:3457 -msgid "`matrix_mxisd_ldap_attribute_threepid_email`" +msgid "Goofys support for other S3-compatible object stores" msgstr "" #: ../../../CHANGELOG.md:3458 -msgid "`matrix_mxisd_ldap_attribute_threepid_msisdn`" -msgstr "" - -#: ../../../CHANGELOG.md:3459 -msgid "`matrix_mxisd_ldap_identity_filter`" -msgstr "" - -#: ../../../CHANGELOG.md:3460 -msgid "`matrix_mxisd_ldap_identity_medium`" +msgid "Until now, you could optionally host Synapse's media repository on Amazon S3, but we now also support [using other S3-compatible object stores](docs/configuring-playbook-s3.md)," msgstr "" #: ../../../CHANGELOG.md:3461 -msgid "`matrix_mxisd_ldap_auth_filter`" -msgstr "" - -#: ../../../CHANGELOG.md:3462 -msgid "`matrix_mxisd_ldap_directory_filter`" +msgid "2019-04-03" msgstr "" #: ../../../CHANGELOG.md:3463 -msgid "`matrix_mxisd_template_config`" +msgid "Ansible >= 2.5 is required" msgstr "" #: ../../../CHANGELOG.md:3465 -msgid "You are encouraged to use the `matrix_mxisd_configuration_extension_yaml` variable to define your own mxisd configuration additions and overrides. Refer to the [default variables file](roles/custom/matrix-mxisd/defaults/main.yml) for more information." +msgid "Due to recent playbook improvements and the fact that the world keeps turning, we're bumping the [version requirement for Ansible](docs/ansible.md#supported-ansible-versions) (2.4 -> 2.5)." msgstr "" #: ../../../CHANGELOG.md:3467 -msgid "This new way of configuring mxisd is beneficial because:" -msgstr "" - -#: ../../../CHANGELOG.md:3469 -msgid "it lets us support all mxisd configuration options, as the playbook simply forwards them to mxisd without needing to care or understand them" +msgid "We've also started building our own Docker image of Ansible ([devture/ansible](https://hub.docker.com/r/devture/ansible/)), which is useful for people who can't upgrade their local Ansible installation (see [Using Ansible via Docker](docs/ansible.md#using-ansible-via-docker))." msgstr "" #: ../../../CHANGELOG.md:3470 -msgid "it lets you upgrade to newer mxisd versions and make use of their features, without us having to add support for them explicitly" +msgid "2019-03-19" msgstr "" -#: ../../../CHANGELOG.md:3473 -msgid "2019-01-08" +#: ../../../CHANGELOG.md:3472 +msgid "TLS support for coturn" msgstr "" -#: ../../../CHANGELOG.md:3475 -msgid "(BC Break) Cronjob schedule no longer configurable" +#: ../../../CHANGELOG.md:3474 +msgid "We've added TLS support to the coturn TURN server installed by the playbook by default. The certificates from the Matrix domain will be used for the coturn server." msgstr "" -#: ../../../CHANGELOG.md:3477 -msgid "Due to the way we manage cronjobs now, you can no longer configure the schedule they're invoked at." -msgstr "" - -#: ../../../CHANGELOG.md:3479 -msgid "If you were previously using `matrix_ssl_lets_encrypt_renew_cron_time_definition` or `matrix_nginx_proxy_reload_cron_time_definition` to set a custom schedule, you should note that these variables don't affect anything anymore." +#: ../../../CHANGELOG.md:3476 +msgid "This feature is enabled by default for new installations. To make use of TLS support for your existing Matrix server's coturn, make sure to rebuild both coturn and Synapse:" msgstr "" #: ../../../CHANGELOG.md:3482 -msgid "If you miss this functionality, please [open an Issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/new) and let us know about your use case!" +msgid "People who have an extra firewall (besides the iptables firewall, which Docker manages automatically), will need to open these additional firewall ports: `5349/tcp` (TURN over TCP) and `5349/udp` (TURN over UDP)." msgstr "" -#: ../../../CHANGELOG.md:3485 -msgid "2018-12-23" +#: ../../../CHANGELOG.md:3484 +msgid "People who build their own custom playbook from our roles should be aware that:" msgstr "" -#: ../../../CHANGELOG.md:3487 -msgid "(BC Break) More SSL certificate retrieval methods" +#: ../../../CHANGELOG.md:3486 +msgid "the `matrix-coturn` role and actually starting coturn (e.g. `--tags=start`), requires that certificates are already put in place. For this reason, it's usually a good idea to have the `matrix-coturn` role execute after `matrix-nginx-proxy` (which retrieves the certificates)." msgstr "" -#: ../../../CHANGELOG.md:3489 -msgid "The playbook now lets you decide between 3 different SSL certificate retrieval methods:" -msgstr "" - -#: ../../../CHANGELOG.md:3490 -msgid "(default) obtaining free SSL certificates from Let's Encrypt" +#: ../../../CHANGELOG.md:3488 +msgid "there are a few variables that can help you enable TLS support for coturn. See the `matrix-coturn` section in [group_vars/matrix-servers](./group_vars/matrix-servers)." msgstr "" #: ../../../CHANGELOG.md:3491 -msgid "generating self-signed SSL certificates" +msgid "2019-03-12" msgstr "" -#: ../../../CHANGELOG.md:3492 -msgid "managing SSL certificates manually" +#: ../../../CHANGELOG.md:3493 +msgid "matrix-nginx-proxy support for serving the base domain" msgstr "" -#: ../../../CHANGELOG.md:3494 -msgid "Learn more in [Adjusting SSL certificate retrieval](docs/configuring-playbook-ssl-certificates.md)." +#: ../../../CHANGELOG.md:3495 +msgid "If you don't have a dedicated server for your base domain and want to set up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file), the playbook has got you covered now." msgstr "" -#: ../../../CHANGELOG.md:3496 -msgid "For people who use Let's Encrypt (mostly everyone, since it's the default), you'll also have to rename a variable in your configuration:" -msgstr "" - -#: ../../../CHANGELOG.md:3498 -msgid "before: `host_specific_matrix_ssl_support_email`" +#: ../../../CHANGELOG.md:3497 +msgid "It's now possible for the playbook to obtain an SSL certificate and serve the necessary files for Matrix Server Delegation on your base domain. Take a look at the new [Serving the base domain](docs/configuring-playbook-base-domain-serving.md) documentation page." msgstr "" #: ../../../CHANGELOG.md:3499 -msgid "after: `host_specific_matrix_ssl_lets_encrypt_support_email`" +msgid "(BC break) matrix-nginx-proxy data variable renamed" msgstr "" #: ../../../CHANGELOG.md:3501 -msgid "(BC Break) mxisd upgrade with multiple base DN support" +msgid "`matrix_nginx_proxy_data_path` was renamed to `matrix_nginx_proxy_base_path`." msgstr "" #: ../../../CHANGELOG.md:3503 -msgid "mxisd has bee upgraded to [version 1.2.2](https://github.com/kamax-matrix/mxisd/releases/tag/v1.2.2), which supports [multiple base DNs](https://github.com/kamax-matrix/mxisd/blob/v1.2.2/docs/stores/ldap.md#base)." +msgid "There's a new `matrix_nginx_proxy_data_path` variable, which has a different use-purpose now (it's a subdirectory of `matrix_nginx_proxy_base_path` and is meant for storing various data files)." msgstr "" -#: ../../../CHANGELOG.md:3505 -msgid "If you were configuring this playbook's `matrix_mxisd_ldap_connection_baseDn` variable until now (a string containing a single base DN), you'll need to change to configuring the `matrix_mxisd_ldap_connection_baseDns` variable (an array containing multiple base DNs)." +#: ../../../CHANGELOG.md:3506 +msgid "2019-03-10" msgstr "" -#: ../../../CHANGELOG.md:3507 -msgid "Example change:" -msgstr "" - -#: ../../../CHANGELOG.md:3509 -msgid "before: `matrix_mxisd_ldap_connection_baseDn: OU=Users,DC=example,DC=org`" +#: ../../../CHANGELOG.md:3508 +msgid "Dimension integration manager support" msgstr "" #: ../../../CHANGELOG.md:3510 -msgid "after: `matrix_mxisd_ldap_connection_baseDns: ['OU=Users,DC=example,DC=org']`" +msgid "Thanks to [NullIsNot0](https://github.com/NullIsNot0), the playbook can now (optionally) install the [Dimension](https://dimension.t2bot.io/) integration manager. To learn more, see the [Setting up Dimension](docs/configuring-playbook-dimension.md) documentation page." msgstr "" #: ../../../CHANGELOG.md:3513 -msgid "2018-12-21" +msgid "2019-03-07" msgstr "" #: ../../../CHANGELOG.md:3515 -msgid "Synapse 0.34.0 and Python 3" +msgid "Ability to customize mxisd's email templates" msgstr "" #: ../../../CHANGELOG.md:3517 -msgid "Synapse has been upgraded to 0.34.0 and now uses Python 3. Based on feedback from others, running Synapse on Python 3 is supposed to decrease memory usage significantly (~2x)." +msgid "Thanks to [Sylvia van Os](https://github.com/TheLastProject), mxisd's email templates can now be customized easily. To learn more, see the [Customizing email templates](docs/configuring-playbook-mxisd.md#customizing-email-templates) documentation page." msgstr "" #: ../../../CHANGELOG.md:3520 -msgid "2018-12-12" +msgid "2019-03-05" msgstr "" #: ../../../CHANGELOG.md:3522 -msgid "Riot homepage customization" +msgid "Discord bridging support" msgstr "" #: ../../../CHANGELOG.md:3524 -msgid "You can now customize some parts of the Riot homepage (or even completely replace it with your own custom page). See the `matrix_riot_web_homepage_` variables in `roles/custom/matrix-riot-web/defaults/main.yml`." +msgid "[@Lionstiger](https://github.com/Lionstiger) has done some great work adding Discord bridging support via [matrix-appservice-discord](https://github.com/matrix-org/matrix-appservice-discord). To learn more, see the [Setting up Appservice Discord bridging](docs/configuring-playbook-bridge-appservice-discord.md) documentation page." msgstr "" #: ../../../CHANGELOG.md:3527 -msgid "2018-12-04" +msgid "2019-02-19" msgstr "" #: ../../../CHANGELOG.md:3529 -msgid "mxisd extensibility" +msgid "Renaming variables" msgstr "" #: ../../../CHANGELOG.md:3531 -msgid "The [LDAP identity store for mxisd](https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/ldap.md) can now be configured easily using playbook variables (see the `matrix_mxisd_ldap_` variables in `roles/custom/matrix-server/defaults/main.yml`)." +#: ../../../CHANGELOG.md:3848 +#: ../../../CHANGELOG.md:3933 +#: ../../../CHANGELOG.md:4053 +msgid "The following playbook variables were renamed:" +msgstr "" + +#: ../../../CHANGELOG.md:3533 +msgid "from `host_specific_hostname_identity` to `matrix_domain`" msgstr "" #: ../../../CHANGELOG.md:3534 -msgid "2018-11-28" +msgid "from `hostname_identity` to `matrix_domain`" +msgstr "" + +#: ../../../CHANGELOG.md:3535 +msgid "from `hostname_matrix` to `matrix_server_fqn_matrix`" msgstr "" #: ../../../CHANGELOG.md:3536 -msgid "More scripts" +msgid "from `hostname_riot` to `matrix_server_fqn_riot`" msgstr "" -#: ../../../CHANGELOG.md:3538 -msgid "matrix-remove-all allows to uninstall everything with a single command" +#: ../../../CHANGELOG.md:3537 +msgid "from `host_specific_matrix_ssl_lets_encrypt_support_email` to `matrix_ssl_lets_encrypt_support_email`" msgstr "" #: ../../../CHANGELOG.md:3539 -msgid "matrix-make-user-admin allows to upgrade a user's privileges" +msgid "Doing that, we've simplified things, made names less confusing (hopefully) and moved all variable names under the `matrix_` prefix." msgstr "" -#: ../../../CHANGELOG.md:3541 -msgid "LDAP auth support via matrix-synapse-ldap3" +#: ../../../CHANGELOG.md:3542 +msgid "2019-02-16" msgstr "" -#: ../../../CHANGELOG.md:3543 -msgid "The playbook can now install and configure [LDAP auth support](https://github.com/matrix-org/matrix-synapse-ldap3) for you." +#: ../../../CHANGELOG.md:3544 +msgid "Riot v1.0.1 support" msgstr "" -#: ../../../CHANGELOG.md:3545 -msgid "Additional details are available in [Setting up the LDAP authentication password provider module](docs/configuring-playbook-ldap-auth.md)." +#: ../../../CHANGELOG.md:3546 +msgid "You can now use the brand new and redesigned Riot." msgstr "" #: ../../../CHANGELOG.md:3548 -msgid "2018-11-23" +msgid "The new version no longer has a homepage by default, so we've also removed the custom homepage that we've been installing." msgstr "" #: ../../../CHANGELOG.md:3550 -msgid "Support for controlling public registration and room auto-join" +msgid "However, we still provide you with hooks to install your own `home.html` file by specifying the `matrix_riot_web_embedded_pages_home_path` variable (used to be called `matrix_riot_web_homepage_template` before)." msgstr "" -#: ../../../CHANGELOG.md:3552 -msgid "The playbook now lets you enable public registration for users (controlled via `matrix_synapse_enable_registration`). By default, public registration is forbidden." +#: ../../../CHANGELOG.md:3553 +msgid "2019-02-14" msgstr "" -#: ../../../CHANGELOG.md:3554 -msgid "You can also make people automatically get auto-joined to rooms (controlled via `matrix_synapse_auto_join_rooms`)." +#: ../../../CHANGELOG.md:3555 +msgid "Synapse v0.99.1" msgstr "" -#: ../../../CHANGELOG.md:3556 -msgid "Support for changing the welcome user ID (welcome bot)" +#: ../../../CHANGELOG.md:3557 +msgid "As we're moving toward Synapse v1.0, things are beginning to stabilize. Upgrading from v0.99.0 to v0.99.1 should be painless." msgstr "" -#: ../../../CHANGELOG.md:3558 -msgid "By default, `@riot-bot:matrix.org` is used to welcome newly registered users. This can be changed to something else (or disabled) via the new `matrix_riot_web_welcome_user_id` variable." +#: ../../../CHANGELOG.md:3559 +msgid "If you've been overriding the default configuration so that you can terminate TLS at the Synapse side (`matrix_synapse_no_tls: false`), you'll now have to replace this custom configuration with `matrix_synapse_tls_federation_listener_enabled: true`. The `matrix_synapse_no_tls` variable is no more." msgstr "" -#: ../../../CHANGELOG.md:3561 -msgid "2018-11-14" +#: ../../../CHANGELOG.md:3562 +msgid "2019-02-06" msgstr "" -#: ../../../CHANGELOG.md:3563 -msgid "Ability to set Synapse log levels" +#: ../../../CHANGELOG.md:3564 +msgid "Synapse v0.99 support and preparation for Synapse v1.0" msgstr "" -#: ../../../CHANGELOG.md:3565 -msgid "The playbook now allows you to set the log levels used by Synapse. The default logging levels remain the same." +#: ../../../CHANGELOG.md:3566 +msgid "Matrix is undergoing a lot of changes as it matures towards Synapse v1.0. The first step is the Synapse v0.99 transitional release, which this playbook now supports." msgstr "" -#: ../../../CHANGELOG.md:3567 -msgid "You can now override following variables with any of the supported log levels listed here: https://docs.python.org/3/library/logging.html#logging-levels" +#: ../../../CHANGELOG.md:3568 +msgid "If you've been using this playbook successfully until now, you'd be aware that we've been doing [Server Delegation](docs/howto-server-delegation.md) using a `_matrix._tcp` DNS SRV record (as per [Configuring DNS](docs/configuring-dns.md))." +msgstr "" + +#: ../../../CHANGELOG.md:3570 +msgid "Due to changes related to certificate file requirements that will affect us at Synapse v1.0, we'll have to stop using a **`_matrix._tcp` DNS SRV record in the future** (when Synapse goes to v1.0 — around 5th of March 2019). We **still need to keep the SRV record for now**, for backward compatibility with older Synapse versions (lower than v0.99)." +msgstr "" + +#: ../../../CHANGELOG.md:3572 +msgid "**What you need to do now** is make use of this transitional Synapse v0.99 release to **prepare your federation settings for the future**. You have 2 choices to prepare yourself for compatibility with the future Synapse v1.0:" +msgstr "" + +#: ../../../CHANGELOG.md:3574 +msgid "(recommended) set up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file), unless you are affected by the [Downsides of well-known-based Server Delegation](docs/howto-server-delegation.md#downsides-of-well-known-based-server-delegation). If you had previously set up the well-known `client` file, depending on how you've done it, it may be that there is nothing new required of you (besides [upgrading](docs/maintenance-upgrading-services.md)). After upgrading, you can [run a self-check](docs/maintenance-and-troubleshooting.md#how-to-check-if-services-work), which will tell you if you need to do anything extra with regard to setting up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file). After some time, when most people have upgraded to Synapse v0.99 and older releases have disappeared, be prepared to drop your `_matrix._tcp` SRV record." msgstr "" #: ../../../CHANGELOG.md:3576 -msgid "2018-11-03" +msgid "(more advanced) if the [Downsides of well-known-based Server Delegation](docs/howto-server-delegation.md#downsides-of-well-known-based-server-delegation) are not to your liking, **as an alternative**, you can set up [Server Delegation via a DNS SRV record](docs/howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced). In such a case, you get to keep using your existing `_matrix._tcp` DNS SRV record forever and need to NOT set up a `/.well-known/matrix/server` file. Don't forget that you need to do certificate changes though. Follow the guide at [Server Delegation via a DNS SRV record](docs/howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced)." msgstr "" -#: ../../../CHANGELOG.md:3578 -msgid "Customize parts of Riot's config" +#: ../../../CHANGELOG.md:3579 +msgid "2019-02-01" msgstr "" -#: ../../../CHANGELOG.md:3580 -msgid "You can now customize some parts of Riot's `config.json`. These playbook variables, with these default values, have been added:" +#: ../../../CHANGELOG.md:3581 +msgid "TLS v1.3 support" +msgstr "" + +#: ../../../CHANGELOG.md:3583 +msgid "Now that the [nginx Docker image](https://hub.docker.com/_/nginx) has [added support for TLS v1.3](https://github.com/nginxinc/docker-nginx/issues/190), we have enabled that protocol by default." +msgstr "" + +#: ../../../CHANGELOG.md:3585 +msgid "When using:" +msgstr "" + +#: ../../../CHANGELOG.md:3587 +msgid "the **integrated nginx server**: TLS v1.3 support might not kick in immediately, because the nginx version hasn't been bumped and you may have an older build of the nginx Docker image (currently `nginx:1.15.8-alpine`). Typically, we do not re-pull images that you already have. When the nginx version gets bumped in the future, everyone will get the update. Until then, you could manually force-pull the rebuilt Docker image by running this on the server: `docker pull nginx:1.15.8-alpine`." +msgstr "" + +#: ../../../CHANGELOG.md:3589 +msgid "**your own external nginx server**: if your external nginx server is too old, the new configuration we generate for you in `/matrix/nginx-proxy/conf.d/` might not work anymore, because it mentions `TLSv1.3` and your nginx version might not support that. You can adjust the SSL protocol list by overriding the `matrix_nginx_proxy_ssl_protocols` variable. Learn more in the documentation page for [Using your own webserver, instead of this playbook's nginx proxy](docs/configuring-playbook-own-webserver.md)" msgstr "" #: ../../../CHANGELOG.md:3591 -msgid "This now allows you use a custom integration manager like [Dimension](https://dimension.t2bot.io). For example, if you wish to use the Dimension instance hosted at dimension.t2bot.io, you can set the following in your vars.yml file:" +msgid "**another web server**: you don't need to do anything to accommodate this change" msgstr "" -#: ../../../CHANGELOG.md:3600 -msgid "SSL protocols used to serve Riot and Synapse" +#: ../../../CHANGELOG.md:3594 +msgid "2019-01-31" msgstr "" -#: ../../../CHANGELOG.md:3602 -msgid "There's now a new `matrix_nginx_proxy_ssl_protocols` playbook variable, which controls the SSL protocols used to serve Riot and Synapse. Its default value is `TLSv1.1 TLSv1.2`. This playbook previously used `TLSv1 TLSv1.1 TLSv1.2` to serve Riot and Synapse." +#: ../../../CHANGELOG.md:3596 +msgid "IRC bridging support" msgstr "" -#: ../../../CHANGELOG.md:3604 -msgid "You may wish to reenable TLSv1 if you need to access Riot in older browsers." +#: ../../../CHANGELOG.md:3598 +msgid "[Devon Maloney (@Plailect)](https://github.com/Plailect) has done some great work bringing IRC bridging support via [matrix-appservice-irc](https://github.com/TeDomum/matrix-appservice-irc). To learn more, see the [Setting up Appservice IRC bridging](docs/configuring-playbook-bridge-appservice-irc.md) documentation page." msgstr "" -#: ../../../CHANGELOG.md:3606 -msgid "Note: Currently the dockerized nginx doesn't support TLSv1.3. See https://github.com/nginxinc/docker-nginx/issues/190 for more details." +#: ../../../CHANGELOG.md:3601 +msgid "2019-01-29" +msgstr "" + +#: ../../../CHANGELOG.md:3603 +msgid "Running container processes as non-root, without capabilities and read-only" +msgstr "" + +#: ../../../CHANGELOG.md:3605 +msgid "To improve security, this playbook no longer starts container processes as the `root` user. Most containers were dropping privileges anyway, but we were trusting them with `root` privileges until they would do that. Not anymore — container processes now start as a non-root user (usually `matrix`) from the get-go." +msgstr "" + +#: ../../../CHANGELOG.md:3607 +msgid "For additional security, various capabilities are also dropped (see [why it's important](https://github.com/projectatomic/atomic-site/issues/203)) for all containers." msgstr "" #: ../../../CHANGELOG.md:3609 -msgid "2018-11-01" +msgid "Additionally, most containers now use a read-only filesystem (see [why it's important](https://www.projectatomic.io/blog/2015/12/making-docker-images-write-only-in-production/)). Containers are given write access only to the directories they need to write to." msgstr "" #: ../../../CHANGELOG.md:3611 -msgid "Postgres 11 support" +msgid "A minor breaking change is the `matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size` variable having being renamed to `matrix_nginx_proxy_proxy_matrix_client_api_client_max_body_size_mb` (note the `_mb` suffix). The new variable expects a number value (e.g. `25M` -> `25`). If you weren't customizing this variable, this wouldn't affect you." msgstr "" #: ../../../CHANGELOG.md:3613 -msgid "The playbook now installs [Postgres 11](https://www.postgresql.org/about/news/1894/) by default." +msgid "matrix-mailer is now based on Exim, not Postfix" msgstr "" #: ../../../CHANGELOG.md:3615 -msgid "If you have have an existing setup, it's likely running on an older Postgres version (9.x or 10.x). You can easily upgrade by following the [upgrading PostgreSQL guide](docs/maintenance-postgres.md#upgrading-postgresql)." +msgid "While we would have preferred to stay with [Postfix](http://www.postfix.org/), we found out that it cannot run as a non-root user. We've had to replace it with [Exim](https://www.exim.org/) (via the [devture/exim-relay](https://hub.docker.com/r/devture/exim-relay) container image)." msgstr "" #: ../../../CHANGELOG.md:3617 -#: ../../../CHANGELOG.md:3704 -#: ../../../CHANGELOG.md:3824 -msgid "(BC Break) Renaming playbook variables" +msgid "The internal `matrix-mailer` service (running in a container) now listens on port `8025` (used to be `587` before). The playbook will update your Synapse and mxisd email settings to match (`matrix-mailer:587` -> `matrix-mailer:8025`)." msgstr "" #: ../../../CHANGELOG.md:3619 -msgid "Due to the large amount of features added to this playbook lately, to keep things manageable we've had to reorganize its configuration variables a bit." +msgid "Using the [devture/exim-relay](https://hub.docker.com/r/devture/exim-relay) container image instead of [panubo/postfix](https://hub.docker.com/r/panubo/postfix/) also gives us a nice disk usage reduction (~200MB -> 8MB)." msgstr "" -#: ../../../CHANGELOG.md:3623 -msgid "from `matrix_docker_image_mxisd` to `matrix_mxisd_docker_image`" +#: ../../../CHANGELOG.md:3622 +msgid "2019-01-17" msgstr "" #: ../../../CHANGELOG.md:3624 -msgid "from `matrix_docker_image_mautrix_telegram` to `matrix_mautrix_telegram_docker_image`" -msgstr "" - -#: ../../../CHANGELOG.md:3625 -msgid "from `matrix_docker_image_mautrix_whatsapp` to `matrix_mautrix_whatsapp_docker_image`" +msgid "(BC Break) Making the playbook's roles more independent of one another" msgstr "" #: ../../../CHANGELOG.md:3626 -msgid "from `matrix_docker_image_mailer` to `matrix_mailer_docker_image`" -msgstr "" - -#: ../../../CHANGELOG.md:3627 -msgid "from `matrix_docker_image_coturn` to `matrix_coturn_docker_image`" -msgstr "" - -#: ../../../CHANGELOG.md:3628 -msgid "from `matrix_docker_image_goofys` to `matrix_s3_goofys_docker_image`" +msgid "The following change **affects people running a more non-standard setup** — external Postgres or using our roles in their own other playbook. **Most users don't need to do anything**, besides becoming aware of the new glue variables file [`group_vars/matrix-servers`](group_vars/matrix-servers)." msgstr "" #: ../../../CHANGELOG.md:3629 -msgid "from `matrix_docker_image_riot` to `matrix_riot_web_docker_image`" -msgstr "" - -#: ../../../CHANGELOG.md:3630 -msgid "from `matrix_docker_image_nginx` to `matrix_nginx_proxy_docker_image`" +msgid "Because people like using the playbook's components independently (outside of this playbook) and because it's much better for maintainability, we've continued working on separating them. Still, we'd like to offer a turnkey solution for running a fully-featured Matrix server, so this playbook remains important for wiring up the various components." msgstr "" #: ../../../CHANGELOG.md:3631 -msgid "from `matrix_docker_image_synapse` to `matrix_synapse_docker_image`" -msgstr "" - -#: ../../../CHANGELOG.md:3632 -msgid "from `matrix_docker_image_postgres_v9` to `matrix_postgres_docker_image_v9`" +msgid "With the new changes, **all roles are now only dependent on the minimal `matrix-base` role**. They are no longer dependent among themselves." msgstr "" #: ../../../CHANGELOG.md:3633 -msgid "from `matrix_docker_image_postgres_v10` to `matrix_postgres_docker_image_v10`" +msgid "In addition, the following components can now be completely disabled (for those who want/need to):" msgstr "" #: ../../../CHANGELOG.md:3634 -msgid "from `matrix_docker_image_postgres_latest` to `matrix_postgres_docker_image_latest`" +msgid "`matrix-coturn` by using `matrix_coturn_enabled: false`" msgstr "" -#: ../../../CHANGELOG.md:3637 -msgid "2018-10-26" +#: ../../../CHANGELOG.md:3635 +msgid "`matrix-mailer` by using `matrix_mailer_enabled: false`" msgstr "" -#: ../../../CHANGELOG.md:3639 -msgid "Mautrix Whatsapp bridging support" +#: ../../../CHANGELOG.md:3636 +msgid "`matrix-postgres` by using `matrix_postgres_enabled: false`" msgstr "" -#: ../../../CHANGELOG.md:3641 -msgid "The playbook now supports bridging with [Whatsapp](https://www.whatsapp.com/) by installing the [mautrix-whatsapp](https://github.com/tulir/mautrix-whatsapp) bridge. This playbook functionality is available thanks to [@izissise](https://github.com/izissise)." +#: ../../../CHANGELOG.md:3638 +msgid "The following changes had to be done:" msgstr "" -#: ../../../CHANGELOG.md:3643 -msgid "Additional details are available in [Setting up Mautrix Whatsapp bridging](docs/configuring-playbook-bridge-mautrix-whatsapp.md)." +#: ../../../CHANGELOG.md:3640 +msgid "glue variables had to be introduced to the playbook, so it can wire together the various components. Those glue vars are stored in the [`group_vars/matrix-servers`](group_vars/matrix-servers) file. When overriding variables for a given component (role), you need to be aware of both the role defaults (`role/ROLE/defaults/main.yml`) and the role's corresponding section in the [`group_vars/matrix-servers`](group_vars/matrix-servers) file." +msgstr "" + +#: ../../../CHANGELOG.md:3642 +msgid "`matrix_postgres_use_external` has been superseded by the more consistently named `matrix_postgres_enabled` variable and a few other `matrix_synapse_database_` variables. See the [Using an external PostgreSQL server (optional)](docs/configuring-playbook-external-postgres.md) documentation page for an up-to-date replacement." +msgstr "" + +#: ../../../CHANGELOG.md:3644 +msgid "Postgres tools (`matrix-postgres-cli` and `matrix-make-user-admin`) are no longer installed if you're not enabling the `matrix-postgres` role (`matrix_postgres_enabled: false`)" msgstr "" #: ../../../CHANGELOG.md:3646 -msgid "2018-10-25" +msgid "roles, being more independent now, are more minimal and do not do so much magic for you. People that are building their own playbook using our roles will definitely need to take a look at the [`group_vars/matrix-servers`](group_vars/matrix-servers) file and adapt their playbooks with the same (or similar) wiring logic." msgstr "" -#: ../../../CHANGELOG.md:3648 -msgid "Support for controlling Matrix federation" +#: ../../../CHANGELOG.md:3649 +msgid "2019-01-16" msgstr "" -#: ../../../CHANGELOG.md:3650 -msgid "The playbook can now help you with [Controlling Matrix federation](docs/configuring-playbook-federation), should you wish to run a more private (isolated) server." +#: ../../../CHANGELOG.md:3651 +msgid "Splitting the playbook into multiple roles" msgstr "" #: ../../../CHANGELOG.md:3653 -msgid "2018-10-24" +msgid "For better maintainability, the playbook logic (which all used to reside in a single `matrix-server` role) has been split out into a number of different roles: `matrix-synapse`, `matrix-postgres`, `matrix-riot-web`, `matrix-mxisd`, etc. (see the `roles/` directory)." msgstr "" -#: ../../../CHANGELOG.md:3655 -msgid "Disabling riot-web guests" +#: ../../../CHANGELOG.md:3656 +msgid "To keep the filesystem more consistent with this separation, the **Postgres data had to be relocated**." msgstr "" -#: ../../../CHANGELOG.md:3657 -msgid "From now on, Riot's configuration setting `disable_guests` would be set to `true`. The homeserver was rejecting guests anyway, so this is just a cosmetic change affecting Riot's UI." +#: ../../../CHANGELOG.md:3658 +msgid "The default value of `matrix_postgres_data_path` was changed from `/matrix/postgres` to `/matrix/postgres/data`. The `/matrix/postgres` directory is what we consider a base path now (new variable `matrix_postgres_base_path`). **Your Postgres data files will automatically be relocated by the playbook** (`/matrix/postgres/*` -> `/matrix/postgres/data/`) when you run with `--tags=setup-all` (or `--tags=setup-postgres`). While this shouldn't cause data-loss, **it's better if you do a Postgres backup just in case**. You'd need to restart all services after this migration (`--tags=start`)." msgstr "" -#: ../../../CHANGELOG.md:3660 -msgid "2018-10-21" +#: ../../../CHANGELOG.md:3661 +msgid "2019-01-11" msgstr "" -#: ../../../CHANGELOG.md:3662 -msgid "Self-check maintenance command" +#: ../../../CHANGELOG.md:3663 +msgid "(BC Break) mxisd configuration changes" msgstr "" -#: ../../../CHANGELOG.md:3664 -msgid "The playbook can now [check if services are configured correctly](docs/maintenance-checking-services.md)." +#: ../../../CHANGELOG.md:3665 +msgid "To be more flexible and to support the upcoming [mxisd](https://github.com/kamax-io/mxisd) 1.3.0 (when it gets released), we've had to redo how mxisd gets configured." msgstr "" -#: ../../../CHANGELOG.md:3667 -msgid "2018-10-05" +#: ../../../CHANGELOG.md:3668 +msgid "The following variables are no longer supported by this playbook:" msgstr "" -#: ../../../CHANGELOG.md:3669 -msgid "Presence tracking made configurable" +#: ../../../CHANGELOG.md:3670 +msgid "`matrix_mxisd_ldap_enabled`" msgstr "" #: ../../../CHANGELOG.md:3671 -msgid "The playbook can now enable/disable user presence-status tracking in Synapse, through the playbook's `matrix_synapse_use_presence` variable (having a default value of `true` — enabled)." +msgid "`matrix_mxisd_ldap_connection_host`" +msgstr "" + +#: ../../../CHANGELOG.md:3672 +msgid "`matrix_mxisd_ldap_connection_tls`" msgstr "" #: ../../../CHANGELOG.md:3673 -msgid "If users participate in large rooms with many other servers, disabling presence will decrease server load significantly." +msgid "`matrix_mxisd_ldap_connection_port`" +msgstr "" + +#: ../../../CHANGELOG.md:3674 +msgid "`matrix_mxisd_ldap_connection_baseDn`" +msgstr "" + +#: ../../../CHANGELOG.md:3675 +msgid "`matrix_mxisd_ldap_connection_baseDns`" msgstr "" #: ../../../CHANGELOG.md:3676 -msgid "2018-09-27" +#: ../../../CHANGELOG.md:3677 +msgid "`matrix_mxisd_ldap_connection_bindDn`" msgstr "" #: ../../../CHANGELOG.md:3678 -msgid "Synapse Cache Factor made configurable" +#: ../../../CHANGELOG.md:3682 +msgid "`matrix_mxisd_ldap_connection_bindPassword`" +msgstr "" + +#: ../../../CHANGELOG.md:3679 +msgid "`matrix_mxisd_ldap_filter`" msgstr "" #: ../../../CHANGELOG.md:3680 -msgid "The playbook now makes the Synapse cache factor configurable, through the playbook's `matrix_synapse_cache_factor` variable (having a default value of `0.5`)." +msgid "`matrix_mxisd_ldap_attribute_uid_type`" msgstr "" -#: ../../../CHANGELOG.md:3682 -msgid "Changing that value allows you to potentially decrease RAM usage or to increase performance by caching more stuff. Some information on it is available here: https://github.com/element-hq/synapse#help-synapse-eats-all-my-ram" +#: ../../../CHANGELOG.md:3681 +msgid "`matrix_mxisd_ldap_attribute_uid_value`" +msgstr "" + +#: ../../../CHANGELOG.md:3683 +msgid "`matrix_mxisd_ldap_attribute_name`" +msgstr "" + +#: ../../../CHANGELOG.md:3684 +msgid "`matrix_mxisd_ldap_attribute_threepid_email`" msgstr "" #: ../../../CHANGELOG.md:3685 -msgid "2018-09-26" +msgid "`matrix_mxisd_ldap_attribute_threepid_msisdn`" +msgstr "" + +#: ../../../CHANGELOG.md:3686 +msgid "`matrix_mxisd_ldap_identity_filter`" msgstr "" #: ../../../CHANGELOG.md:3687 -msgid "Disabling Docker container logging" +msgid "`matrix_mxisd_ldap_identity_medium`" +msgstr "" + +#: ../../../CHANGELOG.md:3688 +msgid "`matrix_mxisd_ldap_auth_filter`" msgstr "" #: ../../../CHANGELOG.md:3689 -msgid "`--log-driver=none` is used for all Docker containers now." +msgid "`matrix_mxisd_ldap_directory_filter`" msgstr "" -#: ../../../CHANGELOG.md:3691 -msgid "All these containers are started through systemd anyway and get logged in journald, so there's no need for Docker to be logging the same thing using the default `json-file` driver. Doing that was growing `/var/lib/docker/containers/…` infinitely until service/container restart." +#: ../../../CHANGELOG.md:3690 +msgid "`matrix_mxisd_template_config`" msgstr "" -#: ../../../CHANGELOG.md:3693 -msgid "As a result of this, things like `docker logs matrix-synapse` won't work anymore. `journalctl -u matrix-synapse` is how one can see the logs." +#: ../../../CHANGELOG.md:3692 +msgid "You are encouraged to use the `matrix_mxisd_configuration_extension_yaml` variable to define your own mxisd configuration additions and overrides. Refer to the [default variables file](roles/custom/matrix-mxisd/defaults/main.yml) for more information." +msgstr "" + +#: ../../../CHANGELOG.md:3694 +msgid "This new way of configuring mxisd is beneficial because:" msgstr "" #: ../../../CHANGELOG.md:3696 -msgid "2018-09-17" +msgid "it lets us support all mxisd configuration options, as the playbook simply forwards them to mxisd without needing to care or understand them" msgstr "" -#: ../../../CHANGELOG.md:3698 -msgid "Service discovery support" +#: ../../../CHANGELOG.md:3697 +msgid "it lets you upgrade to newer mxisd versions and make use of their features, without us having to add support for them explicitly" msgstr "" #: ../../../CHANGELOG.md:3700 -msgid "The playbook now helps you set up [service discovery](https://matrix.org/docs/spec/client_server/r0.4.0.html#server-discovery) using a `/.well-known/matrix/client` file." +msgid "2019-01-08" msgstr "" #: ../../../CHANGELOG.md:3702 -msgid "Additional details are available in [Configuring service discovery via .well-known](docs/configuring-well-known.md)." +msgid "(BC Break) Cronjob schedule no longer configurable" msgstr "" -#: ../../../CHANGELOG.md:3708 -msgid "from `matrix_nginx_riot_web_data_path` to `matrix_riot_web_data_path`" +#: ../../../CHANGELOG.md:3704 +msgid "Due to the way we manage cronjobs now, you can no longer configure the schedule they're invoked at." +msgstr "" + +#: ../../../CHANGELOG.md:3706 +msgid "If you were previously using `matrix_ssl_lets_encrypt_renew_cron_time_definition` or `matrix_nginx_proxy_reload_cron_time_definition` to set a custom schedule, you should note that these variables don't affect anything anymore." msgstr "" #: ../../../CHANGELOG.md:3709 -msgid "from `matrix_riot_web_default_identity_server_url` to `matrix_identity_server_url`" +msgid "If you miss this functionality, please [open an Issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/new) and let us know about your use case!" msgstr "" #: ../../../CHANGELOG.md:3712 -msgid "2018-09-07" +msgid "2018-12-23" msgstr "" #: ../../../CHANGELOG.md:3714 -msgid "Mautrix Telegram bridging support" +msgid "(BC Break) More SSL certificate retrieval methods" msgstr "" #: ../../../CHANGELOG.md:3716 -msgid "The playbook now supports bridging with [Telegram](https://telegram.org/) by installing the [mautrix-telegram](https://github.com/tulir/mautrix-telegram) bridge. This playbook functionality is available thanks to [@izissise](https://github.com/izissise)." +msgid "The playbook now lets you decide between 3 different SSL certificate retrieval methods:" +msgstr "" + +#: ../../../CHANGELOG.md:3717 +msgid "(default) obtaining free SSL certificates from Let's Encrypt" msgstr "" #: ../../../CHANGELOG.md:3718 -msgid "Additional details are available in [Setting up Mautrix Telegram bridging](docs/configuring-playbook-bridge-mautrix-telegram.md)." +msgid "generating self-signed SSL certificates" msgstr "" -#: ../../../CHANGELOG.md:3720 -msgid "Events cache size increase and configurability for Matrix Synapse" +#: ../../../CHANGELOG.md:3719 +msgid "managing SSL certificates manually" msgstr "" -#: ../../../CHANGELOG.md:3722 -msgid "The playbook now lets you configure Matrix Synapse's `event_cache_size` configuration via the `matrix_synapse_event_cache_size` playbook variable." +#: ../../../CHANGELOG.md:3721 +msgid "Learn more in [Adjusting SSL certificate retrieval](docs/configuring-playbook-ssl-certificates.md)." msgstr "" -#: ../../../CHANGELOG.md:3724 -msgid "Previously, this value was hardcoded to `\"10K\"`. From now on, a more reasonable default of `\"100K\"` is used." +#: ../../../CHANGELOG.md:3723 +msgid "For people who use Let's Encrypt (mostly everyone, since it's the default), you'll also have to rename a variable in your configuration:" +msgstr "" + +#: ../../../CHANGELOG.md:3725 +msgid "before: `host_specific_matrix_ssl_support_email`" msgstr "" #: ../../../CHANGELOG.md:3726 -msgid "Password-peppering support for Matrix Synapse" +msgid "after: `host_specific_matrix_ssl_lets_encrypt_support_email`" msgstr "" #: ../../../CHANGELOG.md:3728 -msgid "The playbook now supports enabling password-peppering for increased security in Matrix Synapse via the `matrix_synapse_password_config_pepper` playbook variable. Using a password pepper is disabled by default (just like it used to be before this playbook variable got introduced) and is not to be enabled/disabled after initial setup, as that would invalidate all existing passwords." +msgid "(BC Break) mxisd upgrade with multiple base DN support" msgstr "" #: ../../../CHANGELOG.md:3730 -msgid "Statistics-reporting support for Matrix Synapse" +msgid "mxisd has bee upgraded to [version 1.2.2](https://github.com/kamax-matrix/mxisd/releases/tag/v1.2.2), which supports [multiple base DNs](https://github.com/kamax-matrix/mxisd/blob/v1.2.2/docs/stores/ldap.md#base)." msgstr "" #: ../../../CHANGELOG.md:3732 -msgid "There's now a new `matrix_synapse_report_stats` playbook variable, which controls the `report_stats` configuration option for Matrix Synapse. It defaults to `false`, so no change is required to retain your privacy." +msgid "If you were configuring this playbook's `matrix_mxisd_ldap_connection_baseDn` variable until now (a string containing a single base DN), you'll need to change to configuring the `matrix_mxisd_ldap_connection_baseDns` variable (an array containing multiple base DNs)." msgstr "" #: ../../../CHANGELOG.md:3734 -msgid "If you'd like to start reporting statistics about your homeserver (things like number of users, number of messages sent, uptime, load, etc.) to matrix.org, you can turn on stats reporting." +msgid "Example change:" +msgstr "" + +#: ../../../CHANGELOG.md:3736 +msgid "before: `matrix_mxisd_ldap_connection_baseDn: OU=Users,DC=example,DC=org`" msgstr "" #: ../../../CHANGELOG.md:3737 -msgid "2018-08-29" +msgid "after: `matrix_mxisd_ldap_connection_baseDns: ['OU=Users,DC=example,DC=org']`" msgstr "" -#: ../../../CHANGELOG.md:3739 -msgid "Changing the way SSL certificates are retrieved" +#: ../../../CHANGELOG.md:3740 +msgid "2018-12-21" msgstr "" -#: ../../../CHANGELOG.md:3741 -msgid "We've been using [acmetool](https://github.com/hlandau/acme) (with the [willwill/acme-docker](https://hub.docker.com/r/willwill/acme-docker/) Docker image) until now." +#: ../../../CHANGELOG.md:3742 +msgid "Synapse 0.34.0 and Python 3" msgstr "" -#: ../../../CHANGELOG.md:3743 -msgid "Due to the Docker image being deprecated, and things looking bleak for acmetool's support of the newer ACME v2 API endpoint, we've switched to using [certbot](https://certbot.eff.org/) (with the [certbot/certbot](https://hub.docker.com/r/certbot/certbot/) Docker image)." -msgstr "" - -#: ../../../CHANGELOG.md:3745 -msgid "Simply re-running the playbook will retrieve new certificates (via certbot) for you. To ensure you don't leave any old files behind, though, you'd better do this:" +#: ../../../CHANGELOG.md:3744 +msgid "Synapse has been upgraded to 0.34.0 and now uses Python 3. Based on feedback from others, running Synapse on Python 3 is supposed to decrease memory usage significantly (~2x)." msgstr "" #: ../../../CHANGELOG.md:3747 -msgid "`systemctl stop 'matrix*'`" -msgstr "" - -#: ../../../CHANGELOG.md:3748 -msgid "stop your custom webserver, if you're running one (only affects you if you've installed with `matrix_nginx_proxy_enabled: false`)" +msgid "2018-12-12" msgstr "" #: ../../../CHANGELOG.md:3749 -msgid "`mv /matrix/ssl /matrix/ssl-acmetool-delete-later`" -msgstr "" - -#: ../../../CHANGELOG.md:3750 -msgid "re-run the playbook's [installation](docs/installing.md)" +msgid "Riot homepage customization" msgstr "" #: ../../../CHANGELOG.md:3751 -msgid "possibly delete `/matrix/ssl-acmetool-delete-later`" +msgid "You can now customize some parts of the Riot homepage (or even completely replace it with your own custom page). See the `matrix_riot_web_homepage_` variables in `roles/custom/matrix-riot-web/defaults/main.yml`." msgstr "" #: ../../../CHANGELOG.md:3754 -msgid "2018-08-21" +msgid "2018-12-04" msgstr "" #: ../../../CHANGELOG.md:3756 -msgid "Matrix Corporal support" +msgid "mxisd extensibility" msgstr "" #: ../../../CHANGELOG.md:3758 -msgid "The playbook can now install and configure [matrix-corporal](https://github.com/devture/matrix-corporal) for you." +msgid "The [LDAP identity store for mxisd](https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/ldap.md) can now be configured easily using playbook variables (see the `matrix_mxisd_ldap_` variables in `roles/custom/matrix-server/defaults/main.yml`)." msgstr "" -#: ../../../CHANGELOG.md:3760 -msgid "Additional details are available in [Setting up Matrix Corporal](docs/configuring-playbook-matrix-corporal.md)." +#: ../../../CHANGELOG.md:3761 +msgid "2018-11-28" msgstr "" #: ../../../CHANGELOG.md:3763 -msgid "2018-08-20" +msgid "More scripts" msgstr "" #: ../../../CHANGELOG.md:3765 -msgid "Matrix Synapse rate limit control variables" +msgid "matrix-remove-all allows to uninstall everything with a single command" msgstr "" -#: ../../../CHANGELOG.md:3767 -msgid "The following new variables can now be configured to control Matrix Synapse's rate-limiting (default values are shown below)." +#: ../../../CHANGELOG.md:3766 +msgid "matrix-make-user-admin allows to upgrade a user's privileges" msgstr "" -#: ../../../CHANGELOG.md:3774 -msgid "Shared Secret Auth support via matrix-synapse-shared-secret-auth" +#: ../../../CHANGELOG.md:3768 +msgid "LDAP auth support via matrix-synapse-ldap3" msgstr "" -#: ../../../CHANGELOG.md:3776 -msgid "The playbook can now install and configure [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) for you." +#: ../../../CHANGELOG.md:3770 +msgid "The playbook can now install and configure [LDAP auth support](https://github.com/matrix-org/matrix-synapse-ldap3) for you." msgstr "" -#: ../../../CHANGELOG.md:3778 -msgid "Additional details are available in [Setting up the Shared Secret Auth password provider module](docs/configuring-playbook-shared-secret-auth.md)." +#: ../../../CHANGELOG.md:3772 +msgid "Additional details are available in [Setting up the LDAP authentication password provider module](docs/configuring-playbook-ldap-auth.md)." +msgstr "" + +#: ../../../CHANGELOG.md:3775 +msgid "2018-11-23" +msgstr "" + +#: ../../../CHANGELOG.md:3777 +msgid "Support for controlling public registration and room auto-join" +msgstr "" + +#: ../../../CHANGELOG.md:3779 +msgid "The playbook now lets you enable public registration for users (controlled via `matrix_synapse_enable_registration`). By default, public registration is forbidden." msgstr "" #: ../../../CHANGELOG.md:3781 -msgid "2018-08-17" +msgid "You can also make people automatically get auto-joined to rooms (controlled via `matrix_synapse_auto_join_rooms`)." msgstr "" #: ../../../CHANGELOG.md:3783 -msgid "REST auth support via matrix-synapse-rest-auth" +msgid "Support for changing the welcome user ID (welcome bot)" msgstr "" #: ../../../CHANGELOG.md:3785 -msgid "The playbook can now install and configure [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-auth) for you." +msgid "By default, `@riot-bot:matrix.org` is used to welcome newly registered users. This can be changed to something else (or disabled) via the new `matrix_riot_web_welcome_user_id` variable." msgstr "" -#: ../../../CHANGELOG.md:3787 -msgid "Additional details are available in [Setting up the REST authentication password provider module](docs/configuring-playbook-rest-auth.md)." +#: ../../../CHANGELOG.md:3788 +msgid "2018-11-14" msgstr "" -#: ../../../CHANGELOG.md:3789 -msgid "Compression improvements" +#: ../../../CHANGELOG.md:3790 +msgid "Ability to set Synapse log levels" msgstr "" -#: ../../../CHANGELOG.md:3791 -msgid "Shifted Matrix Synapse compression from happening in the Matrix Synapse, to happening in the nginx proxy that's in front of it." +#: ../../../CHANGELOG.md:3792 +msgid "The playbook now allows you to set the log levels used by Synapse. The default logging levels remain the same." msgstr "" #: ../../../CHANGELOG.md:3794 -msgid "Additionally, `riot-web` also gets compressed now (in the nginx proxy), which drops the initial page load's size from 5.31MB to 1.86MB." -msgstr "" - -#: ../../../CHANGELOG.md:3797 -msgid "Disabling some unnecessary Synapse services" -msgstr "" - -#: ../../../CHANGELOG.md:3799 -msgid "The following services are not necessary, so they have been disabled:" -msgstr "" - -#: ../../../CHANGELOG.md:3800 -msgid "on the federation port (8448): the `client` service" -msgstr "" - -#: ../../../CHANGELOG.md:3801 -msgid "on the http port (8008, exposed over 443): the old Angular `webclient` and the `federation` service" +msgid "You can now override following variables with any of the supported log levels listed here: https://docs.python.org/3/library/logging.html#logging-levels" msgstr "" #: ../../../CHANGELOG.md:3803 -msgid "Federation runs only on the federation port (8448) now. The Client APIs run only on the http port (8008) now." +msgid "2018-11-03" msgstr "" -#: ../../../CHANGELOG.md:3806 -msgid "2018-08-15" +#: ../../../CHANGELOG.md:3805 +msgid "Customize parts of Riot's config" msgstr "" -#: ../../../CHANGELOG.md:3808 -msgid "mxisd Identity Server support" +#: ../../../CHANGELOG.md:3807 +msgid "You can now customize some parts of Riot's `config.json`. These playbook variables, with these default values, have been added:" msgstr "" -#: ../../../CHANGELOG.md:3810 -msgid "The playbook now sets up an [mxisd](https://github.com/kamax-io/mxisd) Identity Server for you by default. Additional details are available in [Setting up ma1sd Identity Server](docs/configuring-playbook-mxisd.md)." +#: ../../../CHANGELOG.md:3818 +msgid "This now allows you use a custom integration manager like [Dimension](https://dimension.t2bot.io). For example, if you wish to use the Dimension instance hosted at dimension.t2bot.io, you can set the following in your vars.yml file:" msgstr "" -#: ../../../CHANGELOG.md:3813 -msgid "2018-08-14" -msgstr "" - -#: ../../../CHANGELOG.md:3815 -msgid "Email-sending support" -msgstr "" - -#: ../../../CHANGELOG.md:3817 -msgid "The playbook now configures an email-sending service (postfix) by default. Additional details are available in [Adjusting email-sending settings](docs/configuring-playbook-email.md)." -msgstr "" - -#: ../../../CHANGELOG.md:3819 -msgid "With this, Matrix Synapse is able to send email notifications for missed messages, etc." -msgstr "" - -#: ../../../CHANGELOG.md:3822 -msgid "2018-08-08" -msgstr "" - -#: ../../../CHANGELOG.md:3828 -msgid "from `matrix_max_upload_size_mb` to `matrix_synapse_max_upload_size_mb`" +#: ../../../CHANGELOG.md:3827 +msgid "SSL protocols used to serve Riot and Synapse" msgstr "" #: ../../../CHANGELOG.md:3829 -msgid "from `matrix_max_log_file_size_mb` to `matrix_synapse_max_log_file_size_mb`" -msgstr "" - -#: ../../../CHANGELOG.md:3830 -msgid "from `matrix_max_log_files_count` to `matrix_synapse_max_log_files_count`" +msgid "There's now a new `matrix_nginx_proxy_ssl_protocols` playbook variable, which controls the SSL protocols used to serve Riot and Synapse. Its default value is `TLSv1.1 TLSv1.2`. This playbook previously used `TLSv1 TLSv1.1 TLSv1.2` to serve Riot and Synapse." msgstr "" #: ../../../CHANGELOG.md:3831 -msgid "from `docker_matrix_image` to `matrix_docker_image_synapse`" -msgstr "" - -#: ../../../CHANGELOG.md:3832 -msgid "from `docker_nginx_image` to `matrix_docker_image_nginx`" +msgid "You may wish to re-enable TLSv1 if you need to access Riot in older browsers." msgstr "" #: ../../../CHANGELOG.md:3833 +msgid "Note: Currently the dockerized nginx doesn't support TLSv1.3. See https://github.com/nginxinc/docker-nginx/issues/190 for more details." +msgstr "" + +#: ../../../CHANGELOG.md:3836 +msgid "2018-11-01" +msgstr "" + +#: ../../../CHANGELOG.md:3838 +msgid "Postgres 11 support" +msgstr "" + +#: ../../../CHANGELOG.md:3840 +msgid "The playbook now installs [Postgres 11](https://www.postgresql.org/about/news/1894/) by default." +msgstr "" + +#: ../../../CHANGELOG.md:3842 +msgid "If you have have an existing setup, it's likely running on an older Postgres version (9.x or 10.x). You can easily upgrade by following the [upgrading PostgreSQL guide](docs/maintenance-postgres.md#upgrading-postgresql)." +msgstr "" + +#: ../../../CHANGELOG.md:3844 +#: ../../../CHANGELOG.md:3931 +#: ../../../CHANGELOG.md:4051 +msgid "(BC Break) Renaming playbook variables" +msgstr "" + +#: ../../../CHANGELOG.md:3846 +msgid "Due to the large amount of features added to this playbook lately, to keep things manageable we've had to reorganize its configuration variables a bit." +msgstr "" + +#: ../../../CHANGELOG.md:3850 +msgid "from `matrix_docker_image_mxisd` to `matrix_mxisd_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3851 +msgid "from `matrix_docker_image_mautrix_telegram` to `matrix_mautrix_telegram_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3852 +msgid "from `matrix_docker_image_mautrix_whatsapp` to `matrix_mautrix_whatsapp_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3853 +msgid "from `matrix_docker_image_mailer` to `matrix_mailer_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3854 +msgid "from `matrix_docker_image_coturn` to `matrix_coturn_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3855 +msgid "from `matrix_docker_image_goofys` to `matrix_s3_goofys_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3856 +msgid "from `matrix_docker_image_riot` to `matrix_riot_web_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3857 +msgid "from `matrix_docker_image_nginx` to `matrix_nginx_proxy_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3858 +msgid "from `matrix_docker_image_synapse` to `matrix_synapse_docker_image`" +msgstr "" + +#: ../../../CHANGELOG.md:3859 +msgid "from `matrix_docker_image_postgres_v9` to `matrix_postgres_docker_image_v9`" +msgstr "" + +#: ../../../CHANGELOG.md:3860 +msgid "from `matrix_docker_image_postgres_v10` to `matrix_postgres_docker_image_v10`" +msgstr "" + +#: ../../../CHANGELOG.md:3861 +msgid "from `matrix_docker_image_postgres_latest` to `matrix_postgres_docker_image_latest`" +msgstr "" + +#: ../../../CHANGELOG.md:3864 +msgid "2018-10-26" +msgstr "" + +#: ../../../CHANGELOG.md:3866 +msgid "Mautrix Whatsapp bridging support" +msgstr "" + +#: ../../../CHANGELOG.md:3868 +msgid "The playbook now supports bridging with [Whatsapp](https://www.whatsapp.com/) by installing the [mautrix-whatsapp](https://github.com/tulir/mautrix-whatsapp) bridge. This playbook functionality is available thanks to [@izissise](https://github.com/izissise)." +msgstr "" + +#: ../../../CHANGELOG.md:3870 +msgid "Additional details are available in [Setting up Mautrix Whatsapp bridging](docs/configuring-playbook-bridge-mautrix-whatsapp.md)." +msgstr "" + +#: ../../../CHANGELOG.md:3873 +msgid "2018-10-25" +msgstr "" + +#: ../../../CHANGELOG.md:3875 +msgid "Support for controlling Matrix federation" +msgstr "" + +#: ../../../CHANGELOG.md:3877 +msgid "The playbook can now help you with [Controlling Matrix federation](docs/configuring-playbook-federation), should you wish to run a more private (isolated) server." +msgstr "" + +#: ../../../CHANGELOG.md:3880 +msgid "2018-10-24" +msgstr "" + +#: ../../../CHANGELOG.md:3882 +msgid "Disabling riot-web guests" +msgstr "" + +#: ../../../CHANGELOG.md:3884 +msgid "From now on, Riot's configuration setting `disable_guests` would be set to `true`. The homeserver was rejecting guests anyway, so this is just a cosmetic change affecting Riot's UI." +msgstr "" + +#: ../../../CHANGELOG.md:3887 +msgid "2018-10-21" +msgstr "" + +#: ../../../CHANGELOG.md:3889 +msgid "Self-check maintenance command" +msgstr "" + +#: ../../../CHANGELOG.md:3891 +msgid "The playbook can now [check if services are configured correctly](docs/maintenance-and-troubleshooting.md#how-to-check-if-services-work)." +msgstr "" + +#: ../../../CHANGELOG.md:3894 +msgid "2018-10-05" +msgstr "" + +#: ../../../CHANGELOG.md:3896 +msgid "Presence tracking made configurable" +msgstr "" + +#: ../../../CHANGELOG.md:3898 +msgid "The playbook can now enable/disable user presence-status tracking in Synapse, through the playbook's `matrix_synapse_use_presence` variable (having a default value of `true` — enabled)." +msgstr "" + +#: ../../../CHANGELOG.md:3900 +msgid "If users participate in large rooms with many other servers, disabling presence will decrease server load significantly." +msgstr "" + +#: ../../../CHANGELOG.md:3903 +msgid "2018-09-27" +msgstr "" + +#: ../../../CHANGELOG.md:3905 +msgid "Synapse Cache Factor made configurable" +msgstr "" + +#: ../../../CHANGELOG.md:3907 +msgid "The playbook now makes the Synapse cache factor configurable, through the playbook's `matrix_synapse_cache_factor` variable (having a default value of `0.5`)." +msgstr "" + +#: ../../../CHANGELOG.md:3909 +msgid "Changing that value allows you to potentially decrease RAM usage or to increase performance by caching more stuff. Some information on it is available here: https://github.com/element-hq/synapse#help-synapse-eats-all-my-ram" +msgstr "" + +#: ../../../CHANGELOG.md:3912 +msgid "2018-09-26" +msgstr "" + +#: ../../../CHANGELOG.md:3914 +msgid "Disabling Docker container logging" +msgstr "" + +#: ../../../CHANGELOG.md:3916 +msgid "`--log-driver=none` is used for all Docker containers now." +msgstr "" + +#: ../../../CHANGELOG.md:3918 +msgid "All these containers are started through systemd anyway and get logged in journald, so there's no need for Docker to be logging the same thing using the default `json-file` driver. Doing that was growing `/var/lib/docker/containers/…` infinitely until service/container restart." +msgstr "" + +#: ../../../CHANGELOG.md:3920 +msgid "As a result of this, things like `docker logs matrix-synapse` won't work anymore. `journalctl -u matrix-synapse` is how one can see the logs." +msgstr "" + +#: ../../../CHANGELOG.md:3923 +msgid "2018-09-17" +msgstr "" + +#: ../../../CHANGELOG.md:3925 +msgid "Service discovery support" +msgstr "" + +#: ../../../CHANGELOG.md:3927 +msgid "The playbook now helps you set up [service discovery](https://matrix.org/docs/spec/client_server/r0.4.0.html#server-discovery) using a `/.well-known/matrix/client` file." +msgstr "" + +#: ../../../CHANGELOG.md:3929 +msgid "Additional details are available in [Configuring service discovery via .well-known](docs/configuring-well-known.md)." +msgstr "" + +#: ../../../CHANGELOG.md:3935 +msgid "from `matrix_nginx_riot_web_data_path` to `matrix_riot_web_data_path`" +msgstr "" + +#: ../../../CHANGELOG.md:3936 +msgid "from `matrix_riot_web_default_identity_server_url` to `matrix_identity_server_url`" +msgstr "" + +#: ../../../CHANGELOG.md:3939 +msgid "2018-09-07" +msgstr "" + +#: ../../../CHANGELOG.md:3941 +msgid "Mautrix Telegram bridging support" +msgstr "" + +#: ../../../CHANGELOG.md:3943 +msgid "The playbook now supports bridging with [Telegram](https://telegram.org/) by installing the [mautrix-telegram](https://github.com/tulir/mautrix-telegram) bridge. This playbook functionality is available thanks to [@izissise](https://github.com/izissise)." +msgstr "" + +#: ../../../CHANGELOG.md:3945 +msgid "Additional details are available in [Setting up Mautrix Telegram bridging](docs/configuring-playbook-bridge-mautrix-telegram.md)." +msgstr "" + +#: ../../../CHANGELOG.md:3947 +msgid "Events cache size increase and configurability for Matrix Synapse" +msgstr "" + +#: ../../../CHANGELOG.md:3949 +msgid "The playbook now lets you configure Matrix Synapse's `event_cache_size` configuration via the `matrix_synapse_event_cache_size` playbook variable." +msgstr "" + +#: ../../../CHANGELOG.md:3951 +msgid "Previously, this value was hardcoded to `\"10K\"`. From now on, a more reasonable default of `\"100K\"` is used." +msgstr "" + +#: ../../../CHANGELOG.md:3953 +msgid "Password-peppering support for Matrix Synapse" +msgstr "" + +#: ../../../CHANGELOG.md:3955 +msgid "The playbook now supports enabling password-peppering for increased security in Matrix Synapse via the `matrix_synapse_password_config_pepper` playbook variable. Using a password pepper is disabled by default (just like it used to be before this playbook variable got introduced) and is not to be enabled/disabled after initial setup, as that would invalidate all existing passwords." +msgstr "" + +#: ../../../CHANGELOG.md:3957 +msgid "Statistics-reporting support for Matrix Synapse" +msgstr "" + +#: ../../../CHANGELOG.md:3959 +msgid "There's now a new `matrix_synapse_report_stats` playbook variable, which controls the `report_stats` configuration option for Matrix Synapse. It defaults to `false`, so no change is required to retain your privacy." +msgstr "" + +#: ../../../CHANGELOG.md:3961 +msgid "If you'd like to start reporting statistics about your homeserver (things like number of users, number of messages sent, uptime, load, etc.) to matrix.org, you can turn on stats reporting." +msgstr "" + +#: ../../../CHANGELOG.md:3964 +msgid "2018-08-29" +msgstr "" + +#: ../../../CHANGELOG.md:3966 +msgid "Changing the way SSL certificates are retrieved" +msgstr "" + +#: ../../../CHANGELOG.md:3968 +msgid "We've been using [acmetool](https://github.com/hlandau/acme) (with the [willwill/acme-docker](https://hub.docker.com/r/willwill/acme-docker/) Docker image) until now." +msgstr "" + +#: ../../../CHANGELOG.md:3970 +msgid "Due to the Docker image being deprecated, and things looking bleak for acmetool's support of the newer ACME v2 API endpoint, we've switched to using [certbot](https://certbot.eff.org/) (with the [certbot/certbot](https://hub.docker.com/r/certbot/certbot/) Docker image)." +msgstr "" + +#: ../../../CHANGELOG.md:3972 +msgid "Simply re-running the playbook will retrieve new certificates (via certbot) for you. To ensure you don't leave any old files behind, though, you'd better do this:" +msgstr "" + +#: ../../../CHANGELOG.md:3974 +msgid "`systemctl stop 'matrix*'`" +msgstr "" + +#: ../../../CHANGELOG.md:3975 +msgid "stop your custom webserver, if you're running one (only affects you if you've installed with `matrix_nginx_proxy_enabled: false`)" +msgstr "" + +#: ../../../CHANGELOG.md:3976 +msgid "`mv /matrix/ssl /matrix/ssl-acmetool-delete-later`" +msgstr "" + +#: ../../../CHANGELOG.md:3977 +msgid "re-run the playbook's [installation](docs/installing.md)" +msgstr "" + +#: ../../../CHANGELOG.md:3978 +msgid "possibly delete `/matrix/ssl-acmetool-delete-later`" +msgstr "" + +#: ../../../CHANGELOG.md:3981 +msgid "2018-08-21" +msgstr "" + +#: ../../../CHANGELOG.md:3983 +msgid "Matrix Corporal support" +msgstr "" + +#: ../../../CHANGELOG.md:3985 +msgid "The playbook can now install and configure [matrix-corporal](https://github.com/devture/matrix-corporal) for you." +msgstr "" + +#: ../../../CHANGELOG.md:3987 +msgid "Additional details are available in [Setting up Matrix Corporal](docs/configuring-playbook-matrix-corporal.md)." +msgstr "" + +#: ../../../CHANGELOG.md:3990 +msgid "2018-08-20" +msgstr "" + +#: ../../../CHANGELOG.md:3992 +msgid "Matrix Synapse rate limit control variables" +msgstr "" + +#: ../../../CHANGELOG.md:3994 +msgid "The following new variables can now be configured to control Matrix Synapse's rate-limiting (default values are shown below)." +msgstr "" + +#: ../../../CHANGELOG.md:4001 +msgid "Shared Secret Auth support via matrix-synapse-shared-secret-auth" +msgstr "" + +#: ../../../CHANGELOG.md:4003 +msgid "The playbook can now install and configure [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) for you." +msgstr "" + +#: ../../../CHANGELOG.md:4005 +msgid "Additional details are available in [Setting up the Shared Secret Auth password provider module](docs/configuring-playbook-shared-secret-auth.md)." +msgstr "" + +#: ../../../CHANGELOG.md:4008 +msgid "2018-08-17" +msgstr "" + +#: ../../../CHANGELOG.md:4010 +msgid "REST auth support via matrix-synapse-rest-auth" +msgstr "" + +#: ../../../CHANGELOG.md:4012 +msgid "The playbook can now install and configure [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-auth) for you." +msgstr "" + +#: ../../../CHANGELOG.md:4014 +msgid "Additional details are available in [Setting up the REST authentication password provider module](docs/configuring-playbook-rest-auth.md)." +msgstr "" + +#: ../../../CHANGELOG.md:4016 +msgid "Compression improvements" +msgstr "" + +#: ../../../CHANGELOG.md:4018 +msgid "Shifted Matrix Synapse compression from happening in the Matrix Synapse, to happening in the nginx proxy that's in front of it." +msgstr "" + +#: ../../../CHANGELOG.md:4021 +msgid "Additionally, `riot-web` also gets compressed now (in the nginx proxy), which drops the initial page load's size from 5.31MB to 1.86MB." +msgstr "" + +#: ../../../CHANGELOG.md:4024 +msgid "Disabling some unnecessary Synapse services" +msgstr "" + +#: ../../../CHANGELOG.md:4026 +msgid "The following services are not necessary, so they have been disabled:" +msgstr "" + +#: ../../../CHANGELOG.md:4027 +msgid "on the federation port (8448): the `client` service" +msgstr "" + +#: ../../../CHANGELOG.md:4028 +msgid "on the http port (8008, exposed over 443): the old Angular `webclient` and the `federation` service" +msgstr "" + +#: ../../../CHANGELOG.md:4030 +msgid "Federation runs only on the federation port (8448) now. The Client APIs run only on the http port (8008) now." +msgstr "" + +#: ../../../CHANGELOG.md:4033 +msgid "2018-08-15" +msgstr "" + +#: ../../../CHANGELOG.md:4035 +msgid "mxisd Identity Server support" +msgstr "" + +#: ../../../CHANGELOG.md:4037 +msgid "The playbook now sets up an [mxisd](https://github.com/kamax-io/mxisd) Identity Server for you by default. Additional details are available in [Setting up ma1sd Identity Server](docs/configuring-playbook-mxisd.md)." +msgstr "" + +#: ../../../CHANGELOG.md:4040 +msgid "2018-08-14" +msgstr "" + +#: ../../../CHANGELOG.md:4042 +msgid "Email-sending support" +msgstr "" + +#: ../../../CHANGELOG.md:4044 +msgid "The playbook now configures an email-sending service (postfix) by default. Additional details are available in [Adjusting email-sending settings](docs/configuring-playbook-email.md)." +msgstr "" + +#: ../../../CHANGELOG.md:4046 +msgid "With this, Matrix Synapse is able to send email notifications for missed messages, etc." +msgstr "" + +#: ../../../CHANGELOG.md:4049 +msgid "2018-08-08" +msgstr "" + +#: ../../../CHANGELOG.md:4055 +msgid "from `matrix_max_upload_size_mb` to `matrix_synapse_max_upload_size_mb`" +msgstr "" + +#: ../../../CHANGELOG.md:4056 +msgid "from `matrix_max_log_file_size_mb` to `matrix_synapse_max_log_file_size_mb`" +msgstr "" + +#: ../../../CHANGELOG.md:4057 +msgid "from `matrix_max_log_files_count` to `matrix_synapse_max_log_files_count`" +msgstr "" + +#: ../../../CHANGELOG.md:4058 +msgid "from `docker_matrix_image` to `matrix_docker_image_synapse`" +msgstr "" + +#: ../../../CHANGELOG.md:4059 +msgid "from `docker_nginx_image` to `matrix_docker_image_nginx`" +msgstr "" + +#: ../../../CHANGELOG.md:4060 msgid "from `docker_riot_image` to `matrix_docker_image_riot`" msgstr "" -#: ../../../CHANGELOG.md:3834 +#: ../../../CHANGELOG.md:4061 msgid "from `docker_goofys_image` to `matrix_docker_image_goofys`" msgstr "" -#: ../../../CHANGELOG.md:3835 +#: ../../../CHANGELOG.md:4062 msgid "from `docker_coturn_image` to `matrix_docker_image_coturn`" msgstr "" -#: ../../../CHANGELOG.md:3837 +#: ../../../CHANGELOG.md:4064 msgid "If you're overriding any of them in your `vars.yml` file, you'd need to change to the new names." msgstr "" -#: ../../../CHANGELOG.md:3839 +#: ../../../CHANGELOG.md:4066 msgid "Renaming Ansible playbook tag" msgstr "" -#: ../../../CHANGELOG.md:3841 +#: ../../../CHANGELOG.md:4068 msgid "The command for executing the whole playbook has changed. The `setup-main` tag got renamed to `setup-all`." msgstr "" -#: ../../../CHANGELOG.md:3843 +#: ../../../CHANGELOG.md:4070 msgid "Docker container linking" msgstr "" -#: ../../../CHANGELOG.md:3845 +#: ../../../CHANGELOG.md:4072 msgid "Changed the way the Docker containers are linked together. The ones that need to communicate with others operate in a `matrix` network now and not in the default bridge network." msgstr "" diff --git a/i18n/translation-templates/README.pot b/i18n/translation-templates/README.pot index 43bd0d07c..027456baf 100644 --- a/i18n/translation-templates/README.pot +++ b/i18n/translation-templates/README.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -17,7 +17,7 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" #: ../../../README.md:1 -msgid "[![Support room on Matrix](https://img.shields.io/matrix/matrix-docker-ansible-deploy:devture.com.svg?label=%23matrix-docker-ansible-deploy%3Adevture.com&logo=matrix&style=for-the-badge&server_fqdn=matrix.devture.com)](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) [![donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/s.pantaleev/donate)" +msgid "[![Support room on Matrix](https://img.shields.io/matrix/matrix-docker-ansible-deploy:devture.com.svg?label=%23matrix-docker-ansible-deploy%3Adevture.com&logo=matrix&style=for-the-badge&server_fqdn=matrix.devture.com&fetchMode=summary)](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) [![donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/s.pantaleev/donate) [![REUSE status](https://api.reuse.software/badge/github.com/spantaleev/matrix-docker-ansible-deploy)](https://api.reuse.software/info/github.com/spantaleev/matrix-docker-ansible-deploy)" msgstr "" #: ../../../README.md:1 @@ -28,6 +28,10 @@ msgstr "" msgid "donate" msgstr "" +#: ../../../README.md:1 +msgid "REUSE status" +msgstr "" + #: ../../../README.md:3 msgid "Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker" msgstr "" @@ -184,6 +188,18 @@ msgstr "" msgid "[Link](docs/configuring-playbook-conduwuit.md)" msgstr "" +#: ../../../README.md:0 +msgid "[continuwuity](https://continuwuity.org)" +msgstr "" + +#: ../../../README.md:0 +msgid "Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. continuwuity is a continuation of conduwuit." +msgstr "" + +#: ../../../README.md:0 +msgid "[Link](docs/configuring-playbook-continuwuity.md)" +msgstr "" + #: ../../../README.md:0 msgid "[Dendrite](https://github.com/element-hq/dendrite)" msgstr "" @@ -196,11 +212,11 @@ msgstr "" msgid "[Link](docs/configuring-playbook-dendrite.md)" msgstr "" -#: ../../../README.md:58 +#: ../../../README.md:59 msgid "Clients" msgstr "" -#: ../../../README.md:60 +#: ../../../README.md:61 msgid "Web clients for Matrix that you can host on your own domains." msgstr "" @@ -252,11 +268,23 @@ msgstr "" msgid "[Link](docs/configuring-playbook-client-schildichat-web.md)" msgstr "" -#: ../../../README.md:69 -msgid "Server Components" +#: ../../../README.md:0 +msgid "[FluffyChat Web](https://fluffychat.im/)" +msgstr "" + +#: ../../../README.md:0 +msgid "The cutest messenger in Matrix" +msgstr "" + +#: ../../../README.md:0 +msgid "[Link](docs/configuring-playbook-client-fluffychat-web.md)" msgstr "" #: ../../../README.md:71 +msgid "Server Components" +msgstr "" + +#: ../../../README.md:73 msgid "Services that run on the server to make the various parts of your installation work." msgstr "" @@ -289,7 +317,7 @@ msgid "[Traefik](https://doc.traefik.io/traefik/)" msgstr "" #: ../../../README.md:0 -msgid "Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver [is possible](docs/configuring-playbook-own-webserver.md)" +msgid "Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. [Using your own webserver](docs/configuring-playbook-own-webserver.md) is also possible." msgstr "" #: ../../../README.md:0 @@ -344,11 +372,35 @@ msgstr "" msgid "[Link](docs/configuring-playbook-dynamic-dns.md)" msgstr "" -#: ../../../README.md:83 +#: ../../../README.md:0 +msgid "[LiveKit Server](https://github.com/livekit/livekit)" +msgstr "" + +#: ../../../README.md:0 +msgid "WebRTC server for audio/video calls" +msgstr "" + +#: ../../../README.md:0 +msgid "[Link](docs/configuring-playbook-livekit-server.md)" +msgstr "" + +#: ../../../README.md:0 +msgid "[Livekit JWT Service](https://github.com/livekit/livekit-jwt-service)" +msgstr "" + +#: ../../../README.md:0 +msgid "JWT service for integrating [Element Call](./configuring-playbook-element-call.md) with [LiveKit Server](./configuring-playbook-livekit-server.md)" +msgstr "" + +#: ../../../README.md:0 +msgid "[Link](docs/configuring-playbook-livekit-jwt-service.md)" +msgstr "" + +#: ../../../README.md:87 msgid "Authentication" msgstr "" -#: ../../../README.md:85 +#: ../../../README.md:89 msgid "Extend and modify how users are authenticated on your homeserver." msgstr "" @@ -393,7 +445,7 @@ msgid "[matrix-ldap-registration-proxy](https://gitlab.com/activism.internationa msgstr "" #: ../../../README.md:0 -msgid "A proxy that handles Matrix registration requests and forwards them to LDAP." +msgid "Proxy that handles Matrix registration requests and forwards them to LDAP" msgstr "" #: ../../../README.md:0 @@ -405,7 +457,7 @@ msgid "[matrix-registration](https://github.com/ZerataX/matrix-registration)" msgstr "" #: ../../../README.md:0 -msgid "A simple python application to have a token based Matrix registration" +msgid "Simple python application to have a token based Matrix registration" msgstr "" #: ../../../README.md:0 @@ -413,7 +465,7 @@ msgid "[Link](docs/configuring-playbook-matrix-registration.md)" msgstr "" #: ../../../README.md:0 -msgid "[Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (UVS)" +msgid "[Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service)" msgstr "" #: ../../../README.md:0 @@ -429,18 +481,18 @@ msgid "[synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispa msgstr "" #: ../../../README.md:0 -msgid "A spam checker module" +msgid "Spam checker module" msgstr "" #: ../../../README.md:0 msgid "[Link](docs/configuring-playbook-synapse-simple-antispam.md)" msgstr "" -#: ../../../README.md:97 +#: ../../../README.md:101 msgid "File Storage" msgstr "" -#: ../../../README.md:99 +#: ../../../README.md:103 msgid "Use alternative file storage to the default `media_store` folder." msgstr "" @@ -469,18 +521,18 @@ msgid "[matrix-media-repo](https://github.com/turt2live/matrix-media-repo)" msgstr "" #: ../../../README.md:0 -msgid "matrix-media-repo is a highly customizable multi-domain media repository for Matrix. Intended for medium to large deployments, this media repo de-duplicates media while being fully compliant with the specification." +msgid "Highly customizable multi-domain media repository for Matrix. Intended for medium to large deployments, this media repo de-duplicates media while being fully compliant with the specification." msgstr "" #: ../../../README.md:0 msgid "[Link](docs/configuring-playbook-matrix-media-repo.md)" msgstr "" -#: ../../../README.md:107 +#: ../../../README.md:111 msgid "Bridges" msgstr "" -#: ../../../README.md:109 +#: ../../../README.md:113 msgid "Bridges can be used to connect your Matrix installation with third-party communication networks." msgstr "" @@ -556,6 +608,18 @@ msgstr "" msgid "[Link](docs/configuring-playbook-bridge-mautrix-wsproxy.md)" msgstr "" +#: ../../../README.md:0 +msgid "[mautrix-bluesky](https://github.com/mautrix/bluesky)" +msgstr "" + +#: ../../../README.md:0 +msgid "Bridge to [Bluesky](https://bsky.social/)" +msgstr "" + +#: ../../../README.md:0 +msgid "[Link](docs/configuring-playbook-bridge-mautrix-bluesky.md)" +msgstr "" + #: ../../../README.md:0 msgid "[mautrix-twitter](https://github.com/mautrix/twitter)" msgstr "" @@ -684,6 +748,18 @@ msgstr "" msgid "[Link](docs/configuring-playbook-bridge-matrix-bridge-sms.md)" msgstr "" +#: ../../../README.md:0 +msgid "[matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge)" +msgstr "" + +#: ../../../README.md:0 +msgid "Bridge to [Steam](https://steampowered.com/)" +msgstr "" + +#: ../../../README.md:0 +msgid "[Link](docs/configuring-playbook-bridge-steam.md)" +msgstr "" + #: ../../../README.md:0 msgid "[matrix-wechat](https://github.com/duo/matrix-wechat)" msgstr "" @@ -708,62 +784,6 @@ msgstr "" msgid "[Link](docs/configuring-playbook-bridge-heisenbridge.md)" msgstr "" -#: ../../../README.md:0 -msgid "[go-skype-bridge](https://github.com/kelaresg/go-skype-bridge)" -msgstr "" - -#: ../../../README.md:0 -msgid "Bridge to [Skype](https://www.skype.com)" -msgstr "" - -#: ../../../README.md:0 -msgid "[Link](docs/configuring-playbook-bridge-go-skype-bridge.md)" -msgstr "" - -#: ../../../README.md:0 -msgid "[mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack)" -msgstr "" - -#: ../../../README.md:0 -msgid "Bridge to [Slack](https://slack.com)" -msgstr "" - -#: ../../../README.md:0 -msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-slack.md)" -msgstr "" - -#: ../../../README.md:0 -msgid "[mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram)" -msgstr "" - -#: ../../../README.md:0 -msgid "Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/))" -msgstr "" - -#: ../../../README.md:0 -msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-instagram.md)" -msgstr "" - -#: ../../../README.md:0 -msgid "[mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter)" -msgstr "" - -#: ../../../README.md:0 -msgid "Bridge for Twitter-DMs ([Twitter](https://twitter.com/))" -msgstr "" - -#: ../../../README.md:0 -msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-twitter.md)" -msgstr "" - -#: ../../../README.md:0 -msgid "[mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord)" -msgstr "" - -#: ../../../README.md:0 -msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-discord.md)" -msgstr "" - #: ../../../README.md:0 msgid "[mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme)" msgstr "" @@ -777,7 +797,7 @@ msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-groupme.md)" msgstr "" #: ../../../README.md:0 -msgid "[mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam)" +msgid "[mx-puppet-steam](https://codeberg.org/icewind/mx-puppet-steam)" msgstr "" #: ../../../README.md:0 @@ -800,11 +820,11 @@ msgstr "" msgid "[Link](docs/configuring-playbook-bridge-postmoogle.md)" msgstr "" -#: ../../../README.md:141 +#: ../../../README.md:142 msgid "Bots" msgstr "" -#: ../../../README.md:143 +#: ../../../README.md:144 msgid "Bots provide various additional functionality to your installation." msgstr "" @@ -813,7 +833,7 @@ msgid "[baibot](https://github.com/etkecc/baibot)" msgstr "" #: ../../../README.md:0 -msgid "A bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you" +msgid "Bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you" msgstr "" #: ../../../README.md:0 @@ -849,7 +869,7 @@ msgid "[maubot](https://github.com/maubot/maubot)" msgstr "" #: ../../../README.md:0 -msgid "A plugin-based Matrix bot system" +msgid "Plugin-based Matrix bot system" msgstr "" #: ../../../README.md:0 @@ -861,7 +881,7 @@ msgid "[Honoroit](https://github.com/etkecc/honoroit)" msgstr "" #: ../../../README.md:0 -msgid "A helpdesk bot" +msgid "Helpdesk bot" msgstr "" #: ../../../README.md:0 @@ -873,7 +893,7 @@ msgid "[Mjolnir](https://github.com/matrix-org/mjolnir)" msgstr "" #: ../../../README.md:0 -msgid "A moderation tool for Matrix" +msgid "Moderation tool for Matrix" msgstr "" #: ../../../README.md:0 @@ -885,7 +905,7 @@ msgid "[Draupnir](https://github.com/the-draupnir-project/Draupnir)" msgstr "" #: ../../../README.md:0 -msgid "A moderation tool for Matrix (Fork of Mjolnir)" +msgid "Moderation tool for Matrix (Fork of Mjolnir)" msgstr "" #: ../../../README.md:0 @@ -904,11 +924,11 @@ msgstr "" msgid "[Link](docs/configuring-playbook-bot-buscarron.md)" msgstr "" -#: ../../../README.md:156 +#: ../../../README.md:157 msgid "Administration" msgstr "" -#: ../../../README.md:158 +#: ../../../README.md:159 msgid "Services that help you in administrating and monitoring your Matrix installation." msgstr "" @@ -941,7 +961,7 @@ msgid "[synapse-admin](https://github.com/etkecc/synapse-admin)" msgstr "" #: ../../../README.md:0 -msgid "A web UI tool for administrating users and rooms on your Matrix server" +msgid "Web UI tool for administrating users and rooms on your Matrix server" msgstr "" #: ../../../README.md:0 @@ -957,7 +977,7 @@ msgid "Consists of the [Prometheus](https://prometheus.io) time-series database msgstr "" #: ../../../README.md:0 -msgid "[Link](docs/configuring-playbook-prometheus-grafana.md) (for [prometheus-nginxlog-exporter](docs/configuring-playbook-prometheus-nginxlog.md))" +msgid "[Link](docs/configuring-playbook-prometheus-grafana.md) (for [prometheus-nginxlog-exporter](docs/configuring-playbook-prometheus-grafana.md#enable-metrics-and-graphs-for-nginx-logs-optional))" msgstr "" #: ../../../README.md:0 @@ -996,11 +1016,11 @@ msgstr "" msgid "[Link](docs/configuring-playbook-synapse-usage-exporter.md)" msgstr "" -#: ../../../README.md:170 +#: ../../../README.md:171 msgid "Misc" msgstr "" -#: ../../../README.md:172 +#: ../../../README.md:173 msgid "Various services that don't fit any other categories." msgstr "" @@ -1021,7 +1041,7 @@ msgid "[synapse_auto_accept_invite](https://github.com/matrix-org/synapse-auto-a msgstr "" #: ../../../README.md:0 -msgid "A Synapse module to automatically accept invites." +msgid "Synapse module to automatically accept invites" msgstr "" #: ../../../README.md:0 @@ -1033,7 +1053,7 @@ msgid "[synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-comp msgstr "" #: ../../../README.md:0 -msgid "A cli tool that automatically compresses `state_groups` database table in background." +msgid "Cli tool that automatically compresses `state_groups` database table in background" msgstr "" #: ../../../README.md:0 @@ -1057,7 +1077,7 @@ msgid "[Etherpad](https://etherpad.org)" msgstr "" #: ../../../README.md:0 -msgid "An open source collaborative text editor" +msgid "Open source collaborative text editor" msgstr "" #: ../../../README.md:0 @@ -1069,7 +1089,7 @@ msgid "[Jitsi](https://jitsi.org/)" msgstr "" #: ../../../README.md:0 -msgid "An open source video-conferencing platform" +msgid "Open source video-conferencing platform" msgstr "" #: ../../../README.md:0 @@ -1081,7 +1101,7 @@ msgid "[Cactus Comments](https://cactus.chat)" msgstr "" #: ../../../README.md:0 -msgid "A federated comment system built on Matrix" +msgid "Federated comment system built on Matrix" msgstr "" #: ../../../README.md:0 @@ -1093,7 +1113,7 @@ msgid "[Pantalaimon](https://github.com/matrix-org/pantalaimon)" msgstr "" #: ../../../README.md:0 -msgid "An E2EE aware proxy daemon" +msgid "E2EE aware proxy daemon" msgstr "" #: ../../../README.md:0 @@ -1124,54 +1144,66 @@ msgstr "" msgid "[Link](docs/configuring-playbook-ntfy.md)" msgstr "" -#: ../../../README.md:187 -msgid "🆕 Changes" +#: ../../../README.md:0 +msgid "[Element Call](https://github.com/element-hq/element-call)" +msgstr "" + +#: ../../../README.md:0 +msgid "A native Matrix video conferencing application" +msgstr "" + +#: ../../../README.md:0 +msgid "[Link](docs/configuring-playbook-element-call.md)" msgstr "" #: ../../../README.md:189 -msgid "This playbook evolves over time, sometimes with backward-incompatible changes." +msgid "🆕 Changes" msgstr "" #: ../../../README.md:191 -msgid "When updating the playbook, refer to [the changelog](CHANGELOG.md) to catch up with what's new." +msgid "This playbook evolves over time, sometimes with backward-incompatible changes." msgstr "" #: ../../../README.md:193 -msgid "🆘 Support" +msgid "When updating the playbook, refer to [the changelog](CHANGELOG.md) to catch up with what's new." msgstr "" #: ../../../README.md:195 -msgid "Matrix room: [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com)" +msgid "🆘 Support" msgstr "" #: ../../../README.md:197 -msgid "IRC channel: `#matrix-docker-ansible-deploy` on the [Libera Chat](https://libera.chat/) IRC network (irc.libera.chat:6697)" +msgid "Matrix room: [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com)" msgstr "" #: ../../../README.md:199 -msgid "GitHub issues: [spantaleev/matrix-docker-ansible-deploy/issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues)" +msgid "IRC channel: `#matrix-docker-ansible-deploy` on the [Libera Chat](https://libera.chat/) IRC network (irc.libera.chat:6697)" msgstr "" #: ../../../README.md:201 -msgid "🌐 Translation" +msgid "GitHub issues: [spantaleev/matrix-docker-ansible-deploy/issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues)" msgstr "" #: ../../../README.md:203 -msgid "See the [i18n/README.md](i18n/README.md) file for more information about translation." +msgid "🌐 Translation" msgstr "" #: ../../../README.md:205 -msgid "Translations are still work in progress." +msgid "See the [i18n/README.md](i18n/README.md) file for more information about translation." msgstr "" #: ../../../README.md:207 -msgid "🤝 Related" +msgid "Translations are still work in progress." msgstr "" #: ../../../README.md:209 -msgid "You may also be interested in [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) - another Ansible playbook for self-hosting non-Matrix services (see its [List of supported services](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md))." +msgid "🤝 Related" msgstr "" #: ../../../README.md:211 +msgid "You may also be interested in [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) - another Ansible playbook for self-hosting non-Matrix services (see its [List of supported services](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md))." +msgstr "" + +#: ../../../README.md:213 msgid "mash-playbook also makes use of [Traefik](./docs/configuring-playbook-traefik.md) as its reverse-proxy, so with minor [interoperability adjustments](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/interoperability.md), you can make matrix-docker-ansible-deploy and mash-playbook co-exist and host Matrix and non-Matrix services on the same server." msgstr "" diff --git a/i18n/translation-templates/YEAR-IN-REVIEW.pot b/i18n/translation-templates/YEAR-IN-REVIEW.pot index e17e16d39..bdcca3feb 100644 --- a/i18n/translation-templates/YEAR-IN-REVIEW.pot +++ b/i18n/translation-templates/YEAR-IN-REVIEW.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,274 +16,274 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../YEAR-IN-REVIEW.md:1 +#: ../../../YEAR-IN-REVIEW.md:8 msgid "2023" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:3 +#: ../../../YEAR-IN-REVIEW.md:10 msgid "2023 was a year filled with many changes for matrix-docker-ansible-deploy. In this post, we're looking backward at some of the major changes that happened this year, as well as taking a glimpse of what's ahead in 2024." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:5 +#: ../../../YEAR-IN-REVIEW.md:12 msgid "2023 is probably [the year of AI](https://journal.everypixel.com/2023-the-year-of-ai), with millions of people jumping aboard [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/chatgpt) train. matrix-docker-ansible-deploy is no stranger to this and 2023 began with a PR from [bertybuttface](https://github.com/bertybuttface) who added support for [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#chatgpt-support)). While OpenAI's chat GPT website was frequently overloaded in the past, their API was up which made using this bot both convenient and more reliable." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:7 -msgid "AI aside, with the playbook's focus being containers, we're **doubling down on being \"container native\"** and becoming more interoperable for people hosting other containers on the Matrix server. In [2022](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/YEAR-IN-REVIEW.md#2022), we've announced a few sibling Ansible playbooks, their use of [Traefik](https://doc.traefik.io/traefik/) and the possiblity of matrix-docker-ansible-deploy also switching to this reverse-proxy. This prediction materialized quickly. The **largest change** in the playbook in 2023 happened way back in February - matrix-docker-ansible-deploy [starting the switch from nginx to Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support) and then quickly [making Treafik the default reverse-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now). As noted in the changelog entries, we envisioned a quick and complete elimination of `matrix-nginx-proxy`, but at the end of 2023, it hasn't happened yet. The playbook is already using Traefik as the front-most reverse-proxy, but nginx (via `matrix-nginx-proxy`) is still around - it has taken a step back and is only used internally for new setups. Work got to a stall due to:" -msgstr "" - -#: ../../../YEAR-IN-REVIEW.md:9 -msgid "complexity: untangling the overly large and messy `matrix-nginx-proxy` component is difficult" -msgstr "" - -#: ../../../YEAR-IN-REVIEW.md:10 -msgid "the current setup became \"good enough\" because nginx has become an internal implementation detail for those who have migrated to Traefik. Traefik is already the default public reverse-proxy and gives better possibilities to people wishing to run other web-exposed containers on their Matrix server via [Docker Compose](https://docs.docker.com/compose/), other Ansible playbooks like [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) (more about this one, below) or any other way." -msgstr "" - -#: ../../../YEAR-IN-REVIEW.md:12 -msgid "`matrix-nginx-proxy` is no longer in the way of us being interoperable, but its ugly internal details are still there. It is one more proxy in the long chain of reverse-proxies we have and we'd like to cut it out. This would both make things simpler and also boost performance." -msgstr "" - #: ../../../YEAR-IN-REVIEW.md:14 -msgid "The delay in eliminating `matrix-nginx-proxy` has probably been welcome by many existing users who decided to postpone the Traefik migration a bit longer. In 2024, work on eliminating `matrix-nginx-proxy` will continue with rapid pace. People who are still using `matrix-nginx-proxy` as their front-most reverse-proxy will need to rework their setup. About a year of putting it off has been long enough." +msgid "AI aside, with the playbook's focus being containers, we're **doubling down on being \"container native\"** and becoming more interoperable for people hosting other containers on the Matrix server. In [2022](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/YEAR-IN-REVIEW.md#2022), we've announced a few sibling Ansible playbooks, their use of [Traefik](https://doc.traefik.io/traefik/) and the possibility of matrix-docker-ansible-deploy also switching to this reverse-proxy. This prediction materialized quickly. The **largest change** in the playbook in 2023 happened way back in February - matrix-docker-ansible-deploy [starting the switch from nginx to Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support) and then quickly [making Treafik the default reverse-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now). As noted in the changelog entries, we envisioned a quick and complete elimination of `matrix-nginx-proxy`, but at the end of 2023, it hasn't happened yet. The playbook is already using Traefik as the front-most reverse-proxy, but nginx (via `matrix-nginx-proxy`) is still around - it has taken a step back and is only used internally for new setups. Work got to a stall due to:" msgstr "" #: ../../../YEAR-IN-REVIEW.md:16 +msgid "complexity: untangling the overly large and messy `matrix-nginx-proxy` component is difficult" +msgstr "" + +#: ../../../YEAR-IN-REVIEW.md:17 +msgid "the current setup became \"good enough\" because nginx has become an internal implementation detail for those who have migrated to Traefik. Traefik is already the default public reverse-proxy and gives better possibilities to people wishing to run other web-exposed containers on their Matrix server via [Docker Compose](https://docs.docker.com/compose/), other Ansible playbooks like [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) (more about this one, below) or any other way." +msgstr "" + +#: ../../../YEAR-IN-REVIEW.md:19 +msgid "`matrix-nginx-proxy` is no longer in the way of us being interoperable, but its ugly internal details are still there. It is one more proxy in the long chain of reverse-proxies we have and we'd like to cut it out. This would both make things simpler and also boost performance." +msgstr "" + +#: ../../../YEAR-IN-REVIEW.md:21 +msgid "The delay in eliminating `matrix-nginx-proxy` has probably been welcome by many existing users who decided to postpone the Traefik migration a bit longer. In 2024, work on eliminating `matrix-nginx-proxy` will continue with rapid pace. People who are still using `matrix-nginx-proxy` as their front-most reverse-proxy will need to rework their setup. About a year of putting it off has been long enough." +msgstr "" + +#: ../../../YEAR-IN-REVIEW.md:23 msgid "This large Traefik reverse-proxy change was also accompanied by another internal change which began in 2022, but continued in 2023 - **moving non-Matrix-related roles from being internal to the playbook to living their own life outside of it**. Various roles were made more decoupled and moved outside of the playbook, so that other projects (like the [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) Ansible playbook or other Ansible playbooks) could benefit from them. This led to the **death of a few sibling playbooks** ([gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy), [nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy), [peertube-docker-ansible-deploy](https://github.com/spantaleev/peertube-docker-ansible-deploy), [vaultwarden-docker-ansible-deploy](https://github.com/spantaleev/vaultwarden-docker-ansible-deploy)), but brought life to something better, which supports all these services and more." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:18 +#: ../../../YEAR-IN-REVIEW.md:25 msgid "[mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) is a new Ansible playbook that a few of us (matrix-docker-ansible-deploy contributors) have launched in 2023. It has quickly grown to supports [60+ services](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md) and aims to do the same for [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) service hosting, as matrix-docker-ansible-deploy has done for Matrix - providing a clean and secure way to run a bunch of services in containers on a regular server (that is to say, without Kubernetes, etc.). Thanks to Traefik and Ansible role reuse, it's easy to host both mash-playbook services and matrix-docker-ansible-deploy services on the same server - see mash-playbook's [interoperability](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/interoperability.md) documentation page. If you've been looking for a holiday project or your New Year's Resolutions list contains \"self-hosting more services\", then you're welcome to give this new playbook a try and join its Matrix room ([#mash-playbook:devture.com](https://matrix.to/#/#mash-playbook:devture.com))." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:20 +#: ../../../YEAR-IN-REVIEW.md:27 msgid "Because many of the roles are now external to this playbook (defined in the [requirements.yml](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/da27655ef34999fa924bc0a5e641dbd9ba06f133/requirements.yml) file), running `make roles` (or better yet `just roles` via the [just tool](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#support-for-running-commands-via-just)) becomes a necessity each time one pulls playbook updates (`git pull`). Pulling external roles happens via the [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) command-line tool, but if available, the playbook would also use the much faster [agru](https://github.com/etkecc/agru) tool (developed by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) this year)." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:22 +#: ../../../YEAR-IN-REVIEW.md:29 msgid "With the internal (but important) details out of the way, we can now talk more about **new features that landed in matrix-docker-ansible-deploy in 2023**." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:24 +#: ../../../YEAR-IN-REVIEW.md:31 msgid "The following **new** **bridges** were added to the playbook in 2023:" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:26 +#: ../../../YEAR-IN-REVIEW.md:33 msgid "(2023-01-11) [mautrix-slack](https://mau.dev/mautrix/slack), thanks to a PR by [Cody Neiman](https://github.com/xangelix) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#mautrix-slack-support))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:27 +#: ../../../YEAR-IN-REVIEW.md:34 msgid "(2023-07-21) [mautrix-gmessages](https://github.com/mautrix/gmessages), thanks to a PR by [Shreyas Ajjarapu](https://github.com/shreyasajj) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#mautrix-gmessages-support))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:28 +#: ../../../YEAR-IN-REVIEW.md:35 msgid "(2023-08-23) [mautrix-wsproxy](https://github.com/mautrix/wsproxy) for Apple iMessage bridging (when combined with the [mautrix-imessage](https://github.com/mautrix/imessage) bridge running on your Mac or Android phone), thanks to a PR by [Johan Swetzén](https://github.com/jswetzen)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:30 +#: ../../../YEAR-IN-REVIEW.md:37 msgid "This brings the total number of **[bridges that the playbook supports](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/docs/configuring-playbook.md#bridging-other-networks) up to 30**. There are alternative bridge implementations for various networks and protocols, so the number of \"unique bridged networks\" is surely much smaller." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:32 +#: ../../../YEAR-IN-REVIEW.md:39 msgid "A few other **major components and changes** landed in 2023:" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:34 +#: ../../../YEAR-IN-REVIEW.md:41 msgid "(2023-02-10) The [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool (successor to [Mjolnir](https://github.com/matrix-org/mjolnir)), thanks to a PR by [FSG-Cat](https://github.com/FSG-Cat) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#draupnir-moderation-tool-bot-support))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:35 +#: ../../../YEAR-IN-REVIEW.md:42 msgid "(2023-02-10) [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) to add Matrix Authentication Support to our Jitsi setup, thanks to a PR by [Jakob S.](https://github.com/jakicoll) from [zakk gGmbH](https://github.com/zakk-it) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#matrix-authentication-support-for-jitsi))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:36 +#: ../../../YEAR-IN-REVIEW.md:43 msgid "(2023-02-25) The [rageshake](https://github.com/matrix-org/rageshake) bug report server, thanks to a PR by [Benjamin Kampmann](https://github.com/gnunicorn) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#rageshake-support))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:37 +#: ../../../YEAR-IN-REVIEW.md:44 msgid "(2023-03-07) [Sliding Sync proxy](https://github.com/matrix-org/sliding-sync) (currently a necessary component for [Element X](https://element.io/labs/element-x) to work), thanks to: [Benjamin Kampmann](https://github.com/gnunicorn) and [FSG-Cat](https://github.com/FSG-Cat) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#sliding-sync-proxy-element-x-support))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:38 +#: ../../../YEAR-IN-REVIEW.md:45 msgid "(2023-03-12) synapse-auto-compressor to periodically and automatically run [rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state), thanks to a PR by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#synapse-auto-compressor-support))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:39 +#: ../../../YEAR-IN-REVIEW.md:46 msgid "(2023-07-17) [matrix-media-repo](https://github.com/turt2live/matrix-media-repo),  thanks to a PR by [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#matrix-media-repo-support))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:40 +#: ../../../YEAR-IN-REVIEW.md:47 msgid "(2023-08-31) [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) client app (fork of [Element Web)](https://github.com/element-hq/element-web), thanks to a PR by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#schildichat-support))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:41 +#: ../../../YEAR-IN-REVIEW.md:48 msgid "(2023-10-18) Postgres parameters auto-tuning, thanks to a PR by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#postgres-parameters-are-automatically-tuned-now))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:42 +#: ../../../YEAR-IN-REVIEW.md:49 msgid "(2023-10-23) Enabling federation of the room directory for Synapse (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#enabling-allow_public_rooms_over_federation-by-default-for-synapse))" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:44 +#: ../../../YEAR-IN-REVIEW.md:51 msgid "The most recent change in the list above (Enabling federation of the room directory for Synapse) has been somewhat **controversial** as it goes against upstream defaults for Synapse. Nevertheless, we believe it **promotes the well-being of the Matrix Federation by improving room discovery**." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:46 +#: ../../../YEAR-IN-REVIEW.md:53 msgid "**Matrix Federation Stats** (containing the percentage of servers publishing their room directory publicly) are posted to [TWIM](https://matrix.org/category/this-week-in-matrix/) each week by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/). The number of servers which [currently published their room directory publicly](https://matrix.org/blog/2023/12/2/this-week-in-matrix-2023-12-22/#matrix-federation-stats) stands at `26.6%`, which is:" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:48 +#: ../../../YEAR-IN-REVIEW.md:55 msgid "**2.4% more** than when it was when [first published to TWIM](https://matrix.org/blog/2023/11/03/this-week-in-matrix-2023-11-03/#matrix-federation-stats) (1 month earlier, in November)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:49 +#: ../../../YEAR-IN-REVIEW.md:56 msgid "likely about **15+% more** than from before we flipped the switch (in October)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:51 +#: ../../../YEAR-IN-REVIEW.md:58 msgid "Hopefully, Synapse defaults would also change the same way and we'd see the number of servers publicly listing their room directory grow faster." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:53 +#: ../../../YEAR-IN-REVIEW.md:60 msgid "With this configuration change in place, projects like [MatrixRooms.info](https://matrixrooms.info/) (made by [etke.cc](https://etke.cc/)) and potentially others in the future, can discover, index the metadata (room address, title, topic, number of users, etc.) and make public rooms browsable & searchable across the whole Matrix Federation. It'd be great if users joining Matrix could more easily find interesting communities that match their interests!" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:55 +#: ../../../YEAR-IN-REVIEW.md:62 msgid "On the **media side of things**, besides Jitsi getting better Matrix integration (via the aforementioned Matrix User Verification Service), we've also had some [coturn security tightening](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-tightening-coturn-security-can-lead-to-connectivity-issues) as well as [performance optimizations](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#coturn-can-now-use-host-networking) for configurations exposing lots of network ports." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:57 +#: ../../../YEAR-IN-REVIEW.md:64 msgid "[Element Call](https://github.com/element-hq/element-call) seems to have become a nice and polished product lately (as proclaimed in [The Matrix Holiday Update 2023](https://matrix.org/blog/2023/12/25/the-matrix-holiday-update-2023/)), so 2024 is likely the year we'll see support for it in the playbook. Element Call depends on the [LiveKit](https://livekit.io/) streaming server (which is also useful to developers even by itself), so the first step is likely to see LiveKit support in mash-playbook via a reusable Ansible role. Such a LiveKit Ansible role could later easily land in matrix-docker-ansible-deploy and an Element Call static website could be hooked to it." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:59 +#: ../../../YEAR-IN-REVIEW.md:66 msgid "Besides these highlights, there were many other relatively large changes announced in our [CHANGELOG](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md) and hundreds of other more minor (but still important) playbook changes that didn't get a mention." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:61 +#: ../../../YEAR-IN-REVIEW.md:68 msgid "We have **hundreds of contributors to thank for their hard work** on making Matrix self-hosting better for all of us! It should be noted that **support comes in many shapes**, not only in raw code commits and financial help (via [donations](https://liberapay.com/s.pantaleev) or using the [etke.cc managed Matrix hosting service](https://etke.cc/) which is based on matrix-docker-ansible-deploy). It also comes in the shape of code reviews, helping others with [issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues), reporting new issues, participating in our support room on Matrix ([#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com)), etc. To everyone who has been there to make matrix-docker-ansible-deploy better in 2023, thank you! 🙇‍♂️" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:64 +#: ../../../YEAR-IN-REVIEW.md:71 msgid "2022" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:66 +#: ../../../YEAR-IN-REVIEW.md:73 msgid "For [matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy/), 2022 started with **breaking the** [**Synapse**](https://github.com/element-hq/synapse) **monopoly** by [adding support](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#dendrite-support) for the [Dendrite](https://github.com/matrix-org/dendrite) Matrix homeserver in early January. This required various internal changes so that the [Ansible](https://www.ansible.com/) playbook would not be Synapse-centric anymore. This groundwork paved the way for continuing in this direction and we [added support](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#conduit-support) for [Conduit](https://conduit.rs/) in August." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:68 +#: ../../../YEAR-IN-REVIEW.md:75 msgid "When it comes to the `matrix-docker-ansible-deploy` Ansible playbook, 2022 was the year of the non-Synapse homeserver implementation. In practice, none of these homeserver implementations seem ready for prime-time yet and there is no migration path when coming from Synapse. Having done our job of adding support for these alternative homeserver implementations, we can say that we're not getting in the way of future progress. It's time for the Dendrite developers to push harder (development-wise) and for the Synapse developers to take a well-deserved long (infinite) break, and we may get to see more people migrating away from Synapse in the next year(s)." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:70 +#: ../../../YEAR-IN-REVIEW.md:77 msgid "Support for the following new **bridges** was added:" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:72 +#: ../../../YEAR-IN-REVIEW.md:79 msgid "[Postmoogle](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#postmoogle-email-bridge-support) for bi-directional email bridging, which supersedes my old and simplistic [Email2Matrix](https://github.com/devture/email2matrix) one-way bridge-bot" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:73 +#: ../../../YEAR-IN-REVIEW.md:80 msgid "[mautrix-discord](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#mautrix-discord-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:74 +#: ../../../YEAR-IN-REVIEW.md:81 msgid "[go-skype-bridge](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#go-skype-bridge-bridging-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:75 +#: ../../../YEAR-IN-REVIEW.md:82 msgid "[matrix-appservice-kakaotalk](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-appservice-kakaotalk-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:77 +#: ../../../YEAR-IN-REVIEW.md:84 msgid "Support for the following new **bots** was added:" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:79 +#: ../../../YEAR-IN-REVIEW.md:86 msgid "[buscarron bot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#buscarron-bot-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:80 +#: ../../../YEAR-IN-REVIEW.md:87 msgid "[Honoroit bot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#honoroit-bot-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:81 +#: ../../../YEAR-IN-REVIEW.md:88 msgid "[matrix-registration-bot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-registration-bot-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:82 +#: ../../../YEAR-IN-REVIEW.md:89 msgid "[matrix-hookshot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-hookshot-bridging-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:83 +#: ../../../YEAR-IN-REVIEW.md:90 msgid "[maubot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#maubot-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:85 +#: ../../../YEAR-IN-REVIEW.md:92 msgid "Support for the following new **components and services** was added:" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:87 +#: ../../../YEAR-IN-REVIEW.md:94 msgid "[BorgBackup](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#borg-backup-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:88 +#: ../../../YEAR-IN-REVIEW.md:95 msgid "[Cactus Comments](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#cactus-comments-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:89 +#: ../../../YEAR-IN-REVIEW.md:96 msgid "[Cinny](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#cinny-support) client support" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:90 +#: ../../../YEAR-IN-REVIEW.md:97 msgid "[ntfy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#ntfy-push-notifications-support) notifications" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:91 +#: ../../../YEAR-IN-REVIEW.md:98 msgid "[matrix-ldap-registration-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-ldap-registration-proxy-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:92 +#: ../../../YEAR-IN-REVIEW.md:99 msgid "[matrix\\_encryption\\_disabler support](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix_encryption_disabler-support)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:93 +#: ../../../YEAR-IN-REVIEW.md:100 msgid "[synapse-s3-storage-provider](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#synapse-s3-storage-provider-support) to stop the Synapse media store from being a scalability problem. This brought along [another feature](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#synapse-container-image-customization-support) - an easier way to customize the Synapse container image without having to fork and self-build all of it from scratch" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:95 +#: ../../../YEAR-IN-REVIEW.md:102 msgid "Besides these major user-visible changes, a lot of work also happened **under the hood**:" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:97 +#: ../../../YEAR-IN-REVIEW.md:104 msgid "we made [major improvements to Synapse workers](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#potential-backward-compatibility-break-major-improvements-to-synapse-workers) - adding support for stream writers and for running multiple workers of various kinds (federation senders, pushers, background task processing workers, etc.)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:98 +#: ../../../YEAR-IN-REVIEW.md:105 msgid "we [improved the compatibility of (Synapse + workers) with the rest of the playbook](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#backward-compatibility-break-changing-how-reverse-proxying-to-synapse-works---now-via-a-matrix-synapse-reverse-proxy-companion-service) by introducing a new `matrix-synapse-reverse-proxy-companion-service` service" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:99 +#: ../../../YEAR-IN-REVIEW.md:106 msgid "we started [splitting various Ansible roles out of the Matrix playbook and into independent roles](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#the-playbook-now-uses-external-roles-for-some-things) (e.g. `matrix-postgres` -> [ansible-role-postgres](https://github.com/mother-of-all-self-hosting/ansible-role-postgres)), which could be included in other Ansible playbooks. In fact, these roles already power a few **interesting other sibling playbooks**:" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:100 +#: ../../../YEAR-IN-REVIEW.md:107 msgid "[gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy), for deploying a [Gitea](https://gitea.io/) (self-hosted [Git](https://git-scm.com/) service) server" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:101 +#: ../../../YEAR-IN-REVIEW.md:108 msgid "[nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy), for deploying a [Nextcloud](https://nextcloud.com/) groupware server" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:102 +#: ../../../YEAR-IN-REVIEW.md:109 msgid "[vaultwarden-docker-ansible-deploy](https://github.com/spantaleev/vaultwarden-docker-ansible-deploy), for deploying a [Vaultwarden](https://github.com/dani-garcia/vaultwarden) password manager server (unofficial [Bitwarden](https://bitwarden.com/) compatible server)" msgstr "" -#: ../../../YEAR-IN-REVIEW.md:104 +#: ../../../YEAR-IN-REVIEW.md:111 msgid "These sibling playbooks co-exist nicely with one another due to using [Traefik](https://traefik.io/) for reverse-proxying, instead of trying to overtake the whole server by running their own [nginx](https://nginx.org/) reverse-proxy. Hopefully soon, the Matrix playbook will follow suit and be powered by Traefik by default." msgstr "" -#: ../../../YEAR-IN-REVIEW.md:106 +#: ../../../YEAR-IN-REVIEW.md:113 msgid "Last, but not least, to optimize our [etke.cc managed Matrix hosting service](https://etke.cc/)'s performance (but also individual Ansible playbook runs for people self-hosting by themselves using the playbook), we've [improved playbook runtime 2-5x](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) by employing various Ansible tricks." msgstr "" diff --git a/i18n/translation-templates/docs/README.pot b/i18n/translation-templates/docs/README.pot index 0acbd653e..c09bd197c 100644 --- a/i18n/translation-templates/docs/README.pot +++ b/i18n/translation-templates/docs/README.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,154 +16,154 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/README.md:1 +#: ../../../docs/README.md:10 msgid "Table of Contents" msgstr "" -#: ../../../docs/README.md:3 -msgid "⬇️ Installaton guides " +#: ../../../docs/README.md:12 +msgid "⬇️ Installation guides " msgstr "" -#: ../../../docs/README.md:5 +#: ../../../docs/README.md:14 msgid "There are two installation guides available for beginners and advanced users." msgstr "" -#: ../../../docs/README.md:7 +#: ../../../docs/README.md:16 msgid "⚡ **[Quick start](quick-start.md) (for beginners)**: this is recommended for those who do not have an existing Matrix server and want to start quickly with \"opinionated defaults\"." msgstr "" -#: ../../../docs/README.md:9 +#: ../../../docs/README.md:18 msgid "**Full installation guide (for advanced users)**: if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide." msgstr "" -#: ../../../docs/README.md:11 +#: ../../../docs/README.md:20 msgid "[Prerequisites](prerequisites.md)" msgstr "" -#: ../../../docs/README.md:13 -msgid "[Configuring your DNS settings](configuring-dns.md)" +#: ../../../docs/README.md:22 +msgid "[Configuring DNS settings](configuring-dns.md)" msgstr "" -#: ../../../docs/README.md:15 +#: ../../../docs/README.md:24 msgid "[Getting the playbook](getting-the-playbook.md)" msgstr "" -#: ../../../docs/README.md:17 +#: ../../../docs/README.md:26 msgid "[Configuring the playbook](configuring-playbook.md)" msgstr "" -#: ../../../docs/README.md:19 +#: ../../../docs/README.md:28 msgid "[Installing](installing.md)" msgstr "" -#: ../../../docs/README.md:21 +#: ../../../docs/README.md:30 msgid "🛠️ Configuration options" msgstr "" -#: ../../../docs/README.md:28 +#: ../../../docs/README.md:37 msgid "You can check useful documentation for configuring components here: [Configuring the playbook](configuring-playbook.md)" msgstr "" -#: ../../../docs/README.md:30 +#: ../../../docs/README.md:39 msgid "[Administration](configuring-playbook.md#administration) — services that help you in administrating and monitoring your Matrix installation" msgstr "" -#: ../../../docs/README.md:32 +#: ../../../docs/README.md:41 msgid "[Authentication and user-related](configuring-playbook.md#authentication-and-user-related) — extend and modify how users are authenticated on your homeserver" msgstr "" -#: ../../../docs/README.md:34 +#: ../../../docs/README.md:43 msgid "[Bots](configuring-playbook.md#bots) — bots provide various additional functionality to your installation" msgstr "" -#: ../../../docs/README.md:36 +#: ../../../docs/README.md:45 msgid "[Bridges](configuring-playbook.md#bridging-other-networks) — bridges can be used to connect your Matrix installation with third-party communication networks" msgstr "" -#: ../../../docs/README.md:38 +#: ../../../docs/README.md:47 msgid "[Clients](configuring-playbook.md#clients) — web clients for Matrix that you can host on your own domains" msgstr "" -#: ../../../docs/README.md:40 +#: ../../../docs/README.md:49 msgid "[Core service adjustments](configuring-playbook.md#core-service-adjustments) — backbone of your Matrix system" msgstr "" -#: ../../../docs/README.md:42 +#: ../../../docs/README.md:51 msgid "[File Storage](configuring-playbook.md#file-storage) — use alternative file storage to the default `media_store` folder" msgstr "" -#: ../../../docs/README.md:46 +#: ../../../docs/README.md:55 msgid "[Other specialized services](configuring-playbook.md#other-specialized-services) — various services that don't fit any other categories" msgstr "" -#: ../../../docs/README.md:48 +#: ../../../docs/README.md:57 msgid "👨‍🔧 Maintenance" msgstr "" -#: ../../../docs/README.md:50 +#: ../../../docs/README.md:59 msgid "If your server and services experience issues, feel free to come to [our support room](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) and ask for help." msgstr "" -#: ../../../docs/README.md:54 -msgid "[Checking if services work](maintenance-checking-services.md)" -msgstr "" - -#: ../../../docs/README.md:56 +#: ../../../docs/README.md:63 msgid "[Maintenance and Troubleshooting](maintenance-and-troubleshooting.md)" msgstr "" -#: ../../../docs/README.md:58 +#: ../../../docs/README.md:65 msgid "[PostgreSQL maintenance](maintenance-postgres.md)" msgstr "" -#: ../../../docs/README.md:60 +#: ../../../docs/README.md:67 msgid "[Synapse maintenance](maintenance-synapse.md)" msgstr "" -#: ../../../docs/README.md:62 +#: ../../../docs/README.md:69 msgid "[Upgrading services](maintenance-upgrading-services.md)" msgstr "" -#: ../../../docs/README.md:64 +#: ../../../docs/README.md:71 msgid "Other documentation pages " msgstr "" -#: ../../../docs/README.md:66 +#: ../../../docs/README.md:73 msgid "ℹ️ **[FAQ](faq.md)** — various Frequently Asked Questions about Matrix, with a focus on this Ansible playbook" msgstr "" -#: ../../../docs/README.md:70 +#: ../../../docs/README.md:77 msgid "[Alternative architectures](alternative-architectures.md)" msgstr "" -#: ../../../docs/README.md:72 +#: ../../../docs/README.md:79 msgid "[Container images used by the playbook](container-images.md)" msgstr "" -#: ../../../docs/README.md:74 +#: ../../../docs/README.md:81 msgid "[Obtaining an Access Token](obtaining-access-tokens.md)" msgstr "" -#: ../../../docs/README.md:76 +#: ../../../docs/README.md:83 msgid "[Playbook tags](playbook-tags.md)" msgstr "" -#: ../../../docs/README.md:78 +#: ../../../docs/README.md:85 msgid "[Registering users](registering-users.md)" msgstr "" -#: ../../../docs/README.md:80 +#: ../../../docs/README.md:87 msgid "[Running `just` commands](just.md)" msgstr "" -#: ../../../docs/README.md:82 +#: ../../../docs/README.md:89 msgid "[Self-building](self-building.md)" msgstr "" -#: ../../../docs/README.md:84 +#: ../../../docs/README.md:91 msgid "[Uninstalling](uninstalling.md)" msgstr "" -#: ../../../docs/README.md:86 +#: ../../../docs/README.md:93 msgid "[Updating users passwords](updating-users-passwords.md)" msgstr "" + +#: ../../../docs/README.md:95 +msgid "[Using Ansible for the playbook](ansible.md)" +msgstr "" diff --git a/i18n/translation-templates/docs/alternative-architectures.pot b/i18n/translation-templates/docs/alternative-architectures.pot index efb512f68..ea089be09 100644 --- a/i18n/translation-templates/docs/alternative-architectures.pot +++ b/i18n/translation-templates/docs/alternative-architectures.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,42 +16,42 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/alternative-architectures.md:1 +#: ../../../docs/alternative-architectures.md:9 msgid "Alternative architectures" msgstr "" -#: ../../../docs/alternative-architectures.md:3 +#: ../../../docs/alternative-architectures.md:11 msgid "As stated in the [Prerequisites](prerequisites.md), currently only `amd64` (`x86_64`) is fully supported." msgstr "" -#: ../../../docs/alternative-architectures.md:5 +#: ../../../docs/alternative-architectures.md:13 msgid "The playbook automatically determines the target server's architecture (the `matrix_architecture` variable) to be one of the following:" msgstr "" -#: ../../../docs/alternative-architectures.md:7 +#: ../../../docs/alternative-architectures.md:15 msgid "`amd64` (`x86_64`)" msgstr "" -#: ../../../docs/alternative-architectures.md:8 +#: ../../../docs/alternative-architectures.md:16 msgid "`arm32`" msgstr "" -#: ../../../docs/alternative-architectures.md:9 +#: ../../../docs/alternative-architectures.md:17 msgid "`arm64`" msgstr "" -#: ../../../docs/alternative-architectures.md:11 +#: ../../../docs/alternative-architectures.md:19 msgid "Some tools and container images can be built on the host or other measures can be used to install on that architecture." msgstr "" -#: ../../../docs/alternative-architectures.md:13 +#: ../../../docs/alternative-architectures.md:21 msgid "Implementation details" msgstr "" -#: ../../../docs/alternative-architectures.md:15 +#: ../../../docs/alternative-architectures.md:23 msgid "For `amd64`, prebuilt container images (see the [container images we use](container-images.md)) are used for all components (except [Hydrogen](configuring-playbook-client-hydrogen.md), which goes through self-building)." msgstr "" -#: ../../../docs/alternative-architectures.md:17 +#: ../../../docs/alternative-architectures.md:25 msgid "For other architecture (`arm64`, `arm32`), components which have a prebuilt image make use of it. If the component is not available for the specific architecture, [self-building](self-building.md) will be used. Not all components support self-building though, so your mileage may vary." msgstr "" diff --git a/i18n/translation-templates/docs/ansible.pot b/i18n/translation-templates/docs/ansible.pot index dec504ce5..678e3bec5 100644 --- a/i18n/translation-templates/docs/ansible.pot +++ b/i18n/translation-templates/docs/ansible.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,165 +16,177 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/ansible.md:2 -msgid "Running this playbook" +#: ../../../docs/ansible.md:11 +msgid "Using Ansible for the playbook" msgstr "" -#: ../../../docs/ansible.md:4 +#: ../../../docs/ansible.md:13 msgid "This playbook is meant to be run using [Ansible](https://www.ansible.com/)." msgstr "" -#: ../../../docs/ansible.md:6 +#: ../../../docs/ansible.md:15 msgid "Ansible typically runs on your local computer and carries out tasks on a remote server. If your local computer cannot run Ansible, you can also run Ansible on some server somewhere (including the server you wish to install to)." msgstr "" -#: ../../../docs/ansible.md:8 +#: ../../../docs/ansible.md:17 msgid "Supported Ansible versions" msgstr "" -#: ../../../docs/ansible.md:10 +#: ../../../docs/ansible.md:19 msgid "To manually check which version of Ansible you're on, run: `ansible --version`." msgstr "" -#: ../../../docs/ansible.md:12 +#: ../../../docs/ansible.md:21 msgid "For the **best experience**, we recommend getting the **latest version of Ansible available**." msgstr "" -#: ../../../docs/ansible.md:14 -msgid "We're not sure what's the minimum version of Ansible that can run this playbook successfully. The lowest version that we've confirmed (on 2022-11-26) to be working fine is: `ansible-core` (`2.11.7`) combined with `ansible` (`4.10.0`)." +#: ../../../docs/ansible.md:23 +msgid "We're not sure what's the minimum version of Ansible that can run this playbook successfully. The lowest version that we suspect (on 2025-09-03) to be working fine is: `ansible-core` (`2.15.1`)." msgstr "" -#: ../../../docs/ansible.md:16 +#: ../../../docs/ansible.md:25 msgid "If your distro ships with an Ansible version older than this, you may run into issues. Consider [Upgrading Ansible](#upgrading-ansible) or [using Ansible via Docker](#using-ansible-via-docker)." msgstr "" -#: ../../../docs/ansible.md:18 -msgid "Upgrading Ansible" -msgstr "" - -#: ../../../docs/ansible.md:20 -msgid "Depending on your distribution, you may be able to upgrade Ansible in a few different ways:" -msgstr "" - -#: ../../../docs/ansible.md:22 -msgid "by using an additional repository (PPA, etc.), which provides newer Ansible versions. See instructions for [CentOS](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-rhel-centos-or-fedora), [Debian](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-debian), or [Ubuntu](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-ubuntu) on the Ansible website." -msgstr "" - -#: ../../../docs/ansible.md:24 -msgid "by removing the Ansible package (`yum remove ansible` or `apt-get remove ansible`) and installing via [pip](https://pip.pypa.io/en/stable/installation/) (`pip install ansible`)." -msgstr "" - -#: ../../../docs/ansible.md:26 -msgid "If using the `pip` method, do note that the `ansible-playbook` binary may not be on the `$PATH` (https://linuxconfig.org/linux-path-environment-variable), but in some more special location like `/usr/local/bin/ansible-playbook`. You may need to invoke it using the full path." -msgstr "" - -#: ../../../docs/ansible.md:28 -msgid "**Note**: Both of the above methods are a bad way to run system software such as Ansible. If you find yourself needing to resort to such hacks, please consider reporting a bug to your distribution and/or switching to a sane distribution, which provides up-to-date software." +#: ../../../docs/ansible.md:27 +msgid "[!WARNING] One reason for the version requirement being as such is that the playbook by default installs Docker for you using [this Docker role](https://github.com/geerlingguy/ansible-role-docker) which [has a hard requirement on Ansible v2.15.1](https://github.com/geerlingguy/ansible-role-docker/commit/7f44a1d9ad8132819ea9852918bca5dab8757cd0). If you install Docker yourself another way, you can tell the playbook to skip running this role (by adding `matrix_playbook_docker_installation_enabled: false` to your `vars.yml` configuration). It may then be possible to get the playbook running on an older version of Ansible. Still, this is a complication and your mileage may vary. We recommend [upgrading Ansible](#upgrading-ansible) instead of going into uncharted territory." msgstr "" #: ../../../docs/ansible.md:30 -msgid "Using Ansible via Docker" +msgid "Upgrading Ansible" msgstr "" #: ../../../docs/ansible.md:32 -msgid "Alternatively, you can run Ansible inside a Docker container (powered by the [devture/ansible](https://hub.docker.com/r/devture/ansible/) Docker image)." +msgid "Depending on your distribution, you may be able to upgrade Ansible in a few different ways:" msgstr "" #: ../../../docs/ansible.md:34 -msgid "This ensures that you're using a very recent Ansible version, which is less likely to be incompatible with the playbook." +msgid "by using an additional repository (PPA, etc.), which provides newer Ansible versions. See instructions for [CentOS](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-rhel-centos-or-fedora), [Debian](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-debian), or [Ubuntu](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-ubuntu) on the Ansible website." msgstr "" #: ../../../docs/ansible.md:36 -msgid "You can either [run Ansible in a container on the Matrix server itself](#running-ansible-in-a-container-on-the-matrix-server-itself) or [run Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)." +msgid "by removing the Ansible package (`yum remove ansible` or `apt-get remove ansible`) and installing via [pip](https://pip.pypa.io/en/stable/installation/) (`pip install ansible`)." msgstr "" #: ../../../docs/ansible.md:38 -msgid "Running Ansible in a container on the Matrix server itself" +msgid "If using the `pip` method, do note that the `ansible-playbook` binary may not be on the `$PATH` (https://linuxconfig.org/linux-path-environment-variable), but in some more special location like `/usr/local/bin/ansible-playbook`. You may need to invoke it using the full path." msgstr "" #: ../../../docs/ansible.md:40 -msgid "To run Ansible in a (Docker) container on the Matrix server itself, you need to have a working Docker installation. Docker is normally installed by the playbook, so this may be a bit of a chicken and egg problem. To solve it:" +msgid "**Note**: Both of the above methods are a bad way to run system software such as Ansible. If you find yourself needing to resort to such hacks, please consider reporting a bug to your distribution and/or switching to a sane distribution, which provides up-to-date software." msgstr "" #: ../../../docs/ansible.md:42 -msgid "you **either** need to install Docker manually first. Follow [the upstream instructions](https://docs.docker.com/engine/install/) for your distribution and consider setting `matrix_playbook_docker_installation_enabled: false` in your `vars.yml` file, to prevent the playbook from installing Docker" +msgid "Using Ansible via Docker" msgstr "" -#: ../../../docs/ansible.md:43 -msgid "**or** you need to run the playbook in another way (e.g. [Running Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)) at least the first time around" +#: ../../../docs/ansible.md:44 +msgid "Alternatively, you can run Ansible inside a Docker container (powered by the [ghcr.io/devture/ansible](https://github.com/devture/docker-ansible/pkgs/container/ansible) Docker image)." msgstr "" -#: ../../../docs/ansible.md:45 -msgid "Once you have a working Docker installation on the server, **clone the playbook** somewhere on the server and configure it as per usual (`inventory/hosts`, `inventory/host_vars/…`, etc.), as described in [configuring the playbook](configuring-playbook.md)." +#: ../../../docs/ansible.md:46 +msgid "This ensures that:" msgstr "" -#: ../../../docs/ansible.md:47 -msgid "You would then need to add `ansible_connection=community.docker.nsenter` to the host line in `inventory/hosts`. This tells Ansible to connect to the \"remote\" machine by switching Linux namespaces with [nsenter](https://man7.org/linux/man-pages/man1/nsenter.1.html), instead of using SSH." +#: ../../../docs/ansible.md:48 +msgid "you're using a very recent Ansible version, which is less likely to be incompatible with the playbook" msgstr "" #: ../../../docs/ansible.md:49 -msgid "Alternatively, you can leave your `inventory/hosts` as is and specify the connection type in **each** `ansible-playbook` call you do later, like this: `ansible-playbook --connection=community.docker.nsenter …`" +msgid "you also get access to the [agru](https://github.com/etkecc/agru) tool for quicker Ansible role installation (when running `just roles`) compared to `ansible-galaxy`" msgstr "" #: ../../../docs/ansible.md:51 -#: ../../../docs/ansible.md:71 +msgid "You can either [run Ansible in a container on the Matrix server itself](#running-ansible-in-a-container-on-the-matrix-server-itself) or [run Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)." +msgstr "" + +#: ../../../docs/ansible.md:53 +msgid "Running Ansible in a container on the Matrix server itself" +msgstr "" + +#: ../../../docs/ansible.md:55 +msgid "To run Ansible in a (Docker) container on the Matrix server itself, you need to have a working Docker installation. Docker is normally installed by the playbook, so this may be a bit of a chicken and egg problem. To solve it:" +msgstr "" + +#: ../../../docs/ansible.md:57 +msgid "you **either** need to install Docker manually first. Follow [the upstream instructions](https://docs.docker.com/engine/install/) for your distribution and consider setting `matrix_playbook_docker_installation_enabled: false` in your `vars.yml` file, to prevent the playbook from installing Docker" +msgstr "" + +#: ../../../docs/ansible.md:58 +msgid "**or** you need to run the playbook in another way (e.g. [Running Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)) at least the first time around" +msgstr "" + +#: ../../../docs/ansible.md:60 +msgid "Once you have a working Docker installation on the server, **clone the playbook** somewhere on the server and configure it as per usual (`inventory/hosts`, `inventory/host_vars/…`, etc.), as described in [configuring the playbook](configuring-playbook.md)." +msgstr "" + +#: ../../../docs/ansible.md:62 +msgid "You would then need to add `ansible_connection=community.docker.nsenter` to the host line in `inventory/hosts`. This tells Ansible to connect to the \"remote\" machine by switching Linux namespaces with [nsenter](https://man7.org/linux/man-pages/man1/nsenter.1.html), instead of using SSH." +msgstr "" + +#: ../../../docs/ansible.md:64 +msgid "Alternatively, you can leave your `inventory/hosts` as is and specify the connection type in **each** `ansible-playbook` call you do later, like this: `just install-all --connection=community.docker.nsenter` (or `ansible-playbook --connection=community.docker.nsenter …`)." +msgstr "" + +#: ../../../docs/ansible.md:66 +#: ../../../docs/ansible.md:88 msgid "Run this from the playbook's directory:" msgstr "" -#: ../../../docs/ansible.md:63 -#: ../../../docs/ansible.md:84 +#: ../../../docs/ansible.md:80 +#: ../../../docs/ansible.md:103 msgid "Once you execute the above command, you'll be dropped into a `/work` directory inside a Docker container. The `/work` directory contains the playbook's code." msgstr "" -#: ../../../docs/ansible.md:65 -#: ../../../docs/ansible.md:86 +#: ../../../docs/ansible.md:82 +#: ../../../docs/ansible.md:105 msgid "First, consider running `git config --global --add safe.directory /work` to [resolve directory ownership issues](#resolve-directory-ownership-issues)." msgstr "" -#: ../../../docs/ansible.md:67 -msgid "Finally, you can execute `ansible-playbook …` (or `ansible-playbook --connection=community.docker.nsenter …`) commands as per normal now." +#: ../../../docs/ansible.md:84 +msgid "Finally, you can execute `just` or `ansible-playbook …` (e.g. `ansible-playbook --connection=community.docker.nsenter …`) commands as per normal now." msgstr "" -#: ../../../docs/ansible.md:69 +#: ../../../docs/ansible.md:86 msgid "Running Ansible in a container on another computer (not the Matrix server)" msgstr "" -#: ../../../docs/ansible.md:82 -msgid "The above command tries to mount an SSH key (`$HOME/.ssh/id_rsa`) into the container (at `/root/.ssh/id_rsa`). If your SSH key is at a different path (not in `$HOME/.ssh/id_rsa`), adjust that part." +#: ../../../docs/ansible.md:101 +msgid "The above command tries to mount an SSH key (`$HOME/.ssh/id_ed25519`) into the container (at `/root/.ssh/id_ed25519`). If your SSH key is at a different path (not in `$HOME/.ssh/id_ed25519`), adjust that part." msgstr "" -#: ../../../docs/ansible.md:88 -msgid "Finally, you execute `ansible-playbook …` commands as per normal now." +#: ../../../docs/ansible.md:107 +msgid "Finally, you execute `just` or `ansible-playbook …` commands as per normal now." msgstr "" -#: ../../../docs/ansible.md:90 +#: ../../../docs/ansible.md:109 msgid "If you don't use SSH keys for authentication" msgstr "" -#: ../../../docs/ansible.md:92 -msgid "If you don't use SSH keys for authentication, simply remove that whole line (`-v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa:ro`)." +#: ../../../docs/ansible.md:111 +msgid "If you don't use SSH keys for authentication, simply remove that whole line (`--mount type=bind,src$HOME/.ssh/id_ed25519,dst=/root/.ssh/id_ed25519,ro`)." msgstr "" -#: ../../../docs/ansible.md:94 +#: ../../../docs/ansible.md:113 msgid "To authenticate at your server using a password, you need to add a package. So, when you are in the shell of the ansible docker container (the previously used `docker run -it …` command), run:" msgstr "" -#: ../../../docs/ansible.md:100 -msgid "Then, to be asked for the password whenever running an `ansible-playbook` command add `--ask-pass` to the arguments of the command." +#: ../../../docs/ansible.md:119 +msgid "Then, to be asked for the password whenever running an `ansible-playbook` command add `--ask-pass` to the arguments of the command." msgstr "" -#: ../../../docs/ansible.md:102 +#: ../../../docs/ansible.md:121 msgid "Resolve directory ownership issues" msgstr "" -#: ../../../docs/ansible.md:104 -msgid "Because you're `root` in the container running Ansible and this likely differs fom the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as:" +#: ../../../docs/ansible.md:123 +msgid "Because you're `root` in the container running Ansible and this likely differs from the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as:" msgstr "" -#: ../../../docs/ansible.md:106 +#: ../../../docs/ansible.md:125 msgid "fatal: unsafe repository ('/work' is owned by someone else) To add an exception for this directory, call: git config --global --add safe.directory /work" msgstr "" -#: ../../../docs/ansible.md:110 +#: ../../../docs/ansible.md:129 msgid "These errors can be resolved by making `git` trust the playbook directory by running `git config --global --add safe.directory /work`" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-captcha.pot b/i18n/translation-templates/docs/configuring-captcha.pot index a652f8838..53c1aab0a 100644 --- a/i18n/translation-templates/docs/configuring-captcha.pot +++ b/i18n/translation-templates/docs/configuring-captcha.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,60 +16,60 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-captcha.md:1 +#: ../../../docs/configuring-captcha.md:10 msgid "(Adapted from the [upstream project](https://github.com/element-hq/synapse/blob/develop/docs/CAPTCHA_SETUP.md))" msgstr "" -#: ../../../docs/configuring-captcha.md:3 +#: ../../../docs/configuring-captcha.md:12 msgid "Overview" msgstr "" -#: ../../../docs/configuring-captcha.md:5 +#: ../../../docs/configuring-captcha.md:14 msgid "Captcha can be enabled for this home server. This file explains how to do that." msgstr "" -#: ../../../docs/configuring-captcha.md:7 +#: ../../../docs/configuring-captcha.md:16 msgid "The captcha mechanism used is Google's [ReCaptcha](https://www.google.com/recaptcha/). This requires API keys from Google. If your homeserver is Dendrite then [hCapcha](https://www.hcaptcha.com) can be used instead." msgstr "" -#: ../../../docs/configuring-captcha.md:9 +#: ../../../docs/configuring-captcha.md:18 msgid "ReCaptcha" msgstr "" -#: ../../../docs/configuring-captcha.md:11 -#: ../../../docs/configuring-captcha.md:37 +#: ../../../docs/configuring-captcha.md:20 +#: ../../../docs/configuring-captcha.md:46 msgid "Getting keys" msgstr "" -#: ../../../docs/configuring-captcha.md:13 -#: ../../../docs/configuring-captcha.md:39 +#: ../../../docs/configuring-captcha.md:22 +#: ../../../docs/configuring-captcha.md:48 msgid "Requires a site/secret key pair from:" msgstr "" -#: ../../../docs/configuring-captcha.md:15 +#: ../../../docs/configuring-captcha.md:24 msgid "" msgstr "" -#: ../../../docs/configuring-captcha.md:17 +#: ../../../docs/configuring-captcha.md:26 msgid "Must be a reCAPTCHA **v2** key using the \"I'm not a robot\" Checkbox option" msgstr "" -#: ../../../docs/configuring-captcha.md:19 +#: ../../../docs/configuring-captcha.md:28 msgid "Setting ReCaptcha keys" msgstr "" -#: ../../../docs/configuring-captcha.md:21 +#: ../../../docs/configuring-captcha.md:30 msgid "Once registered as above, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-captcha.md:35 +#: ../../../docs/configuring-captcha.md:44 msgid "hCaptcha" msgstr "" -#: ../../../docs/configuring-captcha.md:41 +#: ../../../docs/configuring-captcha.md:50 msgid "" msgstr "" -#: ../../../docs/configuring-captcha.md:43 +#: ../../../docs/configuring-captcha.md:52 msgid "Setting hCaptcha keys" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-dns.pot b/i18n/translation-templates/docs/configuring-dns.pot index 5cbb56f35..579ce4883 100644 --- a/i18n/translation-templates/docs/configuring-dns.pot +++ b/i18n/translation-templates/docs/configuring-dns.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,23 +16,23 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-dns.md:1 -msgid "Configuring your DNS settings" +#: ../../../docs/configuring-dns.md:18 +msgid "Configuring DNS settings" msgstr "" -#: ../../../docs/configuring-dns.md:3 -msgid "[Prerequisites](prerequisites.md) > Configuring your DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)" +#: ../../../docs/configuring-dns.md:20 +msgid "[Prerequisites](prerequisites.md) > Configuring DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)" msgstr "" -#: ../../../docs/configuring-dns.md:5 +#: ../../../docs/configuring-dns.md:22 msgid "To set up Matrix on your domain, you'd need to do some DNS configuration." msgstr "" -#: ../../../docs/configuring-dns.md:7 +#: ../../../docs/configuring-dns.md:24 msgid "DNS settings for services enabled by default" msgstr "" -#: ../../../docs/configuring-dns.md:9 +#: ../../../docs/configuring-dns.md:26 msgid "To serve the base domain (`example.com`) and [Element Web](configuring-playbook-client-element-web.md) with the default subdomain, adjust DNS records as below." msgstr "" @@ -73,7 +73,15 @@ msgid "-" msgstr "" #: ../../../docs/configuring-dns.md:0 -msgid "`matrix-server-IP`" +msgid "`matrix-server-IPv4`" +msgstr "" + +#: ../../../docs/configuring-dns.md:0 +msgid "AAAA" +msgstr "" + +#: ../../../docs/configuring-dns.md:0 +msgid "`matrix-server-IPv6`" msgstr "" #: ../../../docs/configuring-dns.md:0 @@ -88,58 +96,62 @@ msgstr "" msgid "`matrix.example.com`" msgstr "" -#: ../../../docs/configuring-dns.md:16 -msgid "As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IP address (DNS `A` record or `CNAME` record is fine)." +#: ../../../docs/configuring-dns.md:34 +msgid "As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IPv4/IPv6 address." msgstr "" -#: ../../../docs/configuring-dns.md:18 +#: ../../../docs/configuring-dns.md:36 +msgid "If you don't have IPv6 connectivity yet, you can skip the `AAAA` record. For more details about IPv6, see the [Configuring IPv6](./configuring-ipv6.md) documentation page." +msgstr "" + +#: ../../../docs/configuring-dns.md:38 msgid "The `element.example.com` subdomain is necessary, because this playbook installs the [Element Web](https://github.com/element-hq/element-web) client for you by default. If you'd rather instruct the playbook not to install Element Web (`matrix_client_element_enabled: false` when [Configuring the playbook](configuring-playbook.md) later), feel free to skip the `element.example.com` DNS record." msgstr "" -#: ../../../docs/configuring-dns.md:20 +#: ../../../docs/configuring-dns.md:40 msgid "Be mindful as to how long it will take for the DNS records to propagate." msgstr "" -#: ../../../docs/configuring-dns.md:22 +#: ../../../docs/configuring-dns.md:42 msgid "**Note**: if you are using Cloudflare DNS, make sure to disable the proxy and set all records to \"DNS only\". Otherwise, fetching certificates will fail." msgstr "" -#: ../../../docs/configuring-dns.md:24 +#: ../../../docs/configuring-dns.md:44 msgid "DNS setting for server delegation (optional)" msgstr "" -#: ../../../docs/configuring-dns.md:26 +#: ../../../docs/configuring-dns.md:46 msgid "In the sample `vars.yml` ([`examples/vars.yml`](../examples/vars.yml)), we recommend to use a short user ID like `@alice:example.com` instead of `@alice:matrix.example.com`." msgstr "" -#: ../../../docs/configuring-dns.md:28 +#: ../../../docs/configuring-dns.md:48 msgid "To use such an ID, you don't need to install anything on the actual `example.com` server. Instead, you need to instruct the Matrix network that Matrix services for `example.com` are redirected over to `matrix.example.com`. This redirection is also known as \"delegation\"." msgstr "" -#: ../../../docs/configuring-dns.md:30 +#: ../../../docs/configuring-dns.md:50 msgid "As we discuss in [Server Delegation](howto-server-delegation.md), server delegation can be configured in either of these ways:" msgstr "" -#: ../../../docs/configuring-dns.md:32 +#: ../../../docs/configuring-dns.md:52 msgid "Setting up a `/.well-known/matrix/server` file on the base domain (`example.com`)" msgstr "" -#: ../../../docs/configuring-dns.md:33 +#: ../../../docs/configuring-dns.md:53 msgid "Setting up a `_matrix._tcp` DNS SRV record" msgstr "" -#: ../../../docs/configuring-dns.md:35 +#: ../../../docs/configuring-dns.md:55 msgid "For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file, instead of using a DNS SRV record." msgstr "" -#: ../../../docs/configuring-dns.md:37 +#: ../../../docs/configuring-dns.md:57 msgid "If you choose the recommended method (file-based delegation), you do not need to configure the DNS record to enable server delegation. You will need to add a necessary configuration later, when you [finalize the installation](installing.md#finalize-the-installation) after installing and starting Matrix services." msgstr "" -#: ../../../docs/configuring-dns.md:39 +#: ../../../docs/configuring-dns.md:59 msgid "On the other hand, if you choose this method (setting up a DNS SRV record), you need to configure the additional DNS record as well as adjust SSL certificate handling. Take a look at this documentation for more information: [Server Delegation via a DNS SRV record (advanced)](howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced)" msgstr "" -#: ../../../docs/configuring-dns.md:43 +#: ../../../docs/configuring-dns.md:63 msgid "[▶️](getting-the-playbook.md) When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md)." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-ipv6.pot b/i18n/translation-templates/docs/configuring-ipv6.pot new file mode 100644 index 000000000..f77fe6c4c --- /dev/null +++ b/i18n/translation-templates/docs/configuring-ipv6.pot @@ -0,0 +1,361 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-ipv6.md:6 +msgid "Configuring IPv6" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:8 +msgid "Since 2025-03-08, the [default example configuration](../examples/vars.yml) for the playbook recommends enabling [IPv6](https://en.wikipedia.org/wiki/IPv6) support for Docker's container networks." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:10 +msgid "**If you have IPv6 support on your server/network** (see [How do I check if my server has IPv6 connectivity?](#how-do-i-check-if-my-server-has-ipv6-connectivity)), then [enabling IPv6 support for the playbook](#enabling-ipv6-support-for-the-playbook) would give you:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:12 +msgid "📥 incoming IPv6 connectivity to the server via the server's IPv6 address/addresses (containers won't have their own individual publicly accessible IPs)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:13 +msgid "📤 outgoing IPv6 connectivity from the server via the server's IPv6 address/addresses (containers won't exit via their own individual IPv6 address)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:14 +msgid "🔄 IPv6 connectivity for cross-container communication" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:16 +msgid "**If you still don't have IPv6 support on your server/network**, then enabling IPv6 support for the playbook will only enable IPv6 connectivity for cross-container communication and shouldn't affect your server's incoming/outgoing communication. You may also be interested in reading if [there's a performance penalty to enabling IPv6 if the server/network doesn't support IPv6 connectivity?](#is-there-a-performance-penalty-to-enabling-ipv6-if-the-server-network-doesn-t-support-ipv6-connectivity)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:18 +msgid "As such, **we recommend that you follow the default example configuration and leave IPv6 support for Docker enabled in all cases**." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:20 +msgid "Enabling IPv6 consists of 2 steps:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:22 +msgid "[Enabling IPv6 support for the playbook](#enabling-ipv6-support-for-the-playbook)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:23 +msgid "[Configuring DNS records for IPv6](#configuring-dns-records-for-ipv6)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:25 +msgid "💡 If you've followed a recent version of our documentation, you would have already done these steps, so there's nothing else to do." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:27 +msgid "Enabling IPv6 support for the playbook" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:29 +msgid "You can enable IPv6 support for all components' Docker container networks by using the following `vars.yml` configuration:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:50 +msgid "Doing this:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:52 +msgid "all container networks will be IPv6-enabled" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:54 +msgid "NAT66 will be used, so that:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:55 +msgid "containers will get [Unique Local Addresses (ULA)](https://en.wikipedia.org/wiki/Unique_local_address)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:56 +msgid "the outgoing IPv6 address for containers will be the same as the one on the server" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:57 +msgid "traffic destined for the IPv6 address of the server will be forwarded to the containers that handle (and publish) that specific port" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:59 +msgid "[!WARNING] Without enabling this and assuming you have IPv6 `AAAA` DNS records pointing to the server (see [Configuring DNS records for IPv6](#configuring-dns-records-for-ipv6)), IPv6 traffic will still be handled, but NAT64 will be used instead of NAT66. As such, containers will only have an IPv4 address and all IPv6 traffic that reaches them will seem to originate from a local IP. Containers also won't be able to make outgoing (even cross-container) IPv6 requests." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:63 +msgid "To confirm connectivity, see the following other resources:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:65 +msgid "[How do I check if my server has IPv6 connectivity?](#how-do-i-check-if-my-server-has-ipv6-connectivity)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:66 +msgid "[How do I check outgoing IPv6 connectivity for containers?](#how-do-i-check-outgoing-ipv6-connectivity-for-containers)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:67 +msgid "[How do I check incoming IPv6 connectivity for containers?](#how-do-i-check-incoming-ipv6-connectivity-for-containers)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:68 +msgid "[How do I confirm if my container networks are IPv6-enabled?](#how-do-i-confirm-if-my-container-networks-are-ipv6-enabled)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:69 +msgid "Ensure that the [Federation Tester](https://federationtester.matrix.org/) reports that your server is reachable over IPv6." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:71 +msgid "Configuring DNS records for IPv6" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:73 +msgid "[Enabling IPv6 support for the playbook](#enabling-ipv6-support-for-the-playbook) tells you how to prepare for IPv6 on the container (Docker) side." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:75 +msgid "For full public IPv6 connectivity (and not just IPv6 connectivity for containers inside the container networks) you also need to **ensure that your domain names** (e.g. `matrix.example.com` and others) have IPv6 (`AAAA`) DNS records pointing to the server's IPv6 address." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:77 +msgid "Also see the [Configuring DNS settings](configuring-dns.md) documentation page for more details." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:79 +msgid "A note about old Docker" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:81 +msgid "With our [default example configuration](../examples/vars.yml), the playbook manages Docker for you and installs a modern-enough version." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:83 +msgid "Docker versions newer than 27.0.1 enable IPv6 integration at the Docker daemon level out of the box. This still requires that networks are created with IPv6 support as described in the [Enabling IPv6 support for the playbook](#enabling-ipv6-support-for-the-playbook) section above." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:85 +msgid "**If you're on an old Docker version** (Docker 27.0.0 or older) for some reason, it's likely that your Docker installation is not enabled for IPv6 at all. In such a case:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:87 +msgid "if Docker is managed by the playbook, you can tell it to force-enable IPv6 via `devture_systemd_docker_base_ipv6_daemon_options_changing_enabled: true`" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:89 +msgid "if Docker is managed by you manually, you can add `{\"experimental\": true, \"ip6tables\": true}` to the Docker daemon options and restart the Docker service (`docker.service`)." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:91 +msgid "Frequently Asked Questions" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:93 +msgid "How do I check if my server has IPv6 connectivity?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:95 +msgid "With curl" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:97 +msgid "You can run `curl https://icanhazip.com` and see if it returns an [IPv6 address](https://en.wikipedia.org/wiki/IPv6_address) (an address with `:` characters in it, like `2001:db8:1234:5678::1`). If it does, then your server has IPv6 connectivity and prefers it over using IPv4. This is common." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:99 +msgid "If you see an IPv4 address instead (e.g. `1.2.3.4`), it may be that your server prefers IPv4 over IPv6 or that your network does not support IPv6. You can try forcing `curl` to use IPv6 by running `curl -6 https://icanhazip.com` and see if it returns an IPv6 address." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:101 +msgid "With other network utilities" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:103 +msgid "You can run `ip -6 addr` to see if you have any IPv6 addresses assigned to your server, besides the link-local (`fe80::*`) addresses that everyone has (unless they have force-disabled IPv6 support on their system)." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:105 +msgid "If you do have an IPv6 address, it's still worth [using curl](#with-curl) to confirm that your server can successfully make outgoing requests over IPv6." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:107 +msgid "What does the `devture_systemd_docker_base_ipv6_enabled` setting actually do?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:109 +msgid "The `devture_systemd_docker_base_ipv6_enabled` setting controls whether container networks will be created with IPv6 support." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:111 +msgid "Changing this setting subsequently requires manual work (deleting all container networks). See [I've changed the `devture_systemd_docker_base_ipv6_enabled` setting, but it doesn't seem to have any effect](#i-ve-changed-the-devture_systemd_docker_base_ipv6_enabled-setting-but-it-doesn-t-seem-to-have-any-effect)." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:114 +msgid "I've changed the `devture_systemd_docker_base_ipv6_enabled` setting, but it doesn't seem to have any effect." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:116 +msgid "If you're using an older Docker version (Docker 27.0.0 or older), see [A note about old Docker](#a-note-about-old-docker)." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:118 +msgid "If you've previously installed with one `devture_systemd_docker_base_ipv6_enabled` value and then changed it to another, you need to:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:120 +msgid "stop all services (`just stop-all`)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:121 +msgid "delete all container networks on the server: `docker network rm $(docker network ls -q)`" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:122 +msgid "re-run the playbook fully: `just install-all`" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:124 +msgid "How do I confirm if my container networks are IPv6-enabled?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:126 +msgid "You can list container networks by running `docker network ls` on the server." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:128 +msgid "For each container network (e.g. `matrix-homeserver`), you can check if it has IPv6 connectivity by running a command like this: `docker network inspect matrix-homeserver`." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:130 +msgid "Ensure that there's an IPv6 subnet/gateway in the `IPAM.Config` section. If yes, you may wish to proceed with [How do I check outgoing IPv6 connectivity for containers?](#how-do-i-check-outgoing-ipv6-connectivity-for-containers)" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:132 +msgid "If there's no IPv6 subnet/gateway in the `IPAM.Config` section, this container network was not created with IPv6 support. See [I've changed the `devture_systemd_docker_base_ipv6_enabled` setting, but it doesn't seem to have any effect](#i-ve-changed-the-devture_systemd_docker_base_ipv6_enabled-setting-but-it-doesn-t-seem-to-have-any-effect)." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:135 +msgid "How do I check outgoing IPv6 connectivity for containers?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:141 +msgid "💡 This one-off container is connected to the `matrix-homeserver` container network, not to the default Docker bridge network. The default Docker `bridge` network does not have IPv6 connectivity by default (yet) and is not influenced by the `devture_systemd_docker_base_ipv6_enabled` setting, so using that network (by omitting `--network=..` from the command above) will not show an IPv6 address" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:143 +msgid "✅ If this command returns an IPv6 address, you're all good." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:145 +msgid "❌ If this command doesn't return an IPv6 address, it may be that:" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:147 +msgid "your container network does not have IPv6 connectivity. See [How do I confirm if my container networks are IPv6-enabled?](#how-do-i-confirm-if-my-container-networks-are-ipv6-enabled) for more details." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:149 +msgid "your server does not have IPv6 connectivity. See [How do I check if my server has IPv6 connectivity?](#how-do-i-check-if-my-server-has-ipv6-connectivity) for more details. If you do have IPv6 connectivity, then the issue is with Docker's IPv6 configuration. Otherwise, you need to check your server's network configuration/firewall/routing and get back to configuring the playbook later on." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:151 +msgid "How do I check incoming IPv6 connectivity for containers?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:153 +msgid "Only containers that publish ports will be exposed (reachable) publicly on the server's own IPv6 address. Containers will not get their own individual public IPv6 address." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:155 +msgid "For this playbook, a commonly exposed container is the Traefik reverse-proxy container (unless [you're using your own webserver](./configuring-playbook-own-webserver.md))." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:157 +msgid "You can either do something like `curl -6 https://matrix.example.com` from an IPv6-enabled host (including the server itself) and see if it works." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:159 +msgid "An alternative is to use the [IPv6 Port Checker](https://port.tools/port-checker-ipv6/) with a hostname of `matrix.example.com` and a port of `443`." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:161 +msgid "💡 Trying to connect to `matrix.example.com` via IPv6 requires that you have already [configured the DNS records for IPv6](#configuring-dns-records-for-ipv6) as described above. If you wish to eliminate DNS as a potential issue, you can also try connecting to the server's own IPv6 address directly: `curl -6 -H 'Host: matrix.example.com' https://[2001:db8:1234:5678::1]` (we pass a `Host` header to tell Traefik which host we'd like it to serve)." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:163 +msgid "Why enable IPv6 if my network doesn't support it yet?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:165 +msgid "Because when your network does get support for IPv6 later on (even if that's 5 years away), you won't have to change anything besides [configuring the DNS records for IPv6](#configuring-dns-records-for-ipv6)." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:167 +msgid "Can I use a custom subnet for IPv6?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:169 +msgid "Not easily." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:171 +msgid "The playbook and the various roles only support passing an `enable_ipv6` flag (`true` or `false` value depending on the `devture_systemd_docker_base_ipv6_enabled` Ansible variable) when creating the Docker container networks." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:173 +msgid "There's no support for passing a custom subnet for IPv4 and IPv6. We let Docker auto-generate the subnets for us." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:175 +msgid "You can either create a Pull Request that adds support for this to the various playbook roles, or you can manually recreate the networks from the command-line (e.g. `docker network rm matrix-homeserver && docker network create --ipv6 --subnet=2001:db8:1234:5678::/64 matrix-homeserver`)." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:177 +msgid "Can I use Global Unicast Addresses (GUA) for IPv6?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:179 +msgid "No. You cannot have GUA addresses where each container is individually addressable over the public internet." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:181 +msgid "The playbook only supports NAT66, which should be good enough for most use cases." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:183 +msgid "Having containers get IPv6 addresses from your own GUA subnet requires complex configuration (ndp-proxy, etc.) and is not supported." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:185 +msgid "You may find [this Reddit post](https://www.reddit.com/r/ipv6/comments/1alpzmb/comment/kphpw11/) interesting." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:187 +msgid "Is there a performance penalty to enabling IPv6 if the server/network doesn't support IPv6 connectivity?" +msgstr "" + +#: ../../../docs/configuring-ipv6.md:189 +msgid "Probably a tiny one, as services may try to make (unsuccessful) outgoing requests over IPv6." +msgstr "" + +#: ../../../docs/configuring-ipv6.md:191 +msgid "In practice, it's probably negligible." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-alertmanager-receiver.pot b/i18n/translation-templates/docs/configuring-playbook-alertmanager-receiver.pot index b0324d65a..b4a7d552f 100644 --- a/i18n/translation-templates/docs/configuring-playbook-alertmanager-receiver.pot +++ b/i18n/translation-templates/docs/configuring-playbook-alertmanager-receiver.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,182 +16,174 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:1 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:9 msgid "Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver (optional)" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:3 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:11 msgid "The playbook can install and configure the [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver) service for you. It's a [client](https://prometheus.io/docs/alerting/latest/clients/) for Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), allowing you to deliver alerts to Matrix rooms." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:5 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:13 msgid "See the project's [documentation](https://github.com/metio/matrix-alertmanager-receiver/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:7 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:15 msgid "This service is meant to be used with an external [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) instance. It's **not** meant to be integrated with the [Prometheus & Grafana stack](./configuring-playbook-prometheus-grafana.md) installed by this playbook, because the Alertmanager component is not installed by it." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:9 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:17 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:11 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:19 msgid "Register the bot account" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:13 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:21 msgid "This service uses a bot (with a username specified in `matrix_alertmanager_receiver_config_matrix_user_id_localpart`) for delivering messages." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:15 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:23 msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:17 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:25 msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:19 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:27 msgid "You can use the playbook to [register a new user](registering-users.md):" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:25 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:33 msgid "Obtain an access token" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:27 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:35 msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:29 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:37 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:32 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:40 msgid "Join to rooms as the bot manually" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:34 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:42 msgid "ℹ️ **This bot does not accept room invitations automatically**. To deliver messages to rooms, the bot must be joined to all rooms manually." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:36 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:44 msgid "For each new room you would like the bot to deliver alerts to, invite the bot to the room." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:38 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:46 msgid "Then, log in as the bot using any Matrix client of your choosing, accept the room invitation from the bot's account, and log out." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:40 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:48 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:42 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:50 msgid "By default, this playbook installs matrix-alertmanager-receiver on the `matrix.` subdomain, at the `/matrix-alertmanager-receiver` path (https://matrix.example.com/matrix-alertmanager-receiver). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:44 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:52 msgid "If you wish to adjust it, see the section [below](#adjusting-the-matrix-alertmanager-receiver-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:46 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:54 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:48 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:56 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#obtain-an-access-token)." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:69 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:77 msgid "Adjusting the matrix-alertmanager-receiver URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:71 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:79 msgid "By tweaking the `matrix_alertmanager_receiver_hostname` and `matrix_alertmanager_receiver_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:73 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:81 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:81 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:89 msgid "If you've changed the default hostname, you may need to create a CNAME record for the matrix-alertmanager-receiver domain (`alertmanager.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:83 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:91 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:85 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:93 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:87 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:95 msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:89 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:97 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:91 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:99 msgid "`roles/custom/matrix-alertmanager-receiver/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:92 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:100 msgid "`roles/custom/matrix-alertmanager-receiver/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_alertmanager_receiver_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:94 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:102 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:96 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:104 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:103 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:105 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:107 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:111 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:109 -msgid "`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." +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:113 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:111 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:115 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:113 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:117 msgid "Configure your Prometheus Alertmanager with configuration like this:" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:132 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:136 msgid "where `URL_HERE` looks like `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name` or `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!qporfwt:example.com`." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:134 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:138 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:136 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:140 msgid "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-alertmanager-receiver`." msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:138 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:142 msgid "Increase logging verbosity" msgstr "" -#: ../../../docs/configuring-playbook-alertmanager-receiver.md:140 +#: ../../../docs/configuring-playbook-alertmanager-receiver.md:144 msgid "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:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-appservice-double-puppet.pot b/i18n/translation-templates/docs/configuring-playbook-appservice-double-puppet.pot index afd8b9282..ba0e360b4 100644 --- a/i18n/translation-templates/docs/configuring-playbook-appservice-double-puppet.pot +++ b/i18n/translation-templates/docs/configuring-playbook-appservice-double-puppet.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,74 +16,66 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:1 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:8 msgid "Setting up Appservice Double Puppet (optional)" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:3 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:10 msgid "The playbook can install and configure the Appservice Double Puppet service for you. It is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver." msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:5 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:12 msgid "This is useful for performing [double-puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) via the appservice method. The service is an implementation of this approach." msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:7 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:14 msgid "Previously, bridges supported performing double-puppeting with the help of the [Shared Secret Auth password provider module](./configuring-playbook-shared-secret-auth.md), but this old and hacky solution has been superseded by this Appservice Double Puppet method." msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:9 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:16 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:11 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:18 msgid "To enable the Appservice Double Puppet service, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:17 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:24 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:19 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:26 msgid "There are some additional things you may wish to configure about the service." msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:21 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:28 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:23 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:30 msgid "`roles/custom/matrix-appservice-double-puppet/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_double_puppet_registration_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:25 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:32 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:27 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:34 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:34 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:36 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:38 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:41 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:40 -msgid "`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." +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:43 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:42 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:45 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-appservice-double-puppet.md:44 +#: ../../../docs/configuring-playbook-appservice-double-puppet.md:47 msgid "Installing the service will automatically enable double puppeting for all bridges that support double puppeting via the appservice method." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-appservice-draupnir-for-all.pot b/i18n/translation-templates/docs/configuring-playbook-appservice-draupnir-for-all.pot index e050f2b2a..73a043577 100644 --- a/i18n/translation-templates/docs/configuring-playbook-appservice-draupnir-for-all.pot +++ b/i18n/translation-templates/docs/configuring-playbook-appservice-draupnir-for-all.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,167 +16,167 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:1 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:8 msgid "Setting up Draupnir for All/D4A (optional)" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:3 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:10 msgid "The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool for you in appservice mode." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:5 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:12 msgid "Appservice mode can be used together with the regular [Draupnir bot](configuring-playbook-bot-draupnir.md) or independently. Details about the differences between the 2 modes are described below." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:7 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:14 msgid "Draupnir Appservice mode compared to Draupnir bot mode" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:9 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:16 msgid "The administrative functions for managing the appservice are alpha quality and very limited. However, the experience of using an appservice-provisioned Draupnir is on par with the experience of using Draupnir from bot mode except in the case of avatar customisation as described later on in this document." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:11 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:18 msgid "Draupnir for all is the way to go if you need more than 1 Draupnir instance, but you don't need access to Synapse Admin features as they are not accessible through Draupnir for All (Even though the commands do show up in help)." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:13 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:20 msgid "Draupnir for all in the playbook is rate-limit-exempt automatically as its appservice configuration file does not specify any rate limits." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:15 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:22 msgid "Normal Draupnir does come with the benefit of access to Synapse Admin features. You are also able to more easily customise your normal Draupnir than D4A as D4A even on the branch with the Avatar command (To be Upstreamed to Mainline Draupnir) that command is clunky as it requires the use of things like Element Web devtools. In normal Draupnir this is a quick operation where you login to Draupnir with a normal client and set Avatar and Display name normally." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:17 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:24 msgid "Draupnir for all does not support external tooling like [MRU](https://mru.rory.gay) as it can't access Draupnir's user account." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:19 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:26 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:21 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:28 msgid "Create a main management room" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:23 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:30 msgid "The playbook does not create a management room for your Main Draupnir. You **need to create the room manually** before setting up the bot." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:25 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:32 msgid "Note that the room must be unencrypted." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:27 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:34 msgid "The management room has to be given an alias, and your bot has to be invited to the room." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:29 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:36 msgid "This management room is used to control who has access to your D4A deployment. The room stores this data inside of the control room state so your bot must have sufficient powerlevel to send custom state events. This is default 50 or moderator as Element clients call this powerlevel." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:31 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:38 msgid "[!WARNING] Anyone in this room can control the bot so it is important that you only invite trusted users to this room." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:34 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:41 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:36 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:43 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `MANAGEMENT_ROOM_ALIAS_HERE`." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:44 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:51 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:46 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:53 msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:48 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:55 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:50 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:57 msgid "`roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_draupnir_for_all_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:52 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:59 msgid "For example, to change Draupnir's `protectAllJoinedRooms` option to `true`, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:66 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:73 msgid "You can refer to the upstream [documentation](https://github.com/the-draupnir-project/Draupnir) for more configuration documentation." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:68 -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:83 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:75 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:90 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:70 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:77 msgid "The playbook ships a full copy of the example config that does transfer to provisioned Draupnirs in the production-bots.yaml.j2 file in the template directory of the role." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:72 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:79 msgid "Config extension does not affect the appservices config as this config is not extensible in current Draupnir anyway. It instead touches the config passed to the Draupnirs that your Appservice creates. So the example above (`protectAllJoinedRooms: true`) makes all provisioned Draupnirs protect all joined rooms." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:74 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:81 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:76 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:83 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:85 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:92 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:87 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:94 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:89 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:96 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:91 -msgid "If you made it through all the steps above and your main control room was joined by a user called `@draupnir-main:example.com` you have succesfully installed Draupnir for All and can now start using it." +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:98 +msgid "If you made it through all the steps above and your main control room was joined by a user called `@draupnir-main:example.com` you have successfully installed Draupnir for All and can now start using it." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:93 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:100 msgid "The installation of Draupnir for all in this playbook is very much Alpha quality. Usage-wise, Draupnir for all is almost identical to Draupnir bot mode." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:95 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:102 msgid "Granting Users the ability to use D4A" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:97 -msgid "Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recomendation. Using the chat is recomended." +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:104 +msgid "Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recommendation. Using the chat is recommended." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:99 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:106 msgid "The bot requires a powerlevel of 50 in the management room to control who is allowed to use the bot. The bot does currently not say anything if this is true or false. (This is considered a bug and is documented in issue [#297](https://github.com/the-draupnir-project/Draupnir/issues/297))" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:101 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:108 msgid "To allow users or whole homeservers you type /plain !admin allow `target` and target can be either a MXID or a wildcard like `@*:example.com` to allow all users on example.com to register. We use /plain to force the client to not attempt to mess with this command as it can break Wildcard commands especially." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:103 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:110 msgid "How to provision a D4A once you are allowed to" msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:105 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:112 msgid "To provision a D4A, you need to start a chat with `@draupnir-main:example.com`. The bot will reject this invite and you will shortly get invited to the Draupnir control room for your newly provisioned Draupnir. From here its just a normal Draupnir experience." msgstr "" -#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:107 +#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:114 msgid "Congratulations if you made it all the way here because you now have a fully working Draupnir for all deployment." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-backup-borg.pot b/i18n/translation-templates/docs/configuring-playbook-backup-borg.pot index ca89549cf..f11f64dc8 100644 --- a/i18n/translation-templates/docs/configuring-playbook-backup-borg.pot +++ b/i18n/translation-templates/docs/configuring-playbook-backup-borg.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,174 +16,26 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-backup-borg.md:1 +#: ../../../docs/configuring-playbook-backup-borg.md:11 msgid "Setting up BorgBackup (optional)" msgstr "" -#: ../../../docs/configuring-playbook-backup-borg.md:3 +#: ../../../docs/configuring-playbook-backup-borg.md:13 msgid "The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you." msgstr "" -#: ../../../docs/configuring-playbook-backup-borg.md:5 +#: ../../../docs/configuring-playbook-backup-borg.md:15 msgid "BorgBackup is a deduplicating backup program with optional compression and encryption. That means your daily incremental backups can be stored in a fraction of the space and is safe whether you store it at home or on a cloud service." msgstr "" -#: ../../../docs/configuring-playbook-backup-borg.md:7 -msgid "Prerequisites" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:9 -msgid "Set up a remote server for storing backups" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:11 -msgid "You will need a remote server where BorgBackup will store the backups. There are hosted, BorgBackup compatible solutions available, such as [BorgBase](https://www.borgbase.com)." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:13 -msgid "Check the Postgres version" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:15 -msgid "By default, if you're using the integrated Postgres database server (as opposed to [an external Postgres server](configuring-playbook-external-postgres.md)), backups with BorgBackup will also include dumps of your Postgres database." -msgstr "" - #: ../../../docs/configuring-playbook-backup-borg.md:17 -msgid "Unless you disable the Postgres-backup support, make sure that the Postgres version of your homeserver's database is compatible with borgmatic. You can check the compatible versions [here](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/main/defaults/main.yml)." +msgid "The [Ansible role for BorgBackup](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring BorgBackup, you can check them via:" +msgstr "" + +#: ../../../docs/configuring-playbook-backup-borg.md:18 +msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/main/docs/configuring-backup-borg.md) online" msgstr "" #: ../../../docs/configuring-playbook-backup-borg.md:19 -msgid "An alternative solution for backing up the Postgres database is [postgres backup](configuring-playbook-postgres-backup.md). If you decide to go with another solution, you can disable Postgres-backup support for BorgBackup using the `backup_borg_postgresql_enabled` variable." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:21 -msgid "Create a new SSH key" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:23 -msgid "Run the command below on any machine to create a new SSH key:" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:29 -msgid "You don't need to place the key in the `.ssh` folder." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:31 -msgid "Add the public key" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:33 -msgid "Next, add the **public** part of this SSH key (the `matrix-borg-backup.pub` file) to your BorgBackup provider/server." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:35 -msgid "If you are using a hosted solution, follow their instructions. If you have your own server, copy the key to it with the command like below:" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:45 -msgid "The **private** key needs to be added to `backup_borg_ssh_key_private` on your `inventory/host_vars/matrix.example.com/vars.yml` file as below." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:47 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:49 -msgid "To enable BorgBackup, add the following configuration to your `vars.yml` file (adapt to your needs):" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:76 -msgid "**Note**: `REPO` will be initialized on backup start, for example: `matrix`. See [Remote repositories](https://borgbackup.readthedocs.io/en/stable/usage/general.html#repository-urls) for the syntax." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:78 -msgid "Set backup archive name (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:80 -msgid "You can specify the backup archive name format. To set it, add the following configuration to your `vars.yml` file (adapt to your needs):" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:86 -msgid "Configure retention policy (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:88 -msgid "It is also possible to configure a retention strategy. To configure it, add the following configuration to your `vars.yml` file (adapt to your needs):" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:98 -msgid "Edit the backup schedule (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:100 -msgid "By default the backup will run 4 a.m. every day based on the `backup_borg_schedule` variable. It is defined in the format of systemd timer calendar." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:102 -msgid "To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:108 -msgid "**Note**: the actual job may run with a delay. See `backup_borg_schedule_randomized_delay_sec` [here](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/f5d5b473d48c6504be10b3d946255ef5c186c2a6/defaults/main.yml#L50) for its default value." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:110 -msgid "Set include and/or exclude directories (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:112 -msgid "`backup_borg_location_source_directories` defines the list of directories to back up. It's set to `{{ matrix_base_data_path }}` by default, which is the base directory for every service's data, such as Synapse, Postgres and the bridges." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:114 -msgid "You might also want to exclude certain directories or file patterns from the backup using the `backup_borg_location_exclude_patterns` variable." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:116 -msgid "Extending the configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:118 -msgid "There are some additional things you may wish to configure about the component." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:120 -msgid "Take a look at:" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:122 -msgid "[backup_borg role](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg)'s [`defaults/main.yml`](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/main/defaults/main.yml) for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `backup_borg_configuration_extension_yaml` variable" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:124 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:126 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:133 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:135 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:137 -msgid "Manually start a backup" -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:139 -msgid "Sometimes it can be helpful to run the backup as you'd like, avoiding to wait until 4 a.m., like when you test your configuration." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:141 -msgid "If you want to run it immediately, log in to the server with SSH and run `systemctl start matrix-backup-borg`." -msgstr "" - -#: ../../../docs/configuring-playbook-backup-borg.md:143 -msgid "This will not return until the backup is done, so it can possibly take a long time. Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable." +msgid "📁 `roles/galaxy/backup_borg/docs/configuring-backup-borg.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-base-domain-serving.pot b/i18n/translation-templates/docs/configuring-playbook-base-domain-serving.pot index 8fa55d07a..6700fdd01 100644 --- a/i18n/translation-templates/docs/configuring-playbook-base-domain-serving.pot +++ b/i18n/translation-templates/docs/configuring-playbook-base-domain-serving.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,142 +16,142 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-base-domain-serving.md:1 +#: ../../../docs/configuring-playbook-base-domain-serving.md:8 msgid "Serving the base domain (optional)" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:3 +#: ../../../docs/configuring-playbook-base-domain-serving.md:10 msgid "By default, this playbook sets up services on your Matrix server (`matrix.example.com`), but has it configured so that it presents itself as the base domain (`example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:5 +#: ../../../docs/configuring-playbook-base-domain-serving.md:12 msgid "As we discuss in [Server Delegation](howto-server-delegation.md), server delegation / redirection can be configured in either of these ways:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:7 +#: ../../../docs/configuring-playbook-base-domain-serving.md:14 msgid "Setting up a `/.well-known/matrix/server` file on the base domain (`example.com`)" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:8 +#: ../../../docs/configuring-playbook-base-domain-serving.md:15 msgid "Setting up a `_matrix._tcp` DNS SRV record" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:10 +#: ../../../docs/configuring-playbook-base-domain-serving.md:17 msgid "For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:12 +#: ../../../docs/configuring-playbook-base-domain-serving.md:19 msgid "However, those who don't have a separate server to dedicate to the base domain have trouble arranging this." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:14 +#: ../../../docs/configuring-playbook-base-domain-serving.md:21 msgid "Usually, there are 2 options:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:16 +#: ../../../docs/configuring-playbook-base-domain-serving.md:23 msgid "either get a separate server for the base domain, just for serving the files necessary for [Server Delegation via a well-known file](howto-server-delegation.md#server-delegation-via-a-well-known-file)" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:18 +#: ../../../docs/configuring-playbook-base-domain-serving.md:25 msgid "or, arrange for the Matrix server to serve the base domain. This either involves you [using your own webserver](configuring-playbook-own-webserver.md) or making the integrated webserver serve the base domain for you." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:20 +#: ../../../docs/configuring-playbook-base-domain-serving.md:27 msgid "This documentation page tells you how to do the latter. With some easy changes, we make it possible to serve the base domain from the Matrix server via the integrated webserver." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:22 +#: ../../../docs/configuring-playbook-base-domain-serving.md:29 msgid "Just [**adjust your DNS records**](configuring-dns.md), so that your base domain is pointed to the Matrix server's IP address (using a DNS `A` record) **and then add the following configuration** to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:28 +#: ../../../docs/configuring-playbook-base-domain-serving.md:35 msgid "Doing this, the playbook will:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:30 +#: ../../../docs/configuring-playbook-base-domain-serving.md:37 msgid "obtain an SSL certificate for the base domain, just like it does for all other domains (see [how we handle SSL certificates](configuring-playbook-ssl-certificates.md))" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:32 +#: ../../../docs/configuring-playbook-base-domain-serving.md:39 msgid "serve the `/.well-known/matrix/*` files which are necessary for [Federation Server Discovery](configuring-well-known.md#federation-server-discovery) (also see [Server Delegation](howto-server-delegation.md)) and [Client-Server discovery](configuring-well-known.md#client-server-discovery)" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:34 +#: ../../../docs/configuring-playbook-base-domain-serving.md:41 msgid "serve a simple homepage at `https://example.com` with content `Hello from example.com` (configurable via the `matrix_static_files_file_index_html_template` variable). You can also [serve a more complicated static website](#serving-a-static-website-at-the-base-domain)." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:36 +#: ../../../docs/configuring-playbook-base-domain-serving.md:43 msgid "Serving a static website at the base domain" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:38 +#: ../../../docs/configuring-playbook-base-domain-serving.md:45 msgid "By default, when \"serving the base domain\" is enabled, the playbook hosts a simple `index.html` webpage at `/matrix/static-files/public/index.html`. The content of this page is taken from the `matrix_static_files_file_index_html_template` variable." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:40 +#: ../../../docs/configuring-playbook-base-domain-serving.md:47 msgid "If you'd like to host your own static website (more than a single `index.html` page) at the base domain, you can disable the creation of this default `index.html` page like this:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:54 +#: ../../../docs/configuring-playbook-base-domain-serving.md:61 msgid "With this configuration, Ansible will no longer mess around with the `/matrix/static-files/public/index.html` file." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:56 +#: ../../../docs/configuring-playbook-base-domain-serving.md:63 msgid "You are then free to upload any static website files to `/matrix/static-files/public` and they will get served at the base domain. You can do so manually or by using the [ansible-role-aux](https://github.com/mother-of-all-self-hosting/ansible-role-aux) Ansible role, which is part of this playbook already." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:58 +#: ../../../docs/configuring-playbook-base-domain-serving.md:65 msgid "Serving a more complicated website at the base domain" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:60 +#: ../../../docs/configuring-playbook-base-domain-serving.md:67 msgid "If you'd like to serve an even more complicated (dynamic) website from the Matrix server, relying on the playbook to serve the base domain is not the best choice." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:62 +#: ../../../docs/configuring-playbook-base-domain-serving.md:69 msgid "You have 2 options." msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:64 +#: ../../../docs/configuring-playbook-base-domain-serving.md:71 msgid "**One way is to host your base domain elsewhere**. This involves:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:65 +#: ../../../docs/configuring-playbook-base-domain-serving.md:72 msgid "you stopping to serve it from the Matrix server: remove `matrix_static_files_container_labels_base_domain_enabled` from your configuration" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:66 +#: ../../../docs/configuring-playbook-base-domain-serving.md:73 msgid "[configuring Matrix Delegation via well-known](./configuring-well-known.md)" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:68 +#: ../../../docs/configuring-playbook-base-domain-serving.md:75 msgid "**Another way is to serve the base domain from another (your own) container on the Matrix server**. This involves:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:69 +#: ../../../docs/configuring-playbook-base-domain-serving.md:76 msgid "telling the playbook to only serve `example.com/.well-known/matrix` files by adjusting your `vars.yml` configuration like this:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:70 +#: ../../../docs/configuring-playbook-base-domain-serving.md:77 msgid "keep `matrix_static_files_container_labels_base_domain_enabled: true`" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:71 +#: ../../../docs/configuring-playbook-base-domain-serving.md:78 msgid "add an extra: `matrix_static_files_container_labels_base_domain_traefik_path_prefix: /.well-known/matrix`" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:72 +#: ../../../docs/configuring-playbook-base-domain-serving.md:79 msgid "building and running a new container on the Matrix server:" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:73 +#: ../../../docs/configuring-playbook-base-domain-serving.md:80 msgid "it should be connected to the `traefik` network, so that Traefik can reverse-proxy to it" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:74 +#: ../../../docs/configuring-playbook-base-domain-serving.md:81 msgid "it should have appropriate [container labels](https://docs.docker.com/config/labels-custom-metadata/), which instruct Traefik to reverse-proxy to it" msgstr "" -#: ../../../docs/configuring-playbook-base-domain-serving.md:76 +#: ../../../docs/configuring-playbook-base-domain-serving.md:83 msgid "How you'll be managing building and running this container is up-to-you. You may use of the primitives from [ansible-role-aux](https://github.com/mother-of-all-self-hosting/ansible-role-aux) Ansible role to organize it yourself, or you can set it up in another way." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot b/i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot index f6b6bb6a5..1a765faed 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,429 +16,433 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-baibot.md:1 +#: ../../../docs/configuring-playbook-bot-baibot.md:8 msgid "Setting up baibot (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:8 +#: ../../../docs/configuring-playbook-bot-baibot.md:15 msgid "🤖 [baibot](https://github.com/etkecc/baibot) (pronounced bye-bot) is a [Matrix](https://matrix.org/) bot developed by [etke.cc](https://etke.cc/) that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you. 🤖" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:10 +#: ../../../docs/configuring-playbook-bot-baibot.md:17 msgid "It supports [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, as many well as other [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:12 +#: ../../../docs/configuring-playbook-bot-baibot.md:19 msgid "It's designed as a more private and [✨ featureful](https://github.com/etkecc/baibot/?tab=readme-ov-file#-features) alternative to [matrix-chatgpt-bot](./configuring-playbook-bot-chatgpt.md). See the [baibot](https://github.com/etkecc/baibot) project and its documentation for more information." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:14 +#: ../../../docs/configuring-playbook-bot-baibot.md:21 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:16 +#: ../../../docs/configuring-playbook-bot-baibot.md:23 msgid "API access to one or more LLM [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:18 +#: ../../../docs/configuring-playbook-bot-baibot.md:25 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:20 +#: ../../../docs/configuring-playbook-bot-baibot.md:27 msgid "There are **a lot of configuration options** (some required, some possibly required, some optional), so they're **split into multiple sections below**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:23 +#: ../../../docs/configuring-playbook-bot-baibot.md:30 msgid "[Base configuration](#base-configuration)" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:24 +#: ../../../docs/configuring-playbook-bot-baibot.md:31 msgid "[👮‍♂️ Administrator configuration](#️-administrator-configuration)" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:25 +#: ../../../docs/configuring-playbook-bot-baibot.md:32 msgid "[👥 Initial users configuration](#-initial-users-configuration)" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:26 +#: ../../../docs/configuring-playbook-bot-baibot.md:33 msgid "[🤖 Configuring agents via Ansible](#-configuring-agents-via-ansible)" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:27 +#: ../../../docs/configuring-playbook-bot-baibot.md:34 msgid "[🤝 Configuring initial default handlers](#-configuring-initial-default-handlers)" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:29 +#: ../../../docs/configuring-playbook-bot-baibot.md:36 msgid "Depending on your current `vars.yml` file and desired configuration, **you may require more than just the [base configuration](#base-configuration)**." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:31 +#: ../../../docs/configuring-playbook-bot-baibot.md:38 msgid "Base configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:33 +#: ../../../docs/configuring-playbook-bot-baibot.md:40 msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:71 +#: ../../../docs/configuring-playbook-bot-baibot.md:78 msgid "As mentioned above, **this may not be enough**. Continue with the configuration sections below." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:73 +#: ../../../docs/configuring-playbook-bot-baibot.md:80 msgid "👮‍♂️ Administrator configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:75 -#: ../../../docs/configuring-playbook-bot-baibot.md:99 +#: ../../../docs/configuring-playbook-bot-baibot.md:82 +#: ../../../docs/configuring-playbook-bot-baibot.md:106 msgid "This is an addition to the [base configuration](#base-configuration)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:77 +#: ../../../docs/configuring-playbook-bot-baibot.md:84 msgid "To specify who is considered a bot [👮‍♂️ Administrator](https://github.com/etkecc/baibot/blob/main/docs/access.md#administrators), you either need to specify `matrix_bot_baibot_config_access_admin_patterns` or `matrix_admin`. The latter is a single variable which affects all bridges and bots." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:79 +#: ../../../docs/configuring-playbook-bot-baibot.md:86 msgid "If `matrix_admin` is already configured in your `vars.yml` configuration, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:81 -#: ../../../docs/configuring-playbook-bot-baibot.md:110 +#: ../../../docs/configuring-playbook-bot-baibot.md:88 +#: ../../../docs/configuring-playbook-bot-baibot.md:117 msgid "**If necessary**, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:95 +#: ../../../docs/configuring-playbook-bot-baibot.md:102 msgid "👥 Initial users configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:97 +#: ../../../docs/configuring-playbook-bot-baibot.md:104 msgid "By default, **all users on your homeserver are considered allowed users**. If that's OK, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:101 +#: ../../../docs/configuring-playbook-bot-baibot.md:108 msgid "To specify who is considered a bot [👥 User](https://github.com/etkecc/baibot/blob/main/docs/access.md#user), you may:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:103 +#: ../../../docs/configuring-playbook-bot-baibot.md:110 msgid "define an **initial** value for `matrix_bot_baibot_config_initial_global_config_user_patterns` Ansible variable, as shown below" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:104 +#: ../../../docs/configuring-playbook-bot-baibot.md:111 msgid "configure the list at runtime via the bot's `!bai access set-users SPACE_SEPARATED_PATTERNS` command" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:106 +#: ../../../docs/configuring-playbook-bot-baibot.md:113 msgid "Configuring `matrix_bot_baibot_config_initial_global_config_user_patterns` is optional, but it can be useful to pre-configure the bot with a list of users who should have access to the bot's features." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:108 +#: ../../../docs/configuring-playbook-bot-baibot.md:115 msgid "**Note**: Once initially configured, the allowed users list **cannot be managed via Ansible anymore**. It can only be managed subsequently via bot commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:122 +#: ../../../docs/configuring-playbook-bot-baibot.md:129 msgid "🤖 Configuring agents via Ansible" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:124 +#: ../../../docs/configuring-playbook-bot-baibot.md:131 msgid "You are **not required** to define agents [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration) via Ansible. **To get started quickly**, you can **skip this section and define agents at runtime via chat commands** (following the bot's guidance)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:126 +#: ../../../docs/configuring-playbook-bot-baibot.md:133 msgid "Privileged users (like the [👮‍♂️ Administrator](#️-administrator-configuration), but potentially others too — see the upstream [🔒 access](https://github.com/etkecc/baibot/blob/main/docs/access.md) documentation) can **define agents dynamically at any time** via chat commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:128 +#: ../../../docs/configuring-playbook-bot-baibot.md:135 msgid "The Ansible role includes preset variables for easily enabling some [🤖 agents](https://github.com/etkecc/baibot/blob/main/docs/agents.md) on various [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md) (e.g. OpenAI, etc)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:130 +#: ../../../docs/configuring-playbook-bot-baibot.md:137 msgid "Besides the presets, the Ansible role also includes support for configuring additional statically-defined agents via the `matrix_bot_baibot_config_agents_static_definitions_custom` Ansible variable." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:132 +#: ../../../docs/configuring-playbook-bot-baibot.md:139 msgid "Agents defined statically and those created dynamically (via chat) are named differently, so **conflict cannot arise**." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:134 +#: ../../../docs/configuring-playbook-bot-baibot.md:141 msgid "Depending on your propensity for [GitOps](https://en.wikipedia.org/wiki/DevOps#GitOps), you may prefer to define agents statically via Ansible, or you may wish to do it dynamically via chat." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:136 +#: ../../../docs/configuring-playbook-bot-baibot.md:143 msgid "Before proceeding, we recommend reading the upstream documentation on [How to choose a provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#how-to-choose-a-provider). In short, it's probably best to go with [OpenAI](#openai)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:138 +#: ../../../docs/configuring-playbook-bot-baibot.md:145 msgid "Anthropic" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:140 +#: ../../../docs/configuring-playbook-bot-baibot.md:147 msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Anthropic provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#anthropic) with the help of the playbook's preset variables." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:142 -#: ../../../docs/configuring-playbook-bot-baibot.md:166 -#: ../../../docs/configuring-playbook-bot-baibot.md:197 -#: ../../../docs/configuring-playbook-bot-baibot.md:225 +#: ../../../docs/configuring-playbook-bot-baibot.md:149 +#: ../../../docs/configuring-playbook-bot-baibot.md:173 +#: ../../../docs/configuring-playbook-bot-baibot.md:204 +#: ../../../docs/configuring-playbook-bot-baibot.md:232 msgid "Here's an example **addition** to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:158 -#: ../../../docs/configuring-playbook-bot-baibot.md:189 -#: ../../../docs/configuring-playbook-bot-baibot.md:215 -#: ../../../docs/configuring-playbook-bot-baibot.md:243 +#: ../../../docs/configuring-playbook-bot-baibot.md:165 +#: ../../../docs/configuring-playbook-bot-baibot.md:196 +#: ../../../docs/configuring-playbook-bot-baibot.md:222 +#: ../../../docs/configuring-playbook-bot-baibot.md:250 msgid "If you'd like to use more than one model, take a look at the [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset) section below." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:160 -#: ../../../docs/configuring-playbook-bot-baibot.md:191 -#: ../../../docs/configuring-playbook-bot-baibot.md:217 -#: ../../../docs/configuring-playbook-bot-baibot.md:245 +#: ../../../docs/configuring-playbook-bot-baibot.md:167 +#: ../../../docs/configuring-playbook-bot-baibot.md:198 +#: ../../../docs/configuring-playbook-bot-baibot.md:224 +#: ../../../docs/configuring-playbook-bot-baibot.md:252 msgid "💡 You may also wish to use this new agent for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:162 +#: ../../../docs/configuring-playbook-bot-baibot.md:169 msgid "Groq" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:164 +#: ../../../docs/configuring-playbook-bot-baibot.md:171 msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Groq provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#groq) with the help of the playbook's preset variables." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:187 +#: ../../../docs/configuring-playbook-bot-baibot.md:194 msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/groq`." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:193 +#: ../../../docs/configuring-playbook-bot-baibot.md:200 msgid "Mistral" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:195 +#: ../../../docs/configuring-playbook-bot-baibot.md:202 msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [🇫🇷 Mistral provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#mistral) with the help of the playbook's preset variables." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:213 +#: ../../../docs/configuring-playbook-bot-baibot.md:220 msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/mistral`." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:219 +#: ../../../docs/configuring-playbook-bot-baibot.md:226 msgid "OpenAI" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:221 +#: ../../../docs/configuring-playbook-bot-baibot.md:228 msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [OpenAI provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openai) with the help of the playbook's preset variables." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:223 +#: ../../../docs/configuring-playbook-bot-baibot.md:230 msgid "The OpenAI provider is **only meant to be used with OpenAI's official API** and compatibility with other services (which do not fully adhere to the OpenAI API spec completely) is limited. **If you're targeting an OpenAI-compatible service**, use the [OpenAI Compatible](#openai-compatible) provider instead." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:241 +#: ../../../docs/configuring-playbook-bot-baibot.md:248 msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/openai`." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:247 +#: ../../../docs/configuring-playbook-bot-baibot.md:254 msgid "OpenAI Compatible" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:249 +#: ../../../docs/configuring-playbook-bot-baibot.md:256 msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [OpenAI Compatible provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openai-compatible) with the help of the playbook's preset variables." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:251 +#: ../../../docs/configuring-playbook-bot-baibot.md:258 msgid "This provider allows you to use OpenAI-compatible API services like [OpenRouter](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openrouter), [Together AI](https://github.com/etkecc/baibot/blob/main/docs/providers.md#together-ai), etc." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:253 +#: ../../../docs/configuring-playbook-bot-baibot.md:260 msgid "Some of these popular services already have **shortcut** providers (see [supported providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md#supported-providers) leading to this one behind the scenes — this make it easier to get started." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:255 +#: ../../../docs/configuring-playbook-bot-baibot.md:262 msgid "As of this moment, the playbook does not include presets for any of these services, so you'll need to [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:257 +#: ../../../docs/configuring-playbook-bot-baibot.md:264 msgid "Configuring additional agents (without a preset)" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:259 +#: ../../../docs/configuring-playbook-bot-baibot.md:266 msgid "The Ansible role may be lacking preset variables for some [☁️ provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md), or you may wish to statically-define an agent on the same provider twice (or more) with different configuration." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:261 +#: ../../../docs/configuring-playbook-bot-baibot.md:268 msgid "It's possible to inject your own agent configuration using the `matrix_bot_baibot_config_agents_static_definitions_custom` Ansible variable." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:263 +#: ../../../docs/configuring-playbook-bot-baibot.md:270 msgid "You can also define providers at runtime, by chatting with the bot, so using Ansible is not a requirement." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:265 +#: ../../../docs/configuring-playbook-bot-baibot.md:272 msgid "Below is an an **example** demonstrating **statically-defining agents via Ansible without using presets**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:304 +#: ../../../docs/configuring-playbook-bot-baibot.md:311 msgid "Because these are [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agents, they will be given a `static/` ID prefix and will be named `static/my-openai-gpt-3.5-turbo-agent` and `static/my-ollama-agent`, respectively." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:306 +#: ../../../docs/configuring-playbook-bot-baibot.md:313 msgid "💡 To figure out what to put in the `config` section, refer to the [☁️ provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md) page, which contains **sample configuration YAML for each provider**." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:308 +#: ../../../docs/configuring-playbook-bot-baibot.md:315 msgid "As with any [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md), defining them means they exist. To actually make use of them, they need to be configured as handlers globally or in a specific room — see [Mixing & matching models](https://github.com/etkecc/baibot/blob/main/docs/features.md#mixing--matching-models)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:310 +#: ../../../docs/configuring-playbook-bot-baibot.md:317 msgid "💡 You may also wish to use these new agents for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:312 +#: ../../../docs/configuring-playbook-bot-baibot.md:319 msgid "🤝 Configuring initial default handlers" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:314 +#: ../../../docs/configuring-playbook-bot-baibot.md:321 msgid "This section is only useful if you're [🤖 Configuring agents via Ansible](#-configuring-agents-via-ansible), as it lets you put these agents to use as soon as the bot starts (by adjusting the bot's **initial global configuration**)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:316 +#: ../../../docs/configuring-playbook-bot-baibot.md:323 msgid "If you're not configuring agents via Ansible, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:318 +#: ../../../docs/configuring-playbook-bot-baibot.md:325 msgid "This section is only useful the first time around. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:320 +#: ../../../docs/configuring-playbook-bot-baibot.md:327 msgid "baibot supports [various purposes](https://github.com/etkecc/baibot/blob/main/docs/features.md):" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:322 +#: ../../../docs/configuring-playbook-bot-baibot.md:329 msgid "[💬 text-generation](https://github.com/etkecc/baibot/blob/main/docs/features.md#-text-generation): communicating with you via text" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:324 +#: ../../../docs/configuring-playbook-bot-baibot.md:331 msgid "[🦻 speech-to-text](https://github.com/etkecc/baibot/blob/main/docs/features.md#-speech-to-text): turning your voice messages into text" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:326 +#: ../../../docs/configuring-playbook-bot-baibot.md:333 msgid "[🗣️ text-to-speech](https://github.com/etkecc/baibot/blob/main/docs/features.md#-text-to-speech): turning bot or users text messages into voice messages" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:328 +#: ../../../docs/configuring-playbook-bot-baibot.md:335 msgid "[🖌️ image-generation](https://github.com/etkecc/baibot/blob/main/docs/features.md#-image-generation): generating images based on instructions" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:330 +#: ../../../docs/configuring-playbook-bot-baibot.md:337 msgid "❓ catch-all: special purposes, indicating use as a fallback (when no specific handler is configured)" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:332 +#: ../../../docs/configuring-playbook-bot-baibot.md:339 msgid "[Mixing & matching models](https://github.com/etkecc/baibot/blob/main/docs/features.md#mixing--matching-models) is made possible by the bot's ability to have different [🤝 handlers](https://github.com/etkecc/baibot/blob/main/docs/configuration/handlers.md) configured for different purposes." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:334 +#: ../../../docs/configuring-playbook-bot-baibot.md:341 msgid "This configuration can be done as a global fallback, or per-room. Both of these [🛠️ configurations](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md) are managed at runtime (viat chat), but **the global configuration can have some initial defaults configured via Ansible**." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:336 +#: ../../../docs/configuring-playbook-bot-baibot.md:343 msgid "You can configure the **initial values** for these via Ansible, via the `matrix_bot_baibot_config_initial_global_config_handler_*` variables." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:338 +#: ../../../docs/configuring-playbook-bot-baibot.md:345 msgid "Example **additional** `vars.yml` configuration:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:355 +#: ../../../docs/configuring-playbook-bot-baibot.md:362 msgid "**Note**: these are initial defaults for the bot's global configuration. As such, changing any of these values subsequently has no effect on the bot's behavior. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:357 +#: ../../../docs/configuring-playbook-bot-baibot.md:364 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:359 +#: ../../../docs/configuring-playbook-bot-baibot.md:366 msgid "There are some additional things you may wish to configure about the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:361 +#: ../../../docs/configuring-playbook-bot-baibot.md:368 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:363 +#: ../../../docs/configuring-playbook-bot-baibot.md:370 msgid "`roles/custom/matrix-bot-baibot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:364 +#: ../../../docs/configuring-playbook-bot-baibot.md:371 msgid "`roles/custom/matrix-bot-baibot/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_baibot_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:366 +#: ../../../docs/configuring-playbook-bot-baibot.md:373 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:368 +#: ../../../docs/configuring-playbook-bot-baibot.md:375 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:375 +#: ../../../docs/configuring-playbook-bot-baibot.md:382 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:377 +#: ../../../docs/configuring-playbook-bot-baibot.md:384 msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:379 +#: ../../../docs/configuring-playbook-bot-baibot.md:386 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:381 +#: ../../../docs/configuring-playbook-bot-baibot.md:388 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:383 +#: ../../../docs/configuring-playbook-bot-baibot.md:390 msgid "If you change the bot password (`matrix_bot_baibot_config_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_baibot_config_user_password` to let the bot know its new password." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:385 +#: ../../../docs/configuring-playbook-bot-baibot.md:392 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:387 +#: ../../../docs/configuring-playbook-bot-baibot.md:394 msgid "To use the bot, invite it to any existing Matrix room (`/invite @baibot:example.com` where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:389 +#: ../../../docs/configuring-playbook-bot-baibot.md:396 msgid "If you're an allowed bot [👥 user](https://github.com/etkecc/baibot/blob/main/docs/access.md#user) (see [👥 Initial users configuration](#-initial-users-configuration)), the bot will accept your invitation and join the room." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:391 +#: ../../../docs/configuring-playbook-bot-baibot.md:398 msgid "After joining, the bot will introduce itself and show information about the [✨ features](https://github.com/etkecc/baibot/blob/main/docs/features.md) that are enabled for it." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:393 +#: ../../../docs/configuring-playbook-bot-baibot.md:400 msgid "If you've [🤖 configured one or more agents via Ansible](#-configuring-agents-via-ansible) and have [🤝 configured initial default handlers](#configuring-initial-default-handlers), the bot will immediately be able to make use of these agents for this new room. Otherwise, you will need to configure agents and/or handlers via chat commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:395 +#: ../../../docs/configuring-playbook-bot-baibot.md:402 msgid "Send `!bai help` to the bot in the room to see the available commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:397 +#: ../../../docs/configuring-playbook-bot-baibot.md:404 msgid "You can also refer to the upstream [baibot](https://github.com/etkecc/baibot) project's documentation." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:399 +#: ../../../docs/configuring-playbook-bot-baibot.md:406 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:401 -msgid "As with all other services, you can find service logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by running something like `journalctl -fu matrix-bot-baibot`" +#: ../../../docs/configuring-playbook-bot-baibot.md:408 +msgid "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-baibot`." msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:403 -msgid "The default logging level for this service is `info`, but you can increase it to `debug` (or even `trace`) with the following additional configuration:" +#: ../../../docs/configuring-playbook-bot-baibot.md:410 +msgid "Increase logging verbosity" msgstr "" -#: ../../../docs/configuring-playbook-bot-baibot.md:417 +#: ../../../docs/configuring-playbook-bot-baibot.md:412 +msgid "The default logging level for this service is `info`. If you want to increase the verbosity to `debug` (or even `trace`), add the following configuration to your `vars.yml` file and re-run the playbook:" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-baibot.md:426 msgid "**Alternatively**, you can use a single variable to set the logging level for all of the above (bot + all libraries):" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot b/i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot index f2330ca77..62418f3c7 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,154 +16,154 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-buscarron.md:1 +#: ../../../docs/configuring-playbook-bot-buscarron.md:9 msgid "Setting up Buscarron (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:3 +#: ../../../docs/configuring-playbook-bot-buscarron.md:11 msgid "The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:5 +#: ../../../docs/configuring-playbook-bot-buscarron.md:13 msgid "Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:7 +#: ../../../docs/configuring-playbook-bot-buscarron.md:15 msgid "See the project's [documentation](https://github.com/etkecc/buscarron/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:9 +#: ../../../docs/configuring-playbook-bot-buscarron.md:17 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:11 +#: ../../../docs/configuring-playbook-bot-buscarron.md:19 msgid "By default, this playbook installs Buscarron on the `buscarron.` subdomain (`buscarron.example.com`) and requires you to create a CNAME record for `buscarron`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:13 +#: ../../../docs/configuring-playbook-bot-buscarron.md:21 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:15 +#: ../../../docs/configuring-playbook-bot-buscarron.md:23 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:17 +#: ../../../docs/configuring-playbook-bot-buscarron.md:25 msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:40 +#: ../../../docs/configuring-playbook-bot-buscarron.md:48 msgid "Adjusting the Buscarron URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:42 +#: ../../../docs/configuring-playbook-bot-buscarron.md:50 msgid "By tweaking the `matrix_bot_buscarron_hostname` and `matrix_bot_buscarron_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:44 +#: ../../../docs/configuring-playbook-bot-buscarron.md:52 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:55 +#: ../../../docs/configuring-playbook-bot-buscarron.md:63 msgid "After changing the domain, **you may need to adjust your DNS** records to point the Buscarron domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:57 +#: ../../../docs/configuring-playbook-bot-buscarron.md:65 msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:59 +#: ../../../docs/configuring-playbook-bot-buscarron.md:67 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:61 +#: ../../../docs/configuring-playbook-bot-buscarron.md:69 msgid "There are some additional things you may wish to configure about the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:63 +#: ../../../docs/configuring-playbook-bot-buscarron.md:71 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:65 +#: ../../../docs/configuring-playbook-bot-buscarron.md:73 msgid "`roles/custom/matrix-bot-buscarron/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:67 +#: ../../../docs/configuring-playbook-bot-buscarron.md:75 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:69 +#: ../../../docs/configuring-playbook-bot-buscarron.md:77 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:76 +#: ../../../docs/configuring-playbook-bot-buscarron.md:84 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:78 +#: ../../../docs/configuring-playbook-bot-buscarron.md:86 msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:80 +#: ../../../docs/configuring-playbook-bot-buscarron.md:88 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:82 +#: ../../../docs/configuring-playbook-bot-buscarron.md:90 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:84 +#: ../../../docs/configuring-playbook-bot-buscarron.md:92 msgid "If you change the bot password (`matrix_bot_buscarron_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_buscarron_password` to let the bot know its new password." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:86 +#: ../../../docs/configuring-playbook-bot-buscarron.md:94 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:88 +#: ../../../docs/configuring-playbook-bot-buscarron.md:96 msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:90 +#: ../../../docs/configuring-playbook-bot-buscarron.md:98 msgid "After the bot joins the room, anyone can call the web form via HTTP POST method." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:92 +#: ../../../docs/configuring-playbook-bot-buscarron.md:100 msgid "Here is an example for the `contact` form:" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:100 +#: ../../../docs/configuring-playbook-bot-buscarron.md:108 msgid "**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:102 +#: ../../../docs/configuring-playbook-bot-buscarron.md:110 msgid "you hit the homepage (HTTP `GET` request to `/`)" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:103 +#: ../../../docs/configuring-playbook-bot-buscarron.md:111 msgid "you submit a form to the wrong URL (`POST` request to `/non-existing-form`)" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:104 +#: ../../../docs/configuring-playbook-bot-buscarron.md:112 msgid "`hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:106 +#: ../../../docs/configuring-playbook-bot-buscarron.md:114 msgid "If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:108 +#: ../../../docs/configuring-playbook-bot-buscarron.md:116 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:110 +#: ../../../docs/configuring-playbook-bot-buscarron.md:118 msgid "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-buscarron`." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:112 +#: ../../../docs/configuring-playbook-bot-buscarron.md:120 msgid "Increase logging verbosity" msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:114 +#: ../../../docs/configuring-playbook-bot-buscarron.md:122 msgid "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:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot b/i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot index 19354a2fa..07b66f52d 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,110 +16,134 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:1 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:9 msgid "Setting up matrix-bot-chatgpt (optional, unmaintained)" msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:3 -msgid "**Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](https://github.com/etkecc/baibot), which can be installed using [this playbook](configuring-playbook-bot-baibot.md). Consider using that bot instead of this one." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-chatgpt.md:5 -msgid "The playbook can install and configure [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-chatgpt.md:7 -msgid "Talk to [ChatGPT](https://openai.com/blog/chatgpt/) via your favourite Matrix client!" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-chatgpt.md:9 -msgid "Prerequisites" -msgstr "" - #: ../../../docs/configuring-playbook-bot-chatgpt.md:11 -msgid "Obtain an OpenAI API key" +msgid "**Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](https://github.com/etkecc/baibot), which can be [installed using this playbook](configuring-playbook-bot-baibot.md). Consider using that bot instead of this one." msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:13 -msgid "To use the bot, you'd need to obtain an API key from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys)." +msgid "The playbook can install and configure [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) for you." msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:15 -msgid "Register the bot account" +msgid "Talk to [ChatGPT](https://openai.com/blog/chatgpt/) via your favourite Matrix client!" msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:17 -msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot." +msgid "See the project's [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:19 -msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`." +msgid "Prerequisites" msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:21 -msgid "You can use the playbook to [register a new user](registering-users.md):" +msgid "Obtain an OpenAI API key" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:23 +msgid "To use the bot, you'd need to obtain an API key from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:25 +msgid "Register the bot account" msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:27 -msgid "Obtain an access token and create encryption keys" +msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot." msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:29 -msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." +msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`." msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:31 +msgid "You can use the playbook to [register a new user](registering-users.md):" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:37 +msgid "Obtain an access token and create encryption keys" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:39 +msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:41 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:34 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:44 msgid "To make sure the bot can read encrypted messages, it will need an encryption key, just like any other new user. While obtaining the access token, follow the prompts to setup a backup key. More information can be found in the [Element documentation](https://element.io/help#encryption6)." msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:36 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:46 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:38 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:48 msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `API_KEY_HERE` with the API key retrieved [here](#obtain-an-openai-api-key) and `ACCESS_TOKEN_HERE` with the access token created [here](#obtain-an-access-token-and-create-encryption-keys), respectively." msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:55 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:65 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:67 +msgid "There are some additional things you may wish to configure about the bot." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:69 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:71 +msgid "`roles/custom/matrix-bot-chatgpt/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:73 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:57 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:75 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:64 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:82 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:66 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:84 msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:68 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:86 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:70 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:88 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:72 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:90 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:74 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:92 msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.chatgpt:example.com` where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:76 +#: ../../../docs/configuring-playbook-bot-chatgpt.md:94 msgid "After the bot joins the room, you can send a message to it. When you do so, use the prefix if you configured it or mention the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-chatgpt.md:78 -msgid "You can also refer to the upstream [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot)." +#: ../../../docs/configuring-playbook-bot-chatgpt.md:96 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:98 +msgid "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-chatgpt`." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-draupnir.pot b/i18n/translation-templates/docs/configuring-playbook-bot-draupnir.pot index 1ebffdc1f..02149ef4b 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-draupnir.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-draupnir.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,390 +16,419 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-draupnir.md:1 +#: ../../../docs/configuring-playbook-bot-draupnir.md:10 msgid "Setting up Draupnir (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:3 +#: ../../../docs/configuring-playbook-bot-draupnir.md:12 msgid "The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation bot for you." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:5 +#: ../../../docs/configuring-playbook-bot-draupnir.md:14 msgid "See the project's [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:7 +#: ../../../docs/configuring-playbook-bot-draupnir.md:16 msgid "This documentation page is about installing Draupnir in bot mode. As an alternative, you can run a multi-instance Draupnir deployment by installing [Draupnir in appservice mode](./configuring-playbook-appservice-draupnir-for-all.md) (called Draupnir-for-all) instead." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:9 +#: ../../../docs/configuring-playbook-bot-draupnir.md:18 msgid "If your migrating from [Mjolnir](configuring-playbook-bot-mjolnir.md), skip to [this section](#migrating-from-mjolnir-only-required-if-migrating)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:11 +#: ../../../docs/configuring-playbook-bot-draupnir.md:20 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:13 +#: ../../../docs/configuring-playbook-bot-draupnir.md:22 msgid "Create a management room" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:15 +#: ../../../docs/configuring-playbook-bot-draupnir.md:24 msgid "Using your own account, create a new invite only room that you will use to manage the bot. This is the room where you will see the status of the bot and where you will send commands to the bot, such as the command to ban a user from another room." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:17 +#: ../../../docs/configuring-playbook-bot-draupnir.md:26 msgid "[!WARNING] Anyone in this room can control the bot so it is important that you only invite trusted users to this room." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:20 +#: ../../../docs/configuring-playbook-bot-draupnir.md:29 msgid "It is possible to make the management room encrypted (E2EE). If doing so, then you need to enable the native E2EE support (see [below](#native-e2ee-support))." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:22 +#: ../../../docs/configuring-playbook-bot-draupnir.md:31 msgid "Once you have created the room you need to copy the room ID so you can specify it on your `inventory/host_vars/matrix.example.com/vars.yml` file. In Element Web you can check the ID by going to the room's settings and clicking \"Advanced\". The room ID will look something like `!qporfwt:example.com`." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:24 +#: ../../../docs/configuring-playbook-bot-draupnir.md:33 msgid "End-to-End Encryption support" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:26 +#: ../../../docs/configuring-playbook-bot-draupnir.md:35 msgid "Decide whether you want to support having an encrypted management room or not. Draupnir can still protect encrypted rooms without encryption support enabled." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:28 +#: ../../../docs/configuring-playbook-bot-draupnir.md:37 msgid "Refer to Draupnir's [documentation](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#protecting-encrypted-rooms) for more details about why you might want to care about encryption support for protected rooms." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:30 +#: ../../../docs/configuring-playbook-bot-draupnir.md:39 msgid "Disable Pantalaimon for Draupnir (since v2.0.0; optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:32 +#: ../../../docs/configuring-playbook-bot-draupnir.md:41 msgid "It is known that running Draupnir along with Pantalaimon breaks all workflows that involve answering prompts with reactions." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:34 +#: ../../../docs/configuring-playbook-bot-draupnir.md:43 msgid "If you are updating Draupnir from v1.x.x and have enabled Pantalaimon for it, you can disable Pantalaimon in favor of the native E2EE support. To disable Pantalaimon, remove the configuration `matrix_bot_draupnir_pantalaimon_use: true` from your `vars.yml` file." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:36 +#: ../../../docs/configuring-playbook-bot-draupnir.md:45 msgid "**Note**: because the management room is still encrypted, disabling it without enabling the native E2EE support will break the management room." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:38 +#: ../../../docs/configuring-playbook-bot-draupnir.md:47 msgid "Native E2EE support" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:40 +#: ../../../docs/configuring-playbook-bot-draupnir.md:49 msgid "To enable the native E2EE support, you need to obtain an access token for Draupnir and set it on your `vars.yml` file." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:42 +#: ../../../docs/configuring-playbook-bot-draupnir.md:51 msgid "Note that native E2EE requires a clean access token that has not touched E2EE so curl is recommended as a method to obtain it. **The access token obtained via Element Web does not work with it**. Refer to the documentation on [how to obtain an access token via curl](obtaining-access-tokens.md#obtain-an-access-token-via-curl)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:44 +#: ../../../docs/configuring-playbook-bot-draupnir.md:53 msgid "To enable the native E2EE support, add the following configuration to your `vars.yml` file. Make sure to replace `CLEAN_ACCESS_TOKEN_HERE` with the access token you obtained just now." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:55 +#: ../../../docs/configuring-playbook-bot-draupnir.md:64 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:57 +#: ../../../docs/configuring-playbook-bot-draupnir.md:66 msgid "To enable the bot, add the following configuration to your `vars.yml` file. Make sure to replace `MANAGEMENT_ROOM_ID_HERE` with the one of the room which you have created earlier." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:76 +#: ../../../docs/configuring-playbook-bot-draupnir.md:85 msgid "Create and invite the bot to the management room" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:78 +#: ../../../docs/configuring-playbook-bot-draupnir.md:87 msgid "Before proceeding to the next step, run the playbook with the following command to create the bot user." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:84 +#: ../../../docs/configuring-playbook-bot-draupnir.md:93 msgid "**Note**: the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:86 +#: ../../../docs/configuring-playbook-bot-draupnir.md:95 msgid "Then, invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:88 +#: ../../../docs/configuring-playbook-bot-draupnir.md:97 msgid "Make sure the account is free from rate limiting (optional, recommended)" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:90 +#: ../../../docs/configuring-playbook-bot-draupnir.md:99 msgid "If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a highly recommended step. If you do not configure it, Draupnir performance will be degraded.**" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:92 +#: ../../../docs/configuring-playbook-bot-draupnir.md:101 msgid "This can be done using Synapse's [Admin APIs](https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#override-ratelimiting-for-users). They can be accessed both externally and internally." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:94 +#: ../../../docs/configuring-playbook-bot-draupnir.md:103 msgid "**Note**: access to the APIs is restricted with a valid access token, so exposing them publicly should not be a real security concern. Still, doing so is not recommended for additional security. See [official Synapse reverse-proxying recommendations](https://element-hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-endpoints)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:96 +#: ../../../docs/configuring-playbook-bot-draupnir.md:105 msgid "The APIs can also be accessed via [Synapse Admin](https://github.com/etkecc/synapse-admin), a web UI tool you can use to administrate users, rooms, media, etc. on your Matrix server. The playbook can install and configure Synapse Admin for you. For details about it, see [this page](configuring-playbook-synapse-admin.md)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:98 +#: ../../../docs/configuring-playbook-bot-draupnir.md:107 msgid "Add the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:100 +#: ../../../docs/configuring-playbook-bot-draupnir.md:109 msgid "To expose the APIs publicly, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:106 +#: ../../../docs/configuring-playbook-bot-draupnir.md:115 msgid "Obtain an access token for admin account" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:108 +#: ../../../docs/configuring-playbook-bot-draupnir.md:117 msgid "Manual access to Synapse's Admin APIs requires an access token for a homeserver admin account. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:110 +#: ../../../docs/configuring-playbook-bot-draupnir.md:119 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:113 +#: ../../../docs/configuring-playbook-bot-draupnir.md:122 msgid "Run the `curl` command" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:115 +#: ../../../docs/configuring-playbook-bot-draupnir.md:124 msgid "To disable rate limiting, run the following command on systems that ship curl. Before running it, make sure to replace:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:117 +#: ../../../docs/configuring-playbook-bot-draupnir.md:126 msgid "`ADMIN_ACCESS_TOKEN_HERE` with the access token of the admin account" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:118 +#: ../../../docs/configuring-playbook-bot-draupnir.md:127 msgid "`example.com` with your base domain" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:119 +#: ../../../docs/configuring-playbook-bot-draupnir.md:128 msgid "`@bot.draupnir:example.com` with the MXID of your Draupnir bot user" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:125 +#: ../../../docs/configuring-playbook-bot-draupnir.md:134 +#: ../../../docs/configuring-playbook-bot-draupnir.md:207 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:126 +#: ../../../docs/configuring-playbook-bot-draupnir.md:135 msgid "This does not work on outdated Windows 10 as curl is not available there." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:127 +#: ../../../docs/configuring-playbook-bot-draupnir.md:136 msgid "Even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:129 +#: ../../../docs/configuring-playbook-bot-draupnir.md:138 msgid "Abuse Reports" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:131 +#: ../../../docs/configuring-playbook-bot-draupnir.md:140 msgid "Draupnir can receive reports in the management room." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:133 +#: ../../../docs/configuring-playbook-bot-draupnir.md:142 msgid "The bot can intercept the report API endpoint of the client-server API, which requires integration with the reverse proxy in front of the homeserver. If you are using Traefik, this playbook can set this up for you:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:145 +#: ../../../docs/configuring-playbook-bot-draupnir.md:148 +msgid "Enabling synapse-http-antispam support" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:150 +msgid "Certain protections in Draupnir require the [synapse-http-antispam](https://github.com/maunium/synapse-http-antispam) module and a Synapse homeserver plus homeserver admin status to function. This module can be enabled in the playbook via setting `matrix_bot_draupnir_config_web_synapseHTTPAntispam_enabled` to `true` and making sure that Draupnir admin API access is enabled." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:160 +msgid "These protections need to be manually activated and consulting the [enabling protections](#enabling-built-in-protections) guide can be helpful or consulting upstream documentation." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:168 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:147 +#: ../../../docs/configuring-playbook-bot-draupnir.md:170 msgid "There are some additional things you may wish to configure about the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:149 +#: ../../../docs/configuring-playbook-bot-draupnir.md:172 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:151 +#: ../../../docs/configuring-playbook-bot-draupnir.md:174 msgid "`roles/custom/matrix-bot-draupnir/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_draupnir_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:153 +#: ../../../docs/configuring-playbook-bot-draupnir.md:176 msgid "For example, to change Draupnir's `acceptInvitesFromSpace` option to `!qporfwt:example.com`, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:167 +#: ../../../docs/configuring-playbook-bot-draupnir.md:190 msgid "Migrating from Mjolnir (Only required if migrating)" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:169 +#: ../../../docs/configuring-playbook-bot-draupnir.md:192 msgid "Replace your `matrix_bot_mjolnir` config with `matrix_bot_draupnir` config. Also disable Mjolnir if you're doing migration." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:171 +#: ../../../docs/configuring-playbook-bot-draupnir.md:194 msgid "Note that Draupnir supports E2EE natively, so you can enable it instead of Pantalaimon. It is recommended to consult the instruction [here](#native-e2ee-support)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:173 +#: ../../../docs/configuring-playbook-bot-draupnir.md:196 msgid "That is all you need to do due to that Draupnir can complete migration on its own." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:175 +#: ../../../docs/configuring-playbook-bot-draupnir.md:198 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:177 +#: ../../../docs/configuring-playbook-bot-draupnir.md:200 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:184 +#: ../../../docs/configuring-playbook-bot-draupnir.md:209 +msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:211 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:186 +#: ../../../docs/configuring-playbook-bot-draupnir.md:213 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:188 +#: ../../../docs/configuring-playbook-bot-draupnir.md:215 +msgid "If you change the bot password (`matrix_bot_draupnir_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_draupnir_password` to let the bot know its new password." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:217 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:190 +#: ../../../docs/configuring-playbook-bot-draupnir.md:219 msgid "You can refer to the upstream [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) for additional ways to use and configure Draupnir and for a more detailed usage guide." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:192 +#: ../../../docs/configuring-playbook-bot-draupnir.md:221 msgid "Below is a **non-exhaustive quick-start guide** for the impatient." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:194 +#: ../../../docs/configuring-playbook-bot-draupnir.md:223 msgid "Making Draupnir join and protect a room" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:196 +#: ../../../docs/configuring-playbook-bot-draupnir.md:225 msgid "Draupnir can be told to self-join public rooms, but it's better to follow this flow which works well for all kinds of rooms:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:198 +#: ../../../docs/configuring-playbook-bot-draupnir.md:227 msgid "Invite the bot to the room manually ([inviting Draupnir to rooms](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#inviting-draupnir-to-rooms)). Before joining, the bot *may* ask for confirmation in the Management Room" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:200 +#: ../../../docs/configuring-playbook-bot-draupnir.md:229 msgid "[Give the bot permissions to do its job](#giving-draupnir-permissions-to-do-its-job)" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:202 +#: ../../../docs/configuring-playbook-bot-draupnir.md:231 msgid "Tell it to protect the room (using the [rooms command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#using-the-draupnir-rooms-command)) by sending the following command to the Management Room: `!draupnir rooms add !qporfwt:example.com`" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:204 +#: ../../../docs/configuring-playbook-bot-draupnir.md:233 msgid "To have Draupnir provide useful room protection, you need do to a bit more work (at least the first time around). You may wish to [Subscribe to a public policy list](#subscribing-to-a-public-policy-list), [Create your own own policy and rules](#creating-your-own-policy-lists-and-rules) and [Enabling built-in protections](#enabling-built-in-protections)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:206 +#: ../../../docs/configuring-playbook-bot-draupnir.md:235 msgid "Giving Draupnir permissions to do its job" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:208 +#: ../../../docs/configuring-playbook-bot-draupnir.md:237 msgid "For Draupnir to do its job, you need to [give it permissions](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#giving-draupnir-permissions) in rooms it's protecting. This involves **giving it an Administrator power level**." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:210 +#: ../../../docs/configuring-playbook-bot-draupnir.md:239 msgid "**We recommend setting this power level as soon as the bot joins your room** (and before you create new rules), so that it can apply rules as soon as they are available. If the bot is under-privileged, it may fail to apply protections and may not retry for a while (or until your restart it)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:212 +#: ../../../docs/configuring-playbook-bot-draupnir.md:241 msgid "Subscribing to a public policy list" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:214 +#: ../../../docs/configuring-playbook-bot-draupnir.md:243 msgid "We recommend **subscribing to a public [policy list](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists)** using the [watch command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-watch-command-to-subscribe-to-policy-rooms)." msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:216 -msgid "Polcy lists are maintained in Matrix rooms. A popular policy list is maintained in the public `#community-moderation-effort-bl:neko.dev` room." +#: ../../../docs/configuring-playbook-bot-draupnir.md:245 +msgid "Policy lists are maintained in Matrix rooms. Popular ones maintained in the public are:" msgstr "" -#: ../../../docs/configuring-playbook-bot-draupnir.md:218 -msgid "You can tell Draupnir to subscribe to it by sending the following command to the Management Room: `!draupnir watch #community-moderation-effort-bl:neko.dev`" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:220 -msgid "Creating your own policy lists and rules" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:222 -msgid "We also recommend **creating your own policy lists** with the [list create](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-list-create-command-to-create-a-policy-room) command." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:224 -msgid "You can do so by sending the following command to the Management Room: `!draupnir list create my-bans my-bans-bl`. This will create a policy list having a name (shortcode) of `my-bans` and stored in a public `#my-bans-bl:example.com` room on your server. As soon as you run this command, the bot will invite you to the policy list room." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:226 -msgid "A policy list does nothing by itself, so the next step is **adding some rules to your policy list**. Policies target a so-called `entity` (one of: `user`, `room` or `server`). These entities are mentioned on the [policy lists](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists) documentation page and in the Matrix Spec [here](https://spec.matrix.org/v1.11/client-server-api/#mban-recommendation)." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:228 -msgid "The simplest and most useful entity to target is `user`. Below are a few examples using the [ban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-ban-command) and targeting users." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:230 -msgid "To create rules, you run commands in the Management Room (**not** in the policy list room)." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:232 -msgid "(ban a single user on a given homeserver): `!draupnir ban @charles:example.com my-bans Rude to others`" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:233 -msgid "(ban all users on a given homeserver by using a [wildcard](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server - all users are fake`" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:235 -msgid "As a result of running these commands, you may observe:" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:237 -msgid "Draupnir creating `m.policy.rule.user` state events in the `#my-bans-bl:example.com` room on your server" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:238 -msgid "applying these rules against all rooms that Draupnir is an Administrator in" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:240 -msgid "You can undo bans with the [unban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-unban-command)." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:242 -msgid "Enabling built-in protections" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:244 -msgid "You can also **turn on various built-in [protections](https://the-draupnir-project.github.io/draupnir-documentation/protections)** like `JoinWaveShortCircuit` (\"If X amount of users join in Y time, set the room to invite-only\")." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-draupnir.md:246 -msgid "To **see which protections are available and which are enabled**, send a `!draupnir protections` command to the Management Room." +#: ../../../docs/configuring-playbook-bot-draupnir.md:247 +msgid "`#community-moderation-effort-bl:neko.dev`" msgstr "" #: ../../../docs/configuring-playbook-bot-draupnir.md:248 -msgid "To **see the configuration options for a given protection**, send a `!draupnir protections show PROTECTION_NAME` (e.g. `!draupnir protections show JoinWaveShortCircuit`)." +msgid "`#huginn-muninn-active-threats:feline.support`" msgstr "" #: ../../../docs/configuring-playbook-bot-draupnir.md:250 -msgid "To **set a specific option for a given protection**, send a command like this: `!draupnir config set PROTECTION_NAME.OPTION VALUE` (e.g. `!draupnir config set JoinWaveShortCircuit.timescaleMinutes 30`)." +msgid "You can tell Draupnir to subscribe to each of these by sending the following command to the Management Room: `!draupnir watch POLICY_LIST_ADDRESS_HERE` (e.g. `!draupnir watch #community-moderation-effort-bl:neko.dev`)" msgstr "" #: ../../../docs/configuring-playbook-bot-draupnir.md:252 -msgid "To **enable a given protection**, send a command like this: `!draupnir enable PROTECTION_NAME` (e.g. `!draupnir enable JoinWaveShortCircuit`)." +msgid "Creating your own policy lists and rules" msgstr "" #: ../../../docs/configuring-playbook-bot-draupnir.md:254 -msgid "To **disable a given protection**, send a command like this: `!draupnir disable PROTECTION_NAME` (e.g. `!draupnir disable JoinWaveShortCircuit`)." +msgid "We also recommend **creating your own policy lists** with the [list create](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-list-create-command-to-create-a-policy-room) command." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:256 +msgid "You can do so by sending the following command to the Management Room: `!draupnir list create my-bans my-bans-bl`. This will create a policy list having a name (shortcode) of `my-bans` and stored in a public `#my-bans-bl:example.com` room on your server. As soon as you run this command, the bot will invite you to the policy list room." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:258 +msgid "A policy list does nothing by itself, so the next step is **adding some rules to your policy list**. Policies target a so-called `entity` (one of: `user`, `room` or `server`). These entities are mentioned on the [policy lists](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists) documentation page and in the Matrix Spec [here](https://spec.matrix.org/v1.11/client-server-api/#mban-recommendation)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:260 +msgid "The simplest and most useful entity to target is `user`. Below are a few examples using the [ban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-ban-command) and targeting users." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:262 +msgid "To create rules, you run commands in the Management Room (**not** in the policy list room)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:264 +msgid "(ban a single user on a given homeserver): `!draupnir ban @charles:example.com my-bans Rude to others`" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:265 +msgid "(ban all users on a given homeserver by using a [wildcard](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server, all users are fake`" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:267 +msgid "As a result of running these commands, you may observe:" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:269 +msgid "Draupnir creating `m.policy.rule.user` state events in the `#my-bans-bl:example.com` room on your server" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:270 +msgid "applying these rules against all rooms that Draupnir is an Administrator in" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:272 +msgid "You can undo bans with the [unban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-unban-command)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:274 +msgid "Enabling built-in protections" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:276 +msgid "You can also **turn on various built-in [protections](https://the-draupnir-project.github.io/draupnir-documentation/protections)** like `JoinWaveShortCircuitProtection` (\"If X amount of users join in Y time, set the room to invite-only\")." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:278 +msgid "To **see which protections are available and which are enabled**, send a `!draupnir protections` command to the Management Room." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:280 +msgid "To [**see the configuration options for a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/configuring-protections#displaying-the-protection-settings), send a `!draupnir protections show PROTECTION_NAME` (e.g. `!draupnir protections show JoinWaveShortCircuitProtection`)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:282 +msgid "To [**set a specific option for a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/configuring-protections#changing-protection-settings), send a command like this: `!draupnir protections config set PROTECTION_NAME OPTION VALUE` (e.g. `!draupnir protections config set JoinWaveShortCircuitProtection timescaleMinutes 30`)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:284 +msgid "To [**enable a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/block-invitations-on-server-protection#enabling-the-protection), send a command like this: `!draupnir protections enable PROTECTION_NAME` (e.g. `!draupnir protections enable JoinWaveShortCircuitProtection`)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-draupnir.md:286 +msgid "To **disable a given protection**, send a command like this: `!draupnir protections disable PROTECTION_NAME` (e.g. `!draupnir protections disable JoinWaveShortCircuitProtection`)." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-go-neb.pot b/i18n/translation-templates/docs/configuring-playbook-bot-go-neb.pot index 652820c16..f619c5313 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-go-neb.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-go-neb.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,138 +16,158 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-go-neb.md:1 +#: ../../../docs/configuring-playbook-bot-go-neb.md:11 msgid "Setting up Go-NEB (optional, unmaintained)" msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:3 -msgid "**Note**: [Go-NEB](https://github.com/matrix-org/go-neb) is now an archived (**unmaintained**) project. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bot instead of this one." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-go-neb.md:5 -msgid "The playbook can install and configure [Go-NEB](https://github.com/matrix-org/go-neb) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-go-neb.md:7 -msgid "Go-NEB is a Matrix bot written in Go. It is the successor to Matrix-NEB, the original Matrix bot written in Python." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-go-neb.md:9 -msgid "See the project's [documentation](https://github.com/matrix-org/go-neb/blob/master/README.md) to learn what it does and why it might be useful to you." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-go-neb.md:11 -msgid "Prerequisites" -msgstr "" - #: ../../../docs/configuring-playbook-bot-go-neb.md:13 -msgid "Register the bot account" +msgid "**Note**: [Go-NEB](https://github.com/matrix-org/go-neb) is now an archived (**unmaintained**) project. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bot instead of this one." msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:15 -msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot." +msgid "The playbook can install and configure [Go-NEB](https://github.com/matrix-org/go-neb) for you." msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:17 -msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`." +msgid "Go-NEB is a Matrix bot written in Go. It is the successor to Matrix-NEB, the original Matrix bot written in Python." msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:19 -msgid "You can use the playbook to [register a new user](registering-users.md):" +msgid "See the project's [documentation](https://github.com/matrix-org/go-neb/blob/master/README.md) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:21 +msgid "Prerequisites" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:23 +msgid "Register the bot account" msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:25 -msgid "Obtain an access token" +msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot." msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:27 -msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." +msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`." msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:29 +msgid "You can use the playbook to [register a new user](registering-users.md):" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:35 +msgid "Obtain an access token" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:37 +msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:39 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:32 +#: ../../../docs/configuring-playbook-bot-go-neb.md:42 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:34 +#: ../../../docs/configuring-playbook-bot-go-neb.md:44 msgid "By default, this playbook installs Go-NEB on the `goneb.` subdomain (`goneb.example.com`) and requires you to create a CNAME record for `goneb`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:36 +#: ../../../docs/configuring-playbook-bot-go-neb.md:46 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:38 +#: ../../../docs/configuring-playbook-bot-go-neb.md:48 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:40 +#: ../../../docs/configuring-playbook-bot-go-neb.md:50 msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_FOR_GONEB_HERE` and `ACCESS_TOKEN_FOR_ANOTHER_GONEB_HERE` with the ones created [above](#obtain-an-access-token)." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:204 +#: ../../../docs/configuring-playbook-bot-go-neb.md:214 msgid "Adjusting the Go-NEB URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:206 +#: ../../../docs/configuring-playbook-bot-go-neb.md:216 msgid "By tweaking the `matrix_bot_go_neb_hostname` and `matrix_bot_go_neb_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:208 +#: ../../../docs/configuring-playbook-bot-go-neb.md:218 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:219 +#: ../../../docs/configuring-playbook-bot-go-neb.md:229 msgid "After changing the domain, **you may need to adjust your DNS** records to point the Go-NEB domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:221 +#: ../../../docs/configuring-playbook-bot-go-neb.md:231 msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:223 -msgid "Installing" +#: ../../../docs/configuring-playbook-bot-go-neb.md:233 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:225 -msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-bot-go-neb.md:235 +msgid "There are some additional things you may wish to configure about the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:232 -msgid "**Notes**:" +#: ../../../docs/configuring-playbook-bot-go-neb.md:237 +msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:234 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-go-neb.md:236 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-go-neb.md:238 -msgid "`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." +#: ../../../docs/configuring-playbook-bot-go-neb.md:239 +msgid "`roles/custom/matrix-bot-go-neb/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:240 -msgid "Usage" +msgid "`roles/custom/matrix-bot-go-neb/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_go_neb_configuration_extension_yaml` variable" msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:242 -msgid "To use the bot, invite it to any existing Matrix room (`/invite @bot.go-neb:example.com` where `example.com` is your base domain, not the `matrix.` domain). Make sure you are granted with the sufficient permission if you are not the room owner." +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-bot-go-neb.md:244 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:251 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:253 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:255 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:257 +msgid "To use the bot, invite it to any existing Matrix room (`/invite @bot.go-neb:example.com` where `example.com` is your base domain, not the `matrix.` domain). Make sure you are granted with the sufficient permission if you are not the room owner." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:259 msgid "Basic usage is like this: `!echo hi` or `!imgur puppies` or `!giphy matrix`" msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:246 +#: ../../../docs/configuring-playbook-bot-go-neb.md:261 msgid "If you enabled the github_cmd service, send `!github help` to the bot in the room to see the available commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-go-neb.md:248 +#: ../../../docs/configuring-playbook-bot-go-neb.md:263 msgid "You can also refer to the upstream [Documentation](https://github.com/matrix-org/go-neb)." msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:265 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-go-neb.md:267 +msgid "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-go-neb`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot b/i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot index e8b7a4e0e..bdcd6d1ba 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,106 +16,138 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-honoroit.md:1 +#: ../../../docs/configuring-playbook-bot-honoroit.md:9 msgid "Setting up Honoroit (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:3 +#: ../../../docs/configuring-playbook-bot-honoroit.md:11 msgid "The playbook can install and configure [Honoroit](https://github.com/etkecc/honoroit) for you." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:5 +#: ../../../docs/configuring-playbook-bot-honoroit.md:13 msgid "It's a bot you can use to setup **your own helpdesk on matrix**" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:7 +#: ../../../docs/configuring-playbook-bot-honoroit.md:15 msgid "See the project's [documentation](https://github.com/etkecc/honoroit/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:9 +#: ../../../docs/configuring-playbook-bot-honoroit.md:17 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:11 +#: ../../../docs/configuring-playbook-bot-honoroit.md:19 msgid "By default, this playbook installs Honoroit on the `matrix.` subdomain, at the `/honoroit` path (https://matrix.example.com/honoroit). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:13 +#: ../../../docs/configuring-playbook-bot-honoroit.md:21 msgid "If you wish to adjust it, see the section [below](#adjusting-the-honoroit-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:15 +#: ../../../docs/configuring-playbook-bot-honoroit.md:23 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:17 +#: ../../../docs/configuring-playbook-bot-honoroit.md:25 msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:32 +#: ../../../docs/configuring-playbook-bot-honoroit.md:40 msgid "Adjusting the Honoroit URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:34 +#: ../../../docs/configuring-playbook-bot-honoroit.md:42 msgid "By tweaking the `matrix_bot_honoroit_hostname` and `matrix_bot_honoroit_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:36 +#: ../../../docs/configuring-playbook-bot-honoroit.md:44 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:44 +#: ../../../docs/configuring-playbook-bot-honoroit.md:52 msgid "If you've changed the default hostname, you may need to create a CNAME record for the Honoroit domain (`honoroit.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:46 +#: ../../../docs/configuring-playbook-bot-honoroit.md:54 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:48 +#: ../../../docs/configuring-playbook-bot-honoroit.md:56 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:58 +msgid "There are some additional things you may wish to configure about the bot." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:60 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:62 +msgid "`roles/custom/matrix-bot-honoroit/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:64 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:50 +#: ../../../docs/configuring-playbook-bot-honoroit.md:66 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:57 +#: ../../../docs/configuring-playbook-bot-honoroit.md:73 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:59 +#: ../../../docs/configuring-playbook-bot-honoroit.md:75 msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:61 +#: ../../../docs/configuring-playbook-bot-honoroit.md:77 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:63 +#: ../../../docs/configuring-playbook-bot-honoroit.md:79 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:65 +#: ../../../docs/configuring-playbook-bot-honoroit.md:81 msgid "If you change the bot password (`matrix_bot_honoroit_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_honoroit_password` to let the bot know its new password." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:67 +#: ../../../docs/configuring-playbook-bot-honoroit.md:83 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:69 +#: ../../../docs/configuring-playbook-bot-honoroit.md:85 msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @honoroit:example.com` where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:71 +#: ../../../docs/configuring-playbook-bot-honoroit.md:87 msgid "After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:73 +#: ../../../docs/configuring-playbook-bot-honoroit.md:89 msgid "Send `!ho help` to the bot in the room to see the available commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-honoroit.md:75 +#: ../../../docs/configuring-playbook-bot-honoroit.md:91 msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/honoroit#features)." msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:93 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:95 +msgid "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-honoroit`." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:97 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:99 +msgid "If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-matrix-registration-bot.pot b/i18n/translation-templates/docs/configuring-playbook-bot-matrix-registration-bot.pot index cd5df4bf3..3670682ea 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-matrix-registration-bot.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-matrix-registration-bot.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,82 +16,118 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:1 +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:13 msgid "Setting up matrix-registration-bot (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:3 +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:15 msgid "The playbook can install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for you." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:5 +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:17 msgid "The bot allows you to easily **create and manage registration tokens** aka. invitation codes. It can be used for an invitation-based server, where you invite someone by sending them a registration token (tokens look like this: `rbalQ0zkaDSRQCOp`). They can register as per normal but have to provide a valid registration token in the final step of the registration process." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:7 +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:19 msgid "See the project's [documentation](https://github.com/moan0s/matrix-registration-bot/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:9 +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:21 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:11 +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:23 msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:30 +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:46 msgid "The bot account will be created automatically." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:32 -msgid "Installing" +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:48 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:34 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:50 +msgid "There are some additional things you may wish to configure about the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:41 -msgid "**Notes**:" +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:52 +msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:43 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:45 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:47 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:49 -msgid "If you change the bot password (`matrix_bot_matrix_registration_bot_bot_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:51 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:53 -msgid "To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:54 +msgid "`roles/custom/matrix-bot-matrix-registration-bot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" #: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:55 -msgid "Send `help` to the bot to see the available commands." +msgid "`roles/custom/matrix-bot-matrix-registration-bot/templates/config.yaml.j2` for the bridge's default configuration" msgstr "" #: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:57 -msgid "You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands)." +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:59 -msgid "If you have any questions, or if you need help setting it up, read the [troublshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de)." +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:61 +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:66 +msgid "**Notes**:" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:68 +msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:70 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:72 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:74 +msgid "If you change the bot password (`matrix_bot_matrix_registration_bot_bot_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:76 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:78 +msgid "To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:80 +msgid "Send `help` to the bot to see the available commands." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:82 +msgid "You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:84 +msgid "If you have any questions, or if you need help setting it up, read the [troubleshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de)." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:86 msgid "To clean the cache (session & encryption data) after you changed the bot's username, changed the login method from access_token to password etc… you can use:" msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:92 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:94 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:96 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:98 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-matrix-reminder-bot.pot b/i18n/translation-templates/docs/configuring-playbook-bot-matrix-reminder-bot.pot index 4ef1131c8..9c0e43ec2 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-matrix-reminder-bot.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-matrix-reminder-bot.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,78 +16,114 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:1 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:9 msgid "Setting up matrix-reminder-bot (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:3 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:11 msgid "The playbook can install and configure [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) for you." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:5 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:13 msgid "It's a bot you can use to **schedule one-off & recurring reminders and alarms**." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:7 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:15 msgid "See the project's [documentation](https://github.com/anoadragon453/matrix-reminder-bot/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:9 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:17 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:11 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:19 msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:26 -msgid "Installing" +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:34 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:28 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:36 +msgid "There are some additional things you may wish to configure about the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:35 -msgid "**Notes**:" +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:38 +msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:37 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:39 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:40 +msgid "`roles/custom/matrix-bot-matrix-reminder-bot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" #: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:41 -msgid "`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." +msgid "`roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_matrix_reminder_bot_configuration_extension_yaml` variable" msgstr "" #: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:43 -msgid "If you change the bot password (`matrix_bot_matrix_reminder_bot_matrix_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_reminder_bot_matrix_user_password` to let the bot know its new password." +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:45 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:52 +msgid "**Notes**:" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:54 +msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:56 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:58 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:60 +msgid "If you change the bot password (`matrix_bot_matrix_reminder_bot_matrix_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_reminder_bot_matrix_user_password` to let the bot know its new password." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:62 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:47 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:64 msgid "To use the bot, start a chat with `@bot.matrix-reminder-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:49 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:66 msgid "You can also add the bot to any existing Matrix room (`/invite @bot.matrix-reminder-bot:example.com`)." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:51 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:68 msgid "Basic usage is like this: `!remindme in 2 minutes; This is a test`" msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:53 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:70 msgid "Send `!help reminders` to the room to see the bot's help menu for additional commands." msgstr "" -#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:55 +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:72 msgid "You can also refer to the upstream [Usage documentation](https://github.com/anoadragon453/matrix-reminder-bot#usage)." msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:74 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:76 +msgid "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-reminder-bot`." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:78 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:80 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-maubot.pot b/i18n/translation-templates/docs/configuring-playbook-bot-maubot.pot index 67e480d6b..d3475cd15 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-maubot.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-maubot.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,147 +16,183 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-maubot.md:1 +#: ../../../docs/configuring-playbook-bot-maubot.md:12 msgid "Setting up maubot (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:3 +#: ../../../docs/configuring-playbook-bot-maubot.md:14 msgid "The playbook can install and configure [maubot](https://github.com/maubot/maubot) for you." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:5 +#: ../../../docs/configuring-playbook-bot-maubot.md:16 msgid "After setting up maubot, you can use the web management interface to make it do things. The default location of the management interface is `matrix.example.com/_matrix/maubot/`" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:7 +#: ../../../docs/configuring-playbook-bot-maubot.md:18 msgid "See the project's [documentation](https://docs.mau.fi/maubot/usage/basic.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:9 +#: ../../../docs/configuring-playbook-bot-maubot.md:20 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:11 +#: ../../../docs/configuring-playbook-bot-maubot.md:22 msgid "By default, this playbook installs maubot on the `matrix.` subdomain, at the `/_matrix/maubot/` path (https://matrix.example.com/_matrix/maubot/). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:13 +#: ../../../docs/configuring-playbook-bot-maubot.md:24 msgid "If you wish to adjust it, see the section [below](#adjusting-the-maubot-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:15 +#: ../../../docs/configuring-playbook-bot-maubot.md:26 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:17 +#: ../../../docs/configuring-playbook-bot-maubot.md:28 msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:32 +#: ../../../docs/configuring-playbook-bot-maubot.md:43 msgid "You can add multiple admins. The admin accounts are only used to access the maubot administration interface." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:34 +#: ../../../docs/configuring-playbook-bot-maubot.md:45 msgid "Adjusting the maubot URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:36 +#: ../../../docs/configuring-playbook-bot-maubot.md:47 msgid "By tweaking the `matrix_bot_maubot_hostname` and `matrix_bot_maubot_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:38 -#: ../../../docs/configuring-playbook-bot-maubot.md:56 +#: ../../../docs/configuring-playbook-bot-maubot.md:49 +#: ../../../docs/configuring-playbook-bot-maubot.md:76 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:46 +#: ../../../docs/configuring-playbook-bot-maubot.md:57 msgid "If you've changed the default hostname, you may need to create a CNAME record for the maubot domain (`maubot.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:48 +#: ../../../docs/configuring-playbook-bot-maubot.md:59 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:50 -msgid "Customizing the maubot container image" +#: ../../../docs/configuring-playbook-bot-maubot.md:61 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:52 -msgid "Certain [maubot plugins](https://plugins.mau.bot/) require additional dependencies to be installed." +#: ../../../docs/configuring-playbook-bot-maubot.md:63 +msgid "There are some additional things you may wish to configure about the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:54 -msgid "You can customize the default maubot container image and install your own dependencies." +#: ../../../docs/configuring-playbook-bot-maubot.md:65 +msgid "Take a look at:" msgstr "" #: ../../../docs/configuring-playbook-bot-maubot.md:67 +msgid "`roles/custom/matrix-bot-maubot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:68 +msgid "`roles/custom/matrix-bot-maubot/templates/config.yaml.j2` for the bot's default configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:70 +msgid "Customizing the maubot container image" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:72 +msgid "Certain [maubot plugins](https://plugins.mau.bot/) require additional dependencies to be installed." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:74 +msgid "You can customize the default maubot container image and install your own dependencies." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:87 msgid "Consult the [Dockerfile reference](https://docs.docker.com/reference/dockerfile/) for more information about the syntax." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:69 +#: ../../../docs/configuring-playbook-bot-maubot.md:89 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:71 +#: ../../../docs/configuring-playbook-bot-maubot.md:91 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:78 +#: ../../../docs/configuring-playbook-bot-maubot.md:98 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:80 +#: ../../../docs/configuring-playbook-bot-maubot.md:100 msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:82 +#: ../../../docs/configuring-playbook-bot-maubot.md:102 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:84 +#: ../../../docs/configuring-playbook-bot-maubot.md:104 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:86 +#: ../../../docs/configuring-playbook-bot-maubot.md:106 msgid "If you change the bot password (`matrix_bot_maubot_initial_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_maubot_initial_password` to let the bot know its new password." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:88 +#: ../../../docs/configuring-playbook-bot-maubot.md:108 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:90 +#: ../../../docs/configuring-playbook-bot-maubot.md:110 msgid "By default, you can visit `matrix.example.com/_matrix/maubot/` to manage your available plugins, clients and instances." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:92 +#: ../../../docs/configuring-playbook-bot-maubot.md:112 msgid "You should start in the following order" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:93 +#: ../../../docs/configuring-playbook-bot-maubot.md:113 msgid "**Create one or more clients**: A client is a Matrix account which the bot will use to message. By default, the playbook creates a `bot.maubot` account (as per the configuration above). You only need to [obtain an access token](#obtaining-an-access-token) for it" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:94 +#: ../../../docs/configuring-playbook-bot-maubot.md:114 msgid "**Upload some Plugins**: Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:95 +#: ../../../docs/configuring-playbook-bot-maubot.md:115 msgid "**Create an instance**: An instance is the actual bot. You have to specify a client which the bot instance will use and the plugin (how the bot will behave)" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:97 +#: ../../../docs/configuring-playbook-bot-maubot.md:117 msgid "Obtain an access token" msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:99 +#: ../../../docs/configuring-playbook-bot-maubot.md:119 msgid "This can be done via `mbc login` then `mbc auth` (see the [maubot documentation](https://docs.mau.fi/maubot/usage/cli/auth.html)). To run these commands, you'll first need to `exec` into the maubot container with `docker exec -it matrix-bot-maubot sh`." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:101 +#: ../../../docs/configuring-playbook-bot-maubot.md:121 msgid "Alternatively, you can refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md). Be aware that you'd better use the **Obtain an access token via curl** method (not **Obtain an access token via Element Web**) as the latter will causes issues to your bot in encrypted rooms. Read [more](https://docs.mau.fi/maubot/usage/basic.html#creating-clients)." msgstr "" -#: ../../../docs/configuring-playbook-bot-maubot.md:103 +#: ../../../docs/configuring-playbook-bot-maubot.md:123 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:126 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:128 +msgid "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-maubot`." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:130 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-maubot.md:132 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-mjolnir.pot b/i18n/translation-templates/docs/configuring-playbook-bot-mjolnir.pot index de2d13482..07bc87438 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-mjolnir.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-mjolnir.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,252 +16,264 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:1 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:12 msgid "Setting up Mjolnir (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:3 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:14 msgid "The playbook can install and configure the [Mjolnir](https://github.com/matrix-org/mjolnir) moderation bot for you." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:5 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:16 msgid "See the project's [documentation](https://github.com/matrix-org/mjolnir/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:7 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:18 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:9 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:20 msgid "Register the bot account" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:11 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:22 msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:13 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:24 msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:15 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:26 msgid "You can use the playbook to [register a new user](registering-users.md):" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:21 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:32 msgid "If you would like Mjolnir to be able to deactivate users, move aliases, shutdown rooms, etc then it must be a server admin so you need to change `admin=no` to `admin=yes` in the command above." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:23 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:34 msgid "Obtain an access token" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:25 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:36 msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:27 -#: ../../../docs/configuring-playbook-bot-mjolnir.md:52 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:38 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:63 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:30 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:41 msgid "Make sure the account is free from rate limiting" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:32 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:43 msgid "If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a required step. If you do not configure it, Mjolnir will crash.**" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:34 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:45 msgid "This can be done using Synapse's [Admin APIs](https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#override-ratelimiting-for-users). They can be accessed both externally and internally." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:36 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:47 msgid "**Note**: access to the APIs is restricted with a valid access token, so exposing them publicly should not be a real security concern. Still, doing so is not recommended for additional security. See [official Synapse reverse-proxying recommendations](https://element-hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-endpoints)." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:38 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:49 msgid "The APIs can also be accessed via [Synapse Admin](https://github.com/etkecc/synapse-admin), a web UI tool you can use to administrate users, rooms, media, etc. on your Matrix server. The playbook can install and configure Synapse Admin for you. For details about it, see [this page](configuring-playbook-synapse-admin.md)." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:40 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:51 msgid "Add the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:42 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:53 msgid "To expose the APIs publicly, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:48 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:59 msgid "Obtain an access token for admin account" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:50 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:61 msgid "Manual access to Synapse's Admin APIs requires an access token for a homeserver admin account. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md). If you have made Mjolnir an admin, you can just use the Mjolnir token." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:55 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:66 msgid "Run the `curl` command" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:57 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:68 msgid "To disable rate limiting, run the following command on systems that ship curl. Before running it, make sure to replace:" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:59 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:70 msgid "`ADMIN_ACCESS_TOKEN_HERE` with the access token of the admin account" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:60 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:71 msgid "`example.com` with your base domain" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:61 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:72 msgid "`@bot.mjolnir:example.com` with the MXID of your Mjolnir bot user" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:67 -#: ../../../docs/configuring-playbook-bot-mjolnir.md:184 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:78 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:195 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:68 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:79 msgid "This does not work on outdated Windows 10 as curl is not available there." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:69 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:80 msgid "Even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:71 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:82 msgid "Create a management room" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:73 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:84 msgid "Using your own account, create a new invite only room that you will use to manage the bot. This is the room where you will see the status of the bot and where you will send commands to the bot, such as the command to ban a user from another room." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:75 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:86 msgid "[!WARNING] Anyone in this room can control the bot so it is important that you only invite trusted users to this room." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:78 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:89 msgid "It is possible to make the management room encrypted (E2EE). If doing so, then you MUST enable and use Pantalaimon (see [below](#configuration-with-e2ee-support))." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:80 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:91 msgid "Once you have created the room you need to copy the room ID so you can specify it on your `vars.yml` file. In Element Web you can check the ID by going to the room's settings and clicking \"Advanced\". The room ID will look something like `!qporfwt:example.com`." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:82 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:93 msgid "Finally invite the `@bot.mjolnir:example.com` account you created earlier into the room." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:84 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:95 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:86 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:97 msgid "To enable the bot, add the following configuration to your `vars.yml` file. Make sure to replace `MANAGEMENT_ROOM_ID_HERE` with the one of the room which you have created just now." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:95 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:106 msgid "End-to-End Encryption support" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:97 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:108 msgid "Decide whether you want Mjolnir to be capable of operating in end-to-end encrypted (E2EE) rooms. This includes the management room and the moderated rooms." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:99 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:110 msgid "To support E2EE, Mjolnir needs to [use Pantalaimon](configuring-playbook-pantalaimon.md)." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:101 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:112 msgid "Configuration with E2EE support" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:103 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:114 msgid "When using Pantalaimon, Mjolnir will log in to its bot account itself through Pantalaimon, so configure its username and password." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:105 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:116 msgid "Add the following configuration to your `vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:119 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:130 msgid "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`:" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:131 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:142 msgid "Configuration without E2EE support" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:133 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:144 msgid "When NOT using Pantalaimon, Mjolnir does not log in by itself and you must give it an access token for its bot account." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:135 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:146 msgid "Add the following configuration to your `vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#obtain-an-access-token)." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:141 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:152 msgid "Adding Mjolnir synapse antispam module (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:143 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:154 msgid "To enable Mjolnir synapse antispam module, add the following configuration to your `vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:153 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:164 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:155 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:166 msgid "There are some additional things you may wish to configure about the bot." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:157 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:168 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:159 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:170 msgid "`roles/custom/matrix-bot-mjolnir/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_mjolnir_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:161 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:172 msgid "For example, to change Mjolnir's `recordIgnoredInvites` option to `true`, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:175 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:186 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:177 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:188 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:186 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bot-mjolnir.md:188 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:197 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:190 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:199 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:192 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:201 msgid "If you change the Pantalaimon's password (`matrix_bot_mjolnir_pantalaimon_password` in your `vars.yml` file) subsequently, its credentials on the homeserver won't be updated automatically. If you'd like to change the password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_mjolnir_pantalaimon_password` to let Pantalaimon know its new password." msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:194 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:203 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bot-mjolnir.md:196 +#: ../../../docs/configuring-playbook-bot-mjolnir.md:205 msgid "You can refer to the upstream [documentation](https://github.com/matrix-org/mjolnir) for additional ways to use and configure Mjolnir. Check out their [quickstart guide](https://github.com/matrix-org/mjolnir#quickstart-guide) for some basic commands you can give to the bot." msgstr "" + +#: ../../../docs/configuring-playbook-bot-mjolnir.md:207 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-mjolnir.md:209 +msgid "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-mjolnir`." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-mjolnir.md:211 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-mjolnir.md:213 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-discord.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-discord.pot index 256400515..22442b987 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-discord.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-discord.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,151 +16,179 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:1 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:10 msgid "Setting up Appservice Discord bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:3 -msgid "**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:4 -msgid "For using as a Bot we are recommend the Appservice Discord bridge (the one being discussed here), because it supports plumbing." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:5 -msgid "For personal use we recommend the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge, because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:7 -msgid "The playbook can install and configure [matrix-appservice-discord](https://github.com/matrix-org/matrix-appservice-discord) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:9 -msgid "See the project's [documentation](https://github.com/matrix-org/matrix-appservice-discord/blob/master/README.md) to learn what it does and why it might be useful to you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:11 -msgid "Prerequisites" +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:12 +msgid "**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge supported by the playbook." msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-discord.md:13 +msgid "For using as a Bot we are recommend the Appservice Discord bridge (the one being discussed here), because it supports plumbing." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:14 +msgid "For personal use we recommend the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge, because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:16 +msgid "The playbook can install and configure [matrix-appservice-discord](https://github.com/matrix-org/matrix-appservice-discord) for you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:18 +msgid "See the project's [documentation](https://github.com/matrix-org/matrix-appservice-discord/blob/master/README.md) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:20 +msgid "Prerequisites" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:22 msgid "Create a Discord Application [here](https://discordapp.com/developers/applications). Then retrieve Client ID, and create a bot from the Bot tab and retrieve the Bot token." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:15 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:24 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:17 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:26 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:31 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:33 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - #: ../../../docs/configuring-playbook-bridge-appservice-discord.md:40 -msgid "**Notes**:" +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-discord.md:42 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." +msgid "There are some additional things you may wish to configure about the bridge." msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-discord.md:44 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgid "Take a look at:" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-discord.md:46 -msgid "`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." +msgid "`roles/custom/matrix-bridge-appservice-discord/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:48 -msgid "Self-Service Bridging (Manual)" +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:47 +msgid "`roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_discord_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:50 -msgid "Self-service bridging allows you to bridge specific and existing Matrix rooms to specific Discord rooms. To enable it, add the following configuration to your `vars.yml` file:" +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:49 +msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:56 -msgid "**Note**: If self-service bridging is not enabled, `!discord help` commands will return no results." +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:51 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-discord.md:58 -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:82 -msgid "Usage" +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-discord.md:60 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:63 +msgid "Self-Service Bridging (Manual)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:65 +msgid "Self-service bridging allows you to bridge specific and existing Matrix rooms to specific Discord rooms. To enable it, add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:71 +msgid "**Note**: If self-service bridging is not enabled, `!discord help` commands will return no results." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:73 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:97 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:75 msgid "Once self-service is enabled, start a chat with `@_discord_bot:example.com` and say `!discord help bridge`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:62 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:77 msgid "Then, follow the instructions in the help output message." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:64 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:79 msgid "If the bot is not already in the Discord server, follow the provided invite link. This may require you to be a administrator of the Discord server." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:66 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:81 msgid "On the Discord side, send `!matrix help` to the bot to see the available commands for managing the bridge and Matrix users." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:68 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:83 msgid "**Note**: Encrypted Matrix rooms are not supported as of writing." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:70 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:85 msgid "Portal Bridging (Automatic)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:72 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:87 msgid "Through portal bridging, Matrix rooms will automatically be created by the bot and bridged to the relevant Discord room. This is done by simply joining a room with a specific name pattern (`#_discord__`)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:74 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:89 msgid "All Matrix rooms created this way are **listed publicly** by default, and you will not have admin permissions to change this. To get more control, [make yourself a room Administrator](#getting-administrator-access-in-a-portal-bridged-room). You can then unlist the room from the directory and change the join rules." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:76 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:91 msgid "To disable portal bridging, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:84 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:99 msgid "To get started with Portal Bridging:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:86 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:101 msgid "To invite the bot to Discord, retrieve the invite link from the `{{ matrix_appservice_discord_config_path }}/invite_link` file on the server (this defaults to `/matrix/appservice-discord/config/invite_link`). You need to peek at the file on the server via SSH, etc., because it's not available via HTTP(S)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:87 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:102 msgid "Room addresses follow this syntax: `#_discord__`. You can easily find the guild and channel IDs by logging into Discord in a browser and opening the desired channel. The URL will have this format: `discord.com/channels//`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:88 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:103 msgid "Once you have figured out the appropriate room address, you can join by doing `/join #_discord__` in your Matrix client." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:90 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:105 msgid "Getting Administrator access in a portal bridged room" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:92 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:107 msgid "By default, you won't have Administrator access in rooms created by the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:94 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:109 msgid "To adjust room access privileges or do various other things (change the room name subsequently, etc.), you'd wish to become an Administrator." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:96 +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:111 msgid "There's the Discord bridge's guide for [setting privileges on bridge managed rooms](https://github.com/matrix-org/matrix-appservice-discord/blob/master/docs/howto.md#set-privileges-on-bridge-managed-rooms). To do the same with our container setup, run the following command on the server:" msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:118 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:120 +msgid "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-discord`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:122 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:124 +msgid "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 (adapt to your needs) and re-run the playbook:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-irc.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-irc.pot index 557a6fae8..34588d016 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-irc.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-irc.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,58 +16,86 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:1 +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:10 msgid "Setting up Appservice IRC bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:3 +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:12 msgid "**Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) bridge supported by the playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:5 +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:14 msgid "The playbook can install and configure the [matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc) bridge for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:7 +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:16 msgid "See the project's [documentation](https://github.com/matrix-org/matrix-appservice-irc/blob/master/HOWTO.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:9 +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:18 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:11 +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:20 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:63 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:65 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - #: ../../../docs/configuring-playbook-bridge-appservice-irc.md:72 -msgid "**Notes**:" +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-irc.md:74 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." +msgid "There are some additional things you may wish to configure about the bridge." msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-irc.md:76 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgid "Take a look at:" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-irc.md:78 -msgid "`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." +msgid "`roles/custom/matrix-bridge-appservice-irc/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:80 +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:79 +msgid "`roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_irc_configuration_extension_yaml` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:81 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:83 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:90 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:92 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:94 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:82 +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:96 msgid "To use the bridge, you need to start a chat with `@irc_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:98 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:100 +msgid "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-irc`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:102 +msgid "Configuring for logging" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:104 +msgid "The default logging level for this component is `debug`, and the log is output to the console only. If you want to change the verbosity or enable logging to a file, add the following configuration to your `vars.yml` file (adapt to your needs) and re-run the playbook:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-kakaotalk.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-kakaotalk.pot index 02faa22c0..4fc51ddc4 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-kakaotalk.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-kakaotalk.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,102 +16,110 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:1 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:10 msgid "Setting up Appservice Kakaotalk bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:3 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:12 msgid "The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you, for bridging to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG). This bridge is based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:5 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:14 msgid "See the project's [documentation](https://src.miscworks.net/fair/matrix-appservice-kakaotalk/src/branch/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:7 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:16 msgid "[!WARNING] There have been recent reports (~2022-09-16) that **using this bridge may get your account banned**." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:10 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:19 msgid "Prerequisite (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:12 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:21 msgid "Enable Shared Secret Auth" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:14 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:23 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:16 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:25 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:18 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:27 msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:20 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:29 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:22 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:31 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:28 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:37 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:30 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:39 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:32 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:41 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:34 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:43 msgid "`roles/custom/matrix-bridge-appservice-kakaotalk/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:35 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:44 msgid "`roles/custom/matrix-bridge-appservice-kakaotalk/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_kakaotalk_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:37 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:46 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:39 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:48 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:46 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:48 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:50 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:55 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:52 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:57 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:54 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:59 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:56 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:61 msgid "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)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:58 +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:63 msgid "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." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:65 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:67 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:69 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:71 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-slack.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-slack.pot index 39bbbd431..04d08e82a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-slack.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-slack.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,247 +16,242 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:1 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:12 msgid "Setting up Appservice Slack bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:3 -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:89 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:14 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:4 -msgid "Bridging to [Slack](https://slack.com) can also happen via the [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) and [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook." +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:15 +msgid "Bridging to [Slack](https://slack.com) can also happen via the [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridge supported by the playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:5 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:16 msgid "Currently (as of November, 2024) **this component is not available for new installation unless you have already created a classic Slack application** (which the bridge makes use of in order to enable bridging between Slack and Matrix), because the creation of classic Slack applications has been discontinued since June 4 2024. The author of the bridge claims [here](https://github.com/matrix-org/matrix-appservice-slack/issues/789#issuecomment-2172947787) that he plans to support the modern Slack application and until then \"the best (and only) option for new installations is to use the webhook bridging\"." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:7 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:18 msgid "The playbook can install and configure [matrix-appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:9 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:20 msgid "See the project's [documentation](https://github.com/matrix-org/matrix-appservice-slack/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:11 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:22 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:13 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:24 msgid "Create a Classic Slack App" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:15 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:26 msgid "First, you need to create a Classic Slack App [here](https://api.slack.com/apps?new_classic_app=1)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:17 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:28 msgid "Name the app \"matrixbot\" (or anything else you'll remember). Select the team/workspace this app will belong to. Click on bot users and add a new bot user. We will use this account to bridge the the rooms." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:19 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:30 msgid "Then, click on Event Subscriptions and enable them and use the request url: `https://matrix.example.com/appservice-slack`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:21 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:32 msgid "Add the following events as `Bot User Events` and save:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:23 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:34 msgid "team_domain_change" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:24 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:35 msgid "message.channels" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:25 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:36 msgid "message.groups (if you want to bridge private channels)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:26 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:37 msgid "reaction_added" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:27 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:38 msgid "reaction_removed" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:29 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:40 msgid "Next, click on \"OAuth & Permissions\" and add the following scopes:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:31 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:42 msgid "chat:write:bot" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:32 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:43 msgid "users:read" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:33 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:44 msgid "reactions:write" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:34 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:45 msgid "files:write:user (if you want to bridge files)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:36 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:47 msgid "**Note**: In order to make Slack files visible to Matrix users, this bridge will make Slack files visible to anyone with the url (including files in private channels). This is different than the current behavior in Slack, which only allows authenticated access to media posted in private channels. See MSC701 for details." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:38 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:49 msgid "Click on \"Install App\" and \"Install App to Workspace\". Note the access tokens shown. You will need the Bot User OAuth Access Token and if you want to bridge files, the OAuth Access Token whenever you link a room." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:40 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:51 msgid "Create an administration control room on Matrix" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:42 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:53 msgid "Create a new Matrix room to act as the administration control room." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:44 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:55 msgid "Note its internal room ID. This can be done in Element Web by sending a message, opening the options for that message and choosing \"view source\". The room ID will be displayed near the top." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:46 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:57 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:48 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:59 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:64 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:75 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:66 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:77 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:68 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:79 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:70 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:81 msgid "`roles/custom/matrix-bridge-appservice-slack/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:71 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:82 msgid "`roles/custom/matrix-bridge-appservice-slack/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_slack_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:73 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:84 msgid "For example, to change the bot's username from `slackbot`, add the following configuration to your `vars.yml` file. Replace `examplebot` with your own." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:80 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:91 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:82 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:93 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:91 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:93 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:100 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:95 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:97 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:99 -msgid "To use the bridge, you need to send `/invite @slackbot:example.com` to invite the bridge bot user into the admin room." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:101 -msgid "If Team Sync is not enabled, for each channel you would like to bridge, perform the following steps:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:103 -msgid "Create a Matrix room in the usual manner for your client. Take a note of its Matrix room ID — it will look something like `!qporfwt:example.com`." +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:102 +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-slack.md:104 -msgid "Invite the bot user to both the Slack and Matrix channels you would like to bridge using `/invite @matrixbot` for Slack and `/invite @slackbot:example.com` for Matrix." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:105 -msgid "Determine the \"channel ID\" that Slack uses to identify the channel. You can see it when you open a given Slack channel in a browser. The URL reads like this: `https://app.slack.com/client/XXX//details/`." +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-slack.md:106 -msgid "Issue a link command in the administration control room with these collected values as arguments:" +msgid "To use the bridge, you need to send `/invite @slackbot:example.com` to invite the bridge bot user into the admin room." msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-slack.md:108 +msgid "If Team Sync is not enabled, for each channel you would like to bridge, perform the following steps:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:110 +msgid "Create a Matrix room in the usual manner for your client. Take a note of its Matrix room ID — it will look something like `!qporfwt:example.com`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:111 +msgid "Invite the bot user to both the Slack and Matrix channels you would like to bridge using `/invite @matrixbot` for Slack and `/invite @slackbot:example.com` for Matrix." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:112 +msgid "Determine the \"channel ID\" that Slack uses to identify the channel. You can see it when you open a given Slack channel in a browser. The URL reads like this: `https://app.slack.com/client/XXX//details/`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:113 +msgid "Issue a link command in the administration control room with these collected values as arguments:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:115 msgid "with file bridging:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:114 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:121 msgid "without file bridging:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:120 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:127 msgid "These arguments can be shortened to single-letter forms:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:126 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:133 msgid "Unlinking" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:128 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:135 msgid "Channels can be unlinked again by sending this:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:134 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:141 msgid "Unlinking doesn't only disconnect the bridge, but also makes the slackbot leave the bridged Matrix room. So in case you want to re-link later, don't forget to re-invite the slackbot into this room again." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:136 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:143 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:138 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:145 msgid "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-slack`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:140 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:147 msgid "Linking: \"Room is now pending-name\"" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:142 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:149 msgid "This typically means that you haven't used the correct Slack channel ID. Unlink the room and recheck 'Determine the \"channel ID\"' from above." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:144 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:151 msgid "Messages work from Matrix to Slack, but not the other way around" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:146 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:153 msgid "Check the logs, and if you find the message like below, unlink your room, reinvite the bot and re-link it again." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:148 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:155 msgid "`WARN SlackEventHandler Ignoring message from unrecognised Slack channel ID : %s (%s) `" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:150 +#: ../../../docs/configuring-playbook-bridge-appservice-slack.md:157 msgid "This may particularly hit you, if you tried to unsuccessfully link your room multiple times without unlinking it after each failed attempt." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-webhooks.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-webhooks.pot index 1661603f5..9a8eace41 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-webhooks.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-appservice-webhooks.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,94 +16,122 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:1 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:12 msgid "Setting up Appservice Webhooks bridging (optional, deprecated)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:3 -msgid "**Note**: This bridge has been deprecated. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bridge instead of this one." +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:14 +msgid "**Note**: This bridge has been deprecated. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bridge instead of this one." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:5 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:16 msgid "The playbook can install and configure [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) for you. This bridge provides support for Slack-compatible webhooks." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:7 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:18 msgid "See the project's [documentation](https://github.com/turt2live/matrix-appservice-webhooks/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:9 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:20 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:11 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:22 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:27 -msgid "Installing" +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:35 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:29 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:37 +msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:36 -msgid "**Notes**:" +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:39 +msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:38 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:40 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:41 +msgid "`roles/custom/matrix-bridge-appservice-webhooks/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:42 -msgid "`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." +msgid "`roles/custom/matrix-bridge-appservice-webhooks/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_webhooks_configuration_extension_yaml` variable" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:44 -msgid "Usage" +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:46 -msgid "To use the bridge, you need to invite the bridge bot user to your room in either way." +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:48 -msgid "Send `/invite @_webhook:example.com` (**Note**: Make sure you have administration permissions in your room)" +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:53 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:49 -msgid "Add the bridge bot to a private channel (personal channels imply you being an administrator)" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:51 -msgid "You then need to send a message to the bridge bot to receive a private message including the webhook link:" +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:55 +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:57 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:59 +msgid "To use the bridge, you need to invite the bridge bot user to your room in either way." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:61 +msgid "Send `/invite @_webhook:example.com` (**Note**: Make sure you have administration permissions in your room)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:62 +msgid "Add the bridge bot to a private channel (personal channels imply you being an administrator)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:64 +msgid "You then need to send a message to the bridge bot to receive a private message including the webhook link:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:70 msgid "The JSON body for posting messages will have to look like this:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:68 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:81 msgid "You can test this via curl like so:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:81 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:94 msgid "Setting Webhooks with Dimension integration manager" msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:83 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:96 msgid "If you're using the [Dimension integration manager](configuring-playbook-dimension.md), you can configure the Webhooks bridge with it." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:85 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:98 msgid "To configure it, open the Dimension integration manager, and go to \"Settings\" and \"Bridges\", then select edit action for \"Webhook Bridge\"." msgstr "" -#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:87 +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:100 msgid "On the UI, press \"Add self-hosted Bridge\" button and populate \"Provisioning URL\" and \"Shared Secret\" values from `/matrix/appservice-webhooks/config/config.yaml` file's homeserver URL value and provisioning secret value, respectively." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:102 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:104 +msgid "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-webhooks`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:106 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-appservice-webhooks.md:108 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-beeper-linkedin.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-beeper-linkedin.pot index 7b19a5798..f4f1cc1a2 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-beeper-linkedin.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-beeper-linkedin.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,106 +16,110 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:1 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:11 msgid "Setting up Beeper Linkedin bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:3 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:13 msgid "The playbook can install and configure [beeper-linkedin](https://github.com/beeper/linkedin) for you, for bridging to [LinkedIn](https://www.linkedin.com/) Messaging. This bridge is based on the mautrix-python framework and can be configured in a similar way to the mautrix bridges." msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:5 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:15 msgid "See the project's [documentation](https://github.com/beeper/linkedin/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:7 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:17 msgid "Prerequisite" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:9 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:19 msgid "Enable Appservice Double Puppet or Shared Secret Auth (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:11 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:21 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:13 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:23 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:15 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:25 msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:17 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:27 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:19 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:29 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:25 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:35 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:27 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:37 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:29 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:39 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:31 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:41 msgid "**Note**: when following the guide to configure the bridge, make sure to replace `_mautrix_SERVICENAME_` in the variable names with `_beeper_linkedin_`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:33 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:43 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:35 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:45 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:42 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:44 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:46 +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:52 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:48 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:50 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:52 -msgid "To use the bridge, you need to start a chat with `@linkedinbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." -msgstr "" - #: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:54 -msgid "You then need to send `login YOUR_LINKEDIN_EMAIL_ADDRESS` to the bridge bot to enable bridging for your LinkedIn account." +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:56 -msgid "Troubleshooting" +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:58 -msgid "Bridge asking for 2FA even if you don't have 2FA enabled" +msgid "To use the bridge, you need to start a chat with `@linkedinbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" #: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:60 +msgid "You then need to send `login YOUR_LINKEDIN_EMAIL_ADDRESS` to the bridge bot to enable bridging for your LinkedIn account." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:62 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:64 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:66 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:68 +msgid "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:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:74 +msgid "Bridge asking for 2FA even if you don't have 2FA enabled" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-beeper-linkedin.md:76 msgid "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." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-go-skype-bridge.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-go-skype-bridge.pot index 155e05eed..fbed210a8 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-go-skype-bridge.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-go-skype-bridge.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,90 +16,18 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:1 -msgid "Setting up Go Skype Bridge bridging (optional)" +#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:12 +msgid "Setting up Go Skype Bridge bridging (optional, removed)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:3 -msgid "The playbook can install and configure [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) for you, for bridging to [Skype](https://www.skype.com/). This bridge was created based on [mautrix-whatsapp](https://github.com/mautrix/whatsapp) and can be configured in a similar way to it." +#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:14 +msgid "🪦 The playbook used to be able to install and configure [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge), but no longer includes this component, as Skype has been discontinued since May 2025." msgstr "" -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:5 -msgid "See the project's [documentation](https://github.com/kelaresg/go-skype-bridge/blob/master/README.md) to learn what it does and why it might be useful to you." +#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:16 +msgid "Uninstalling the bridge manually" msgstr "" -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:7 -msgid "Prerequisite (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:9 -msgid "Enable Shared Secret Auth" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:11 -msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:13 -msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:15 -msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:17 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:19 -msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:25 -msgid "Extending the configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:27 -msgid "There are some additional things you may wish to configure about the bridge." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:29 -msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:31 -msgid "**Note**: when following the guide to configure the bridge, make sure to replace `_mautrix_SERVICENAME_` in the variable names with `_go_skype_bridge_`." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:33 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:35 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:42 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:44 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:46 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:48 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:50 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:52 -msgid "To use the bridge, you need to start a chat with `@skypebridgebot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +#: ../../../docs/configuring-playbook-bridge-go-skype-bridge.md:18 +msgid "If you still have the Go Skype bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-heisenbridge.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-heisenbridge.pot index 191ce175c..ff9a45bb5 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-heisenbridge.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-heisenbridge.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,102 +16,118 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:1 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:9 msgid "Setting up Heisenbridge bouncer-style IRC bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:3 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:11 msgid "**Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [matrix-appservice-irc](configuring-playbook-bridge-appservice-irc.md) bridge supported by the playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:5 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:13 msgid "The playbook can install and configure [Heisenbridge](https://github.com/hifi/heisenbridge) — the bouncer-style [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) bridge for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:7 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:15 msgid "See the project's [documentation](https://github.com/hifi/heisenbridge/blob/master/README.md) to learn what it does and why it might be useful to you. You can also take a look at [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:9 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:17 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:11 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:19 msgid "By default, this playbook installs Heisenbridge on the `matrix.` subdomain, at the `/heisenbridge` path (https://matrix.example.com/heisenbridge). It would handle media requests there (see the [release notes for Heisenbridge v1.15.0](https://github.com/hifi/heisenbridge/releases/tag/v1.15.0)). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:13 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:21 msgid "If you wish to adjust it, see the section [below](#adjusting-the-heisenbridge-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:15 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:23 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:17 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:25 msgid "To enable Heisenbridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:30 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:38 msgid "Adjusting the Heisenbridge URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:32 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:40 msgid "By tweaking the `matrix_heisenbridge_hostname` and `matrix_heisenbridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:34 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:42 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:42 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:50 msgid "If you've changed the default hostname, you may need to create a CNAME record for the Heisenbridge domain (`heisenbridge.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:44 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:52 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:46 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:54 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:56 +msgid "There are some additional things you may wish to configure about the bridge." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:58 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:60 +msgid "`roles/custom/matrix-bridge-heisenbridge/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:62 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:48 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:64 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:55 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:57 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:59 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:71 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:61 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:73 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:63 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:75 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:65 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:77 msgid "To use the bridge, you need to start a chat with `@heisenbridge:example.com` (where `example.com` is your base domain, not the `matrix.` domain). If the bridge ignores you and a DM is not accepted then the owner setting may be wrong." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:67 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:79 msgid "Help is available for all commands with the `-h` switch." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:69 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:81 msgid "You can also learn the basics by watching [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:71 +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:83 msgid "If you encounter issues or feel lost you can join the project room at [#heisenbridge:vi.fi](https://matrix.to/#/#heisenbridge:vi.fi) for help." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:85 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:87 +msgid "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-heisenbridge`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-hookshot.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-hookshot.pot index 56b7da8a3..ca450b2c1 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-hookshot.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-hookshot.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,139 +16,139 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:1 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:11 msgid "Setting up matrix-hookshot (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:3 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:13 msgid "The playbook can install and configure [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:5 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:15 msgid "Hookshot can bridge [Webhooks](https://en.wikipedia.org/wiki/Webhook) from software project management services such as GitHub, GitLab, Jira, and Figma, as well as generic webhooks." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:7 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:17 msgid "See the project's [documentation](https://matrix-org.github.io/matrix-hookshot/latest/hookshot.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:9 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:19 msgid "**Note**: the playbook also supports [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md), which however was deprecated by its author." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:11 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:21 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:13 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:23 msgid "Download GitHub app private key (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:15 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:25 msgid "If you're setting up the GitHub bridge, you need to create your GitHub app, and generate a private key file of it." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:17 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:27 msgid "You need to download the private key file, if you will install the file manually or with the `aux` role. For details, see [the section below](#manage-github-private-key-with-aux-role)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:19 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:29 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:21 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:31 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `GITHUB_PRIVATE_KEY_HERE` with the one created [above](#download-github-app-private-key)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:35 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:45 msgid "For each of the services (GitHub, GitLab, Jira, Figma, and generic webhooks) fill in the respective variables `matrix_hookshot_service_*` listed in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) as required." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:37 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:47 msgid "Take special note of the `matrix_hookshot_*_enabled` variables. Services that need no further configuration are enabled by default (GitLab and generic webhooks), while you must first add the required configuration and enable the others (GitHub, Jira, and Figma)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:39 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:49 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:41 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:51 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:43 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:53 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:45 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:55 msgid "`roles/custom/matrix-bridge-hookshot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:46 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:56 msgid "`roles/custom/matrix-bridge-hookshot/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_hookshot_configuration_extension_yaml` and `matrix_hookshot_registration_extension_yaml` variables" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:48 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:58 msgid "Refer the [official instructions](https://matrix-org.github.io/matrix-hookshot/latest/setup.html) and the comments in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) to learn what the individual options do." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:50 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:60 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:52 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:62 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:59 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:69 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-service hookshot` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:61 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:71 msgid "`just install-service hookshot` is useful for maintaining your setup quickly 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 `just setup-all` runs the `ensure-matrix-users-created` tag too." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:63 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:73 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:65 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:75 msgid "To use the bridge, you need to create a room and invite the Hookshot bot (`@hookshot:example.com`) to it." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:67 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:77 msgid "Make sure the bot is able to send state events (usually the Moderator power level in clients)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:69 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:79 msgid "Send `!hookshot help` to the bot to see the available commands." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:71 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:81 msgid "Refer to [Hookshot's documentation](https://matrix-org.github.io/matrix-hookshot/latest/usage.html) for more details about using the bridge's various features." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:73 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:83 msgid "💡 **Note**: the different listeners are bound to certain paths which might differ from those assumed by the hookshot documentation. See [URLs for bridges setup](#urls-for-bridges-setup) below." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:75 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:85 msgid "Reset crypto store" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:77 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:87 msgid "Should the crypto store be corrupted, you can reset it by executing this Ansible playbook with the tag `reset-hookshot-encryption` added:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:83 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:93 msgid "More setup documentation" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:85 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:95 msgid "URLs for bridges setup" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:87 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:97 msgid "Unless indicated otherwise, the following endpoints are reachable on your `matrix.` subdomain (if the feature is enabled)." msgstr "" @@ -248,22 +248,6 @@ msgstr "" msgid "Figma" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:0 -msgid "provisioning" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:0 -msgid "`/hookshot/v1/`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:0 -msgid "`matrix_hookshot_provisioning_endpoint`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:0 -msgid "Dimension [provisioning](#provisioning-api)" -msgstr "" - #: ../../../docs/configuring-playbook-bridge-hookshot.md:0 msgid "appservice" msgstr "" @@ -296,114 +280,106 @@ msgstr "" msgid "Widgets" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:0 -msgid "metrics" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:0 -msgid "`/metrics/hookshot`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:0 -msgid "`matrix_hookshot_metrics_enabled` and exposure enabled via `matrix_hookshot_metrics_proxying_enabled` or `matrix_metrics_exposure_enabled`. Read more in the [Metrics section](#metrics) below." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:0 -msgid "Prometheus" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:101 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:109 msgid "Also see the various `matrix_hookshot_container_labels_*` variables in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml), which expose URLs publicly." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:103 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:111 msgid "The different listeners are also reachable *internally* in the docker-network via the container's name (configured by `matrix_hookshot_container_url`) and on different ports (e.g. `matrix_hookshot_appservice_port`). Read [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) in detail for more info." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:105 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:113 msgid "Manage GitHub Private Key with aux role" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:107 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:115 msgid "The GitHub bridge requires you to install a private key file. This can be done in multiple ways:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:109 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:117 msgid "copy the *contents* of the downloaded file and set the variable `matrix_hookshot_github_private_key` to the contents (see example in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml))." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:110 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:118 msgid "somehow copy the file to the path `{{ matrix_hookshot_base_path }}/{{ matrix_hookshot_github_private_key_file }}` (default: `/matrix/hookshot/private-key.pem`) on the server manually." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:111 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:119 msgid "use the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) to copy the file from an arbitrary path on your ansible client to the correct path on the server." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:113 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:121 msgid "To use the `aux` role, make sure the `matrix_hookshot_github_private_key` variable is empty. Then add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:124 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:132 msgid "For more information, see the documentation in the [default configuration of the aux role](https://github.com/mother-of-all-self-hosting/ansible-role-aux/blob/main/defaults/main.yml)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:126 -msgid "Provisioning API" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:128 -msgid "The provisioning API will be enabled automatically if you set `matrix_dimension_enabled: true` and provided a `matrix_hookshot_provisioning_secret`, unless you override it either way. To use hookshot with dimension, you will need to enter as \"Provisioning URL\": `http://matrix-hookshot:9002`, which is made up of the variables `matrix_hookshot_container_url` and `matrix_hookshot_provisioning_port`." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:130 -msgid "Metrics" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:132 -msgid "Metrics are **only enabled by default** if the builtin [Prometheus](configuring-playbook-prometheus-grafana.md) is enabled (by default, Prometheus isn't enabled). If so, metrics will automatically be collected by Prometheus and made available in Grafana. You will, however, need to set up your own Dashboard for displaying them." -msgstr "" - #: ../../../docs/configuring-playbook-bridge-hookshot.md:134 -msgid "To explicitly enable metrics, use `matrix_hookshot_metrics_enabled: true`. This only exposes metrics over the container network, however." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:136 -msgid "**To collect metrics from an external Prometheus server**, besides enabling metrics as described above, you will also need to enable metrics exposure on `https://matrix.example.com/metrics/hookshot` by:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:138 -msgid "either enabling metrics exposure for Hookshot via `matrix_hookshot_metrics_proxying_enabled: true`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:139 -msgid "or enabling metrics exposure for all services via `matrix_metrics_exposure_enabled: true`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:141 -msgid "Whichever one you go with, by default metrics are exposed publicly **without** password-protection. See [the Prometheus and Grafana docs](configuring-playbook-prometheus-grafana.md) for details about password-protection for metrics." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-hookshot.md:143 msgid "Collision with matrix-appservice-webhooks" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:145 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:136 msgid "If you are also running [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md), it reserves its namespace by the default setting `matrix_appservice_webhooks_user_prefix: '_webhook_'`. You should take care if you modify its or hookshot's prefix that they do not collide with each other's namespace (default `matrix_hookshot_generic_userIdPrefix: '_webhooks_'`)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:147 -msgid "Troubleshooting" +#: ../../../docs/configuring-playbook-bridge-hookshot.md:138 +msgid "Enable metrics" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:149 -msgid "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`." +#: ../../../docs/configuring-playbook-bridge-hookshot.md:140 +msgid "The playbook can enable and configure the metrics of the service for you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:142 +msgid "Metrics are **only enabled by default** if the builtin [Prometheus](configuring-playbook-prometheus-grafana.md) is enabled (by default, Prometheus isn't enabled). If so, metrics will automatically be collected by Prometheus and made available in Grafana. You will, however, need to set up your own Dashboard for displaying them." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:144 +msgid "To enable the metrics, add the following configuration to your `vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-bridge-hookshot.md:151 +msgid "**To collect metrics from an external Prometheus server**, besides enabling metrics as described above, you will also need to enable metrics exposure on `https://matrix.example.com/metrics/hookshot` by adding the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:157 +msgid "By default metrics are exposed publicly **without** password-protection. To password-protect the metrics with dedicated credentials, add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:164 +msgid "To `matrix_hookshot_container_labels_metrics_middleware_basic_auth_users`, set the Basic Authentication credentials (raw `htpasswd` file content) used to protect the endpoint. See https://doc.traefik.io/traefik/middlewares/http/basicauth/#users for details about it." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:166 +msgid "**Note**: alternatively, you can use `matrix_metrics_exposure_enabled` to expose all services on this `/metrics/*` feature, and you can use `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users` to password-protect the metrics of them. See [this section](configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) for more information." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:168 +msgid "Enable Grafana (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:170 +msgid "Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:172 +msgid "To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:174 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:176 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-hookshot.md:178 msgid "Increase logging verbosity" msgstr "" -#: ../../../docs/configuring-playbook-bridge-hookshot.md:153 +#: ../../../docs/configuring-playbook-bridge-hookshot.md:180 msgid "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:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-matrix-bridge-sms.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-matrix-bridge-sms.pot index 0e4992bdf..436461cd6 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-matrix-bridge-sms.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-matrix-bridge-sms.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,62 +16,78 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:1 +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:9 msgid "Setting up Matrix SMS bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:3 +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:11 msgid "The playbook can install and configure [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:5 +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:13 msgid "See the project's [documentation](https://github.com/benkuly/matrix-sms-bridge/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:7 +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:15 msgid "Prerequisite" msgstr "" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:9 +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:17 msgid "The bridge uses [android-sms-gateway-server](https://github.com/RebekkaMa/android-sms-gateway-server). You need to configure it first." msgstr "" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:11 +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:19 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:13 +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:21 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:36 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:38 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:43 +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:45 -msgid "**Notes**:" +msgid "There are some additional things you may wish to configure about the bridge." msgstr "" #: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:47 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." +msgid "Take a look at:" msgstr "" #: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:49 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgid "`roles/custom/matrix-bridge-sms/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_sms_bridge_configuration_extension_yaml` variable" msgstr "" #: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:51 -msgid "`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." +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:53 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:60 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:62 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:64 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:55 +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:66 msgid "Read the [user guide](https://github.com/benkuly/matrix-sms-bridge/blob/master/README.md#user-guide) to see how this bridge works." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:68 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:70 +msgid "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-sms-bridge`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bluesky.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bluesky.pot new file mode 100644 index 000000000..d5b869994 --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bluesky.pot @@ -0,0 +1,121 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:9 +msgid "Setting up Mautrix Bluesky bridging (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:11 +msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:13 +msgid "The playbook can install and configure [mautrix-bluesky](https://github.com/mautrix/bluesky) for you, which provides a bridge to [Bluesky](https://bsky.social/about)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:15 +msgid "See the project's [documentation](https://github.com/mautrix/bluesky/blob/master/README.md) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:17 +msgid "Prerequisite (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:19 +msgid "Enable Appservice Double Puppet" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:21 +msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:23 +msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:25 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:27 +msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:33 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:35 +msgid "There are some additional things you may wish to configure about the bridge." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:38 +msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:40 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:42 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:49 +msgid "**Notes**:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:51 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:53 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:55 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:57 +msgid "To use the bridge, you need to start a chat with `@blueskybot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:59 +msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/bluesky/authentication.html)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:61 +msgid "After logging in, the bridge will create portal rooms for recent chats. Portal rooms for other chats will be created as you receive messages." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:63 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:65 +msgid "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-bluesky`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:67 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bluesky.md:69 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bridges.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bridges.pot index b79c2ed2f..eb90332a1 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bridges.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bridges.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,284 +16,279 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:10 msgid "Setting up a Generic Mautrix Bridge (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:12 msgid "The playbook can install and configure various [mautrix](https://github.com/mautrix) bridges (twitter, discord, signal, googlechat, etc.), as well as many other (non-mautrix) bridges. This is a common guide for configuring mautrix bridges." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:14 msgid "The author of the bridges maintains [the official docs](https://docs.mau.fi/bridges/index.html), whose source code is available at [mautrix/docs](https://github.com/mautrix/docs) repository on GitHub. You may as well to refer it while configuring them." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:16 msgid "You can see each bridge's features on the `ROADMAP.md` file in its corresponding mautrix repository." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:18 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:20 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:18 -msgid "**Note**: for bridging to Meta's Messenger or Instagram, you would need to add `meta` with an underscore symbol (`_`) or hyphen (`-`) based on the context as prefix to each `SERVICENAME`; add `_` to variables (as in `matrix_mautrix_meta_messenger_configuration_extension_yaml` for example) and `-` to paths of the configuration files (as in `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2`), respectively. **`matrix_mautrix_facebook_*` and `matrix_mautrix_instagram_*` variables belong to the deprecated components and do not control the new bridge** ([mautrix-meta](https://github.com/mautrix/meta)), which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md)." +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:27 +msgid "**Note**: for bridging to Meta's Messenger or Instagram, you would need to add `meta` with an underscore symbol (`_`) or hyphen (`-`) based on the context as prefix to each `SERVICENAME`; add `_` to variables (as in `matrix_mautrix_meta_messenger_configuration_extension_yaml` for example) and `-` to paths of the configuration files (as in `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2`), respectively. **`matrix_mautrix_facebook_*` and `matrix_mautrix_instagram_*` variables belong to the deprecated components and do not control the new bridge** ([mautrix-meta](https://github.com/mautrix/meta)), which can be [installed using this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:20 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:29 msgid "There are some additional things you may wish to configure about the bridge before you continue. Each bridge may have additional requirements besides `_enabled: true`. For example, the mautrix-telegram bridge (our documentation page about it is [here](configuring-playbook-bridge-mautrix-telegram.md)) requires the `matrix_mautrix_telegram_api_id` and `matrix_mautrix_telegram_api_hash` variables to be defined. Refer to each bridge's individual documentation page for details about enabling bridges." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:22 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:31 msgid "Configure bridge permissions (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:24 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:33 msgid "By default any user on your homeserver will be able to use the mautrix bridges. To limit who can use them you would need to configure their permissions settings." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:26 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:35 msgid "Different levels of permission can be granted to users. For example, to **configure a user as an administrator for all bridges**, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:32 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:41 msgid "If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin: @alice:example.com`), then there's no admin by default." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:34 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:43 msgid "**Alternatively** (more verbose, but allows multiple admins to be configured), you can do the same on a per-bridge basis with:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:43 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:52 msgid "This will add the admin permission to the specific user, while keeping the default permissions." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:45 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:54 msgid "You could also redefine the default permissions settings completely, rather than adding extra permissions. You may wish to look at `roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` to find information on the permission settings and other options you would like to configure." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:47 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:56 msgid "Enable encryption (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:49 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:58 msgid "[Encryption (End-to-Bridge Encryption, E2BE) support](https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html) is off by default. If you would like to enable encryption, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:51 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:60 msgid "**for all bridges with encryption support**:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:58 -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:77 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:67 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:86 msgid "**Alternatively**, for a specific bridge:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:65 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:74 msgid "Enable relay mode (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:67 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:76 msgid "[Relay mode](https://docs.mau.fi/bridges/general/relay-mode.html) is off by default. Check [the table on the official documentation](https://docs.mau.fi/bridges/general/relay-mode.html#support-table) for bridges which support relay mode." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:69 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:78 msgid "If you would like to enable it, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:71 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:80 msgid "**for all bridges with relay mode support**:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:86 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:95 msgid "You can only have one `matrix_mautrix_SERVICENAME_configuration_extension_yaml` definition in `vars.yml` per bridge, so if you need multiple pieces of configuration there, just merge them like this:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:100 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:109 msgid "If you want to activate the relaybot in a room, send `!prefix set-relay` in the rooms where you want to use the bot (replace `!prefix` with the appropriate command prefix for the bridge, like `!signal` or `!wa`). To deactivate, send `!prefix unset-relay`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:102 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:111 msgid "Use `!prefix set-pl 100` to be able for the bot to modify room settings and invite others." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:104 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:113 msgid "Allow anyone on the homeserver to become a relay user (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:106 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:115 msgid "By default, only admins are allowed to set themselves as relay users. To allow anyone on your homeserver to set themselves as relay users, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:112 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:121 msgid "Set the bot's username (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:114 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:123 msgid "To set the bot's username, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:120 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:129 msgid "Configure the logging level (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:122 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:131 msgid "To specify the logging level, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:128 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:137 msgid "Replace `warn` with one of the following to control the verbosity of the logs generated: `trace`, `debug`, `info`, `warn`, `error` or `fatal`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:130 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:139 msgid "If you have issues with a service, and are requesting support, the higher levels of logging (those that appear earlier in the list, like `trace`) will generally be more helpful." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:132 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:141 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:134 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:143 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:136 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:145 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:138 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:147 msgid "`roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:139 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:148 msgid "`roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_mautrix_SERVICENAME_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:141 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:150 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:143 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:152 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:150 -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:190 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:152 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:154 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:159 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:156 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:161 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:158 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:163 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:160 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:165 msgid "To use the bridge, you need to start a chat with `@SERVICENAMEbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:162 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:167 msgid "For details about the next steps, refer to each bridge's individual documentation page." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:164 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:169 msgid "Send `help` to the bot to see the available commands." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:166 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:171 msgid "If you run into trouble, check the [Troubleshooting](#troubleshooting) section below." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:168 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:173 msgid "Set up Double Puppeting (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:170 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:175 msgid "After successfully enabling bridging, you may wish to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:172 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:177 msgid "To set it up, you have 2 ways of going about it." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:174 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:179 msgid "Method 1: automatically, by enabling Appservice Double Puppet (recommended)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:176 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:181 msgid "To set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html), you could enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:178 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:183 msgid "Appservice Double Puppet is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:180 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:185 msgid "To enable the Appservice Double Puppet service, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:186 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:191 msgid "When enabled, double puppeting will automatically be enabled for all bridges that support double puppeting via the appservice method." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:188 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:193 msgid "This is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:192 -msgid "Previously there were multiple different automatic double puppeting methods like one with the help of the [Shared Secret Auth password provider module](./configuring-playbook-shared-secret-auth.md), but they have been superseded by this Appservice Double Puppet method. Double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future as the older methods were completely removed in the megabridge rewrites on [the upstream project](https://docs.mau.fi/bridges/general/double-puppeting.html#automatically)." -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:195 -msgid "Some bridges like [the deprecated Facebook mautrix bridge](configuring-playbook-bridge-mautrix-facebook.md) and [matrix-appservice-kakaotalk](configuring-playbook-bridge-appservice-kakaotalk.md), which is partially based on the Facebook bridge, are compatible with the Shared Secret Auth service only. These bridges automatically perform Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook." +msgid "**Notes**:" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:197 +msgid "Previously there were multiple different automatic double puppeting methods like one with the help of the [Shared Secret Auth password provider module](./configuring-playbook-shared-secret-auth.md), but they have been superseded by this Appservice Double Puppet method. Double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future as the older methods were completely removed in the megabridge rewrites on [the upstream project](https://docs.mau.fi/bridges/general/double-puppeting.html#automatically)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:200 +msgid "Some bridges like [the deprecated Facebook mautrix bridge](configuring-playbook-bridge-mautrix-facebook.md) and [matrix-appservice-kakaotalk](configuring-playbook-bridge-appservice-kakaotalk.md), which is partially based on the Facebook bridge, are compatible with the Shared Secret Auth service only. These bridges automatically perform Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:202 msgid "Method 2: manually, by asking each user to provide a working access token" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:199 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:204 msgid "When using this method, **each user** that wishes to enable Double Puppeting needs to follow the following steps:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:201 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:206 msgid "retrieve a Matrix access token for yourself. Refer to the documentation on [how to obtain one](obtaining-access-tokens.md)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:203 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:208 msgid "send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:205 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:210 msgid "make sure you don't log out the session for which you obtained an access token some time in the future, as that would break the Double Puppeting feature" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:207 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:212 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:209 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:214 msgid "For troubleshooting information with a specific bridge, please see the playbook documentation about it (some other document in in `docs/`) and the upstream ([mautrix](https://github.com/mautrix)) bridge documentation for that specific bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:211 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:216 msgid "If the bridge's bot doesn't accept the invite to a chat, refer [the official troubleshooting page](https://docs.mau.fi/bridges/general/troubleshooting.html) as well." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:213 +#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:218 msgid "If you found bugs in mautrix bridges, they should be reported to the upstream project, in the corresponding mautrix repository, not to us." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-discord.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-discord.pot index a404f37a0..adad88771 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-discord.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-discord.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,134 +16,142 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:13 msgid "Setting up Mautrix Discord bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:15 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:5 -msgid "**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridges supported by the playbook." +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:17 +msgid "**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridge supported by the playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:6 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:18 msgid "For using as a Bot we recommend the [Appservice Discord](configuring-playbook-bridge-appservice-discord.md), because it supports plumbing." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:19 msgid "For personal use with a discord account we recommend the `mautrix-discord` bridge (the one being discussed here), because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:21 msgid "The playbook can install and configure [mautrix-discord](https://github.com/mautrix/discord) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:23 msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/discord/index.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:25 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:27 msgid "There are 2 ways to login to discord using this bridge, either by [scanning a QR code](#method-1-login-using-qr-code-recommended) using the Discord mobile app **or** by using a [Discord token](#method-2-login-using-discord-token-not-recommended)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:17 -msgid "If this is a dealbreaker for you, consider using one of the other Discord bridges supported by the playbook: [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) or [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md). These come with their own complexity and limitations, however, so we recommend that you proceed with this one if possible." +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:29 +msgid "If this is a dealbreaker for you, consider using [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md). This comes with its own complexity and limitations, however, so we recommend that you proceed with this one if possible." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:31 msgid "Enable Appservice Double Puppet or Shared Secret Auth (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:21 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:33 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:23 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:35 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:25 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:37 msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:39 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:29 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:41 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:35 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:47 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:37 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:49 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:40 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:52 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:42 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:54 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:44 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:56 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:51 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:53 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:55 +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:63 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:57 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:59 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:61 -msgid "To use the bridge, you need to start a chat with `@discordbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:63 -msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/discord/authentication.html)." -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:65 -msgid "After logging in, the bridge will create portal rooms for some recent direct messages." +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:67 -msgid "Bridge guilds" +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:69 -msgid "If you'd like to bridge guilds, send `guilds status` to see the list of guilds, then send `guilds bridge GUILD_ID_HERE` for each guild that you'd like bridged. Make sure to replace `GUILD_ID_HERE` with the guild's ID." +msgid "To use the bridge, you need to start a chat with `@discordbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:71 -msgid "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." +msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/discord/authentication.html)." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:73 +msgid "After logging in, the bridge will create portal rooms for some recent direct messages." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:75 +msgid "Bridge guilds" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:77 +msgid "If you'd like to bridge guilds, send `guilds status` to see the list of guilds, then send `guilds bridge GUILD_ID_HERE` for each guild that you'd like bridged. Make sure to replace `GUILD_ID_HERE` with the guild's ID." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:79 +msgid "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." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:81 msgid "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." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:83 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:85 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:87 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-discord.md:89 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-facebook.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-facebook.pot index 53424a6d9..a4c6c74d4 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-facebook.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-facebook.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,142 +16,146 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:13 msgid "Setting up Mautrix Facebook bridging (optional, deprecated)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:15 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:5 -msgid "**Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md). Consider using that bridge instead of this one." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:7 -msgid "The playbook can install and configure [mautrix-facebook](https://github.com/mautrix/facebook) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:9 -msgid "See the project's [documentation](https://github.com/mautrix/facebook/blob/master/README.md) to learn what it does and why it might be useful to you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:11 -msgid "Prerequisite (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:13 -msgid "Enable Shared Secret Auth" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:15 -msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook." -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:17 -msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." +msgid "**Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be [installed using this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md). Consider using that bridge instead of this one." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:19 -msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." +msgid "The playbook can install and configure [mautrix-facebook](https://github.com/mautrix/facebook) for you." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:21 -msgid "Adjusting the playbook configuration" +msgid "See the project's [documentation](https://github.com/mautrix/facebook/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:23 -msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgid "Prerequisite (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:25 +msgid "Enable Shared Secret Auth" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:27 +msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:29 -msgid "Extending the configuration" +msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:31 -msgid "There are some additional things you may wish to configure about the bridge." +msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:33 -msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." +msgid "Adjusting the playbook configuration" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:35 +msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:41 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:43 +msgid "There are some additional things you may wish to configure about the bridge." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:45 +msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:47 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:37 +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:49 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:44 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:46 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:48 +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:56 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:50 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:52 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:54 -msgid "To use the bridge, you need to start a chat with `@facebookbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:56 -msgid "You then need to send `login YOUR_FACEBOOK_EMAIL_ADDRESS` to the bridge bot to enable bridging for your Facebook Messenger account." -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:58 -msgid "If you run into trouble, check the [Troubleshooting](#troubleshooting) section below." +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:60 -msgid "Troubleshooting" +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:62 -msgid "Facebook rejecting login attempts and forcing you to change password" +msgid "To use the bridge, you need to start a chat with `@facebookbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:64 -msgid "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." +msgid "You then need to send `login YOUR_FACEBOOK_EMAIL_ADDRESS` to the bridge bot to enable bridging for your Facebook Messenger account." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:66 -msgid "If you happen to run into this problem while [setting up bridging](#usage), try to first get a successful session up by logging in to Facebook through the Matrix server's IP address." +msgid "If you run into trouble, check the [Troubleshooting](#troubleshooting) section below." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:68 -msgid "The easiest way to do this may be to use [sshuttle](https://sshuttle.readthedocs.io/) to proxy your traffic through the Matrix server." +msgid "Troubleshooting" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:70 -msgid "Example command for proxying your traffic through the Matrix server:" +msgid "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`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:76 -msgid "Once connected, you should be able to verify that you're browsing the web through the Matrix server's IP by checking [icanhazip](https://icanhazip.com/)." +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:72 +msgid "Increase logging verbosity" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:78 -msgid "Then proceed to log in to [Facebook/Messenger](https://www.facebook.com/)." +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:74 +msgid "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:" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:80 -msgid "Once logged in, proceed to [set up bridging](#usage)." +msgid "Facebook rejecting login attempts and forcing you to change password" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:82 +msgid "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." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:84 +msgid "If you happen to run into this problem while [setting up bridging](#usage), try to first get a successful session up by logging in to Facebook through the Matrix server's IP address." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:86 +msgid "The easiest way to do this may be to use [sshuttle](https://sshuttle.readthedocs.io/) to proxy your traffic through the Matrix server." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:88 +msgid "Example command for proxying your traffic through the Matrix server:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:94 +msgid "Once connected, you should be able to verify that you're browsing the web through the Matrix server's IP by checking [icanhazip](https://icanhazip.com/)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:96 +msgid "Then proceed to log in to [Facebook/Messenger](https://www.facebook.com/)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:98 +msgid "Once logged in, proceed to [set up bridging](#usage)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-facebook.md:100 msgid "If that doesn't work, enable 2FA (see: [Facebook help page on enabling 2FA](https://www.facebook.com/help/148233965247823)) and try to login again with a new password, and entering the 2FA code when prompted, it may take more then one try, in between attempts, check facebook.com to see if they are requiring another password change" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-gmessages.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-gmessages.pot index 21b6221ac..2bd57ccaf 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-gmessages.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-gmessages.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,94 +16,102 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:9 msgid "Setting up Mautrix Google Messages bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:11 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:13 msgid "The playbook can install and configure [mautrix-gmessages](https://github.com/mautrix/gmessages) for you, for bridging to [Google Messages](https://messages.google.com/)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:15 msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/gmessages/index.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:17 msgid "Prerequisite (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:19 msgid "Enable Appservice Double Puppet" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:21 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:23 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:25 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:27 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:25 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:33 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:35 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:30 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:38 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:32 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:40 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:34 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:42 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:41 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:43 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:45 +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:49 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:47 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:49 -msgid "Usage" -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:51 -msgid "To use the bridge, you need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:53 -msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/gmessages/authentication.html)." +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:55 +msgid "To use the bridge, you need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:57 +msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/gmessages/authentication.html)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:59 msgid "After logging in, the bridge will create portal rooms for recent chats." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:61 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:63 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:65 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-gmessages.md:67 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-googlechat.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-googlechat.pot index 5cc62b1ca..81f184b0a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-googlechat.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-googlechat.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,98 +16,106 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:10 msgid "Setting up Mautrix Google Chat bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:12 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:14 msgid "The playbook can install and configure [mautrix-googlechat](https://github.com/mautrix/googlechat) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:16 msgid "See the project's [documentation](https://docs.mau.fi/bridges/python/googlechat/index.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:18 msgid "Prerequisite (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:20 msgid "Enable Appservice Double Puppet or Shared Secret Auth" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:22 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:24 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:26 msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:28 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:21 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:30 msgid "To enable the [Google Chat](https://chat.google.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:36 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:29 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:38 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:32 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:41 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:34 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:43 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:36 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:45 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:43 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:45 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:47 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:52 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:49 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:54 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:51 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:56 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:53 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:58 msgid "To use the bridge, you need to start a chat with `@googlechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:55 +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:60 msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/googlechat/authentication.html)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:57 -msgid "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." +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:62 +msgid "After logging in, the bridge will create portal rooms for recent chats. Portal rooms for other chats will be created as you receive messages." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:64 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:66 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:68 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-googlechat.md:70 +msgid "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:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-hangouts.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-hangouts.pot index 72ed5d3ac..1a364cdb8 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-hangouts.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-hangouts.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,102 +16,22 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:1 -msgid "Setting up Mautrix Hangouts bridging (optional, deprecated)" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:3 -msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:5 -msgid "💡 **Note**: This bridge has been deprecated in favor of [Google Chat bridge](https://github.com/mautrix/googlechat), which can be installed using [this playbook](configuring-playbook-bridge-mautrix-googlechat.md). Installing the mautrix-hangouts bridge is **no longer possible**. For now, this documentation page remains here for historical purposes." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:7 -msgid "The playbook can install and configure [mautrix-hangouts](https://github.com/mautrix/hangouts) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:9 -msgid "Prerequisite (optional)" -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:11 -msgid "Enable Shared Secret Auth" +msgid "Setting up Mautrix Hangouts bridging (optional, removed)" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:13 -msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook." +msgid "🪦 The playbook used to be able to install and configure [mautrix-hangouts](https://github.com/mautrix/hangouts), but no longer includes this component, because Google Hangouts has been discontinued since the 1st of November 2022." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:15 -msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." +msgid "You may wish to use the [Google Chat bridge](https://github.com/mautrix/googlechat) instead." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:17 -msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." +msgid "Uninstalling the bridge manually" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:19 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:21 -msgid "To enable the [Google Hangouts](https://hangouts.google.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:27 -msgid "Extending the configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:29 -msgid "There are some additional things you may wish to configure about the bridge." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:31 -msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:33 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:35 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:42 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:44 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:46 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:48 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:50 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:52 -msgid "To use the bridge, you need to start a chat with `@hangoutsbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:54 -msgid "You then need to send `login` to the bridge bot to receive a link to the portal from which you can enable the bridging. Open the link sent by the bot and follow the instructions." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:56 -msgid "Automatic login may not work. If it does not, reload the page and select the \"Manual login\" checkbox before starting. Manual login involves logging into your Google account normally and then manually getting the OAuth token from browser cookies with developer tools." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-hangouts.md:58 -msgid "Once logged in, recent chats should show up as new conversations automatically. Other chats will get portals as you receive messages." +msgid "If you still have the Hangouts bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-instagram.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-instagram.pot index eba944ee2..38e17784d 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-instagram.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-instagram.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,78 +16,86 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:10 msgid "Setting up Mautrix Instagram bridging (optional, deprecated)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:12 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:5 -msgid "**Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-instagram.md). Consider using that bridge instead of this one." +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:14 +msgid "**Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be [installed using this playbook](configuring-playbook-bridge-mautrix-meta-instagram.md). Consider using that bridge instead of this one." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:16 msgid "The playbook can install and configure [mautrix-instagram](https://github.com/mautrix/instagram) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:18 msgid "See the project's [documentation](https://github.com/mautrix/instagram/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:20 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:22 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:28 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:21 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:30 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:23 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:32 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:25 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:34 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:36 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:34 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:36 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:38 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:43 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:40 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:45 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:42 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:47 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:44 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:49 msgid "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)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:46 +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:51 msgid "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." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:53 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:55 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:57 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-instagram.md:59 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-instagram.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-instagram.pot index cb04ef1d1..66c537121 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-instagram.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-instagram.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,130 +16,138 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:8 msgid "Setting up Instagram bridging via Mautrix Meta (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:10 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:12 msgid "The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:14 msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/meta/index.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:16 msgid "Since this bridge component can bridge to both [Messenger](https://messenger.com/) and [Instagram](https://instagram.com/) and you may wish to do both at the same time, the playbook makes it available via 2 different Ansible roles (`matrix-bridge-mautrix-meta-messenger` and `matrix-bridge-mautrix-meta-instagram`). The latter is a reconfigured copy of the first one (created by `just rebuild-mautrix-meta-instagram` and `bin/rebuild-mautrix-meta-instagram.sh`)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:18 msgid "This documentation page only deals with the bridge's ability to bridge to Instagram. For bridging to Facebook/Messenger, see [Setting up Messenger bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-messenger.md)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:20 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:22 msgid "Migrating from the old mautrix-instagram bridge" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:24 msgid "If you've been using the [mautrix-instagram](./configuring-playbook-bridge-mautrix-instagram.md) bridge, **you'd better get rid of it first** or the 2 bridges will be in conflict:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:26 msgid "both trying to use `@instagrambot:example.com` as their username. This conflict may be resolved by adjusting `matrix_mautrix_instagram_appservice_bot_username` or `matrix_mautrix_meta_instagram_appservice_username`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:20 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:27 msgid "both trying to bridge the same DMs" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:22 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:29 msgid "To do so, send a `clean-rooms` command to the management room with the old bridge bot (`@instagrambot:example.com`). It gives you a list of portals and groups of portals you may purge. Proceed with sending commands like `clean recommended`, etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:24 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:31 msgid "Then, consider disabling the old bridge in your configuration, so it won't recreate the portals when you receive new messages." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:26 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:33 msgid "Enable Appservice Double Puppet (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:28 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:35 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:30 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:37 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:32 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:39 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:34 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:41 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:40 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:47 msgid "Before proceeding to [re-running the playbook](./installing.md), you may wish to adjust the configuration further. See below." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:42 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:49 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:44 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:51 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:46 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:53 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:48 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:55 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:50 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:57 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:57 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:59 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:61 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:64 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:63 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:66 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:65 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:68 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:67 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:70 msgid "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)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:69 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:72 msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:71 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:74 msgid "After logging in, the bridge will sync recent chats." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:76 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:78 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:80 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:82 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-messenger.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-messenger.pot index e92f38ec6..00f47e0c2 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-messenger.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-messenger.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,162 +16,170 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:9 msgid "Setting up Messenger bridging via Mautrix Meta (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:11 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:13 msgid "The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:15 msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/meta/index.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:17 msgid "Since this bridge component can bridge to both [Messenger](https://messenger.com/) and [Instagram](https://instagram.com/) and you may wish to do both at the same time, the playbook makes it available via 2 different Ansible roles (`matrix-bridge-mautrix-meta-messenger` and `matrix-bridge-mautrix-meta-instagram`). The latter is a reconfigured copy of the first one (created by `just rebuild-mautrix-meta-instagram` and `bin/rebuild-mautrix-meta-instagram.sh`)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:19 msgid "This documentation page only deals with the bridge's ability to bridge to Facebook Messenger. For bridging to Instagram, see [Setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:21 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:23 msgid "Migrating from the old mautrix-facebook bridge" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:25 msgid "If you've been using the [mautrix-facebook](./configuring-playbook-bridge-mautrix-facebook.md) bridge, it's possible to migrate the database using [instructions from the bridge documentation](https://docs.mau.fi/bridges/go/meta/facebook-migration.html) (advanced)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:27 msgid "Then you may wish to get rid of the Facebook bridge. To do so, send a `clean-rooms` command to the management room with the old bridge bot (`@facebookbot:example.com`). It gives you a list of portals and groups of portals you may purge. Proceed with sending commands like `clean recommended`, etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:21 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:29 msgid "Then, consider disabling the old bridge in your configuration, so it won't recreate the portals when you receive new messages." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:23 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:31 msgid "**Note**: the user ID of the new bridge bot is `@messengerbot:example.com`, not `@facebookbot:example.com`. After disabling the old bridge, its bot user will stop responding to a command." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:25 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:33 msgid "Enable Appservice Double Puppet (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:35 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:29 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:37 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:31 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:39 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:33 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:41 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:39 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:47 msgid "Before proceeding to [re-running the playbook](./installing.md), you may wish to adjust the configuration further. See below." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:41 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:49 msgid "Bridge mode" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:43 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:51 msgid "As mentioned above, the [mautrix-meta](https://github.com/mautrix/meta) bridge supports multiple modes of operation." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:45 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:53 msgid "The bridge can pull your Messenger messages via 3 different methods:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:47 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:55 msgid "(`facebook`) Facebook via `facebook.com`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:48 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:56 msgid "(`facebook-tor`) Facebook via `facebookwkhpilnemxj7asaniu7vnjjbiltxjqhye3mhbshg7kx5tfyd.onion` ([Tor](https://www.torproject.org/)) — does not currently proxy media downloads" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:49 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:57 msgid "(default) (`messenger`) Messenger via `messenger.com` — usable even without a Facebook account" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:51 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:59 msgid "You may switch the mode via the `matrix_mautrix_meta_messenger_meta_mode` variable. The playbook defaults to the `messenger` mode, because it's most universal (every Facebook user has a Messenger account, but the opposite is not true)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:53 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:61 msgid "Note that switching the mode (especially between `facebook*` and `messenger`) will intentionally make the bridge use another database (`matrix_mautrix_meta_facebook` or `matrix_mautrix_meta_messenger`) to isolate the 2 instances. Switching between Tor and non-Tor may be possible without dataloss, but your mileage may vary. Before switching to a new mode, you may wish to de-configure the old one (send `help` to the bridge bot and unbridge your portals, etc.)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:55 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:63 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:57 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:65 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:59 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:67 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:61 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:69 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:63 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:71 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:70 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:72 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:74 +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:78 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:76 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:78 -msgid "Usage" -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:80 -msgid "To use the bridge, you need to start a chat with `@messengerbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). Note that the user ID of the bridge's bot is not `@facebookbot:example.com`." +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:82 -msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html)." +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:84 -msgid "After logging in, the bridge will sync recent chats." +msgid "To use the bridge, you need to start a chat with `@messengerbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). Note that the user ID of the bridge's bot is not `@facebookbot:example.com`." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:86 +msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/meta/authentication.html)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:88 +msgid "After logging in, the bridge will sync recent chats." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:90 msgid "**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." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:92 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:94 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:96 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:98 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-signal.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-signal.pot index 3bf4fdb89..e52354fa2 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-signal.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-signal.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,110 +16,118 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:17 msgid "Setting up Mautrix Signal bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:19 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:21 msgid "The playbook can install and configure [mautrix-signal](https://github.com/mautrix/signal) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:23 msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/signal/index.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:25 msgid "Prerequisites (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:27 msgid "Prepare Postgres database on external Postgres server" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:29 msgid "If you're running with the Postgres database server integrated by the playbook (which is the default), you don't need to do anything special and can easily proceed with installing." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:31 msgid "However, if you're [using an external Postgres server](configuring-playbook-external-postgres.md), you'd need to manually prepare a Postgres database for this bridge and adjust the variables related to that (`matrix_mautrix_signal_database_*`)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:33 msgid "Enable Appservice Double Puppet" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:35 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:21 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:37 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:23 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:39 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:25 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:41 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:31 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:47 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:33 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:49 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:35 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:51 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:37 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:53 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:39 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:55 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:46 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:48 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:50 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:62 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:52 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:64 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:54 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:66 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:56 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:68 msgid "To use the bridge, you need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:58 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:70 msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/signal/authentication.html)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:60 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:72 msgid "After logging in, the bridge will bridge chats as you receive messages." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:62 +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:74 msgid "**Note**: Signal does not support any kind of message history (even on official apps), so the bridge won't backfill any messages." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:76 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:78 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:80 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:82 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-slack.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-slack.pot index 5bbbe9d63..8467b902b 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-slack.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-slack.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,118 +16,126 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:10 msgid "Setting up Mautrix Slack bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:12 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:5 -msgid "**Note**: bridging to [Slack](https://slack.com/) can also happen via the [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) and [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridges supported by the playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:6 -msgid "For using as a Bot we recommend the [Appservice Slack](configuring-playbook-bridge-appservice-slack.md), because it supports plumbing. Note that it is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:7 -msgid "For personal use with a slack account we recommend the `mautrix-slack` bridge (the one being discussed here), because it is the most fully-featured and stable of the 3 Slack bridges supported by the playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:9 -msgid "The playbook can install and configure [mautrix-slack](https://github.com/mautrix/slack) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:11 -msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/slack/index.html) to learn what it does and why it might be useful to you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:13 -msgid "See the [features and roadmap](https://github.com/mautrix/slack/blob/main/ROADMAP.md) for more information." +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:14 +msgid "**Note**: bridging to [Slack](https://slack.com/) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridge supported by the playbook." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:15 +msgid "For using as a Bot we recommend the [Appservice Slack](configuring-playbook-bridge-appservice-slack.md), because it supports plumbing. Note that it is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:16 +msgid "For personal use with a slack account we recommend the `mautrix-slack` bridge (the one being discussed here), because it is the most fully-featured and stable of the 3 Slack bridges supported by the playbook." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:18 +msgid "The playbook can install and configure [mautrix-slack](https://github.com/mautrix/slack) for you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:20 +msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/slack/index.html) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:22 +msgid "See the [features and roadmap](https://github.com/mautrix/slack/blob/main/ROADMAP.md) for more information." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:24 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:26 msgid "For using this bridge, you would need to authenticate by **providing your username and password** (legacy) or by using a **token login**. See more information in the [docs](https://docs.mau.fi/bridges/go/slack/authentication.html)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:28 msgid "Note that neither of these methods are officially supported by Slack. [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) uses a Slack bot account which is the only officially supported method for bridging a Slack channel." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:21 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:30 msgid "Enable Appservice Double Puppet (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:23 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:32 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:25 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:34 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:36 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:29 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:38 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:35 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:44 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:37 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:46 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:40 -msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:48 +msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:42 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:50 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:44 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:52 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:51 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:53 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:55 +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:59 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:57 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:59 -msgid "Usage" -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:61 -msgid "To use the bridge, you need to start a chat with `@slackbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:63 -msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/slack/authentication.html)." +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:65 +msgid "To use the bridge, you need to start a chat with `@slackbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:67 +msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/slack/authentication.html)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:69 msgid "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." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:71 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:73 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:75 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-slack.md:77 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-telegram.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-telegram.pot index f289a25b7..633765ccb 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-telegram.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-telegram.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,143 +16,154 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:14 msgid "Setting up Mautrix Telegram bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:16 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:18 msgid "The playbook can install and configure [mautrix-telegram](https://github.com/mautrix/telegram) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:20 msgid "See the project's [documentation](https://docs.mau.fi/bridges/python/telegram/index.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:22 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:24 msgid "Obtain a Telegram API key" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:26 msgid "To use the bridge, you'd need to obtain an API key from [https://my.telegram.org/apps](https://my.telegram.org/apps)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:28 msgid "Enable Appservice Double Puppet or Shared Secret Auth (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:30 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:32 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:21 -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:81 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:34 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:23 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:36 msgid "Double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:25 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:38 msgid "If you decided to enable Double Puppeting manually, send `login-matrix` to the bot in order to receive an instruction about how to send an access token to it." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:40 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:29 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:42 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `YOUR_TELEGRAM_APP_ID` and `YOUR_TELEGRAM_API_HASH`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:37 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:50 msgid "Relaying" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:39 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:52 msgid "Enable relay-bot (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:41 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:54 msgid "If you want to use the relay-bot feature ([relay bot documentation](https://docs.mau.fi/bridges/python/telegram/relay-bot.html)), which allows anonymous user to chat with telegram users, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:51 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:64 msgid "Configure a user as an administrator of the bridge (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:53 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:66 msgid "You might also want to give permissions to a user to administrate the bot. See [this section](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional) on the common guide for details about it." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:55 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:68 msgid "More details about permissions in this example: https://github.com/mautrix/telegram/blob/master/mautrix_telegram/example-config.yaml#L410" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:57 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:70 msgid "Use the bridge for direct chats only (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:59 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:72 msgid "If you want to exclude all groups from syncing and use the Telegram-Bridge only for direct chats, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:65 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:78 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:67 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:80 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:70 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:83 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:72 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:85 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:74 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:87 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:83 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:85 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:94 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:87 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:96 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:89 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:98 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:91 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:100 msgid "To use the bridge, you need to start a chat with `@telegrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:93 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:102 msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/telegram/authentication.html)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:95 +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:104 msgid "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." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:106 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:108 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:110 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-telegram.md:112 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-twitter.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-twitter.pot index cf12fbbf1..49938a922 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-twitter.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-twitter.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,98 +16,102 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:10 msgid "Setting up Mautrix Twitter bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:12 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:5 -msgid "**Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) bridge supported by the playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:14 msgid "The playbook can install and configure [mautrix-twitter](https://github.com/mautrix/twitter) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:16 msgid "See the project's [documentation](https://github.com/mautrix/twitter/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:18 msgid "Prerequisite (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:20 msgid "Enable Appservice Double Puppet" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:22 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:24 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:26 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:21 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:28 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:34 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:29 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:36 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:32 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:39 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:34 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:41 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:36 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:43 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:43 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:45 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:47 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:50 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:49 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:52 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:51 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:54 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:53 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:56 msgid "To use the bridge, you need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:55 +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:58 msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/twitter/authentication.html)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:57 -msgid "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." +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:60 +msgid "After logging in, the bridge will create portal rooms for recent chats. Portal rooms for other chats will be created as you receive messages." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:62 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:64 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:66 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-twitter.md:68 +msgid "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:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-whatsapp.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-whatsapp.pot index 5ad331ed5..cf93bbe15 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-whatsapp.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-whatsapp.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,102 +16,110 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:14 msgid "Setting up Mautrix Whatsapp bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:16 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:18 msgid "The playbook can install and configure [mautrix-whatsapp](https://github.com/mautrix/whatsapp) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:20 msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/whatsapp/index.html) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:22 msgid "Prerequisite (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:24 msgid "Enable Appservice Double Puppet or Shared Secret Auth" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:26 msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service for this playbook." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:28 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:30 msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:19 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:32 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:21 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:34 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:27 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:40 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:29 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:42 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:31 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:44 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:33 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:46 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:35 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:48 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:42 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:44 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:46 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:55 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:48 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:57 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:50 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:59 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:52 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:61 msgid "To use the bridge, you need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:54 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:63 msgid "You can then follow instructions on the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/go/whatsapp/authentication.html)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:56 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:65 msgid "Approximately in a minute after logging in, the bridge will create portal rooms for recent chats." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:58 +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:67 msgid "**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." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:69 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:71 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:73 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-whatsapp.md:75 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-wsproxy.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-wsproxy.pot index bcd9a5179..091a2421f 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-wsproxy.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-wsproxy.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,102 +16,102 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:1 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:9 msgid "Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:3 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:11 msgid "Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:5 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:13 msgid "The playbook can install and configure [mautrix-wsproxy](https://github.com/mautrix/wsproxy) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:7 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:15 msgid "See the project's [documentation](https://github.com/mautrix/wsproxy/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:9 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:17 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:11 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:19 msgid "By default, this playbook installs wsproxy on the `wsproxy.` subdomain (`wsproxy.example.com`) and requires you to create a CNAME record for `wsproxy`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:13 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:21 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:15 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:23 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:17 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:25 msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:29 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:37 msgid "Note that the tokens must match what is compiled into the [mautrix-imessage](https://github.com/mautrix/imessage) bridge running on your Mac or Android device." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:31 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:39 msgid "Adjusting the wsproxy URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:33 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:41 msgid "By tweaking the `matrix_mautrix_wsproxy_hostname` variable, you can easily make the service available at a **different hostname** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:35 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:43 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:42 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:50 msgid "After changing the domain, **you may need to adjust your DNS** records to point the wsproxy domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:44 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:52 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:46 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:54 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:48 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:56 msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:50 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:58 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:52 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:60 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:59 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:61 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:63 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:67 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:65 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:69 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:67 +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:71 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:69 -msgid "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)." +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:73 +msgid "Follow the [mautrix-imessage documentation](https://docs.mau.fi/bridges/go/imessage/index.html) for running `android-sms` and/or `matrix-imessage` on your device(s)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:75 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:77 +msgid "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`." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-discord.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-discord.pot index 5e1d73767..fd1bad65a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-discord.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-discord.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,82 +16,22 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:1 -msgid "Setting up MX Puppet Discord bridging (optional)" +#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:15 +msgid "Setting up MX Puppet Discord bridging (optional, removed)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:3 -msgid "**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md)and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:4 -msgid "For using as a Bot we recommend the [Appservice Discord](configuring-playbook-bridge-appservice-discord.md), because it supports plumbing." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:5 -msgid "For personal use with a discord account we recommend the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge, because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:7 -msgid "The playbook can install and configure [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:9 -msgid "See the project's [documentation](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/blob/master/README.md) to learn what it does and why it might be useful to you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:11 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:13 -msgid "To enable the [Discord](https://discordapp.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:17 +msgid "🪦 The playbook used to be able to install and configure [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord), but no longer includes this component, as it has been unmaintained for a long time." msgstr "" #: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:19 -msgid "Installing" +msgid "You may wish to use the [Mautrix Discord bridge](https://github.com/mautrix/discord) instead." msgstr "" #: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:21 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgid "Uninstalling the bridge manually" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:28 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:30 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:32 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:34 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:36 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:38 -msgid "To use the bridge, you need to start a chat with `Discord Puppet Bridge` with the handle `@_discordpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:40 -msgid "Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-discord [documentation](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) for more information about how to configure the bridge." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:42 -msgid "Once logged in, send `list` to the bot user to list the available rooms." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:44 -msgid "Clicking rooms in the list will result in you receiving an invitation to the bridged room." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:46 -msgid "Send `help` to the bot to see the available commands." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-discord.md:23 +msgid "If you still have the MX Puppet Discord bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-groupme.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-groupme.pot index 758251108..599371a6f 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-groupme.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-groupme.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,74 +16,66 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:1 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:10 msgid "Setting up MX Puppet GroupMe bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:3 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:12 msgid "The playbook can install and configure [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:5 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:14 msgid "See the project's [documentation](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:7 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:16 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:9 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:18 msgid "To enable the [GroupMe](https://groupme.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:15 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:24 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:17 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:26 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:24 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:26 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:28 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:33 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:30 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:35 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:32 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:37 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:34 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:39 msgid "To use the bridge, you need to start a chat with `GroupMe Puppet Bridge` with the handle `@_groupmepuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:36 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:41 msgid "One authentication method is available." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:38 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:43 msgid "To link your GroupMe account, go to [dev.groupme.com](https://dev.groupme.com/), sign in, and select \"Access Token\" from the top menu. Copy the token and message the bridge with:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:44 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:49 msgid "Once logged in, send `listrooms` to the bot user to list the available rooms." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:46 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:51 msgid "Clicking rooms in the list will result in you receiving an invitation to the bridged room." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:48 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-groupme.md:53 msgid "Send `help` to the bot to see the available commands." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-instagram.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-instagram.pot index ba8747713..b7a46a1af 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-instagram.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-instagram.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,86 +16,22 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:1 -msgid "Setting up MX Puppet Instagram bridging (optional)" +#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:14 +msgid "Setting up MX Puppet Instagram bridging (optional, removed)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:3 -msgid "The playbook can install and configure [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) for you." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:16 +msgid "🪦 The playbook used to be able to install and configure [mx-puppet-instagram](https://gitlab.com/mx-puppet/instagram/mx-puppet-instagram), but no longer includes this component, as it has been unmaintained for a long time." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:5 -msgid "This allows you to bridge Instagram DirectMessages into Matrix." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:18 +msgid "You may wish to use the [Mautrix Meta](https://github.com/mautrix/meta) Messenger/Instagram bridge instead." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:7 -msgid "Adjusting the playbook configuration" +#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:20 +msgid "Uninstalling the bridge manually" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:9 -msgid "To enable the [Instagram](https://www.instagram.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:15 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:17 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:24 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:26 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:28 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:30 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:32 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:34 -msgid "To use the bridge, you need to start a chat with `Instagram Puppet Bridge` with the handle `@_instagrampuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:36 -msgid "Send `link ` to the bridge bot to link your instagram account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:38 -msgid "The `list` commands shows which accounts are linked and which `puppetId` is associated." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:40 -msgid "For double-puppeting, you probably want to issue these commands:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:42 -msgid "`settype $puppetId puppet` to enable puppeting for the link (instead of relaying)" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:43 -msgid "`setautoinvite $puppetId 1` to automatically invite you to chats" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:44 -msgid "`setmatrixtoken $accessToken` to set the access token to enable puppeting from the other side (the \"double\" in double puppeting)" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:46 -msgid "If you are linking only one Instagram account, your `$puppetId` is probably 1, but use the `list` command find out." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:48 -msgid "Send `help` to the bot to see the available commands. At the time of writing, not every command is fully implemented." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-instagram.md:22 +msgid "If you still have the MX Puppet Instagram bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-skype.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-skype.pot index d3971b5e0..5b25779e1 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-skype.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-skype.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,14 +16,14 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-skype.md:1 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-skype.md:9 msgid "Setting up MX Puppet Skype bridging (optional, removed)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-skype.md:3 -msgid "The playbook used to be able to install and configure [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype), but no longer includes this component, because it has been broken and unmaintained for a long time." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-skype.md:11 +msgid "🪦 The playbook used to be able to install and configure [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype), but no longer includes this component, because it has been broken and unmaintained for a long time." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-skype.md:5 -msgid "Bridging to [Skype](https://www.skype.com/) can also happen via the [go-skype-bridge](configuring-playbook-bridge-go-skype-bridge.md) bridge supported by the playbook." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-skype.md:13 +msgid "The playbook used to be able to install and configure [go-skype-bridge](configuring-playbook-bridge-go-skype-bridge.md) as alternative to this bridge, but no longer includes this component, because Skype has been discontinued since May 2025." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-slack.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-slack.pot index f3c8cb89f..2d4b3ca12 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-slack.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-slack.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,82 +16,22 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:1 -msgid "Setting up MX Puppet Slack bridging (optional)" +#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:17 +msgid "Setting up MX Puppet Slack bridging (optional, removed)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:3 -msgid "**Note**: bridging to [Slack](https://slack.com) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) and [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook. Note that `matrix-appservice-slack` is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:19 +msgid "🪦 The playbook used to be able to install and configure [mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack), but no longer includes this component, as it has been unmaintained for a long time." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:5 -msgid "The playbook can install and configure [mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) for you." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:21 +msgid "You may wish to use the [Mautrix Slack bridge](https://github.com/mautrix/slack) instead." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:7 -msgid "See the project's [documentation](https://gitlab.com/mx-puppet/slack/mx-puppet-slack/blob/master/README.md) to learn what it does and why it might be useful to you." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:23 +msgid "Uninstalling the bridge manually" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:9 -msgid "Prerequisite" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:11 -msgid "Follow the [OAuth credentials](https://gitlab.com/mx-puppet/slack/mx-puppet-slack#option-2-oauth) instructions to create a new Slack app, setting the redirect URL to `https://matrix.example.com/slack/oauth`." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:13 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:15 -msgid "To enable the [Slack](https://slack.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:24 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:26 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:33 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:35 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:37 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:39 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:41 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:43 -msgid "To use the bridge, you need to start a chat with `Slack Puppet Bridge` with the handle `@_slackpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:45 -msgid "Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-slack [documentation](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) for more information about how to configure the bridge." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:47 -msgid "Once logged in, send `list` to the bot user to list the available rooms." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:49 -msgid "Clicking rooms in the list will result in you receiving an invitation to the bridged room." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:51 -msgid "Send `help` to the bot to see the available commands." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-slack.md:25 +msgid "If you still have the MX Puppet Slack bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-steam.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-steam.pot index f1839dc75..84b49289d 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-steam.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-steam.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,70 +16,66 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:1 -msgid "Setting up MX Puppet Steam bridging (optional)" +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:10 +msgid "Setting up MX Puppet Steam bridging (optional, deprecated)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:3 -msgid "The playbook can install and configure [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) for you." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:12 +msgid "**Note**: This bridge has been deprecated in favor of the [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) bridge for Steam, which can be [installed using this playbook](configuring-playbook-bridge-steam.md). Consider using that bridge instead of this one." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:5 -msgid "See the project's [documentation](https://github.com/icewind1991/mx-puppet-steam/blob/master/README.md) to learn what it does and why it might be useful to you." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:14 +msgid "The playbook can install and configure [mx-puppet-steam](https://codeberg.org/icewind/mx-puppet-steam) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:7 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:16 +msgid "See the project's [documentation](https://codeberg.org/icewind/mx-puppet-steam/blob/master/README.md) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:18 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:9 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:20 msgid "To enable the [Steam](https://steampowered.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:15 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:26 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:17 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:28 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:24 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:26 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:28 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:35 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:30 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:37 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:32 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:39 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:34 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:41 msgid "To use the bridge, you need to start a chat with `Steam Puppet Bridge` with the handle `@_steampuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:36 -msgid "Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-steam [documentation](https://github.com/icewind1991/mx-puppet-steam) for more information about how to configure the bridge." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:43 +msgid "Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-steam [documentation](https://codeberg.org/icewind/mx-puppet-steam) for more information about how to configure the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:38 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:45 msgid "Once logged in, send `list` to the bot user to list the available rooms." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:40 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:47 msgid "Clicking rooms in the list will result in you receiving an invitation to the bridged room." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:42 +#: ../../../docs/configuring-playbook-bridge-mx-puppet-steam.md:49 msgid "Send `help` to the bot to see the available commands." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-twitter.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-twitter.pot index 9b1a35b97..7c4de74c5 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-twitter.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-twitter.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,82 +16,22 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:1 -msgid "Setting up MX Puppet Twitter bridging (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:3 -msgid "**Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mautrix-twitter](configuring-playbook-bridge-mautrix-twitter.md) bridge supported by the playbook." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:5 -msgid "The playbook can install and configure [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:7 -msgid "See the project's [documentation](https://github.com/Sorunome/mx-puppet-twitter/blob/master/README.md) to learn what it does and why it might be useful to you." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:9 -msgid "Prerequisite" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:11 -msgid "Make an app on [developer.twitter.com](https://developer.twitter.com/en/apps)." -msgstr "" - #: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:13 -msgid "Adjusting the playbook configuration" +msgid "Setting up MX Puppet Twitter bridging (optional, removed)" msgstr "" #: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:15 -msgid "To enable the [Twitter](https://twitter.com) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgid "🪦 The playbook used to be able to install and configure [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter), but no longer includes this component, as it has been unmaintained for a long time." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:26 -msgid "Installing" +#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:17 +msgid "You may wish to use the [Mautrix Twitter bridge](https://github.com/mautrix/twitter) instead." msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:28 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:19 +msgid "Uninstalling the bridge manually" msgstr "" -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:35 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:37 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:39 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:41 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:43 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:45 -msgid "To use the bridge, you need to start a chat with `Twitter Puppet Bridge` with the handle `@_twitterpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:47 -msgid "To log in, use `link` and click the link." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:49 -msgid "Once logged in, send `list` to the bot user to list the available rooms." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:51 -msgid "Clicking rooms in the list will result in you receiving an invitation to the bridged room." -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:53 -msgid "Send `help` to the bot to see the available commands." +#: ../../../docs/configuring-playbook-bridge-mx-puppet-twitter.md:21 +msgid "If you still have the MX Puppet Twitter bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-postmoogle.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-postmoogle.pot index ff82d45ee..6ba2d3c39 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-postmoogle.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-postmoogle.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,51 +16,51 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:1 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:10 msgid "Setting up Postmoogle email bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:3 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:12 msgid "The playbook can install and configure [Postmoogle](https://github.com/etkecc/postmoogle) for you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:5 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:14 msgid "Postmoogle is a bridge you can use to have its bot user forward emails to Matrix rooms. It runs an SMTP email server and allows you to assign mailbox addresses to the rooms." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:7 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:16 msgid "See the project's [documentation](https://github.com/etkecc/postmoogle/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:9 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:18 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:11 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:20 msgid "Open the following ports on your server to be able to receive incoming emails:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:13 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:22 msgid "`25/tcp`: SMTP" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:14 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:23 msgid "`587/tcp`: Submission (TLS-encrypted SMTP)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:16 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:25 msgid "If you don't open these ports, you will still be able to send emails, but not receive any." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:18 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:27 msgid "These port numbers are configurable via the `matrix_postmoogle_smtp_host_bind_port` and `matrix_postmoogle_submission_host_bind_port` variables, but other email servers will try to deliver on these default (standard) ports, so changing them is of little use." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:20 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:29 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:22 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:31 msgid "To make Postmoogle enable its email sending features, you need to configure MX and TXT (SPF, DMARC, and DKIM) records. See the table below for values which need to be specified." msgstr "" @@ -136,90 +136,94 @@ msgstr "" msgid "get it from `!pm dkim`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:31 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:40 msgid "**Note**: the DKIM record can be retrieved after configuring and installing the bridge's bot." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:33 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:42 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:35 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:44 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:56 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:65 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:58 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:67 msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:60 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:69 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:62 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:71 msgid "`roles/custom/matrix-bridge-postmoogle/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:64 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:73 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:66 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:75 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:73 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:82 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:75 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:84 msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create a user account of the bridge's bot." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:77 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:86 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:79 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:88 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:81 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:90 msgid "If you change the bridge's bot password (`matrix_postmoogle_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_postmoogle_password` to let the bot know its new password." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:83 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:92 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:85 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:94 msgid "To use the bridge, invite the `@postmoogle:example.com` bot user into a room you want to use as a mailbox." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:87 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:96 msgid "Then send `!pm mailbox NAME` to expose this Matrix room as an inbox with the email address `NAME@matrix.example.com`. Emails sent to that email address will be forwarded to the room." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:89 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:98 msgid "Send `!pm help` to the bot in the room to see the available commands." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:91 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:100 msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/postmoogle)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:93 +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:102 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:95 -msgid "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`" +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:104 +msgid "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`." msgstr "" -#: ../../../docs/configuring-playbook-bridge-postmoogle.md:97 -msgid "The default logging level for this bridge is `INFO`, but you can increase it to `DEBUG` with the following additional configuration:" +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:106 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-postmoogle.md:108 +msgid "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:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-steam.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-steam.pot new file mode 100644 index 000000000..d6d44ecba --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-steam.pot @@ -0,0 +1,85 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-bridge-steam.md:7 +msgid "Setting up Steam bridging (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:9 +msgid "The playbook can install and configure [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) for you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:11 +msgid "See the project's [documentation](https://github.com/jasonlaguidice/matrix-steam-bridge/blob/main/README.md) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:13 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:15 +msgid "To enable the [Steam](https://steampowered.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:21 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:23 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:30 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` and `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:32 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:34 +msgid "The tag for `just` commands for this bridge is `matrix-steam-bridge` - for example: `just install-service matrix-steam-bridge`" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:36 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:38 +msgid "To use the bridge, you need to start a chat with `Steam bridge bot` with the handle `@steambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:40 +msgid "The bridge supports QR code and password-based login as well as SteamGuard codes via app, SMS, or e-mail. See matrix-steam-bridge [documentation](https://github.com/jasonlaguidice/matrix-steam-bridge) for more information about how to configure the bridge." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:42 +msgid "To login, send `login [flow ID]` where possible flow IDs are `password` or `qr`" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:44 +msgid "Once logged in, send `search [name]` to search through recognized Steam friends. You can send a user name, display name, or all forms of Steam ID. Send `start-chat [identifier]` to request the bridge bot to open a chat room with a user." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:46 +msgid "Chat rooms will automatically be opened as new messages are received." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-steam.md:48 +msgid "Send `help` to the bot to see the available commands." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bridge-wechat.pot b/i18n/translation-templates/docs/configuring-playbook-bridge-wechat.pot index 9339190f2..7317197ca 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bridge-wechat.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bridge-wechat.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,58 +16,94 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-bridge-wechat.md:1 +#: ../../../docs/configuring-playbook-bridge-wechat.md:8 msgid "Setting up WeChat bridging (optional)" msgstr "" -#: ../../../docs/configuring-playbook-bridge-wechat.md:3 +#: ../../../docs/configuring-playbook-bridge-wechat.md:10 msgid "The playbook can install and configure [matrix-wechat](https://github.com/duo/matrix-wechat) for you, for bridging to [WeChat](https://www.wechat.com/)." msgstr "" -#: ../../../docs/configuring-playbook-bridge-wechat.md:5 +#: ../../../docs/configuring-playbook-bridge-wechat.md:12 msgid "See the project's [documentation](https://github.com/duo/matrix-wechat/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-bridge-wechat.md:7 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-wechat.md:9 -msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-bridge-wechat.md:15 -msgid "Installing" +#: ../../../docs/configuring-playbook-bridge-wechat.md:14 +msgid "[!WARNING] This bridge does not work against newer versions of Synapse anymore. See [this issue](https://github.com/duo/matrix-wechat/issues/33). Don't even bother installing it. Unless bridge maintenance is resumed and fixes this issue, we have no choice but to remove it from the playbook." msgstr "" #: ../../../docs/configuring-playbook-bridge-wechat.md:17 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-wechat.md:24 -msgid "**Notes**:" +#: ../../../docs/configuring-playbook-bridge-wechat.md:19 +msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-bridge-wechat.md:26 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." +#: ../../../docs/configuring-playbook-bridge-wechat.md:25 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-bridge-wechat.md:28 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +#: ../../../docs/configuring-playbook-bridge-wechat.md:27 +msgid "There are some additional things you may wish to configure about the bridge." msgstr "" -#: ../../../docs/configuring-playbook-bridge-wechat.md:30 -msgid "`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." +#: ../../../docs/configuring-playbook-bridge-wechat.md:29 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:31 +msgid "`roles/custom/matrix-bridge-wechat/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" #: ../../../docs/configuring-playbook-bridge-wechat.md:32 -msgid "Usage" +msgid "`roles/custom/matrix-bridge-wechat/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_wechat_configuration_extension_yaml` variable" msgstr "" #: ../../../docs/configuring-playbook-bridge-wechat.md:34 -msgid "To use the bridge, you need to start a chat with `@wechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-bridge-wechat.md:36 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:43 +msgid "**Notes**:" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:45 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:47 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:49 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:51 +msgid "To use the bridge, you need to start a chat with `@wechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:53 msgid "Send `help` to the bot to see the available commands." msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:55 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:57 +msgid "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`." +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:59 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-bridge-wechat.md:61 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-cactus-comments.pot b/i18n/translation-templates/docs/configuring-playbook-cactus-comments.pot index 5e51bc044..874ae436d 100644 --- a/i18n/translation-templates/docs/configuring-playbook-cactus-comments.pot +++ b/i18n/translation-templates/docs/configuring-playbook-cactus-comments.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,186 +16,178 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-cactus-comments.md:1 +#: ../../../docs/configuring-playbook-cactus-comments.md:10 msgid "Setting up Cactus Comments (optional)" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:3 +#: ../../../docs/configuring-playbook-cactus-comments.md:12 msgid "The playbook can install and configure the [Cactus Comments](https://cactus.chat) system for you." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:5 +#: ../../../docs/configuring-playbook-cactus-comments.md:14 msgid "Cactus Comments is a **federated comment system** built on Matrix. It respects your privacy, and puts you in control." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:7 +#: ../../../docs/configuring-playbook-cactus-comments.md:16 msgid "See the project's [documentation](https://cactus.chat/docs/getting-started/introduction/) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:9 +#: ../../../docs/configuring-playbook-cactus-comments.md:18 msgid "The playbook contains 2 roles for configuring different pieces of the Cactus Comments system:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:11 +#: ../../../docs/configuring-playbook-cactus-comments.md:20 msgid "`matrix-cactus-comments` — the backend appservice integrating with the Matrix homeserver" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:13 +#: ../../../docs/configuring-playbook-cactus-comments.md:22 msgid "`matrix-cactus-comments-client` — a static website server serving the [cactus-client](https://cactus.chat/docs/client/introduction/) static assets (`cactus.js` and `styles.css`)" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:15 +#: ../../../docs/configuring-playbook-cactus-comments.md:24 msgid "You can enable whichever component you need (typically both)." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:17 +#: ../../../docs/configuring-playbook-cactus-comments.md:26 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:19 +#: ../../../docs/configuring-playbook-cactus-comments.md:28 msgid "By default, this playbook installs Cactus Comments' client on the `matrix.` subdomain, at the `/cactus-comments` path (https://matrix.example.com/cactus-comments). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:21 +#: ../../../docs/configuring-playbook-cactus-comments.md:30 msgid "If you wish to adjust it, see the section [below](#adjusting-the-cactus-comments-client-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:23 +#: ../../../docs/configuring-playbook-cactus-comments.md:32 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:25 +#: ../../../docs/configuring-playbook-cactus-comments.md:34 msgid "To enable Cactus Comments, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:45 +#: ../../../docs/configuring-playbook-cactus-comments.md:54 msgid "Adjusting the Cactus Comments' client URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:47 +#: ../../../docs/configuring-playbook-cactus-comments.md:56 msgid "By tweaking the `matrix_cactus_comments_client_hostname` and `matrix_cactus_comments_client_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:49 +#: ../../../docs/configuring-playbook-cactus-comments.md:58 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:58 +#: ../../../docs/configuring-playbook-cactus-comments.md:67 msgid "If you've changed the default hostname, you may need to create a CNAME record for the Cactus Comments' client domain (`cactus.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:60 +#: ../../../docs/configuring-playbook-cactus-comments.md:69 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:62 +#: ../../../docs/configuring-playbook-cactus-comments.md:71 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:64 +#: ../../../docs/configuring-playbook-cactus-comments.md:73 msgid "There are some additional things you may wish to configure about the components." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:66 +#: ../../../docs/configuring-playbook-cactus-comments.md:75 msgid "For `matrix-cactus-comments`, take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:68 +#: ../../../docs/configuring-playbook-cactus-comments.md:77 msgid "`roles/custom/matrix-cactus-comments/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:70 +#: ../../../docs/configuring-playbook-cactus-comments.md:79 msgid "For `matrix-cactus-comments-client`, take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:72 +#: ../../../docs/configuring-playbook-cactus-comments.md:81 msgid "`roles/custom/matrix-cactus-comments-client/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:74 +#: ../../../docs/configuring-playbook-cactus-comments.md:83 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:76 +#: ../../../docs/configuring-playbook-cactus-comments.md:85 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:83 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-cactus-comments.md:85 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account." -msgstr "" - -#: ../../../docs/configuring-playbook-cactus-comments.md:87 +#: ../../../docs/configuring-playbook-cactus-comments.md:92 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:89 -msgid "`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." +#: ../../../docs/configuring-playbook-cactus-comments.md:94 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:91 +#: ../../../docs/configuring-playbook-cactus-comments.md:96 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:93 +#: ../../../docs/configuring-playbook-cactus-comments.md:98 msgid "To use the component, you need to start a chat with `@bot.cactusbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:95 +#: ../../../docs/configuring-playbook-cactus-comments.md:100 msgid "Then, register a site by sending `register YOUR_SITE_NAME_HERE` (where `YOUR_SITE_NAME_HERE` is a unique identifier you choose. It does not have to match your domain). You will then be invited into a moderation room." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:97 +#: ../../../docs/configuring-playbook-cactus-comments.md:102 msgid "Now you are good to go and can embed the comment section on your website!" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:99 +#: ../../../docs/configuring-playbook-cactus-comments.md:104 msgid "Embed Cactus Comments" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:101 +#: ../../../docs/configuring-playbook-cactus-comments.md:106 msgid "The official [documentation](https://cactus.chat/docs/getting-started/quick-start/) provides a useful guide to embed Cactus Comments on your website." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:103 +#: ../../../docs/configuring-playbook-cactus-comments.md:108 msgid "After including the JavaScript and CSS asset files, insert a `
` where you'd like to display the comment section:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:109 +#: ../../../docs/configuring-playbook-cactus-comments.md:114 msgid "Then, you need to initialize the comment section. Make sure to replace `example.com` with your base domain and `YOUR_SITE_NAME_HERE` with the one that has been registered above:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:123 +#: ../../../docs/configuring-playbook-cactus-comments.md:128 msgid "Adjust the domain name for self-hosting" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:125 +#: ../../../docs/configuring-playbook-cactus-comments.md:130 msgid "To have the assets served from your homeserver (not from `cactus.chat`), you need to adjust the domain name on the official documentation." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:127 +#: ../../../docs/configuring-playbook-cactus-comments.md:132 msgid "Make sure to replace `example.com` with your base domain before you include the following lines, instead of the one provided by the official documentation:" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:134 +#: ../../../docs/configuring-playbook-cactus-comments.md:139 msgid "**Note**: if the `matrix_cactus_comments_client_hostname` and `matrix_cactus_comments_client_path_prefix` variables are tweaked, you would need to adjust the URLs of the assets accordingly." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:136 +#: ../../../docs/configuring-playbook-cactus-comments.md:141 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:138 +#: ../../../docs/configuring-playbook-cactus-comments.md:143 msgid "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-cactus-comments` for the backend appservice or `journalctl -fu matrix-cactus-comments-client` for the server serving the client assets, respectively." msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:140 +#: ../../../docs/configuring-playbook-cactus-comments.md:145 msgid "Increase logging verbosity" msgstr "" -#: ../../../docs/configuring-playbook-cactus-comments.md:142 +#: ../../../docs/configuring-playbook-cactus-comments.md:147 msgid "It is possible to increase logging verbosity for `matrix-cactus-comments-client`. The default logging level for this component is `error`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-client-cinny.pot b/i18n/translation-templates/docs/configuring-playbook-client-cinny.pot index f9fd230f2..25b7a665c 100644 --- a/i18n/translation-templates/docs/configuring-playbook-client-cinny.pot +++ b/i18n/translation-templates/docs/configuring-playbook-client-cinny.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,78 +16,106 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-client-cinny.md:1 +#: ../../../docs/configuring-playbook-client-cinny.md:9 msgid "Setting up Cinny (optional)" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:3 +#: ../../../docs/configuring-playbook-client-cinny.md:11 msgid "The playbook can install and configure the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you." msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:5 +#: ../../../docs/configuring-playbook-client-cinny.md:13 msgid "Cinny is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of [Element Web](./configuring-playbook-client-element-web.md)." msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:7 +#: ../../../docs/configuring-playbook-client-cinny.md:15 msgid "💡 **Note**: the latest version of Cinny is also available on the web, hosted by 3rd parties. If you trust giving your credentials to the following 3rd party Single Page Applications, you can consider using it from there and avoiding the (small) overhead of self-hosting:" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:9 +#: ../../../docs/configuring-playbook-client-cinny.md:17 msgid "[app.cinny.in](https://app.cinny.in), hosted by the [Cinny](https://cinny.in/) developers" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:11 +#: ../../../docs/configuring-playbook-client-cinny.md:19 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:13 +#: ../../../docs/configuring-playbook-client-cinny.md:21 msgid "By default, this playbook installs Cinny on the `cinny.` subdomain (`cinny.example.com`) and requires you to create a CNAME record for `cinny`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:15 +#: ../../../docs/configuring-playbook-client-cinny.md:23 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:17 +#: ../../../docs/configuring-playbook-client-cinny.md:25 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:19 +#: ../../../docs/configuring-playbook-client-cinny.md:27 msgid "To enable Cinny, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:25 +#: ../../../docs/configuring-playbook-client-cinny.md:33 msgid "Adjusting the Cinny URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:27 +#: ../../../docs/configuring-playbook-client-cinny.md:35 msgid "By tweaking the `matrix_client_cinny_hostname` variable, you can easily make the service available at a **different hostname** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:29 +#: ../../../docs/configuring-playbook-client-cinny.md:37 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:39 +#: ../../../docs/configuring-playbook-client-cinny.md:47 msgid "After changing the domain, **you may need to adjust your DNS** records to point the Cinny domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:41 +#: ../../../docs/configuring-playbook-client-cinny.md:49 msgid "**Note**: while there is a `matrix_client_cinny_path_prefix` variable for changing the path where Cinny is served, overriding it is [not possible](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3701), because Cinny requires an application rebuild (with a tweaked build config) to be functional under a custom path. You'd need to serve Cinny at a dedicated subdomain." msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:43 +#: ../../../docs/configuring-playbook-client-cinny.md:51 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-client-cinny.md:53 +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-client-cinny.md:55 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-cinny.md:57 +msgid "`roles/custom/matrix-client-cinny/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-client-cinny.md:58 +msgid "`roles/custom/matrix-client-cinny/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_cinny_configuration_extension_json` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-client-cinny.md:60 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:45 +#: ../../../docs/configuring-playbook-client-cinny.md:62 msgid "After configuring the playbook and [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:52 +#: ../../../docs/configuring-playbook-client-cinny.md:69 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-client-cinny.md:54 +#: ../../../docs/configuring-playbook-client-cinny.md:71 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-client-cinny.md:73 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-client-cinny.md:75 +msgid "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-client-cinny`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-client-element-web.pot b/i18n/translation-templates/docs/configuring-playbook-client-element-web.pot index 524c4b34e..b2a2f0cdf 100644 --- a/i18n/translation-templates/docs/configuring-playbook-client-element-web.pot +++ b/i18n/translation-templates/docs/configuring-playbook-client-element-web.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,150 +16,174 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-client-element-web.md:1 +#: ../../../docs/configuring-playbook-client-element-web.md:11 msgid "Configuring Element Web (optional)" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:3 +#: ../../../docs/configuring-playbook-client-element-web.md:13 msgid "By default, this playbook installs the [Element Web](https://github.com/element-hq/element-web) Matrix client for you. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:5 +#: ../../../docs/configuring-playbook-client-element-web.md:15 msgid "If you'd like to stop the playbook installing the client, see the section [below](#disabling-element-web) to check the configuration for disabling it." msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:7 +#: ../../../docs/configuring-playbook-client-element-web.md:17 msgid "💡 **Note**: the latest version of Element Web is also available on the web, hosted by 3rd parties. If you trust giving your credentials to the following 3rd party Single Page Applications, you can consider using it from there and avoiding the (small) overhead of self-hosting (by [disabling Element Web](#disabling-element-web)):" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:9 +#: ../../../docs/configuring-playbook-client-element-web.md:19 msgid "[app.element.io](https://app.element.io/), hosted by [Element](https://element.io/)" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:10 +#: ../../../docs/configuring-playbook-client-element-web.md:20 msgid "[app.etke.cc](https://app.etke.cc/), hosted by [etke.cc](https://etke.cc/)" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:12 +#: ../../../docs/configuring-playbook-client-element-web.md:22 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:14 +#: ../../../docs/configuring-playbook-client-element-web.md:24 msgid "By default, this playbook installs Element Web on the `element.` subdomain (`element.example.com`) and requires you to create a CNAME record for `element`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:16 +#: ../../../docs/configuring-playbook-client-element-web.md:26 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:18 +#: ../../../docs/configuring-playbook-client-element-web.md:28 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:20 -msgid "Themes" -msgstr "" - -#: ../../../docs/configuring-playbook-client-element-web.md:22 -msgid "You can change the look of Element Web by pulling themes provided by the [aaronraimist/element-themes](https://github.com/aaronraimist/element-themes) project or defining your own themes manually." -msgstr "" - -#: ../../../docs/configuring-playbook-client-element-web.md:24 -msgid "Use themes by `element-themes`" -msgstr "" - -#: ../../../docs/configuring-playbook-client-element-web.md:26 -msgid "To pull the themes from the `element-themes` project and use them for your Element Web instance, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +#: ../../../docs/configuring-playbook-client-element-web.md:30 +msgid "Set the country code for phone number inputs" msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:32 -msgid "If the variable is set to `true`, all themes found in the repository specified with `matrix_client_element_themes_repository_url` will be installed and enabled automatically." -msgstr "" - -#: ../../../docs/configuring-playbook-client-element-web.md:34 -msgid "Note that for a custom theme to work well, all Element Web instances that you use must have the same theme installed." -msgstr "" - -#: ../../../docs/configuring-playbook-client-element-web.md:36 -msgid "Define themes manually" +msgid "You can change the country code (default: `GB`) to use when showing phone number inputs. To change it to `FR` for example, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:38 -msgid "You can also define your own themes manually by adding and adjusting the following configuration to your `vars.yml` file:" +msgid "Themes" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:45 -msgid "If you define your own themes with it and set `matrix_client_element_themes_enabled` to `true` for the themes by `element-themes`, your themes will be preserved as well." +#: ../../../docs/configuring-playbook-client-element-web.md:40 +msgid "Change the default theme" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:47 -msgid "If you make your own theme, we encourage you to submit it to the **aaronraimist/element-themes** project, so that the whole community could easily enjoy it." +#: ../../../docs/configuring-playbook-client-element-web.md:42 +msgid "You can change the default theme from `light` to `dark`. To do so, add the following configuration to your `vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:49 -msgid "Adjusting the Element Web URL (optional)" +msgid "Use themes by `element-themes`" msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:51 -msgid "By tweaking the `matrix_client_element_hostname` and `matrix_client_element_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." +msgid "You can change the look of Element Web by pulling themes provided by the [aaronraimist/element-themes](https://github.com/aaronraimist/element-themes) project or defining your own themes manually." msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:53 -msgid "Example additional configuration for your `vars.yml` file:" +msgid "To pull the themes and use them for your Element Web instance, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:64 -msgid "After changing the domain, **you may need to adjust your DNS** records to point the Element domain to the Matrix server." +#: ../../../docs/configuring-playbook-client-element-web.md:59 +msgid "If the variable is set to `true`, all themes found in the repository specified with `matrix_client_element_themes_repository_url` will be installed and enabled automatically." msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:66 -msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." +#: ../../../docs/configuring-playbook-client-element-web.md:61 +msgid "Note that for a custom theme to work well, all Element Web instances that you use must have the same theme installed." msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:68 -msgid "Extending the configuration" +#: ../../../docs/configuring-playbook-client-element-web.md:63 +msgid "Define themes manually" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:70 -msgid "There are some additional things you may wish to configure about the component." +#: ../../../docs/configuring-playbook-client-element-web.md:65 +msgid "You can also define your own themes manually by adding and adjusting the following configuration to your `vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:72 -msgid "Take a look at:" +msgid "If you define your own themes with it and set `matrix_client_element_themes_enabled` to `true` for the themes by `element-themes`, your themes will be preserved as well." msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:74 -msgid "`roles/custom/matrix-client-element/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgid "If you make your own theme, we encourage you to submit it to the **aaronraimist/element-themes** project, so that the whole community could easily enjoy it." msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:75 -msgid "`roles/custom/matrix-client-element/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_element_configuration_extension_json` variable" +#: ../../../docs/configuring-playbook-client-element-web.md:76 +msgid "Adjusting the Element Web URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:77 -msgid "For example, to override some Element Web settings, add the following configuration to your `vars.yml` file:" +#: ../../../docs/configuring-playbook-client-element-web.md:78 +msgid "By tweaking the `matrix_client_element_hostname` and `matrix_client_element_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:80 +msgid "Example additional configuration for your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:91 +msgid "After changing the domain, **you may need to adjust your DNS** records to point the Element domain to the Matrix server." +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:93 +msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:95 -msgid "Disabling Element Web" +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-client-element-web.md:97 +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:99 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:101 +msgid "`roles/custom/matrix-client-element/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:102 +msgid "`roles/custom/matrix-client-element/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_element_configuration_extension_json` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:104 +msgid "For example, to override some Element Web settings, add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:122 +msgid "Disabling Element Web" +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:124 msgid "If you'd like for the playbook to not install Element Web (or to uninstall it if it was previously installed), add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:103 +#: ../../../docs/configuring-playbook-client-element-web.md:130 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:105 +#: ../../../docs/configuring-playbook-client-element-web.md:132 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:112 +#: ../../../docs/configuring-playbook-client-element-web.md:139 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-client-element-web.md:114 +#: ../../../docs/configuring-playbook-client-element-web.md:141 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:143 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-client-element-web.md:145 +msgid "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-client-element`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-client-fluffychat-web.pot b/i18n/translation-templates/docs/configuring-playbook-client-fluffychat-web.pot new file mode 100644 index 000000000..f104e5091 --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-client-fluffychat-web.pot @@ -0,0 +1,101 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:8 +msgid "Setting up FluffyChat Web (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:10 +msgid "The playbook can install and configure the [FluffyChat Web](https://github.com/krille-chan/fluffychat) Matrix client for you." +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:12 +msgid "FluffyChat Web is a cute cross-platform (web, iOS, Android) messenger for Matrix written in [Flutter](https://flutter.dev/)." +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:14 +msgid "💡 **Note**: the latest version of FluffyChat Web is also available on the web, hosted by 3rd parties. If you trust giving your credentials to the following 3rd party Single Page Application, you can consider using it from there:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:16 +msgid "[fluffychat.im](https://fluffychat.im/web), hosted by the [FluffyChat](https://fluffychat.im/) developers" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:18 +msgid "Adjusting DNS records" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:20 +msgid "By default, this playbook installs FluffyChat Web on the `fluffychat.` subdomain (`fluffychat.example.com`) and requires you to create a CNAME record for `fluffychat`, which targets `matrix.example.com`." +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:22 +msgid "When setting, replace `example.com` with your own." +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:24 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:26 +msgid "To enable FluffyChat Web, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:32 +msgid "Adjusting the FluffyChat Web URL (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:34 +msgid "By tweaking the `matrix_client_fluffychat_hostname` and `matrix_client_fluffychat_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:36 +msgid "Example additional configuration for your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:47 +msgid "After changing the domain, **you may need to adjust your DNS** records to point the FluffyChat Web domain to the Matrix server." +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:49 +msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:51 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:53 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:60 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:62 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:64 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-client-fluffychat-web.md:66 +msgid "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-client-fluffychat`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-client-hydrogen.pot b/i18n/translation-templates/docs/configuring-playbook-client-hydrogen.pot index 194c8228b..0c8c33bfe 100644 --- a/i18n/translation-templates/docs/configuring-playbook-client-hydrogen.pot +++ b/i18n/translation-templates/docs/configuring-playbook-client-hydrogen.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,70 +16,98 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-client-hydrogen.md:1 +#: ../../../docs/configuring-playbook-client-hydrogen.md:10 msgid "Setting up Hydrogen (optional)" msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:3 +#: ../../../docs/configuring-playbook-client-hydrogen.md:12 msgid "The playbook can install and configure the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you." msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:5 +#: ../../../docs/configuring-playbook-client-hydrogen.md:14 msgid "Hydrogen is a lightweight web client that supports mobile and legacy web browsers. It can be installed alongside or instead of Element Web." msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:7 +#: ../../../docs/configuring-playbook-client-hydrogen.md:16 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:9 +#: ../../../docs/configuring-playbook-client-hydrogen.md:18 msgid "By default, this playbook installs Hydrogen on the `hydrogen.` subdomain (`hydrogen.example.com`) and requires you to create a CNAME record for `hydrogen`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:11 +#: ../../../docs/configuring-playbook-client-hydrogen.md:20 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:13 +#: ../../../docs/configuring-playbook-client-hydrogen.md:22 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:15 +#: ../../../docs/configuring-playbook-client-hydrogen.md:24 msgid "To enable Hydrogen, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:21 +#: ../../../docs/configuring-playbook-client-hydrogen.md:30 msgid "Adjusting the Hydrogen URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:23 +#: ../../../docs/configuring-playbook-client-hydrogen.md:32 msgid "By tweaking the `matrix_client_hydrogen_hostname` and `matrix_client_hydrogen_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:25 +#: ../../../docs/configuring-playbook-client-hydrogen.md:34 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:36 +#: ../../../docs/configuring-playbook-client-hydrogen.md:45 msgid "After changing the domain, **you may need to adjust your DNS** records to point the Hydrogen domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:38 +#: ../../../docs/configuring-playbook-client-hydrogen.md:47 msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-client-hydrogen.md:40 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-client-hydrogen.md:42 -msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" -msgstr "" - #: ../../../docs/configuring-playbook-client-hydrogen.md:49 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-client-hydrogen.md:51 +msgid "There are some additional things you may wish to configure about the client." +msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:53 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:55 +msgid "`roles/custom/matrix-client-hydrogen/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:56 +msgid "`roles/custom/matrix-client-hydrogen/templates/config.json.j2` for the client's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_hydrogen_configuration_extension_json` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:58 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:60 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:67 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:69 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:71 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-client-hydrogen.md:73 +msgid "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-client-hydrogen`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-client-schildichat-web.pot b/i18n/translation-templates/docs/configuring-playbook-client-schildichat-web.pot index 51d7794c3..b7f1a8629 100644 --- a/i18n/translation-templates/docs/configuring-playbook-client-schildichat-web.pot +++ b/i18n/translation-templates/docs/configuring-playbook-client-schildichat-web.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,142 +16,166 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:1 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:9 msgid "Setting up SchildiChat Web (optional)" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:3 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:11 msgid "The playbook can install and configure the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) Matrix client for you." msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:5 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:13 msgid "SchildiChat Web is a feature-rich messenger for Matrix based on Element Web with some extras and tweaks. It can be installed alongside or instead of Element Web." msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:7 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:15 msgid "💡 **Note**: the latest version of SchildiChat Web is also available on the web, hosted by 3rd parties. If you trust giving your credentials to the following 3rd party Single Page Application, you can consider using it from there:" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:9 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:17 msgid "[app.schildi.chat](https://app.schildi.chat/), hosted by the [SchildiChat](https://schildi.chat/) developers" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:11 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:19 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:13 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:21 msgid "By default, this playbook installs SchildiChat Web on the `schildichat.` subdomain (`schildichat.example.com`) and requires you to create a CNAME record for `schildichat`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:15 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:23 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:17 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:25 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:19 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:27 msgid "To enable SchildiChat Web, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:25 -msgid "Themes" +#: ../../../docs/configuring-playbook-client-schildichat-web.md:33 +msgid "Set the country code for phone number inputs" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:27 -msgid "You can change the look of SchildiChat Web by pulling themes provided by the [aaronraimist/element-themes](https://github.com/aaronraimist/element-themes) project or defining your own themes manually." -msgstr "" - -#: ../../../docs/configuring-playbook-client-schildichat-web.md:29 -msgid "Use themes by `element-themes`" -msgstr "" - -#: ../../../docs/configuring-playbook-client-schildichat-web.md:31 -msgid "To pull the themes from the `element-themes` project and use them for your SchildiChat Web instance, add the following configuration to your `vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-client-schildichat-web.md:37 -msgid "If the variable is set to `true`, all themes found in the repository specified with `matrix_client_schildichat_themes_repository_url` will be installed and enabled automatically." -msgstr "" - -#: ../../../docs/configuring-playbook-client-schildichat-web.md:39 -msgid "Note that for a custom theme to work well, all SchildiChat Web instances that you use must have the same theme installed." +#: ../../../docs/configuring-playbook-client-schildichat-web.md:35 +msgid "You can change the country code (default: `GB`) to use when showing phone number inputs. To change it to `FR` for example, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:41 -msgid "Define themes manually" +msgid "Themes" msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:43 -msgid "You can also define your own themes manually by adding and adjusting the following configuration to your `vars.yml` file:" +msgid "Change the default theme" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:50 -msgid "If you define your own themes with it and set `matrix_client_schildichat_themes_enabled` to `true` for the themes by `element-themes`, your themes will be preserved as well." +#: ../../../docs/configuring-playbook-client-schildichat-web.md:45 +msgid "You can change the default theme from `light` to `dark`. To do so, add the following configuration to your `vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:52 -msgid "If you make your own theme, we encourage you to submit it to the **aaronraimist/element-themes** project, so that the whole community could easily enjoy it." +msgid "Use themes by `element-themes`" msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:54 -msgid "Adjusting the SchildiChat Web URL (optional)" +msgid "You can change the look of SchildiChat Web by pulling themes provided by the [aaronraimist/element-themes](https://github.com/aaronraimist/element-themes) project or defining your own themes manually." msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:56 -msgid "By tweaking the `matrix_client_schildichat_hostname` and `matrix_client_schildichat_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." +msgid "To pull the themes and use them for your SchildiChat Web instance, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:58 -msgid "Example additional configuration for your `vars.yml` file:" +#: ../../../docs/configuring-playbook-client-schildichat-web.md:62 +msgid "If the variable is set to `true`, all themes found in the repository specified with `matrix_client_schildichat_themes_repository_url` will be installed and enabled automatically." msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:69 -msgid "After changing the domain, **you may need to adjust your DNS** records to point the SchildiChat Web domain to the Matrix server." +#: ../../../docs/configuring-playbook-client-schildichat-web.md:64 +msgid "Note that for a custom theme to work well, all SchildiChat Web instances that you use must have the same theme installed." msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:71 -msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." +#: ../../../docs/configuring-playbook-client-schildichat-web.md:66 +msgid "Define themes manually" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:73 -msgid "Extending the configuration" +#: ../../../docs/configuring-playbook-client-schildichat-web.md:68 +msgid "You can also define your own themes manually by adding and adjusting the following configuration to your `vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:75 -msgid "There are some additional things you may wish to configure about the component." +msgid "If you define your own themes with it and set `matrix_client_schildichat_themes_enabled` to `true` for the themes by `element-themes`, your themes will be preserved as well." msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:77 -msgid "Take a look at:" +msgid "If you make your own theme, we encourage you to submit it to the **aaronraimist/element-themes** project, so that the whole community could easily enjoy it." msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:79 -msgid "`roles/custom/matrix-client-schildichat/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgid "Adjusting the SchildiChat Web URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:80 -msgid "`roles/custom/matrix-client-schildichat/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_schildichat_configuration_extension_json` variable" +#: ../../../docs/configuring-playbook-client-schildichat-web.md:81 +msgid "By tweaking the `matrix_client_schildichat_hostname` and `matrix_client_schildichat_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:82 -msgid "For example, to override some SchildiChat Web settings, add the following configuration to your `vars.yml` file:" +#: ../../../docs/configuring-playbook-client-schildichat-web.md:83 +msgid "Example additional configuration for your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:94 +msgid "After changing the domain, **you may need to adjust your DNS** records to point the SchildiChat Web domain to the Matrix server." +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:96 +msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:98 +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:100 -msgid "Installing" +msgid "There are some additional things you may wish to configure about the component." msgstr "" #: ../../../docs/configuring-playbook-client-schildichat-web.md:102 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:104 +msgid "`roles/custom/matrix-client-schildichat/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:105 +msgid "`roles/custom/matrix-client-schildichat/templates/config.json.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_client_schildichat_configuration_extension_json` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:107 +msgid "For example, to override some SchildiChat Web settings, add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:125 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:127 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:109 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:134 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-client-schildichat-web.md:111 +#: ../../../docs/configuring-playbook-client-schildichat-web.md:136 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:138 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-client-schildichat-web.md:140 +msgid "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-client-schildichat`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-conduit.pot b/i18n/translation-templates/docs/configuring-playbook-conduit.pot index 995d482e1..5c4785742 100644 --- a/i18n/translation-templates/docs/configuring-playbook-conduit.pot +++ b/i18n/translation-templates/docs/configuring-playbook-conduit.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,114 +16,122 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-conduit.md:1 +#: ../../../docs/configuring-playbook-conduit.md:8 msgid "Configuring Conduit (optional)" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:3 +#: ../../../docs/configuring-playbook-conduit.md:10 msgid "The playbook can install and configure the [Conduit](https://conduit.rs) Matrix server for you." msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:5 +#: ../../../docs/configuring-playbook-conduit.md:12 msgid "See the project's [documentation](https://docs.conduit.rs/) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:7 +#: ../../../docs/configuring-playbook-conduit.md:14 msgid "By default, the playbook installs [Synapse](https://github.com/element-hq/synapse) as it's the only full-featured Matrix server at the moment. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:9 +#: ../../../docs/configuring-playbook-conduit.md:16 msgid "💡 **Note**: The playbook also supports installing a (currently) faster-moving Conduit fork called [conduwuit](./configuring-playbook-conduwuit.md)." msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:11 -msgid "⚠️ **Warnings**:" -msgstr "" - -#: ../../../docs/configuring-playbook-conduit.md:13 -msgid "**You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Conduit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet." -msgstr "" - -#: ../../../docs/configuring-playbook-conduit.md:15 -msgid "**Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding" -msgstr "" - -#: ../../../docs/configuring-playbook-conduit.md:17 -msgid "Adjusting the playbook configuration" +#: ../../../docs/configuring-playbook-conduit.md:18 +msgid "[!WARNING]" msgstr "" #: ../../../docs/configuring-playbook-conduit.md:19 +msgid "**You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Conduit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet." +msgstr "" + +#: ../../../docs/configuring-playbook-conduit.md:20 +msgid "**Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding" +msgstr "" + +#: ../../../docs/configuring-playbook-conduit.md:22 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-conduit.md:24 msgid "To use Conduit, you **generally** need to adjust the `matrix_homeserver_implementation: synapse` configuration on your `inventory/host_vars/matrix.example.com/vars.yml` file as below:" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:25 +#: ../../../docs/configuring-playbook-conduit.md:30 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:27 +#: ../../../docs/configuring-playbook-conduit.md:32 msgid "There are some additional things you may wish to configure about the server." msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:29 +#: ../../../docs/configuring-playbook-conduit.md:34 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:31 +#: ../../../docs/configuring-playbook-conduit.md:36 msgid "`roles/custom/matrix-conduit/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:32 +#: ../../../docs/configuring-playbook-conduit.md:37 msgid "`roles/custom/matrix-conduit/templates/conduit.toml.j2` for the server's default configuration" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:34 +#: ../../../docs/configuring-playbook-conduit.md:39 msgid "If you'd like to have your own different configuration, feel free to copy and paste the original files into your inventory (e.g. in `inventory/host_vars/matrix.example.com/`) and then change the specific host's `vars.yml` file like this:" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:40 +#: ../../../docs/configuring-playbook-conduit.md:45 msgid "Creating the first user account" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:42 +#: ../../../docs/configuring-playbook-conduit.md:47 msgid "Since it is difficult to create the first user account on Conduit (see [famedly/conduit#276](https://gitlab.com/famedly/conduit/-/issues/276) and [famedly/conduit#354](https://gitlab.com/famedly/conduit/-/merge_requests/354)) and it does not support [registering users](registering-users.md) (via the command line or via the playbook) like Synapse and Dendrite do, we recommend the following procedure:" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:44 +#: ../../../docs/configuring-playbook-conduit.md:49 msgid "Add `matrix_conduit_allow_registration: true` to your `vars.yml` the first time around, temporarily" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:45 +#: ../../../docs/configuring-playbook-conduit.md:50 msgid "Run the playbook (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start` — see [Installing](installing.md))" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:46 +#: ../../../docs/configuring-playbook-conduit.md:51 msgid "Create your first user via Element Web or any other client which supports creating users" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:47 +#: ../../../docs/configuring-playbook-conduit.md:52 msgid "Get rid of `matrix_conduit_allow_registration: true` from your `vars.yml`" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:48 +#: ../../../docs/configuring-playbook-conduit.md:53 msgid "Run the playbook again (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-conduit,start` would be enough this time)" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:49 +#: ../../../docs/configuring-playbook-conduit.md:54 msgid "You can now use your server safely. Additional users can be created by messaging the internal Conduit bot" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:51 +#: ../../../docs/configuring-playbook-conduit.md:56 msgid "Configuring bridges / appservices" msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:53 +#: ../../../docs/configuring-playbook-conduit.md:58 msgid "For other homeserver implementations (like Synapse and Dendrite), the playbook automatically registers appservices (for bridges, bots, etc.) with the homeserver." msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:55 +#: ../../../docs/configuring-playbook-conduit.md:60 msgid "For Conduit, you will have to manually register appservices using the the [register-appservice](https://gitlab.com/famedly/conduit/-/blob/next/APPSERVICES.md) command." msgstr "" -#: ../../../docs/configuring-playbook-conduit.md:57 +#: ../../../docs/configuring-playbook-conduit.md:62 msgid "Find the `registration.yaml` in the `/matrix` directory, for example `/matrix/mautrix-signal/bridge/registration.yaml`, then pass the content to Conduit:" msgstr "" + +#: ../../../docs/configuring-playbook-conduit.md:85 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-conduit.md:87 +msgid "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-conduit`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-conduwuit.pot b/i18n/translation-templates/docs/configuring-playbook-conduwuit.pot index 858c78384..dc33d66c1 100644 --- a/i18n/translation-templates/docs/configuring-playbook-conduwuit.pot +++ b/i18n/translation-templates/docs/configuring-playbook-conduwuit.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,114 +16,126 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-conduwuit.md:1 +#: ../../../docs/configuring-playbook-conduwuit.md:8 msgid "Configuring conduwuit (optional)" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:3 +#: ../../../docs/configuring-playbook-conduwuit.md:10 msgid "The playbook can install and configure the [conduwuit](https://conduwuit.puppyirl.gay/) Matrix server for you." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:5 +#: ../../../docs/configuring-playbook-conduwuit.md:12 msgid "See the project's [documentation](https://conduwuit.puppyirl.gay/) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:7 +#: ../../../docs/configuring-playbook-conduwuit.md:14 msgid "By default, the playbook installs [Synapse](https://github.com/element-hq/synapse) as it's the only full-featured Matrix server at the moment. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:9 +#: ../../../docs/configuring-playbook-conduwuit.md:16 msgid "💡 **Note**: conduwuit is a fork of [Conduit](./configuring-playbook-conduit.md), which the playbook also supports. See [Differences from upstream Conduit](https://conduwuit.puppyirl.gay/differences.html)." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:11 -msgid "⚠️ **Warnings**:" -msgstr "" - -#: ../../../docs/configuring-playbook-conduwuit.md:13 -msgid "**You can't switch an existing Matrix server's implementation** (e.g. Synapse -> conduwuit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet." -msgstr "" - -#: ../../../docs/configuring-playbook-conduwuit.md:15 -msgid "**Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding" -msgstr "" - -#: ../../../docs/configuring-playbook-conduwuit.md:17 -msgid "Adjusting the playbook configuration" +#: ../../../docs/configuring-playbook-conduwuit.md:18 +msgid "[!WARNING]" msgstr "" #: ../../../docs/configuring-playbook-conduwuit.md:19 +msgid "**You can't switch an existing Matrix server's implementation** (e.g. Synapse -> conduwuit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet." +msgstr "" + +#: ../../../docs/configuring-playbook-conduwuit.md:20 +msgid "**Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding" +msgstr "" + +#: ../../../docs/configuring-playbook-conduwuit.md:21 +msgid "**the Conduwuit project appears to have been abandoned**. You may wish to install [Conduit](./configuring-playbook-conduit.md), or one of the Conduwuit successors (like [Continuwuity](configuring-playbook-continuwuity.md))" +msgstr "" + +#: ../../../docs/configuring-playbook-conduwuit.md:23 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-conduwuit.md:25 msgid "To use conduwuit, you **generally** need to adjust the `matrix_homeserver_implementation: synapse` configuration on your `inventory/host_vars/matrix.example.com/vars.yml` file as below:" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:33 +#: ../../../docs/configuring-playbook-conduwuit.md:39 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:35 +#: ../../../docs/configuring-playbook-conduwuit.md:41 msgid "There are some additional things you may wish to configure about the server." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:37 +#: ../../../docs/configuring-playbook-conduwuit.md:43 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:39 +#: ../../../docs/configuring-playbook-conduwuit.md:45 msgid "`roles/custom/matrix-conduwuit/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:40 +#: ../../../docs/configuring-playbook-conduwuit.md:46 msgid "`roles/custom/matrix-conduwuit/templates/conduwuit.toml.j2` for the server's default configuration" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:42 +#: ../../../docs/configuring-playbook-conduwuit.md:48 msgid "There are various Ansible variables that control settings in the `conduwuit.toml` file." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:44 +#: ../../../docs/configuring-playbook-conduwuit.md:50 msgid "If a specific setting you'd like to change does not have a dedicated Ansible variable, you can either submit a PR to us to add it, or you can [override the setting using an environment variable](https://conduwuit.puppyirl.gay/configuration.html#environment-variables) using `matrix_conduwuit_environment_variables_extension`. For example:" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:52 +#: ../../../docs/configuring-playbook-conduwuit.md:58 msgid "Creating the first user account" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:54 +#: ../../../docs/configuring-playbook-conduwuit.md:60 msgid "Unlike other homeserver implementations (like Synapse and Dendrite), conduwuit does not support creating users via the command line or via the playbook." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:56 +#: ../../../docs/configuring-playbook-conduwuit.md:62 msgid "If you followed the instructions above (see [Adjusting the playbook configuration](#adjusting-the-playbook-configuration)), you should have registration enabled and protected by a registration token." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:58 +#: ../../../docs/configuring-playbook-conduwuit.md:64 msgid "This should allow you to create the first user account via any client (like [Element Web](./configuring-playbook-client-element-web.md)) which supports creating users." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:60 +#: ../../../docs/configuring-playbook-conduwuit.md:66 msgid "The **first user account that you create will be marked as an admin** and **will be automatically invited to an admin room**." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:63 +#: ../../../docs/configuring-playbook-conduwuit.md:69 msgid "Configuring bridges / appservices" msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:65 +#: ../../../docs/configuring-playbook-conduwuit.md:71 msgid "For other homeserver implementations (like Synapse and Dendrite), the playbook automatically registers appservices (for bridges, bots, etc.) with the homeserver." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:67 +#: ../../../docs/configuring-playbook-conduwuit.md:73 msgid "For conduwuit, you will have to manually register appservices using the [`!admin appservices register` command](https://conduwuit.puppyirl.gay/appservices.html#set-up-the-appservice---general-instructions) sent to the server bot account." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:69 +#: ../../../docs/configuring-playbook-conduwuit.md:75 msgid "The server's bot account has a Matrix ID of `@conduit:example.com` (not `@conduwuit:example.com`!) due to conduwuit's historical legacy. Your first user account would already have been invited to an admin room with this bot." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:72 +#: ../../../docs/configuring-playbook-conduwuit.md:78 msgid "Find the appservice file you'd like to register. This can be any `registration.yaml` file found in the `/matrix` directory, for example `/matrix/mautrix-signal/bridge/registration.yaml`." msgstr "" -#: ../../../docs/configuring-playbook-conduwuit.md:74 +#: ../../../docs/configuring-playbook-conduwuit.md:80 msgid "Then, send its content to the existing admin room:" msgstr "" + +#: ../../../docs/configuring-playbook-conduwuit.md:104 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-conduwuit.md:106 +msgid "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`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-continuwuity.pot b/i18n/translation-templates/docs/configuring-playbook-continuwuity.pot new file mode 100644 index 000000000..731752456 --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-continuwuity.pot @@ -0,0 +1,161 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-continuwuity.md:8 +msgid "Configuring Continuwuity (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:10 +msgid "The playbook can install and configure the [Continuwuity](https://continuwuity.org) Matrix server for you." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:12 +msgid "See the project's [documentation](https://continuwuity.org) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:14 +msgid "By default, the playbook installs [Synapse](https://github.com/element-hq/synapse) as it's the only full-featured Matrix server at the moment. If that's okay, you can skip this document." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:16 +msgid "💡 **Note**: continuwuity is a fork of [conduwuit](./configuring-playbook-conduwuit.md), which the playbook also supports." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:18 +msgid "[!WARNING]" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:19 +msgid "**You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Continuwuity). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:20 +msgid "**Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:22 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:24 +msgid "To use Continuwuity, you **generally** need to adjust the `matrix_homeserver_implementation: synapse` configuration on your `inventory/host_vars/matrix.example.com/vars.yml` file as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:38 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:40 +msgid "There are some additional things you may wish to configure about the server." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:42 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:44 +msgid "`roles/custom/matrix-continuwuity/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:45 +msgid "`roles/custom/matrix-continuwuity/templates/continuwuity.toml.j2` for the server's default configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:47 +msgid "There are various Ansible variables that control settings in the `continuwuity.toml` file." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:49 +msgid "If a specific setting you'd like to change does not have a dedicated Ansible variable, you can either submit a PR to us to add it, or you can [override the setting using an environment variable](https://continuwuity.org/configuration#environment-variables) using `matrix_continuwuity_environment_variables_extension`. For example:" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:57 +msgid "Creating the first user account" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:59 +msgid "Unlike other homeserver implementations (like Synapse and Dendrite), continuwuity does not support creating users via the command line or via the playbook." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:61 +msgid "If you followed the instructions above (see [Adjusting the playbook configuration](#adjusting-the-playbook-configuration)), you should have registration enabled and protected by a registration token." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:63 +msgid "This should allow you to create the first user account via any client (like [Element Web](./configuring-playbook-client-element-web.md)) which supports creating users." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:65 +msgid "The **first user account that you create will be marked as an admin** and **will be automatically invited to an admin room**." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:68 +msgid "Configuring bridges / appservices" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:70 +msgid "For other homeserver implementations (like Synapse and Dendrite), the playbook automatically registers appservices (for bridges, bots, etc.) with the homeserver." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:72 +msgid "For continuwuity, you will have to manually register appservices using the [`!admin appservices register` command](https://continuwuity.org/appservices.html#set-up-the-appservice---general-instructions) sent to the server bot account." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:74 +msgid "The server's bot account has a Matrix ID of `@conduit:example.com` (not `@continuwuity:example.com`!) due to continuwuity's historical legacy. Your first user account would already have been invited to an admin room with this bot." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:77 +msgid "Find the appservice file you'd like to register. This can be any `registration.yaml` file found in the `/matrix` directory, for example `/matrix/mautrix-signal/bridge/registration.yaml`." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:79 +msgid "Then, send its content to the existing admin room:" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:103 +msgid "Migrating from conduwuit" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:105 +msgid "Since Continuwuity is a drop-in replacement for [conduwuit](configuring-playbook-conduwuit.md), migration is possible." +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:107 +msgid "Make sure that Continuwuity is properly set up on your `vars.yml` as described above" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:109 +msgid "Make sure that Conduwuit references are removed from your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:111 +msgid "Run the installation in a way that installs new services and uninstalls old ones (e.g. `just setup-all`)" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:113 +msgid "Run the playbook with the `continuwuity-migrate-from-conduwuit` tag (e.g. `just run-tags continuwuity-migrate-from-conduwuit`). This migrates data from `/matrix/conduwuit` to `/matrix/continuwuity`" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:115 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-continuwuity.md:117 +msgid "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-continuwuity`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-dendrite.pot b/i18n/translation-templates/docs/configuring-playbook-dendrite.pot index ee7e64695..b5ef71836 100644 --- a/i18n/translation-templates/docs/configuring-playbook-dendrite.pot +++ b/i18n/translation-templates/docs/configuring-playbook-dendrite.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,78 +16,94 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-dendrite.md:1 +#: ../../../docs/configuring-playbook-dendrite.md:9 msgid "Configuring Dendrite (optional)" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:3 +#: ../../../docs/configuring-playbook-dendrite.md:11 msgid "The playbook can install and configure the [Dendrite](https://github.com/element-hq/dendrite) Matrix server for you." msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:5 +#: ../../../docs/configuring-playbook-dendrite.md:13 msgid "See the project's [documentation](https://element-hq.github.io/dendrite/) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:7 +#: ../../../docs/configuring-playbook-dendrite.md:15 msgid "By default, the playbook installs [Synapse](https://github.com/element-hq/synapse) as it's the only full-featured Matrix server at the moment. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:9 -msgid "⚠️ **Warnings**:" +#: ../../../docs/configuring-playbook-dendrite.md:17 +msgid "[!WARNING]" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:11 +#: ../../../docs/configuring-playbook-dendrite.md:18 msgid "**You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Dendrite). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet." msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:13 +#: ../../../docs/configuring-playbook-dendrite.md:19 msgid "**Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:15 +#: ../../../docs/configuring-playbook-dendrite.md:21 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:17 +#: ../../../docs/configuring-playbook-dendrite.md:23 msgid "To use Dendrite, you **generally** need to adjust the `matrix_homeserver_implementation: synapse` configuration on your `inventory/host_vars/matrix.example.com/vars.yml` file as below:" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:23 +#: ../../../docs/configuring-playbook-dendrite.md:29 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:25 +#: ../../../docs/configuring-playbook-dendrite.md:31 msgid "There are some additional things you may wish to configure about the server." msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:27 +#: ../../../docs/configuring-playbook-dendrite.md:33 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:29 +#: ../../../docs/configuring-playbook-dendrite.md:35 msgid "`roles/custom/matrix-dendrite/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:30 +#: ../../../docs/configuring-playbook-dendrite.md:36 msgid "`roles/custom/matrix-dendrite/templates/dendrite.yaml.j2` for the server's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_dendrite_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:32 +#: ../../../docs/configuring-playbook-dendrite.md:38 msgid "For example, to override some Dendrite settings, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:53 +#: ../../../docs/configuring-playbook-dendrite.md:59 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:55 +#: ../../../docs/configuring-playbook-dendrite.md:61 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:62 +#: ../../../docs/configuring-playbook-dendrite.md:68 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-dendrite.md:64 +#: ../../../docs/configuring-playbook-dendrite.md:70 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-dendrite.md:72 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-dendrite.md:74 +msgid "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-dendrite`." +msgstr "" + +#: ../../../docs/configuring-playbook-dendrite.md:76 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-dendrite.md:78 +msgid "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:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-dimension.pot b/i18n/translation-templates/docs/configuring-playbook-dimension.pot index 5126a16aa..a920d9bfd 100644 --- a/i18n/translation-templates/docs/configuring-playbook-dimension.pot +++ b/i18n/translation-templates/docs/configuring-playbook-dimension.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,195 +16,203 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-dimension.md:1 +#: ../../../docs/configuring-playbook-dimension.md:16 msgid "Setting up Dimension integration manager (optional, unmaintained)" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:3 -#: ../../../docs/configuring-playbook-dimension.md:109 +#: ../../../docs/configuring-playbook-dimension.md:18 +#: ../../../docs/configuring-playbook-dimension.md:124 msgid "**Notes**:" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:4 +#: ../../../docs/configuring-playbook-dimension.md:19 msgid "Dimension is **[officially unmaintained](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806#issuecomment-1673559299)**. We recommend not bothering with installing it." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:5 +#: ../../../docs/configuring-playbook-dimension.md:20 msgid "This playbook now supports running Dimension in both a federated and [unfederated](https://github.com/turt2live/matrix-dimension/blob/master/docs/unfederated.md) environments. This is handled automatically based on the value of `matrix_homeserver_federation_enabled`." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:7 +#: ../../../docs/configuring-playbook-dimension.md:22 msgid "The playbook can install and configure the [Dimension](https://dimension.t2bot.io) integration manager for you." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:9 +#: ../../../docs/configuring-playbook-dimension.md:24 msgid "See the project's [documentation](https://github.com/turt2live/matrix-dimension/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:11 +#: ../../../docs/configuring-playbook-dimension.md:26 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:13 +#: ../../../docs/configuring-playbook-dimension.md:28 msgid "Open Matrix Federation port" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:15 +#: ../../../docs/configuring-playbook-dimension.md:30 msgid "Enabling the Dimension service will automatically reconfigure your Synapse homeserver to expose the `openid` API endpoints on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. If you enable the component, make sure that the port is accessible." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:17 +#: ../../../docs/configuring-playbook-dimension.md:32 msgid "Install Matrix services" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:19 +#: ../../../docs/configuring-playbook-dimension.md:34 msgid "Dimension can only be installed after Matrix services are installed and running. If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) and come back here later." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:21 +#: ../../../docs/configuring-playbook-dimension.md:36 msgid "Register a dedicated Matrix user (optional, recommended)" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:23 +#: ../../../docs/configuring-playbook-dimension.md:38 msgid "We recommend that you create a dedicated Matrix user for Dimension (`dimension` is a good username)." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:25 +#: ../../../docs/configuring-playbook-dimension.md:40 msgid "Generate a strong password for the user. You can create one with a command like `pwgen -s 64 1`." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:27 +#: ../../../docs/configuring-playbook-dimension.md:42 msgid "You can use the playbook to [register a new user](registering-users.md):" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:33 +#: ../../../docs/configuring-playbook-dimension.md:48 msgid "Obtain an access token" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:35 +#: ../../../docs/configuring-playbook-dimension.md:50 msgid "Dimension requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:37 +#: ../../../docs/configuring-playbook-dimension.md:52 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:40 +#: ../../../docs/configuring-playbook-dimension.md:55 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:42 +#: ../../../docs/configuring-playbook-dimension.md:57 msgid "By default, this playbook installs Dimension on the `dimension.` subdomain (`dimension.example.com`) and requires you to create a CNAME record for `dimension`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:44 +#: ../../../docs/configuring-playbook-dimension.md:59 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:46 +#: ../../../docs/configuring-playbook-dimension.md:61 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:48 +#: ../../../docs/configuring-playbook-dimension.md:63 msgid "To enable Dimension, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#obtain-an-access-token)." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:56 +#: ../../../docs/configuring-playbook-dimension.md:71 msgid "Define admin users" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:58 +#: ../../../docs/configuring-playbook-dimension.md:73 msgid "To define admin users who can modify the integrations this Dimension supports, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:66 +#: ../../../docs/configuring-playbook-dimension.md:81 msgid "The admin interface is accessible within Element Web by accessing it in any room and clicking the cog wheel/settings icon in the top right. Currently, Dimension can be opened in Element Web by the \"Add widgets, bridges, & bots\" link in the room information." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:68 +#: ../../../docs/configuring-playbook-dimension.md:83 msgid "Adjusting the Dimension URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:70 +#: ../../../docs/configuring-playbook-dimension.md:85 msgid "By tweaking the `matrix_dimension_hostname` and `matrix_dimension_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:72 +#: ../../../docs/configuring-playbook-dimension.md:87 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:83 +#: ../../../docs/configuring-playbook-dimension.md:98 msgid "After changing the domain, **you may need to adjust your DNS** records to point the Dimension domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:85 +#: ../../../docs/configuring-playbook-dimension.md:100 msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:87 +#: ../../../docs/configuring-playbook-dimension.md:102 msgid "**Note**: while there is a `matrix_dimension_path_prefix` variable for changing the path where Dimension is served, overriding it is not possible due to [this Dimension issue](https://github.com/turt2live/matrix-dimension/issues/510). You'd need to serve Dimension at a dedicated subdomain." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:89 +#: ../../../docs/configuring-playbook-dimension.md:104 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:91 +#: ../../../docs/configuring-playbook-dimension.md:106 msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:93 +#: ../../../docs/configuring-playbook-dimension.md:108 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:95 +#: ../../../docs/configuring-playbook-dimension.md:110 msgid "`roles/custom/matrix-dimension/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:96 +#: ../../../docs/configuring-playbook-dimension.md:111 msgid "`roles/custom/matrix-dimension/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_dimension_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:98 +#: ../../../docs/configuring-playbook-dimension.md:113 msgid "You can find all configuration options on [GitHub page of Dimension project](https://github.com/turt2live/matrix-dimension/blob/master/config/default.yaml)." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:100 +#: ../../../docs/configuring-playbook-dimension.md:115 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:102 +#: ../../../docs/configuring-playbook-dimension.md:117 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:111 +#: ../../../docs/configuring-playbook-dimension.md:126 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:113 +#: ../../../docs/configuring-playbook-dimension.md:128 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:115 +#: ../../../docs/configuring-playbook-dimension.md:130 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:117 +#: ../../../docs/configuring-playbook-dimension.md:132 msgid "After Dimension has been installed you may need to log out and log back in for it to pick up the new integration manager. Then you can access integrations in Element Web by opening a room, clicking the room info button (`i`) on the top right corner, and then clicking the \"Add widgets, bridges, & bots\" link." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:119 +#: ../../../docs/configuring-playbook-dimension.md:134 msgid "Set up a Jitsi widget" msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:121 +#: ../../../docs/configuring-playbook-dimension.md:136 msgid "By default Dimension will use [jitsi.riot.im](https://jitsi.riot.im/) as the `conferenceDomain` of [Jitsi](https://jitsi.org/) audio/video conference widgets. For users running [a self-hosted Jitsi instance](configuring-playbook-jitsi.md), you will likely want the widget to use your own Jitsi instance." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:123 +#: ../../../docs/configuring-playbook-dimension.md:138 msgid "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." msgstr "" -#: ../../../docs/configuring-playbook-dimension.md:125 +#: ../../../docs/configuring-playbook-dimension.md:140 msgid "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." msgstr "" + +#: ../../../docs/configuring-playbook-dimension.md:142 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-dimension.md:144 +msgid "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`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-dynamic-dns.pot b/i18n/translation-templates/docs/configuring-playbook-dynamic-dns.pot index 9a0939cb2..958e5eb95 100644 --- a/i18n/translation-templates/docs/configuring-playbook-dynamic-dns.pot +++ b/i18n/translation-templates/docs/configuring-playbook-dynamic-dns.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,58 +16,90 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-dynamic-dns.md:1 +#: ../../../docs/configuring-playbook-dynamic-dns.md:9 msgid "Setting up Dynamic DNS (optional)" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:3 +#: ../../../docs/configuring-playbook-dynamic-dns.md:11 msgid "The playbook can configure Dynamic DNS with [ddclient⁠](https://github.com/ddclient/ddclient) for you. It is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider." msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:5 +#: ../../../docs/configuring-playbook-dynamic-dns.md:13 msgid "Most cloud providers / ISPs will charge you extra for a static IP address. If you're not hosting a highly reliable homeserver you can workaround this via dynamic DNS." msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:7 +#: ../../../docs/configuring-playbook-dynamic-dns.md:15 msgid "Prerequisite" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:9 -msgid "You'll need to get a username and password from your DNS provider. Please consult with the provider about how to retrieve them." +#: ../../../docs/configuring-playbook-dynamic-dns.md:17 +msgid "You'll need to authenticate with your DNS provider somehow, in most cases this is simply a username and password but can differ from provider to provider. Please consult with your providers documentation and the upstream [ddclient documentation](https://github.com/ddclient/ddclient/blob/main/ddclient.conf.in) to determine what you'll need to provide to authenticate." msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:11 +#: ../../../docs/configuring-playbook-dynamic-dns.md:19 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:13 +#: ../../../docs/configuring-playbook-dynamic-dns.md:21 msgid "To enable dynamic DNS, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:26 +#: ../../../docs/configuring-playbook-dynamic-dns.md:34 +msgid "Keep in mind that certain providers may require a different configuration of the `matrix_dynamic_dns_domain_configurations` variable, for provider specific examples see the [upstream documentation](https://github.com/ddclient/ddclient/blob/main/ddclient.conf.in)." +msgstr "" + +#: ../../../docs/configuring-playbook-dynamic-dns.md:36 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-dynamic-dns.md:38 +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-dynamic-dns.md:40 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-dynamic-dns.md:42 +msgid "`roles/custom/matrix-dynamic-dns/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-dynamic-dns.md:44 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:28 +#: ../../../docs/configuring-playbook-dynamic-dns.md:46 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:35 +#: ../../../docs/configuring-playbook-dynamic-dns.md:53 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:37 +#: ../../../docs/configuring-playbook-dynamic-dns.md:55 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:39 +#: ../../../docs/configuring-playbook-dynamic-dns.md:57 msgid "Additional Reading" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:41 +#: ../../../docs/configuring-playbook-dynamic-dns.md:59 msgid "Additional resources:" msgstr "" -#: ../../../docs/configuring-playbook-dynamic-dns.md:43 +#: ../../../docs/configuring-playbook-dynamic-dns.md:61 msgid "https://matrix.org/docs/guides/free-small-matrix-server" msgstr "" + +#: ../../../docs/configuring-playbook-dynamic-dns.md:62 +msgid "https://github.com/linuxserver/docker-ddclient" +msgstr "" + +#: ../../../docs/configuring-playbook-dynamic-dns.md:64 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-dynamic-dns.md:66 +msgid "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-dynamic-dns`. However, due to an [upstream issue](https://github.com/linuxserver/docker-ddclient/issues/54#issuecomment-1153143132) the logging output is not always complete. For advanced debugging purposes running the `ddclient` tool outside of the container is useful via the following: `ddclient -file ./ddclient.conf -daemon=0 -debug -verbose -noquiet`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-element-admin.pot b/i18n/translation-templates/docs/configuring-playbook-element-admin.pot new file mode 100644 index 000000000..b2ed8efbb --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-element-admin.pot @@ -0,0 +1,113 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-element-admin.md:8 +msgid "Setting up Element Admin (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:10 +msgid "The playbook can install and configure [Element Admin](https://github.com/element-hq/element-admin) for you." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:12 +msgid "Element Admin is a web-based administration panel for Synapse and [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md)." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:14 +msgid "See the project's [documentation](https://github.com/element-hq/element-admin) to learn more." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:16 +msgid "💡 **Note**: This project is still very young and doesn't have many features. For now, it's recommended to use [Synapse Admin](./configuring-playbook-synapse-admin.md) instead. Deployments that use [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) can use Element Admin for user-management (something that Synapse Admin can't do), while continuing to use Synapse Admin for all other purposes." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:18 +msgid "Prerequisites" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:20 +msgid "A [Synapse](configuring-playbook-synapse.md) homeserver with its Admin API enabled (the playbook automatically enables it for you when you enable Element Admin)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:21 +msgid "[Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) with its Admin API enabled (the playbook automatically enables it for you when you enable Element Admin)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:23 +msgid "Decide on a domain and path" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:25 +msgid "By default, the Element Admin is configured to be served on the `admin.element.example.com` domain." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:27 +msgid "If you'd like to run Element Admin on another hostname, see the [Adjusting the Element Admin URL](#adjusting-the-element-admin-url-optional) section below." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:29 +msgid "Adjusting DNS records (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:31 +msgid "By default, this playbook installs Element Admin on the `admin.element.` subdomain (`admin.element.example.com`) and requires you to create a `CNAME` record for `admin.element`, which targets `matrix.example.com`." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:33 +msgid "When setting these values, replace `example.com` with your own." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:35 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:37 +msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:43 +msgid "Adjusting the Element Admin URL (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:45 +msgid "By tweaking the `matrix_element_admin_hostname` variable, you can easily make the service available at a **different hostname** than the default one." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:47 +msgid "Example additional configuration for your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:53 +msgid "[!WARNING] A `matrix_element_admin_path_prefix` variable is also available and mean to let you configure a path prefix for the Element Admin service, but **Element Admin does not support running under a sub-path yet**." +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:56 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:58 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:65 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-element-admin.md:67 +msgid "`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." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-element-call.pot b/i18n/translation-templates/docs/configuring-playbook-element-call.pot new file mode 100644 index 000000000..a0ed18321 --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-element-call.pot @@ -0,0 +1,245 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-element-call.md:8 +msgid "Setting up Element Call (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:10 +msgid "The playbook can install and configure [Element Call](https://github.com/element-hq/element-call) and its supporting components that are part of the [Matrix RTC stack](configuring-playbook-matrix-rtc.md)." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:12 +msgid "Element Call is a native Matrix video conferencing application developed by [Element](https://element.io), designed for secure, scalable, privacy-respecting, and decentralized video and voice calls over the Matrix protocol. Built on MatrixRTC ([MSC4143](https://github.com/matrix-org/matrix-spec-proposals/pull/4143)), it utilizes [MSC4195](https://github.com/hughns/matrix-spec-proposals/blob/hughns/matrixrtc-livekit/proposals/4195-matrixrtc-livekit.md) with [LiveKit Server](configuring-playbook-livekit-server.md) as its backend." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:14 +msgid "See the project's [documentation](https://github.com/element-hq/element-call) to learn more." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:16 +msgid "Prerequisites" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:18 +msgid "A [Synapse](configuring-playbook-synapse.md) homeserver (see the warning below)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:19 +msgid "The [Matrix RTC (Real-Time Communication) stack](configuring-playbook-matrix-rtc.md) (automatically done when Element Call is enabled)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:20 +msgid "A client compatible with Element Call. As of 2025-03-15, that's just [Element Web](configuring-playbook-client-element-web.md) and the Element X mobile clients (iOS and Android)." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:21 +msgid "(Optional) Guest accounts being enabled for your Matrix server, if you'd like guests to be able to use Element Call. See [Allowing guests to use Element Call](#allowing-guests-to-use-element-call-optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:23 +msgid "[!WARNING] Because Element Call [requires](https://github.com/element-hq/element-call/blob/93ae2aed9841e0b066d515c56bd4c122d2b591b2/docs/self-hosting.md#a-matrix-homeserver) a few experimental features in the Matrix protocol, it's **very likely that it only works with the Synapse homeserver**." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:26 +msgid "Decide between Element Call vs just the Matrix RTC stack" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:28 +msgid "All clients that can currently use Element Call (Element Web and Element X on mobile) already embed the Element Call frontend within them. These **clients will use their own embedded Element Call frontend**, so **self-hosting the Element Call frontend by the playbook is largely unnecessary**." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:31 +msgid "💡 A reason you may wish to continue installing the Element Call frontend (despite Matrix clients not making use of it), is if you need to use it standalone - directly via a browser (without a Matrix client). Note that unless you [allow guest accounts to use Element Call](#allowing-guests-to-use-element-call-optional), you will still need a Matrix user account **on the same homeserver** to be able to use Element Call." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:33 +msgid "The playbook makes a distinction between enabling Element Call (`matrix_element_call_enabled`) and enabling the Matrix RTC Stack (`matrix_rtc_enabled`). Enabling Element Call automatically enables the Matrix RTC stack. Because installing the Element Call frontend is now unnecessary, **we recommend only installing the Matrix RTC stack, without the Element Call frontend**." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "Description / Variable" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "Element Call frontend" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "[LiveKit Server](configuring-playbook-livekit-server.md)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "[LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "Description" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "Static website that provides the Element Call UI (but often embedded by clients)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "Scalable, multi-user conferencing solution based on WebRTC" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "A helper component that allows Element Call to integrate with LiveKit Server" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "Required for Element Call to function" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "No" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "Yes" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "`matrix_element_call_enabled`" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "✅ Installed" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "`matrix_rtc_enabled`" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:0 +msgid "❌ Not Installed, but usually unnecessary" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:42 +msgid "All documentation below assumes that you've decided to install Element Call and not just the Matrix RTC stack." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:44 +msgid "Decide on a domain and path" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:46 +msgid "By default, the Element Call frontend is configured to be served on the `call.element.example.com` domain." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:48 +msgid "If you'd like to run Element Call on another hostname, see the [Adjusting the Element Call URL](#adjusting-the-element-call-url-optional) section below." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:50 +msgid "Adjusting DNS records" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:52 +msgid "By default, this playbook installs Element Call on the `call.element.` subdomain (`call.element.example.com`) and requires you to create a `CNAME` record for `call.element`, which targets `matrix.example.com`." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:54 +msgid "When setting these values, replace `example.com` with your own." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:56 +msgid "All dependency services for Element Call ([LiveKit Server](configuring-playbook-livekit-server.md) and [Livekit JWT Service](configuring-playbook-livekit-jwt-service.md)) are installed and configured automatically by the playbook. By default, these services are installed on subpaths on the `matrix.` domain (e.g. `/livekit-server`, `/livekit-jwt-service`), so no DNS record adjustments are required for them." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:58 +msgid "Adjusting firewall rules" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:60 +msgid "In addition to the HTTP/HTTPS ports (which you've already exposed as per the [prerequisites](prerequisites.md) document), you'll also need to open ports required by [LiveKit Server](configuring-playbook-livekit-server.md) as described in its own [Adjusting firewall rules](configuring-playbook-livekit-server.md#adjusting-firewall-rules) section." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:62 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:64 +msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:72 +msgid "Adjusting the Element Call URL (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:74 +msgid "By tweaking the `matrix_element_call_hostname` variable, you can easily make the service available at a **different hostname** than the default one." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:76 +msgid "Example additional configuration for your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:82 +msgid "[!WARNING] A `matrix_element_call_path_prefix` variable is also available and mean to let you configure a path prefix for the Element Call service, but [Element Call does not support running under a sub-path yet](https://github.com/element-hq/element-call/issues/3084)." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:85 +msgid "Allowing guests to use Element Call (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:87 +msgid "By default, Element Call can only be used by people having accounts on your Matrix server." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:89 +msgid "If you'd like guests to be able to use Element Call as well, you need to enable guest accounts support for your homeserver." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:91 +msgid "[!WARNING] Enabling guest accounts means that your homeserver's user database may get polluted with guest account signups (potentially made by bots). Guest accounts should be limited in what (damage) they can do to your server and the rest of the Matrix ecosystem, but it's better to not enable them unless necessary." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:95 +msgid "For [Synapse](configuring-playbook-synapse.md) (the default homeserver implementation), the configuration is like this:" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:101 +msgid "For [Dendrite](configuring-playbook-dendrite.md), the configuration is like this:" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:107 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:109 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records) and [adjusting firewall rules](#adjusting-firewall-rules), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:116 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:118 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:120 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-element-call.md:122 +msgid "Once installed, Element Call integrates seamlessly with Matrix clients like [Element Web](configuring-playbook-client-element-web.md) and Element X on mobile (iOS and Android)." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-email.pot b/i18n/translation-templates/docs/configuring-playbook-email.pot index 997f2f7cc..4317db3ab 100644 --- a/i18n/translation-templates/docs/configuring-playbook-email.pot +++ b/i18n/translation-templates/docs/configuring-playbook-email.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,74 +16,114 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-email.md:1 +#: ../../../docs/configuring-playbook-email.md:10 msgid "Adjusting email-sending settings (optional)" msgstr "" -#: ../../../docs/configuring-playbook-email.md:3 -msgid "By default, this playbook sets up an [Exim](https://www.exim.org/) email server through which all Matrix services send emails." -msgstr "" - -#: ../../../docs/configuring-playbook-email.md:5 -msgid "The email server would attempt to deliver emails directly to their final destination. This may or may not work, depending on your domain configuration (SPF settings, etc.)" -msgstr "" - -#: ../../../docs/configuring-playbook-email.md:7 -msgid "By default, emails are sent from `matrix@matrix.example.com`, as specified by the `exim_relay_sender_address` playbook variable." -msgstr "" - -#: ../../../docs/configuring-playbook-email.md:9 -msgid "[!WARNING] On some cloud providers (Google Cloud, etc.), [port 25 is always blocked](https://cloud.google.com/compute/docs/tutorials/sending-mail/), so sending email directly from your server is not possible. You will need to [relay email through another SMTP server](#relaying-email-through-another-smtp-server)." -msgstr "" - #: ../../../docs/configuring-playbook-email.md:12 -msgid "💡 To improve deliverability, we recommend [relaying email through another SMTP server](#relaying-email-through-another-smtp-server) anyway." +msgid "By default, this playbook sets up an [Exim](https://www.exim.org/) relay SMTP mailer service (powered by [exim-relay](https://github.com/devture/exim-relay) and the [ansible-role-exim-relay](https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay) Ansible role), through which all Matrix services send emails." msgstr "" #: ../../../docs/configuring-playbook-email.md:14 -msgid "Firewall settings" +msgid "**With the default setting, exim-relay attempts to deliver emails directly with the address `matrix@matrix.example.com`**, as specified by the `exim_relay_sender_address` playbook variable. See below if you want to configure the playbook to relay email through another SMTP server." msgstr "" #: ../../../docs/configuring-playbook-email.md:16 -msgid "No matter whether you send email directly (the default) or you relay email through another host (see how below), you'll probably need to allow outgoing traffic for TCP ports 25/587 (depending on configuration)." +msgid "The [Ansible role for exim-relay](https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring exim-relay, you can check them via:" +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:17 +msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay/blob/main/docs/configuring-exim-relay.md) online" msgstr "" #: ../../../docs/configuring-playbook-email.md:18 -msgid "Adjusting the playbook configuration" +msgid "📁 `roles/galaxy/exim_relay/docs/configuring-exim-relay.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)" msgstr "" #: ../../../docs/configuring-playbook-email.md:20 -msgid "Relaying email through another SMTP server" +msgid "Firewall settings" msgstr "" #: ../../../docs/configuring-playbook-email.md:22 -msgid "If you'd like to relay email through another SMTP server, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" +msgid "No matter whether you send email directly (the default) or you relay email through another host, you'll probably need to allow outgoing traffic for TCP ports 25/587 (depending on configuration)." +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:24 +msgid "Docker automatically opens these ports in the server's firewall, so you likely don't need to do anything. If you use another firewall in front of the server, you may need to adjust it." +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:26 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:28 +msgid "Enable DKIM authentication to improve deliverability (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:30 +msgid "By default, exim-relay attempts to deliver emails directly. This may or may not work, depending on your domain configuration." +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:32 +msgid "To improve email deliverability, you can configure authentication methods such as DKIM (DomainKeys Identified Mail), SPF, and DMARC for your domain. Without setting any of these authentication methods, your outgoing email is most likely to be quarantined as spam at recipient's mail servers." msgstr "" #: ../../../docs/configuring-playbook-email.md:34 -msgid "**Note**: only the secure submission protocol (using `STARTTLS`, usually on port `587`) is supported. **SMTPS** (encrypted SMTP, usually on port `465`) **is not supported**." +msgid "For details about configuring DKIM, refer [this section](https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay/blob/main/docs/configuring-exim-relay.md#enable-dkim-support-optional) on the role's documentation." msgstr "" #: ../../../docs/configuring-playbook-email.md:36 -msgid "Sending emails using Sendgrid" +msgid "💡 If you cannot enable DKIM, SPF, or DMARC on your domain for some reason, we recommend relaying email through another SMTP server." msgstr "" #: ../../../docs/configuring-playbook-email.md:38 -msgid "An easy and free SMTP service to set up is [Sendgrid](https://sendgrid.com/). Its free tier allows for up to 100 emails per day to be sent." +msgid "Relaying email through another SMTP server (optional)" msgstr "" #: ../../../docs/configuring-playbook-email.md:40 -msgid "To set it up, add the following configuration to your `vars.yml` file (adapt to your needs):" +msgid "**On some cloud providers such as Google Cloud, [port 25 is always blocked](https://cloud.google.com/compute/docs/tutorials/sending-mail/), so sending email directly from your server is not possible.** In this case, you will need to relay email through another SMTP server." msgstr "" -#: ../../../docs/configuring-playbook-email.md:57 +#: ../../../docs/configuring-playbook-email.md:42 +msgid "For details about configuration, refer [this section](https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay/blob/main/docs/configuring-exim-relay.md#relaying-email-through-another-smtp-server) on the role's document." +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:44 +msgid "Disable mail service (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:46 +msgid "For a low-power server you might probably want to disable exim-relay. To do so, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:52 +msgid "Note that disabling exim-relay will stop email-notifications and other similar functions from working." +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:54 +msgid "See [this entry on the FAQ](faq.md#how-do-i-optimize-this-setup-for-a-low-power-server) for other possible optimizations for a low-power server." +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:56 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:58 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:65 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:67 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-email.md:69 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-email.md:59 -msgid "If you're having trouble with email not being delivered, it may be useful to inspect the mailer logs." -msgstr "" - -#: ../../../docs/configuring-playbook-email.md:61 -msgid "To do so, log in to the server with SSH and run `journalctl -f -u matrix-exim-relay`." +#: ../../../docs/configuring-playbook-email.md:71 +msgid "See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-exim-relay/blob/main/docs/configuring-exim-relay.md#troubleshooting) on the role's documentation for details." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-email2matrix.pot b/i18n/translation-templates/docs/configuring-playbook-email2matrix.pot index 351bb45a2..7b43a00f9 100644 --- a/i18n/translation-templates/docs/configuring-playbook-email2matrix.pot +++ b/i18n/translation-templates/docs/configuring-playbook-email2matrix.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,258 +16,22 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-email2matrix.md:1 -msgid "Setting up Email2Matrix (optional, deprecated)" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:3 -msgid "**Note**: this component has been deprecated. We recommend not bothering with installing it. While not a 1:1 replacement, the author suggests taking a look at [Postmoogle](https://github.com/etkecc/postmoogle) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-postmoogle.md). Consider using that component instead of this one." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:5 -msgid "The playbook can install and configure [Email2Matrix](https://github.com/devture/email2matrix) for you." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:7 -msgid "See the project's [documentation](https://github.com/devture/email2matrix/blob/master/docs/README.md) to learn what it does and why it might be useful to you." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:9 -msgid "Preparation" -msgstr "" - #: ../../../docs/configuring-playbook-email2matrix.md:11 -msgid "Port availability" +msgid "Setting up Email2Matrix (optional, removed)" msgstr "" #: ../../../docs/configuring-playbook-email2matrix.md:13 -msgid "Ensure that port 25 is available on your Matrix server and open in your firewall." +msgid "🪦 The playbook used to be able to install and configure [Email2Matrix](https://github.com/devture/email2matrix), but no longer includes this component." msgstr "" #: ../../../docs/configuring-playbook-email2matrix.md:15 -msgid "If you have `postfix` or some other email server software installed, you may need to manually remove it first (unless you need it, of course)." +msgid "For a long time now, it been replaced by the much better and more maintained [Postmoogle](https://github.com/etkecc/postmoogle) bridge, which can also be [installed using this playbook](configuring-playbook-bridge-postmoogle.md)." msgstr "" -#: ../../../docs/configuring-playbook-email2matrix.md:17 -msgid "If you really need to run an email server on the Matrix machine for other purposes, it may be possible to run Email2Matrix on another port (with a configuration like `matrix_email2matrix_smtp_host_bind_port: \"127.0.0.01:2525\"`) and have your other email server relay messages there." +#: ../../../docs/configuring-playbook-email2matrix.md:18 +msgid "Uninstalling Email2Matrix manually" msgstr "" -#: ../../../docs/configuring-playbook-email2matrix.md:19 -msgid "For details about using Email2Matrix alongside [Postfix](http://www.postfix.org/), see [here](https://github.com/devture/email2matrix/blob/master/docs/setup_with_postfix.md)." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:21 -msgid "Register a dedicated Matrix user (optional, recommended)" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:23 -msgid "We recommend that you create a dedicated Matrix user for Email2Matrix." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:25 -msgid "Generate a strong password for the user. You can create one with a command like `pwgen -s 64 1`." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:27 -msgid "You can use the playbook to [register a new user](registering-users.md):" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:33 -msgid "Take note of the user's ID as it needs to be specified as `MatrixUserId` on your `inventory/host_vars/matrix.example.com/vars.yml` file later." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:35 -msgid "Obtain an access token" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:37 -msgid "Email2Matrix requires an access token for the sender user to be able to send messages to the room. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:39 -msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:42 -msgid "Join to rooms as the sender user manually" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:44 -msgid "ℹ️ **Email2Matrix does not accept room invitations automatically**. To deliver messages to rooms, the sender user must be joined to all rooms manually." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:46 -msgid "For each new room you would like the user to deliver messages to, invite the user to the room." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:48 -msgid "Then, log in as the sender user using any Matrix client of your choosing, accept the room invitation from the user's account." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:50 -msgid "Make sure that you and the sender user are part of the same room and that the sender user has enough privileges in the room to be able to send messages there, then log out." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:52 -msgid "Take note of each room's room ID (different clients show the room ID in a different place). You'll need the room ID when [configuring the playbook](#adjusting-the-playbook-configuration) below." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:54 -msgid "Adjusting DNS records" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:56 -msgid "To increase the chances that incoming emails reach your server, you can set up a `MX` record for `matrix.example.com` that looks like this:" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "Type" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "Host" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "Priority" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "Weight" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "Port" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "Target" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "MX" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "`matrix`" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "10" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "0" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "-" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:0 -msgid "`matrix.example.com`" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:62 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:64 -msgid "To enable Email2Matrix, add the following configuration to your `vars.yml` file. Make sure to replace `ACCESS_TOKEN_FOR_EMAIL2MATRIX1_HERE` and `ACCESS_TOKEN_FOR_EMAIL2MATRIX2_HERE` with the ones created [above](#obtain-an-access-token)." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:90 -msgid "where:" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:92 -msgid "MailboxName — local-part of the email address, through which emails are bridged to the room whose ID is defined with MatrixRoomId" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:93 -msgid "MatrixRoomId — internal ID of the room, to which received emails are sent as Matrix message" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:94 -msgid "MatrixHomeserverUrl — URL of your Matrix homeserver, through which to send Matrix messages. You can also set `MatrixHomeserverUrl` to the container URL where your homeserver's Client-Server API lives by using the `{{ matrix_addons_homeserver_client_api_url }}` variable" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:95 -msgid "MatrixUserId — the full ID of the sender user which sends bridged messages to the room. On this configuration it is `@email2matrix1:example.com` and `@email2matrix2:example.com` (where `example.com` is your base domain, not the `matrix.` domain)" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:96 -msgid "MatrixAccessToken — sender user's access token" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:97 -msgid "IgnoreSubject — if set to \"true\", the subject is not bridged to Matrix" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:98 -msgid "IgnoreBody — if set to \"true\", the message body is not bridged to Matrix" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:99 -msgid "SkipMarkdown — if set to \"true\", emails are bridged as plain text Matrix message instead of Markdown (actually HTML)" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:101 -msgid "Refer to the official documentation [here](https://github.com/devture/email2matrix/blob/master/docs/configuration.md)." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:103 -msgid "Extending the configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:105 -msgid "There are some additional things you may wish to configure about the component." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:107 -msgid "Take a look at:" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:109 -msgid "`roles/custom/matrix-email2matrix/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:111 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:113 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:120 -msgid "**Notes**:" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:122 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-service email2matrix` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:124 -msgid "`just install-service email2matrix` is useful for maintaining your setup quickly 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 `just setup-all` runs the `ensure-matrix-users-created` tag too." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:126 -msgid "After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:128 -msgid "Troubleshooting" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:130 -msgid "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-email2matrix`." -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:132 -msgid "Increase logging verbosity" -msgstr "" - -#: ../../../docs/configuring-playbook-email2matrix.md:134 -msgid "If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:" +#: ../../../docs/configuring-playbook-email2matrix.md:20 +msgid "If you still have the Email2Matrix component installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-etherpad.pot b/i18n/translation-templates/docs/configuring-playbook-etherpad.pot index 42642e43d..2682b812a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-etherpad.pot +++ b/i18n/translation-templates/docs/configuring-playbook-etherpad.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,154 +16,146 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-etherpad.md:1 +#: ../../../docs/configuring-playbook-etherpad.md:13 msgid "Setting up Etherpad (optional)" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:3 +#: ../../../docs/configuring-playbook-etherpad.md:15 msgid "The playbook can install and configure [Etherpad](https://etherpad.org) for you." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:5 +#: ../../../docs/configuring-playbook-etherpad.md:17 msgid "Etherpad is an open source collaborative text editor. It can not only be integrated with Element clients ([Element Web](configuring-playbook-client-element-web.md)/Desktop, Android and iOS) as a widget, but also be used as standalone web app." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:7 -msgid "When enabled together with the Jitsi audio/video conferencing system (see [our docs on Jitsi](configuring-playbook-jitsi.md)), it will be made available as an option during the conferences." +#: ../../../docs/configuring-playbook-etherpad.md:19 +msgid "When enabled together with the Jitsi video-conferencing platform (see [our docs on Jitsi](configuring-playbook-jitsi.md)), it will be made available as an option during the conferences." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:9 +#: ../../../docs/configuring-playbook-etherpad.md:21 +msgid "The [Ansible role for Etherpad](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring Etherpad, you can check them via:" +msgstr "" + +#: ../../../docs/configuring-playbook-etherpad.md:23 +msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad/blob/main/docs/configuring-etherpad.md) online" +msgstr "" + +#: ../../../docs/configuring-playbook-etherpad.md:24 +msgid "📁 `roles/galaxy/etherpad/docs/configuring-etherpad.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)" +msgstr "" + +#: ../../../docs/configuring-playbook-etherpad.md:26 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:11 +#: ../../../docs/configuring-playbook-etherpad.md:28 msgid "By default, this playbook installs Etherpad on the `etherpad.` subdomain (`etherpad.example.com`) and requires you to create a CNAME record for `etherpad`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:13 +#: ../../../docs/configuring-playbook-etherpad.md:30 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:15 +#: ../../../docs/configuring-playbook-etherpad.md:32 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:17 +#: ../../../docs/configuring-playbook-etherpad.md:34 msgid "To enable Etherpad, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:27 -msgid "Adjusting the Etherpad URL (optional)" +#: ../../../docs/configuring-playbook-etherpad.md:52 +msgid "As the most of the necessary settings for the role have been taken care of by the playbook, you can enable Etherpad on your Matrix server with this minimum configuration." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:29 -msgid "By tweaking the `etherpad_hostname` and `etherpad_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." +#: ../../../docs/configuring-playbook-etherpad.md:54 +msgid "See the role's documentation for details about configuring Etherpad per your preference (such as [the name of the instance](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad/blob/main/docs/configuring-etherpad.md#set-the-name-of-the-instance-optional) and [the default pad text](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad/blob/main/docs/configuring-etherpad.md#set-the-default-text-optional))." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:31 -msgid "Example additional configuration for your `vars.yml` file:" +#: ../../../docs/configuring-playbook-etherpad.md:56 +msgid "Create admin user (optional)" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:42 -msgid "After changing the domain, **you may need to adjust your DNS** records to point the Etherpad domain to the Matrix server." +#: ../../../docs/configuring-playbook-etherpad.md:58 +msgid "You probably might want to enable authentication to disallow anonymous access to your Etherpad." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:44 -msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." -msgstr "" - -#: ../../../docs/configuring-playbook-etherpad.md:46 -msgid "Configure the default text (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-etherpad.md:48 -msgid "You can also edit the default text on a new pad with the variable `etherpad_default_pad_text`." -msgstr "" - -#: ../../../docs/configuring-playbook-etherpad.md:50 -msgid "To do so, add the following configuration to your `vars.yml` file (adapt to your needs):" +#: ../../../docs/configuring-playbook-etherpad.md:60 +msgid "It is possible to enable HTTP basic authentication by **creating an admin user** with `etherpad_admin_username` and `etherpad_admin_password` variables. The admin user account is also used by plugins for authentication and authorization." msgstr "" #: ../../../docs/configuring-playbook-etherpad.md:62 -msgid "Extending the configuration" +msgid "See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad/blob/main/docs/configuring-etherpad.md#create-admin-user-optional) on the role's documentation for details about how to create the admin user." msgstr "" #: ../../../docs/configuring-playbook-etherpad.md:64 -msgid "There are some additional things you may wish to configure about the component." +msgid "Adjusting the Etherpad URL (optional)" msgstr "" #: ../../../docs/configuring-playbook-etherpad.md:66 -msgid "Take a look at:" +msgid "By tweaking the `etherpad_hostname` and `etherpad_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" #: ../../../docs/configuring-playbook-etherpad.md:68 -msgid "[etherpad role](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad)'s [`defaults/main.yml`](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad/blob/main/defaults/main.yml) for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `etherpad_configuration_extension_json` variable" -msgstr "" - -#: ../../../docs/configuring-playbook-etherpad.md:70 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-etherpad.md:72 -msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgid "Example additional configuration for your `vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-etherpad.md:79 -msgid "**Notes**:" +msgid "After changing the domain, **you may need to adjust your DNS** records to point the Etherpad domain to the Matrix server." msgstr "" #: ../../../docs/configuring-playbook-etherpad.md:81 -msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the Etherpad admin user (`etherpad_admin_username`)." +msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." msgstr "" #: ../../../docs/configuring-playbook-etherpad.md:83 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-etherpad.md:85 -msgid "`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." +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:87 -msgid "If you change the Etherpad admin user's password (`etherpad_admin_password` in your `vars.yml` file) subsequently, the admin user's credentials on the homeserver won't be updated automatically. If you'd like to change the admin user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `etherpad_admin_password` to let the admin user know its new password." +#: ../../../docs/configuring-playbook-etherpad.md:92 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:89 +#: ../../../docs/configuring-playbook-etherpad.md:94 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-etherpad.md:96 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:91 -msgid "The Etherpad UI should be available at `https://etherpad.example.com`, while the admin UI (if enabled) should then be available at `https://etherpad.example.com/admin`." +#: ../../../docs/configuring-playbook-etherpad.md:98 +msgid "By default, the Etherpad UI should be available at `https://etherpad.example.com`, while the admin UI (if enabled) should then be available at `https://etherpad.example.com/admin`." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:93 +#: ../../../docs/configuring-playbook-etherpad.md:100 msgid "If you've [decided on another hostname or path-prefix](#adjusting-the-etherpad-url-optional) (e.g. `https://matrix.example.com/etherpad`), adjust these URLs accordingly before using it." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:95 -msgid "Managing / Deleting old pads" +#: ../../../docs/configuring-playbook-etherpad.md:102 +msgid "💡 For more information about usage, take a look at [this section](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad/blob/main/docs/configuring-etherpad.md#usage) on the role's documentation." msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:97 -msgid "If you want to manage and remove old unused pads from Etherpad, you will first need to create the Etherpad admin user as described above." -msgstr "" - -#: ../../../docs/configuring-playbook-etherpad.md:99 -msgid "After logging in to the admin web UI, go to the plugin manager page, and install the `adminpads2` plugin." -msgstr "" - -#: ../../../docs/configuring-playbook-etherpad.md:101 -msgid "Once the plugin is installed, you should have a \"Manage pads\" section in the UI." -msgstr "" - -#: ../../../docs/configuring-playbook-etherpad.md:103 +#: ../../../docs/configuring-playbook-etherpad.md:104 msgid "Integrating a Etherpad widget in a room" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:105 +#: ../../../docs/configuring-playbook-etherpad.md:106 msgid "**Note**: this is how it works in Element Web. It might work quite similar with other clients:" msgstr "" -#: ../../../docs/configuring-playbook-etherpad.md:107 +#: ../../../docs/configuring-playbook-etherpad.md:108 msgid "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." msgstr "" + +#: ../../../docs/configuring-playbook-etherpad.md:110 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-etherpad.md:112 +msgid "See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-etherpad/blob/main/docs/configuring-etherpad.md#troubleshooting) on the role's documentation for details." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-external-postgres.pot b/i18n/translation-templates/docs/configuring-playbook-external-postgres.pot index 36d391f14..5421aad9f 100644 --- a/i18n/translation-templates/docs/configuring-playbook-external-postgres.pot +++ b/i18n/translation-templates/docs/configuring-playbook-external-postgres.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,30 +16,30 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-external-postgres.md:1 +#: ../../../docs/configuring-playbook-external-postgres.md:8 msgid "Using an external PostgreSQL server (optional)" msgstr "" -#: ../../../docs/configuring-playbook-external-postgres.md:3 +#: ../../../docs/configuring-playbook-external-postgres.md:10 msgid "By default, this playbook would set up a PostgreSQL database server on your machine, running in a Docker container. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-external-postgres.md:5 +#: ../../../docs/configuring-playbook-external-postgres.md:12 msgid "**Note**: using **an external Postgres server is currently [not very seamless](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1682#issuecomment-1061461683) when it comes to enabling various other playbook services** — you will need to create a new database/credentials for each service and to point each service to its corresponding database using custom `vars.yml` configuration. **For the best experience with the playbook, stick to using the integrated Postgres server**." msgstr "" -#: ../../../docs/configuring-playbook-external-postgres.md:7 +#: ../../../docs/configuring-playbook-external-postgres.md:14 msgid "If you'd like to use an external Postgres server that you manage, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-external-postgres.md:23 +#: ../../../docs/configuring-playbook-external-postgres.md:30 msgid "The database (as specified in `matrix_synapse_database_database`) must exist and be accessible with the given credentials. It must be empty or contain a valid Synapse database. If empty, Synapse would populate it the first time it runs." msgstr "" -#: ../../../docs/configuring-playbook-external-postgres.md:25 +#: ../../../docs/configuring-playbook-external-postgres.md:32 msgid "**Note**: the external server that you specify in `matrix_synapse_database_host` must be accessible from within the `matrix-synapse` Docker container (and possibly other containers too). This means that it either needs to be a publicly accessible hostname or that it's a hostname on the same Docker network where all containers installed by this playbook run (a network called `matrix` by default). Using a local PostgreSQL instance on the host (running on the same machine, but not in a container) is not possible." msgstr "" -#: ../../../docs/configuring-playbook-external-postgres.md:27 +#: ../../../docs/configuring-playbook-external-postgres.md:34 msgid "The connection to your external Postgres server **will not be SSL encrypted**, as [we don't support that yet](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/89)." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-federation.pot b/i18n/translation-templates/docs/configuring-playbook-federation.pot index 05f38f5f7..acdf377a3 100644 --- a/i18n/translation-templates/docs/configuring-playbook-federation.pot +++ b/i18n/translation-templates/docs/configuring-playbook-federation.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,70 +16,70 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-federation.md:1 +#: ../../../docs/configuring-playbook-federation.md:9 msgid "Controlling Matrix federation (optional)" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:3 +#: ../../../docs/configuring-playbook-federation.md:11 msgid "By default, your server federates with the whole Matrix network. That is, people on your server can communicate with people on any other Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-federation.md:5 -msgid "**Note**: in the sample `vars.yml` ([`examples/vars.yml`](../examples/vars.yml)), we recommend to use a short user ID like `@alice:example.com` instead of `@alice:matrix.example.com` and set up [server delegation](howto-server-delegation.md) / redirection. Without a proper configuration, your server will effectively not be part of the Matrix network. If you find your server is not federated, make sure to [check whether services work](maintenance-checking-services.md) and your server is properly delegated." +#: ../../../docs/configuring-playbook-federation.md:13 +msgid "**Note**: in the sample `vars.yml` ([`examples/vars.yml`](../examples/vars.yml)), we recommend to use a short user ID like `@alice:example.com` instead of `@alice:matrix.example.com` and set up [server delegation](howto-server-delegation.md) / redirection. Without a proper configuration, your server will effectively not be part of the Matrix network. If you find your server is not federated, make sure to [check whether services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work) and your server is properly delegated." msgstr "" -#: ../../../docs/configuring-playbook-federation.md:7 +#: ../../../docs/configuring-playbook-federation.md:15 msgid "Federating only with select servers" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:9 +#: ../../../docs/configuring-playbook-federation.md:17 msgid "To make your server only federate with servers of your choosing, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:17 +#: ../../../docs/configuring-playbook-federation.md:25 msgid "If you wish to disable federation, you can do that with an empty list (`[]`), or better yet by completely disabling federation (see below)." msgstr "" -#: ../../../docs/configuring-playbook-federation.md:19 +#: ../../../docs/configuring-playbook-federation.md:27 msgid "Exposing the room directory over federation" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:21 +#: ../../../docs/configuring-playbook-federation.md:29 msgid "By default, your server's public rooms directory is not exposed to other servers via federation." msgstr "" -#: ../../../docs/configuring-playbook-federation.md:23 +#: ../../../docs/configuring-playbook-federation.md:31 msgid "To expose it, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:29 +#: ../../../docs/configuring-playbook-federation.md:37 msgid "Disabling federation" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:31 +#: ../../../docs/configuring-playbook-federation.md:39 msgid "To completely disable federation, isolating your server from the rest of the Matrix network, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:37 +#: ../../../docs/configuring-playbook-federation.md:45 msgid "With that, your server's users will only be able to talk among themselves, but not to anyone who is on another server." msgstr "" -#: ../../../docs/configuring-playbook-federation.md:39 +#: ../../../docs/configuring-playbook-federation.md:47 msgid "**Disabling federation does not necessarily disable the federation port** (`8448`). Services like [Dimension](configuring-playbook-dimension.md) and [ma1sd](configuring-playbook-ma1sd.md) normally rely on `openid` APIs exposed on that port. Even if you disable federation and only if necessary, we may still be exposing the federation port and serving the `openid` APIs there. To override this and completely disable Synapse's federation port use:" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:51 +#: ../../../docs/configuring-playbook-federation.md:59 msgid "Changing the federation port from 8448 to a different port to use a CDN that only accepts 443/80 ports" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:53 +#: ../../../docs/configuring-playbook-federation.md:61 msgid "Why? This change could be useful for people running small Synapse instances on small severs/VPSes to avoid being impacted by a simple DOS/DDOS when bandwidth, RAM, an CPU resources are limited and if your hosting provider does not provide a DOS/DDOS protection." msgstr "" -#: ../../../docs/configuring-playbook-federation.md:55 +#: ../../../docs/configuring-playbook-federation.md:63 msgid "To make it possible to proxy the federation through a CDN such as CloudFlare or any other, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-federation.md:66 +#: ../../../docs/configuring-playbook-federation.md:74 msgid "**Use this at you own risk as all the possible side-effects of doing this are not fully known. However, it has been tested and works fine and passes all the tests on without issues.**" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-jitsi.pot b/i18n/translation-templates/docs/configuring-playbook-jitsi.pot index 387e81761..f541f0e34 100644 --- a/i18n/translation-templates/docs/configuring-playbook-jitsi.pot +++ b/i18n/translation-templates/docs/configuring-playbook-jitsi.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,486 +16,158 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-jitsi.md:1 +#: ../../../docs/configuring-playbook-jitsi.md:17 msgid "Setting up the Jitsi video-conferencing platform (optional)" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:3 +#: ../../../docs/configuring-playbook-jitsi.md:19 msgid "The playbook can install and configure the [Jitsi](https://jitsi.org/) video-conferencing platform for you." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:5 -msgid "Jitsi can not only be integrated with Element clients ([Element Web](configuring-playbook-client-element-web.md)/Desktop, Android and iOS) as a widget, but also be used as standalone web app." +#: ../../../docs/configuring-playbook-jitsi.md:21 +msgid "Jitsi is an open source video-conferencing platform. It can not only be integrated with Element clients ([Element Web](configuring-playbook-client-element-web.md)/Desktop, Android and iOS) as a widget, but also be used as standalone web app." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:7 -msgid "See the project's [documentation](https://jitsi.github.io/handbook/) to learn what it does and why it might be useful to you." +#: ../../../docs/configuring-playbook-jitsi.md:23 +msgid "💡 If you're into experimental technology, you may also be interested in trying out [Element Call](configuring-playbook-element-call.md) - a native Matrix video conferencing application." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:9 -msgid "**Note**: the configuration by the playbook is similar to the one by [docker-jitsi-meet](https://github.com/jitsi/docker-jitsi-meet). You can refer to the official documentation for Docker deployment [here](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker/)." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:11 -msgid "Prerequisites" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:13 -msgid "You may need to open the following ports to your server:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:15 -msgid "`4443/tcp` — RTP media fallback over TCP" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:16 -msgid "`10000/udp` — RTP media over UDP. Depending on your firewall/NAT configuration, incoming RTP packets on port `10000` may have the external IP of your firewall as destination address, due to the usage of STUN in JVB (see [`jitsi_jvb_stun_servers`](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/defaults/main.yml))." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:18 -msgid "Adjusting DNS records" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:20 -msgid "By default, this playbook installs Jitsi on the `jitsi.` subdomain (`jitsi.example.com`) and requires you to create a CNAME record for `jitsi`, which targets `matrix.example.com`." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:22 -msgid "When setting, replace `example.com` with your own." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:24 -msgid "Adjusting the playbook configuration" +#: ../../../docs/configuring-playbook-jitsi.md:25 +msgid "The [Ansible role for Jitsi](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring Jitsi, you can check them via:" msgstr "" #: ../../../docs/configuring-playbook-jitsi.md:26 -msgid "To enable Jitsi, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md) online" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:32 -msgid "Adjusting the Jitsi URL (optional)" +#: ../../../docs/configuring-playbook-jitsi.md:27 +msgid "📁 `roles/galaxy/jitsi/docs/configuring-jitsi.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:34 -msgid "By tweaking the `jitsi_hostname` variable, you can easily make the service available at a **different hostname** than the default one." +#: ../../../docs/configuring-playbook-jitsi.md:29 +msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:36 -msgid "Example additional configuration for your `vars.yml` file:" +#: ../../../docs/configuring-playbook-jitsi.md:31 +msgid "Before proceeding, make sure to check server's requirements recommended by [the official deployment guide](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-requirements)." +msgstr "" + +#: ../../../docs/configuring-playbook-jitsi.md:33 +msgid "You may need to open some ports to your server, if you use another firewall in front of the server. Refer [the role's documentation](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#prerequisites) to check which ones to be configured." +msgstr "" + +#: ../../../docs/configuring-playbook-jitsi.md:35 +msgid "Adjusting DNS records" +msgstr "" + +#: ../../../docs/configuring-playbook-jitsi.md:37 +msgid "By default, this playbook installs Jitsi on the `jitsi.` subdomain (`jitsi.example.com`) and requires you to create a CNAME record for `jitsi`, which targets `matrix.example.com`." +msgstr "" + +#: ../../../docs/configuring-playbook-jitsi.md:39 +msgid "When setting, replace `example.com` with your own." +msgstr "" + +#: ../../../docs/configuring-playbook-jitsi.md:41 +msgid "Adjusting the playbook configuration" msgstr "" #: ../../../docs/configuring-playbook-jitsi.md:43 -msgid "After changing the domain, **you may need to adjust your DNS** records to point the Jitsi domain to the Matrix server." +msgid "To enable Jitsi, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:45 -msgid "Configure Jitsi authentication and guests mode (optional)" +#: ../../../docs/configuring-playbook-jitsi.md:61 +msgid "As the most of the necessary settings for the role have been taken care of by the playbook, you can enable Jitsi on your Matrix server with this minimum configuration." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:47 -msgid "By default the Jitsi instance does not require for anyone to log in, and is open to use without an account. To control who is allowed to start meetings on your Jitsi instance, you'd need to enable Jitsi's authentication and optionally guests mode." +#: ../../../docs/configuring-playbook-jitsi.md:63 +msgid "However, **since Jitsi's performance heavily depends on server resource (bandwidth, RAM, and CPU), it is recommended to review settings and optimize them as necessary before deployment.** You can check [here](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#example-configurations) for an example set of configurations to set up a Jitsi instance, focusing on performance. If you will host a large conference, you probably might also want to consider to provision additional JVBs ([Jitsi VideoBridge](https://github.com/jitsi/jitsi-videobridge)). See [here](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#set-up-additional-jvbs-for-more-video-conferences-optional) for details about setting them up with the playbook." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:49 -msgid "Authentication type must be one of them: `internal` (default), `jwt`, `matrix` or `ldap`. Currently, only `internal`, `matrix` and `ldap` mechanisms are supported by the [Jitsi role](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi)." +#: ../../../docs/configuring-playbook-jitsi.md:65 +msgid "See the role's documentation for details about configuring Jitsi per your preference (such as setting [a custom hostname](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#set-the-hostname) and [the environment variable for running Jitsi in a LAN](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#configure-jvb_advertise_ips-for-running-behind-nat-or-on-a-lan-environment-optional))." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:51 -msgid "With authentication enabled, all meetings have to be started by a registered user. After the meeting is started by that user, then guests are free to join. If the registered user is not yet present, the guests are put on hold in individual waiting rooms." +#: ../../../docs/configuring-playbook-jitsi.md:67 +msgid "Enable authentication and guests mode (optional)" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:53 -msgid "**Note**: authentication is not tested by the playbook's self-checks. We therefore recommend that you would make sure by yourself that authentication is configured properly. To test it, start a meeting at `jitsi.example.com` on your browser." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:55 -msgid "Authenticate using Jitsi accounts: Auth-Type `internal` (recommended)" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:57 -msgid "The default authentication mechanism is `internal` auth, which requires a Jitsi account to have been configured. This is a recommended method, as it also works in federated rooms." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:59 -msgid "To enable authentication with a Jitsi account, add the following configuration to your `vars.yml` file. Make sure to replace `USERNAME_…` and `PASSWORD_…` with your own values." +#: ../../../docs/configuring-playbook-jitsi.md:69 +msgid "By default the Jitsi Meet instance **does not require for anyone to log in, and is open to use without an account**." msgstr "" #: ../../../docs/configuring-playbook-jitsi.md:71 -msgid "**Note**: as Jitsi account removal function is not integrated into the playbook, these accounts will not be able to be removed from the Prosody server automatically, even if they are removed from your `vars.yml` file subsequently." +msgid "If you would like to control who is allowed to start meetings on your instance, you'd need to enable Jitsi's authentication and optionally guests mode." msgstr "" #: ../../../docs/configuring-playbook-jitsi.md:73 -msgid "Authenticate using Matrix OpenID: Auth-Type `matrix`" +msgid "See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#configure-jitsi-authentication-and-guests-mode-optional) on the role's documentation for details about how to configure the authentication and guests mode. The recommended authentication method is `internal` as it also works in federated rooms. If you want to enable authentication with Matrix OpenID making use of [Matrix User Verification Service (UVS)](configuring-playbook-user-verification-service.md), see [here](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#authenticate-using-matrix-openid-auth-type-matrix) for details about how to set it up." msgstr "" #: ../../../docs/configuring-playbook-jitsi.md:75 -msgid "[!WARNING] This breaks the Jitsi instance on federated rooms probably and does not allow sharing conference links with guests." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:78 -msgid "This authentication method requires [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service), which can be installed using this [playbook](configuring-playbook-user-verification-service.md). It verifies against Matrix openID, and requires a user-verification-service to run." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:80 -msgid "To enable authentication with Matrix OpenID, add the following configuration to your `vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:88 -msgid "For more information see also [https://github.com/matrix-org/prosody-mod-auth-matrix-user-verification](https://github.com/matrix-org/prosody-mod-auth-matrix-user-verification)." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:90 -msgid "Authenticate using LDAP: Auth-Type `ldap`" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:92 -msgid "To enable authentication with LDAP, add the following configuration to your `vars.yml` file (adapt to your needs):" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:112 -msgid "For more information refer to the [docker-jitsi-meet](https://github.com/jitsi/docker-jitsi-meet#authentication-using-ldap) and the [saslauthd `LDAP_SASLAUTHD`](https://github.com/winlibs/cyrus-sasl/blob/master/saslauthd/LDAP_SASLAUTHD) documentation." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:114 -msgid "Configure `JVB_ADVERTISE_IPS` for running behind NAT or on a LAN environment (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:116 -msgid "When running Jitsi in a LAN environment, or on the public Internet via NAT, the `JVB_ADVERTISE_IPS` enviornment variable should be set." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:118 -msgid "This variable allows to control which IP addresses the JVB will advertise for WebRTC media traffic. It is necessary to set it regardless of the use of a reverse proxy, since it's the IP address that will receive the media (audio / video) and not HTTP traffic, hence it's oblivious to the reverse proxy." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:120 -msgid "If your users are coming in over the Internet (and not over LAN), this will likely be your public IP address. If this is not set up correctly, calls will crash when more than two users join a meeting." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:122 -msgid "To set the variable, add the following configuration to your `vars.yml` file. Make sure to replace `LOCAL_IP_ADDRESS_OF_THE_HOST_HERE` with a proper value." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:129 -msgid "Check [the official documentation](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker/#running-behind-nat-or-on-a-lan-environment) for more details about it." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:131 -msgid "Set a maximum number of participants on a Jitsi conference (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:133 -msgid "You can set a maximum number of participants allowed to join a Jitsi conference. By default the number is not specified." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:135 -msgid "To set it, add the following configuration to your `vars.yml` file (adapt to your needs):" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:141 msgid "Enable Gravatar (optional)" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:143 +#: ../../../docs/configuring-playbook-jitsi.md:77 msgid "In the default Jisti Meet configuration, `gravatar.com` is enabled as an avatar service." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:145 -msgid "Since the Element clients send the URL of configured Matrix avatars to the Jitsi instance, our default configuration has disabled the Gravatar service." +#: ../../../docs/configuring-playbook-jitsi.md:79 +msgid "Since the Element clients send the URL of configured Matrix avatars to the Jitsi instance, our configuration has disabled the Gravatar service." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:147 -msgid "To enable the Gravatar service, add the following configuration to your `vars.yml` file:" +#: ../../../docs/configuring-playbook-jitsi.md:81 +msgid "To enable the Gravatar service nevertheless, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:153 +#: ../../../docs/configuring-playbook-jitsi.md:87 msgid "[!WARNING] This will result in third party request leaking data to the Gravatar Service (`gravatar.com`, unless configured otherwise). Besides metadata, the Matrix user_id and possibly the room ID (via `referrer` header) will be also sent to the third party." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:156 -msgid "Fine tune Jitsi (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:158 -msgid "If you'd like to have Jitsi save up resources, add the following configuration to your `vars.yml` file (adapt to your needs):" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:171 -msgid "These configurations:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:173 -msgid "**limit the maximum video resolution**, to save up resources on both server and clients" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:174 -msgid "**suspend unused video layers** until they are requested again, to save up resources on both server and clients. Read more on this feature [here](https://jitsi.org/blog/new-off-stage-layer-suppression-feature/)." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:175 -msgid "**disable audio levels** to avoid excessive refresh of the client-side page and decrease the CPU consumption involved" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:176 -msgid "**limit the number of video feeds forwarded to each client**, to save up resources on both server and clients. As clients’ bandwidth and CPU may not bear the load, use this setting to avoid lag and crashes. This feature is available by default on other webconference applications such as Office 365 Teams (the number is limited to 4). Read how it works [here](https://github.com/jitsi/jitsi-videobridge/blob/5ff195985edf46c9399dcf263cb07167f0a2c724/doc/allocation.md)." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:178 -msgid "Example configurations" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:180 -msgid "Here is an example set of configurations for running a Jitsi instance with:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:182 -msgid "authentication using a Jitsi account (username: `US3RNAME`, password: `passw0rd`)" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:183 -msgid "guests: allowed" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:184 -msgid "maximum participants: 6 people" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:185 -msgid "fine tuning with the configurations presented above" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:186 -msgid "other miscellaneous options (see the official Jitsi documentation [here](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-configuration) and [here](https://jitsi.github.io/handbook/docs/user-guide/user-guide-advanced))" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:206 +#: ../../../docs/configuring-playbook-jitsi.md:90 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:208 +#: ../../../docs/configuring-playbook-jitsi.md:92 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:215 +#: ../../../docs/configuring-playbook-jitsi.md:99 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:217 +#: ../../../docs/configuring-playbook-jitsi.md:101 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:219 +#: ../../../docs/configuring-playbook-jitsi.md:103 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:221 +#: ../../../docs/configuring-playbook-jitsi.md:105 msgid "You can use the self-hosted Jitsi server in multiple ways:" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:223 +#: ../../../docs/configuring-playbook-jitsi.md:107 msgid "**by adding a widget to a room via Element Web** (the one configured by the playbook at `https://element.example.com`). Just start a voice or a video call in a room containing more than 2 members and that would create a Jitsi widget which utilizes your self-hosted Jitsi server." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:225 -msgid "**directly (without any Matrix integration)**. Just go to `https://jitsi.example.com`" +#: ../../../docs/configuring-playbook-jitsi.md:109 +msgid "**directly (without any Matrix integration)**. Just go to `https://jitsi.example.com`, and you can start a videoconference." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:227 -msgid "Set up additional JVBs for more video-conferences (optional)" +#: ../../../docs/configuring-playbook-jitsi.md:111 +msgid "Note that you'll need to log in to your Jitsi's account to start a conference if you have configured authentication with `internal` auth." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:229 -msgid "By default, a single JVB ([Jitsi VideoBridge](https://github.com/jitsi/jitsi-videobridge)) is deployed on the same host as the Matrix server. To allow more video-conferences to happen at the same time, you'd need to provision additional JVB services on other hosts." +#: ../../../docs/configuring-playbook-jitsi.md:113 +msgid "Check [the official user guide](https://jitsi.github.io/handbook/docs/category/user-guide) for details about how to use Jitsi." msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:231 -msgid "These settings below will allow you to provision those extra JVB instances. The instances will register themselves with the Prosody service, and be available for Jicofo to route conferences too." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:233 -msgid "Add the `jitsi_jvb_servers` section on `hosts` file" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:235 -msgid "For additional JVBs, you'd need to add the section titled `jitsi_jvb_servers` on the ansible `hosts` file with the details of the JVB hosts as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:242 -msgid "Make sure to replace `jvb-2.example.com` with your hostname for the JVB and `192.168.0.2` with your JVB's external IP address, respectively." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:244 -msgid "You could add JVB hosts as many as you would like. When doing so, add lines with the details of them." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:246 -msgid "Prepare `vars.yml` files for additional JVBs" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:248 -msgid "If the main server is `matrix.example.com` and the additional JVB instance is going to be deployed at `jvb-2.example.com`, the variables for the latter need to be specified on `vars.yml` in its directory (`inventory/host_vars/jvb-2.example.com`)." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:250 -msgid "Note that most (if not all) variables are common for both servers." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:252 -msgid "If you are setting up multiple JVB instances, you'd need to create `vars.yml` files for each of them too (`inventory/host_vars/jvb-3.example.com/vars.yml`, for example)." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:254 -msgid "Set the server ID to each JVB" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:256 -msgid "Each JVB requires a server ID to be set, so that it will be uniquely identified. The server ID allows Jitsi to keep track of which conferences are on which JVB." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:258 -msgid "The server ID can be set with the variable `jitsi_jvb_server_id`. It will end up as the `JVB_WS_SERVER_ID` environment variables in the JVB docker container." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:260 -msgid "To set the server ID to `jvb-2`, add the following configuration to either `hosts` or `vars.yml` files (adapt to your needs)." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:262 -msgid "On `hosts`:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:264 -msgid "Add `jitsi_jvb_server_id=jvb-2` after your JVB's external IP addresses as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:272 -msgid "On `vars.yml` files:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:278 -msgid "Alternatively, you can specify the variable as a parameter to [the ansible command](#run-the-playbook)." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:280 -msgid "**Note**: the server ID `jvb-1` is reserved for the JVB instance running on the Matrix host, therefore should not be used as the ID of an additional JVB host." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:282 -msgid "Set colibri WebSocket port" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:284 -msgid "The additional JVBs will need to expose the colibri WebSocket port." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:286 -msgid "To expose the port, add the following configuration to your `vars.yml` files:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:292 -msgid "Set Prosody XMPP server" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:294 -msgid "The JVB will also need to know the location of the Prosody XMPP server." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:296 -msgid "Similar to the server ID (`jitsi_jvb_server_id`), this can be set with the variable for the JVB by using the variable `jitsi_xmpp_server`." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:298 -msgid "Set the Matrix domain" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:300 -msgid "The Jitsi Prosody container is deployed on the Matrix server by default, so the value can be set to the Matrix domain. To set the value, add the following configuration to your `vars.yml` files:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:306 -msgid "Set an IP address of the Matrix server" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:308 -msgid "Alternatively, the IP address of the Matrix server can be set. This can be useful if you would like to use a private IP address." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:310 -msgid "To set the IP address of the Matrix server, add the following configuration to your `vars.yml` files:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:316 -msgid "Expose XMPP port" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:318 -msgid "By default, the Matrix server does not expose the XMPP port (`5222`); only the XMPP container exposes it internally inside the host. This means that the first JVB (which runs on the Matrix server) can reach it but the additional JVBs cannot. Therefore, the XMPP server needs to expose the port, so that the additional JVBs can connect to it." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:320 -msgid "To expose the port and have Docker forward the port, add the following configuration to your `vars.yml` files:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:326 -msgid "Reverse-proxy with Traefik" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:328 -msgid "To make Traefik reverse-proxy to these additional JVBs, add the following configuration to your main `vars.yml` file (`inventory/host_vars/matrix.example.com/vars.yml`):" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:364 -msgid "Run the playbook" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:366 -msgid "After configuring `hosts` and `vars.yml` files, run the playbook with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:372 +#: ../../../docs/configuring-playbook-jitsi.md:115 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-jitsi.md:374 -msgid "`Error: Account creation/modification not supported`" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:376 -msgid "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." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:378 -msgid "In this case, you should consider to rebuild your Jitsi installation." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:380 -msgid "Rebuilding your Jitsi installation" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:382 -msgid "If you ever run into any trouble or if you have changed configuration (`jitsi_*` variables) too much, you can rebuild your Jitsi installation." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:384 -msgid "We normally don't recommend manual intervention, but Jitsi services tend to generate a lot of configuration files, and it is often wise to start afresh setting the services up, rather than messing with the existing configuration files. Since not all of those files are managed by Ansible (at least not yet), you may sometimes need to delete them by yourself manually." -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:386 -msgid "To rebuild your Jitsi configuration, follow the procedure below:" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:388 -msgid "run this command locally to stop all Jitsi services: `just run-tags stop-group --extra-vars=group=jitsi`" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:389 -msgid "log in the server with SSH" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:390 -msgid "run this command remotely to remove all Jitsi configuration & data: `rm -rf /matrix/jitsi`" -msgstr "" - -#: ../../../docs/configuring-playbook-jitsi.md:391 -msgid "run this command locally to set up Jitsi anew and restart services: `just install-service jitsi`" +#: ../../../docs/configuring-playbook-jitsi.md:117 +msgid "See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#troubleshooting) on the role's documentation for details." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-jwt-service.pot b/i18n/translation-templates/docs/configuring-playbook-jwt-service.pot new file mode 100644 index 000000000..6b0397eb9 --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-jwt-service.pot @@ -0,0 +1,93 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-jwt-service.md:8 +msgid "Setting up JWT Service (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:10 +msgid "The playbook can install and configure [LiveKit JWT Service](https://github.com/element-hq/lk-jwt-service) for you." +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:12 +msgid "LK-JWT-Service is currently used for a single reason: generate JWT tokens with a given identity for a given room, so that users can use them to authenticate against LiveKit SFU." +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:14 +msgid "See the project's [documentation](https://github.com/element-hq/lk-jwt-service/) to learn more." +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:16 +msgid "Decide on a domain and path" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:18 +msgid "By default, JWT Service is configured to be served:" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:20 +msgid "on the Matrix domain (`matrix.example.com`), configurable via `matrix_livekit_jwt_service_hostname`" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:21 +msgid "under a `/livekit-jwt-service` path prefix, configurable via `matrix_livekit_jwt_service_path_prefix`" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:23 +msgid "This makes it easy to set it up, **without** having to adjust your DNS records manually." +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:25 +msgid "Adjusting DNS records" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:27 +msgid "If you've changed the default hostname, **you may need to adjust your DNS** records accordingly to point to the correct server." +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:29 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:31 +msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:37 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:39 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:41 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:43 +msgid "Once installed, a new `org.matrix.msc4143.rtc_foci` section is added to the Element Web client to point to your JWT service URL (e.g., `https://matrix.example.com/livekit-jwt-service`)." +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:45 +msgid "Additional Information" +msgstr "" + +#: ../../../docs/configuring-playbook-jwt-service.md:47 +msgid "Refer to the LiveKit JWT-Service documentation for more details on configuring and using JWT Service." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-ldap-auth.pot b/i18n/translation-templates/docs/configuring-playbook-ldap-auth.pot index c3f60aca0..26f87346c 100644 --- a/i18n/translation-templates/docs/configuring-playbook-ldap-auth.pot +++ b/i18n/translation-templates/docs/configuring-playbook-ldap-auth.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,46 +16,58 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-ldap-auth.md:1 +#: ../../../docs/configuring-playbook-ldap-auth.md:10 msgid "Setting up the LDAP authentication password provider module (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:3 +#: ../../../docs/configuring-playbook-ldap-auth.md:12 msgid "The playbook can install and configure the [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) LDAP Auth password provider for you." msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:5 +#: ../../../docs/configuring-playbook-ldap-auth.md:14 msgid "See the project's [documentation](https://github.com/matrix-org/matrix-synapse-ldap3/blob/main/README.rst) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:7 -msgid "If you decide that you'd like to let this playbook install it for you, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" +#: ../../../docs/configuring-playbook-ldap-auth.md:16 +msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:24 +#: ../../../docs/configuring-playbook-ldap-auth.md:18 +msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" +msgstr "" + +#: ../../../docs/configuring-playbook-ldap-auth.md:35 msgid "Authenticating only using a password provider" msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:26 -msgid "If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, feel free to disable it:" +#: ../../../docs/configuring-playbook-ldap-auth.md:37 +msgid "If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, you can disable it by adding the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:32 -msgid "Using ma1sd Identity Server for authentication (not recommended)" +#: ../../../docs/configuring-playbook-ldap-auth.md:43 +msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:34 -msgid "The playbook can instead configure [ma1sd](https://github.com/ma1uta/ma1sd) Identity Server for LDAP authentication. However, **we recommend not bothering with installing it** as ma1sd has been unmaintained for years." +#: ../../../docs/configuring-playbook-ldap-auth.md:45 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:36 -msgid "If you wish to install it anyway, consult the [ma1sd Identity Server configuration](configuring-playbook-ma1sd.md#authentication)." +#: ../../../docs/configuring-playbook-ldap-auth.md:52 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:38 +#: ../../../docs/configuring-playbook-ldap-auth.md:54 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-ldap-auth.md:56 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-ldap-auth.md:58 msgid "Handling user registration" msgstr "" -#: ../../../docs/configuring-playbook-ldap-auth.md:40 +#: ../../../docs/configuring-playbook-ldap-auth.md:60 msgid "If you wish for users to also be able to make new registrations against LDAP, you may **also** wish to [set up the ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md)." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-livekit-jwt-service.pot b/i18n/translation-templates/docs/configuring-playbook-livekit-jwt-service.pot new file mode 100644 index 000000000..599809c4d --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-livekit-jwt-service.pot @@ -0,0 +1,45 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-livekit-jwt-service.md:7 +msgid "Setting up LiveKit JWT Service (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-jwt-service.md:9 +msgid "The playbook can install and configure [LiveKit JWT Service](https://github.com/element-hq/lk-jwt-service/) for you." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-jwt-service.md:11 +msgid "This is a helper component which is part of the [Matrix RTC stack](configuring-playbook-matrix-rtc.md) that allows [Element Call](configuring-playbook-element-call.md) to integrate with [LiveKit Server](configuring-playbook-livekit-server.md)." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-jwt-service.md:13 +msgid "💡 LiveKit JWT Service is automatically installed and configured when either [Element Call](configuring-playbook-element-call.md) or the [Matrix RTC stack](configuring-playbook-matrix-rtc.md) is enabled, so you don't need to do anything extra." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-jwt-service.md:15 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-jwt-service.md:17 +msgid "`roles/custom/matrix-livekit-jwt-service/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-jwt-service.md:18 +msgid "`roles/custom/matrix-livekit-jwt-service/templates/env.j2` for the component's default configuration." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-livekit-server.pot b/i18n/translation-templates/docs/configuring-playbook-livekit-server.pot new file mode 100644 index 000000000..e730ec8c0 --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-livekit-server.pot @@ -0,0 +1,85 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-livekit-server.md:8 +msgid "Setting up LiveKit Server (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:10 +msgid "The playbook can install and configure [LiveKit Server](https://github.com/livekit/livekit) for you." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:12 +msgid "LiveKit Server is an open source project that provides scalable, multi-user conferencing based on WebRTC. It's designed to provide everything you need to build real-time video audio data capabilities in your applications." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:14 +msgid "💡 LiveKit Server is automatically installed and configured when either [Element Call](configuring-playbook-element-call.md) or the [Matrix RTC stack](configuring-playbook-matrix-rtc.md) is enabled, so you don't need to do anything extra." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:16 +msgid "The [Ansible role for LiveKit Server](https://github.com/mother-of-all-self-hosting/ansible-role-livekit-server) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring LiveKit Server, you can check them via:" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:17 +msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-livekit-server/blob/main/docs/configuring-livekit-server.md) online" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:18 +msgid "📁 `roles/galaxy/livekit-server/docs/configuring-livekit-server.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:20 +msgid "Adjusting firewall rules" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:22 +msgid "To ensure LiveKit Server functions correctly, the following firewall rules and port forwarding settings are required:" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:24 +msgid "`7881/tcp`: ICE/TCP" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:26 +msgid "`7882/udp`: ICE/UDP Mux" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:28 +msgid "`3479/udp`: TURN/UDP. Also see the [Limitations](#limitations) section below." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:30 +msgid "`5350/tcp`: TURN/TCP. Also see the [Limitations](#limitations) section below." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:32 +msgid "💡 The suggestions above are inspired by the upstream [Ports and Firewall](https://docs.livekit.io/home/self-hosting/ports-firewall/) documentation based on how LiveKit is configured in the playbook. If you've using custom configuration for the LiveKit Server role, you may need to adjust the firewall rules accordingly." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:34 +msgid "Limitations" +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:36 +msgid "For some reason, LiveKit Server's TURN ports (`3479/udp` and `5350/tcp`) are not reachable over IPv6 regardless of whether you've [enabled IPv6](./configuring-ipv6.md) for your server." +msgstr "" + +#: ../../../docs/configuring-playbook-livekit-server.md:38 +msgid "It seems like LiveKit Server intentionally only listens on `udp4` and `tcp4` as seen [here](https://github.com/livekit/livekit/blob/154b4d26b769c68a03c096124094b97bf61a996f/pkg/service/turn.go#L128) and [here](https://github.com/livekit/livekit/blob/154b4d26b769c68a03c096124094b97bf61a996f/pkg/service/turn.go#L92)." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-ma1sd.pot b/i18n/translation-templates/docs/configuring-playbook-ma1sd.pot index daceadecc..ba02c6fd8 100644 --- a/i18n/translation-templates/docs/configuring-playbook-ma1sd.pot +++ b/i18n/translation-templates/docs/configuring-playbook-ma1sd.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,206 +16,214 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-ma1sd.md:1 +#: ../../../docs/configuring-playbook-ma1sd.md:12 msgid "Setting up ma1sd Identity Server (optional)" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:3 -msgid "**⚠️Note**: ma1sd itself has also been unmaintained for years (the latest commit and release being from 2021). The role of identity servers in the Matrix specification also has an uncertain future. **We recommend not bothering with installing it unless it's the only way you can do what you need to do**. For example, certain things like LDAP integration can also be implemented via [the LDAP provider module for Synapse](./configuring-playbook-ldap-auth.md)." -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:5 -msgid "The playbook can configure the [ma1sd](https://github.com/ma1uta/ma1sd) Identity Server for you. It is a fork of [mxisd](https://github.com/kamax-io/mxisd) which was pronounced end of life 2019-06-21." -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:7 -msgid "ma1sd is used for 3PIDs (3rd party identifiers like E-mail and phone numbers) and some [enhanced features](https://github.com/ma1uta/ma1sd/#features). It is private by default, potentially at the expense of user discoverability." -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:9 -msgid "See the project's [documentation](https://github.com/ma1uta/ma1sd/blob/master/README.md) to learn what it does and why it might be useful to you." -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:11 -msgid "Prerequisites" -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:13 -msgid "Open Matrix Federation port" -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:15 -msgid "Enabling the ma1sd service will automatically reconfigure your Synapse homeserver to expose the `openid` API endpoints on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. If you enable the component, make sure that the port is accessible." +#: ../../../docs/configuring-playbook-ma1sd.md:14 +msgid "[!WARNING] Since ma1sd has been unmaintained for years (the latest commit and release being from 2021) and the future of identity server's role in the Matrix specification is uncertain, **we recommend not bothering with installing it unless it's the only way you can do what you need to do**." msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:17 -msgid "Adjusting DNS records" +msgid "Please note that certain things can be achieved with other components. For example, if you wish to implement LDAP integration, you might as well check out [the LDAP provider module for Synapse](./configuring-playbook-ldap-auth.md) instead." msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:19 -msgid "To make the ma1sd Identity Server enable its federation features, set up a SRV record that looks like this:" +msgid "The playbook can configure the [ma1sd](https://github.com/ma1uta/ma1sd) Identity Server for you. It is a fork of [mxisd](https://github.com/kamax-io/mxisd) which was pronounced end of life 2019-06-21." msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:21 +msgid "ma1sd is used for 3PIDs (3rd party identifiers like E-mail and phone numbers) and some [enhanced features](https://github.com/ma1uta/ma1sd/#features). It is private by default, potentially at the expense of user discoverability." +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:23 +msgid "See the project's [documentation](https://github.com/ma1uta/ma1sd/blob/master/README.md) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:25 +msgid "Prerequisites" +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:27 +msgid "Open Matrix Federation port" +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:29 +msgid "Enabling the ma1sd service will automatically reconfigure your Synapse homeserver to expose the `openid` API endpoints on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. If you enable the component, make sure that the port is accessible." +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:31 +msgid "Adjusting DNS records" +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:33 +msgid "To make the ma1sd Identity Server enable its federation features, set up a SRV record that looks like this:" +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:35 msgid "Name: `_matrix-identity._tcp` (use this text as-is)" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:22 +#: ../../../docs/configuring-playbook-ma1sd.md:36 msgid "Content: `10 0 443 matrix.example.com` (replace `example.com` with your own)" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:24 +#: ../../../docs/configuring-playbook-ma1sd.md:38 msgid "See [ma1sd's documentation](https://github.com/ma1uta/ma1sd/wiki/mxisd-and-your-privacy#choices-are-never-easy) for information on the privacy implications of setting up this SRV record." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:26 +#: ../../../docs/configuring-playbook-ma1sd.md:40 msgid "When setting up a SRV record, if you are asked for a service and protocol instead of a hostname split the host value from the table where the period is. For example use service as `_matrix-identity` and protocol as `_tcp`." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:28 +#: ../../../docs/configuring-playbook-ma1sd.md:42 msgid "**Note**: This `_matrix-identity._tcp` SRV record for the identity server is different from the `_matrix._tcp` that can be used for Synapse delegation. See [howto-server-delegation.md](howto-server-delegation.md) for more information about delegation." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:30 +#: ../../../docs/configuring-playbook-ma1sd.md:44 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:32 +#: ../../../docs/configuring-playbook-ma1sd.md:46 msgid "To enable ma1sd, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:38 +#: ../../../docs/configuring-playbook-ma1sd.md:52 msgid "Matrix.org lookup forwarding" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:40 +#: ../../../docs/configuring-playbook-ma1sd.md:54 msgid "To ensure maximum discovery, you can make your identity server also forward lookups to the central matrix.org Identity server (at the cost of potentially leaking all your contacts information)." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:42 +#: ../../../docs/configuring-playbook-ma1sd.md:56 msgid "Enabling this is discouraged and you'd better [learn more](https://github.com/ma1uta/ma1sd/blob/master/docs/features/identity.md#lookups) before proceeding." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:44 +#: ../../../docs/configuring-playbook-ma1sd.md:58 msgid "To enable matrix.org forwarding, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:50 -msgid "Additional features" -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:52 -msgid "What this playbook configures for your is some bare minimum Identity Server functionality, so that you won't need to rely on external 3rd party services." -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:54 -msgid "A few variables can be toggled in this playbook to alter the ma1sd configuration that gets generated." -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:56 -msgid "Still, ma1sd can do much more. You can refer to the [ma1sd website](https://github.com/ma1uta/ma1sd) for more details and configuration options." -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:58 -msgid "To use a more custom configuration, you can define a `matrix_ma1sd_configuration_extension_yaml` string variable and put your configuration in it. To learn more about how to do this, refer to the information about `matrix_ma1sd_configuration_extension_yaml` in the [default variables file](../roles/custom/matrix-ma1sd/defaults/main.yml) of the ma1sd component." -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:60 -msgid "Customizing email templates" -msgstr "" - -#: ../../../docs/configuring-playbook-ma1sd.md:62 -msgid "If you'd like to change the default email templates used by ma1sd, take a look at the `matrix_ma1sd_threepid_medium_email_custom_` variables (in the `roles/custom/matrix-ma1sd/defaults/main.yml` file." -msgstr "" - #: ../../../docs/configuring-playbook-ma1sd.md:64 -msgid "ma1sd-controlled Registration" +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:66 -msgid "To use the [Registration](https://github.com/ma1uta/ma1sd/blob/master/docs/features/registration.md) feature of ma1sd, you can make use of the following variables:" +msgid "There are some additional things you may wish to configure about the component." msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:68 -msgid "`matrix_synapse_enable_registration` — to enable user-initiated registration in Synapse" +msgid "Take a look at:" msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:70 -msgid "`matrix_synapse_enable_registration_captcha` — to validate registering users using reCAPTCHA, as described in the [enabling reCAPTCHA](configuring-captcha.md) documentation." +msgid "`roles/custom/matrix-ma1sd/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_ma1sd_configuration_extension_yaml` variable" msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:72 -msgid "`matrix_synapse_registrations_require_3pid` — a list of 3pid types (among `'email'`, `'msisdn'`) required by the Synapse server for registering" +msgid "You can refer to the [ma1sd website](https://github.com/ma1uta/ma1sd) for more details and configuration options." msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:74 -msgid "variables prefixed with `matrix_ma1sd_container_labels_` (e.g. `matrix_ma1sd_container_labels_matrix_client_3pid_registration_enabled`) — to configure the Traefik reverse-proxy to capture and send registration requests to ma1sd (instead of Synapse), so it can apply its additional functionality" +msgid "Customizing email templates" msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:76 -msgid "`matrix_ma1sd_configuration_extension_yaml` — to configure ma1sd as required. See the [Registration feature's docs](https://github.com/ma1uta/ma1sd/blob/master/docs/features/registration.md) for inspiration. Also see the [Additional features](#additional-features) section below to learn more about how to use `matrix_ma1sd_configuration_extension_yaml`." +msgid "If you'd like to change the default email templates used by ma1sd, take a look at the `matrix_ma1sd_threepid_medium_email_custom_` variables (in the `roles/custom/matrix-ma1sd/defaults/main.yml` file." msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:78 -msgid "**Note**: For this to work, either the homeserver needs to [federate](configuring-playbook-federation.md) or the `openid` APIs need to exposed on the federation port. When federation is disabled and ma1sd is enabled, we automatically expose the `openid` APIs (only!) on the federation port. Make sure the federation port (usually `https://matrix.example.com:8448`) is whitelisted in your firewall (even if you don't actually use/need federation)." +msgid "ma1sd-controlled Registration" msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:80 -msgid "Authentication" +msgid "To use the [Registration](https://github.com/ma1uta/ma1sd/blob/master/docs/features/registration.md) feature of ma1sd, you can make use of the following variables:" msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:82 -msgid "[Authentication](https://github.com/ma1uta/ma1sd/blob/master/docs/features/authentication.md) provides the possibility to use your own [Identity Stores](https://github.com/ma1uta/ma1sd/blob/master/docs/stores/README.md) (for example LDAP) to authenticate users on your Homeserver." +msgid "`matrix_synapse_enable_registration` — to enable user-initiated registration in Synapse" msgstr "" #: ../../../docs/configuring-playbook-ma1sd.md:84 +msgid "`matrix_synapse_enable_registration_captcha` — to validate registering users using reCAPTCHA, as described in the [enabling reCAPTCHA](configuring-captcha.md) documentation." +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:86 +msgid "`matrix_synapse_registrations_require_3pid` — a list of 3pid types (among `'email'`, `'msisdn'`) required by the Synapse server for registering" +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:88 +msgid "variables prefixed with `matrix_ma1sd_container_labels_` (e.g. `matrix_ma1sd_container_labels_matrix_client_3pid_registration_enabled`) — to configure the Traefik reverse-proxy to capture and send registration requests to ma1sd (instead of Synapse), so it can apply its additional functionality" +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:90 +msgid "`matrix_ma1sd_configuration_extension_yaml` — to configure ma1sd as required. See the [Registration feature's docs](https://github.com/ma1uta/ma1sd/blob/master/docs/features/registration.md) for inspiration. Also see the [Additional features](#additional-features) section below to learn more about how to use `matrix_ma1sd_configuration_extension_yaml`." +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:92 +msgid "**Note**: For this to work, either the homeserver needs to [federate](configuring-playbook-federation.md) or the `openid` APIs need to exposed on the federation port. When federation is disabled and ma1sd is enabled, we automatically expose the `openid` APIs (only!) on the federation port. Make sure the federation port (usually `https://matrix.example.com:8448`) is whitelisted in your firewall (even if you don't actually use/need federation)." +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:94 +msgid "Authentication" +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:96 +msgid "[Authentication](https://github.com/ma1uta/ma1sd/blob/master/docs/features/authentication.md) provides the possibility to use your own [Identity Stores](https://github.com/ma1uta/ma1sd/blob/master/docs/stores/README.md) (for example LDAP) to authenticate users on your Homeserver." +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:98 msgid "To enable authentication against an LDAP server, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:104 +#: ../../../docs/configuring-playbook-ma1sd.md:118 msgid "Example: SMS verification" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:106 +#: ../../../docs/configuring-playbook-ma1sd.md:120 msgid "If your use case requires mobile verification, it is quite simple to integrate ma1sd with [Twilio](https://www.twilio.com/), an online telephony services gateway. Their prices are reasonable for low-volume projects and integration can be done with the following configuration:" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:120 +#: ../../../docs/configuring-playbook-ma1sd.md:134 msgid "Example: Open Registration for every Domain" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:122 +#: ../../../docs/configuring-playbook-ma1sd.md:136 msgid "If you want to open registration for any domain, you have to setup the allowed domains with ma1sd's `blacklist` and `whitelist`. The default behavior when neither the `blacklist`, nor the `whitelist` match, is to allow registration. Beware: you can't block toplevel domains (aka `.xy`) because the internal architecture of ma1sd doesn't allow that." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:136 +#: ../../../docs/configuring-playbook-ma1sd.md:150 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:138 +#: ../../../docs/configuring-playbook-ma1sd.md:152 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:145 +#: ../../../docs/configuring-playbook-ma1sd.md:159 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:147 +#: ../../../docs/configuring-playbook-ma1sd.md:161 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:149 +#: ../../../docs/configuring-playbook-ma1sd.md:163 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:151 +#: ../../../docs/configuring-playbook-ma1sd.md:165 msgid "If email address validation emails sent by ma1sd are not reaching you, you should look into [Adjusting email-sending settings](configuring-playbook-email.md)." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:153 -msgid "If you'd like additional logging information, temporarily enable verbose logging for ma1sd." +#: ../../../docs/configuring-playbook-ma1sd.md:167 +msgid "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-ma1sd`." msgstr "" -#: ../../../docs/configuring-playbook-ma1sd.md:155 -msgid "To enable it, add the following configuration to your `vars.yml` file:" +#: ../../../docs/configuring-playbook-ma1sd.md:169 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-ma1sd.md:171 +msgid "If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-matrix-authentication-service.pot b/i18n/translation-templates/docs/configuring-playbook-matrix-authentication-service.pot index da5f99e98..7c14da04e 100644 --- a/i18n/translation-templates/docs/configuring-playbook-matrix-authentication-service.pot +++ b/i18n/translation-templates/docs/configuring-playbook-matrix-authentication-service.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,128 +16,112 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:1 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:8 msgid "Setting up Matrix Authentication Service (optional)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:3 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:10 msgid "The playbook can install and configure [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service/) (MAS) — a service operating alongside your existing [Synapse](./configuring-playbook-synapse.md) homeserver and providing [better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:5 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:12 msgid "Matrix Authentication Service is an implementation of [MSC3861: Next-generation auth for Matrix, based on OAuth 2.0/OIDC](https://github.com/matrix-org/matrix-spec-proposals/pull/3861) and still work in progress, tracked at the [areweoidcyet.com](https://areweoidcyet.com/) website." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:7 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:14 msgid "**Before going through with starting to use Matrix Authentication Service**, make sure to read:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:9 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:16 msgid "the [Reasons to use Matrix Authentication Service](#reasons-to-use-matrix-authentication-service) section below" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:10 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:17 msgid "the [Expectations](#expectations) section below" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:11 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:18 msgid "the [FAQ section on areweoidcyet.com](https://areweoidcyet.com/#faqs)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:13 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:20 msgid "**If you've already been using Synapse** and have user accounts in its database, you can [migrate to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:15 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:22 msgid "Reasons to use Matrix Authentication Service" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:17 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:24 msgid "You may be wondering whether you should make the switch to Matrix Authentication Service (MAS) or keep using your existing authentication flow via Synapse (password-based or [OIDC](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on)-enabled)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:19 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:26 msgid "Matrix Authentication Service is **still an experimental service** and **not a default** for this Ansible playbook." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:21 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:28 msgid "The [Expectations](#expectations) section contains a list of what works and what doesn't (**some services don't work with MAS yet**), as well as the **relative irreversability** of the migration process." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:23 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:30 msgid "Below, we'll try to **highlight some potential reasons for switching** to Matrix Authentication Service:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:25 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:32 msgid "To use SSO in [Element X](https://element.io/blog/element-x-ignition/). The old [Synapse OIDC](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on) login flow is only supported in old Element clients and will not be supported in Element X. Element X will only support the new SSO-based login flow provided by MAS, so if you want to use SSO with Element X, you will need to switch to MAS." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:27 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:34 msgid "To help drive adoption of the \"Next-generation auth for Matrix\" by switching to what's ultimately coming anyway" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:29 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:36 msgid "To help discover (and potentially fix) MAS integration issues with this Ansible playbook" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:31 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:38 msgid "To help discover (and potentially fix) MAS integration issues with various other Matrix components (bridges, bots, clients, etc.)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:33 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:40 msgid "To reap some of the security benefits that Matrix Authentication Service offers, as outlined in the [Better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/) article." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:35 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:42 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:37 -msgid "⚠️ the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default for this playbook). Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating wtih Matrix Authentication Service yet." +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:44 +msgid "⚠️ the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default for this playbook). Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating with Matrix Authentication Service yet." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:39 -msgid "⚠️ **email sending** configured (see [Adjusting email-sending settings](./configuring-playbook-email.md)), because **Matrix Authentication Service [still insists](https://github.com/element-hq/matrix-authentication-service/issues/1505) on having a verified email address for each user** going through the new SSO-based login flow. It's also possible to [work around email deliverability issues](#working-around-email-deliverability-issues) if your email configuration is not working." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:41 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:46 msgid "❌ **disabling all password providers** for Synapse (things like [shared-secret-auth](./configuring-playbook-shared-secret-auth.md), [rest-auth](./configuring-playbook-rest-auth.md), [LDAP auth](./configuring-playbook-ldap-auth.md), etc.) More details about this are available in the [Expectations](#expectations) section below." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:43 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:48 msgid "Expectations" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:45 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:50 msgid "This section details what you can expect when switching to the Matrix Authentication Service (MAS)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:47 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:52 msgid "❌ **Synapse password providers will need to be disabled**. You can no longer use [shared-secret-auth](./configuring-playbook-shared-secret-auth.md), [rest-auth](./configuring-playbook-rest-auth.md), [LDAP auth](./configuring-playbook-ldap-auth.md), etc. When the authentication flow is handled by MAS (not by Synapse anymore), it doesn't make sense to extend the Synapse authentication flow with additional modules. Many bridges used to rely on shared-secret-auth for doing double-puppeting (impersonating other users), but most (at least the mautrix bridges) nowadays use [Appservice Double Puppet](./configuring-playbook-appservice-double-puppet.md) as a better alternative. Older/maintained bridges may still rely on shared-secret-auth, as do other services like [matrix-corporal](./configuring-playbook-matrix-corporal.md)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:49 -msgid "❌ Certain **tools like [synapse-admin](./configuring-playbook-synapse-admin.md) do not have full compatibility with MAS yet**. synapse-admin already supports [login with access token](https://github.com/etkecc/synapse-admin/pull/58), browsing users (which Synapse will internally fetch from MAS) and updating user avatars. However, editing users (passwords, etc.) now needs to happen directly against MAS using the [MAS Admin API](https://element-hq.github.io/matrix-authentication-service/api/index.html), which synapse-admin cannot interact with yet." +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:54 +msgid "❌ Certain **tools like [Synapse Admin](./configuring-playbook-synapse-admin.md) do not have full compatibility with MAS yet**. Synapse Admin already supports OIDC auth, browsing users (which Synapse will internally fetch from MAS) and updating user avatars. However, editing users (passwords, etc.) now needs to happen directly against MAS using the [MAS Admin API](https://element-hq.github.io/matrix-authentication-service/api/index.html), which Synapse Admin cannot interact with yet. You may be interested in using [Element Admin](./configuring-playbook-element-admin.md) for these purposes." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:51 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:56 msgid "❌ **Some services experience issues when authenticating via MAS**:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:53 -msgid "[Postmoogle](./configuring-playbook-bridge-postmoogle.md) works the first time around, but it consistently fails after restarting:" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:55 -msgid "cannot initialize matrix bot error=\"olm account is marked as shared, keys seem to have disappeared from the server\"" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:57 -msgid "[matrix-reminder-bot](./configuring-playbook-bot-matrix-reminder-bot.md) fails to start (see [element-hq/matrix-authentication-service#3439](https://github.com/element-hq/matrix-authentication-service/issues/3439))" -msgstr "" - #: ../../../docs/configuring-playbook-matrix-authentication-service.md:58 -msgid "Other services may be similarly affected. This list is not exhaustive." +msgid "[Reminder bot](configuring-playbook-bot-matrix-reminder-bot.md) seems to be losing some of its state on each restart and may reschedule old reminders once again" msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:60 @@ -145,151 +129,143 @@ msgid "❌ **Encrypted appservices** do not work yet (related to [MSC4190](https msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:62 -msgid "⚠️ **You will need to have email sending configured** (see [Adjusting email-sending settings](./configuring-playbook-email.md)), because **Matrix Authentication Service [still insists](https://github.com/element-hq/matrix-authentication-service/issues/1505) on having a verified email address for each user** going through the new SSO-based login flow. It's also possible to [work around email deliverability issues](#working-around-email-deliverability-issues) if your email configuration is not working." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:64 msgid "⚠️ [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) is **possible**, but requires **some playbook-assisted manual work**. Migration is **reversible with no or minor issues if done quickly enough**, but as users start logging in (creating new login sessions) via the new MAS setup, disabling MAS and reverting back to the Synapse user database will cause these new sessions to break." msgstr "" +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:64 +msgid "⚠️ Delegating user authentication to MAS causes **your Synapse server to be completely dependent on one more service** for its operations. MAS is quick & lightweight and should be stable enough already, but this is something to keep in mind when making the switch." +msgstr "" + #: ../../../docs/configuring-playbook-matrix-authentication-service.md:66 -msgid "⚠️ [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) does not currently seem to preserve the \"admin\" flag for users (as found in the Synapse database). All users are imported as non-admin — see [element-hq/matrix-authentication-service#3440](https://github.com/element-hq/matrix-authentication-service/issues/3440). You may need update the Matrix Authentication Service's database manually and adjust the `can_request_admin` column in the `users` table to `true` for users that need to be administrators (e.g. `UPDATE users SET can_request_admin = true WHERE username = 'someone';`)" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:68 -msgid "⚠️ Delegating user authentication to MAS causes **your Synapse server to be completely dependant on one more service** for its operations. MAS is quick & lightweight and should be stable enough already, but this is something to keep in mind when making the switch." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:70 msgid "⚠️ If you've got [OIDC configured in Synapse](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on), you will need to migrate your OIDC configuration to MAS by adding an [Upstream OAuth2 configuration](#upstream-oauth2-configuration)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:72 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:68 msgid "⚠️ A [compatibility layer](https://element-hq.github.io/matrix-authentication-service/setup/homeserver.html#set-up-the-compatibility-layer) is installed — all `/_matrix/client/*/login` (etc.) requests will be routed to MAS instead of going to the homeserver. This is done both publicly (e.g. `https://matrix.example.com/_matrix/client/*/login`) and on the internal Traefik entrypoint (e.g. `https://matrix-traefik:8008/_matrix/client/*/login`) which helps addon services reach the homeserver's Client-Server API. You typically don't need to do anything to make this work, but it's good to be aware of it, especially if you have a [custom webserver setup](./configuring-playbook-own-webserver.md)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:74 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:70 msgid "✅ Your **existing login sessions will continue to work** (you won't get logged out). Migration will require a bit of manual work and minutes of downtime, but it's not too bad." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:76 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:72 msgid "✅ Various clients ([Cinny](./configuring-playbook-client-cinny.md), [Element Web](./configuring-playbook-client-element-web.md), Element X, FluffyChat) will be able to use the **new SSO-based login flow** provided by Matrix Authentication Service" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:78 -msgid "✅ The **old login flow** (called `m.login.password`) **will still continue to work**, so clients (old Element Web, etc.) and bridges/bots that don't support the new OIDC-based login flow will still work. Going through the old login flow does not require users to have a verified email address, as [is the case](https://github.com/element-hq/matrix-authentication-service/issues/1505) for the new SSO-based login flow." +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:74 +msgid "✅ The **old login flow** (called `m.login.password`) **will still continue to work**, so clients (old Element Web, etc.) and bridges/bots that don't support the new OIDC-based login flow will still work" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:80 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:76 msgid "✅ [Registering users](./registering-users.md) via **the playbook's `register-user` tag remains unchanged**. The playbook automatically does the right thing regardless of homeserver implementation (Synapse, Dendrite, etc.) and whether MAS is enabled or not. When MAS is enabled, the playbook will forward user-registration requests to MAS. Registering users via the command-line is no longer done via the `/matrix/synapse/bin/register` script, but via `/matrix/matrix-authentication-service/bin/register-user`." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:82 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:78 msgid "✅ Users that are prepared by the playbook (for bots, bridges, etc.) will continue to be registered automatically as expected. The playbook automatically does the right thing regardless of homeserver implementation (Synapse, Dendrite, etc.) and whether MAS is enabled or not. When MAS is enabled, the playbook will forward user-registration requests to MAS." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:84 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:80 msgid "Installation flows" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:86 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:82 msgid "New homeserver" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:88 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:84 msgid "For new homeservers (which don't have any users in their Synapse database yet), follow the [Adjusting the playbook configuration](#adjusting-the-playbook-configuration) instructions and then proceed with [Installing](#installing)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:90 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:86 msgid "Existing homeserver" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:92 -msgid "Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating wtih Matrix Authentication Service yet." +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:88 +msgid "Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating with Matrix Authentication Service yet." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:94 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:90 msgid "For existing Synapse homeservers:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:96 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:92 msgid "when following the [Adjusting the playbook configuration](#adjusting-the-playbook-configuration) instructions, make sure to **disable the integration between Synapse and MAS** by **uncommenting** the `matrix_authentication_service_migration_in_progress: true` line as described in the [Marking an existing homeserver for migration](#marking-an-existing-homeserver-for-migration) section below." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:98 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:94 msgid "then follow the [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) instructions to perform the installation and migration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:100 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:96 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:102 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:98 msgid "By default, this playbook installs the Matrix Authentication Service on the `matrix.` subdomain, at the `/auth` path (https://matrix.example.com/auth). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:104 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:100 msgid "If you wish to adjust it, see the section [below](#adjusting-the-matrix-authentication-service-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:106 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:102 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:108 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:104 msgid "To enable Matrix Authentication Service, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:122 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:118 msgid "In the sub-sections that follow, we'll cover some additional configuration options that you may wish to adjust." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:124 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:120 msgid "There are many other configuration options available. Consult the [`defaults/main.yml` file](../roles/custom/matrix-authentication-service/defaults/main.yml) in the [matrix-authentication-service role](../roles/custom/matrix-authentication-service/) to discover them." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:126 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:122 msgid "Adjusting the Matrix Authentication Service URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:128 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:124 msgid "By tweaking the `matrix_authentication_service_hostname` and `matrix_authentication_service_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:130 -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:157 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:126 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:153 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:138 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:134 msgid "If you've changed the default hostname, you may need to create a CNAME record for the Matrix Authentication Service domain (`auth.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:140 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:136 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:142 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:138 msgid "Marking an existing homeserver for migration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:144 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:140 msgid "The [configuration above](#adjusting-the-playbook-configuration) instructs existing users wishing to migrate to add `matrix_authentication_service_migration_in_progress: true` to their configuration." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:146 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:142 msgid "This is done temporarily. The migration steps are described in more detail in the [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) section below." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:148 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:144 msgid "Upstream OAuth2 configuration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:150 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:146 msgid "To make Matrix Authentication Service delegate to an existing upstream OAuth 2.0/OIDC provider, you can use its [`upstream_oauth2.providers` setting](https://element-hq.github.io/matrix-authentication-service/reference/configuration.html#upstream_oauth2providers)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:152 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:148 msgid "The playbook exposes a `matrix_authentication_service_config_upstream_oauth2_providers` variable for controlling this setting." msgstr "" @@ -318,301 +294,317 @@ msgid "remove all Synapse OIDC-related configuration (`matrix_synapse_oidc_*`) t msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:279 -msgid "Installing" +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:281 -msgid "Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-configuration) and [your DNS records](#adjusting-dns-records), you can run the playbook with [playbook tags](playbook-tags.md) as below:" +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:283 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:285 +msgid "`roles/custom/matrix-authentication-service/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:286 +msgid "`roles/custom/matrix-authentication-service/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_authentication_service_configuration_extension_yaml` variable" msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:288 -msgid "**Notes**:" +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:290 +msgid "Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-configuration) and [your DNS records](#adjusting-dns-records), you can run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:297 +msgid "**Notes**:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:299 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:292 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:301 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:294 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:303 msgid "If you're in the process of migrating an existing Synapse homeserver to MAS, you should now follow the rest of the steps in the [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) guide." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:296 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:305 msgid "💡 After installation, you should [verify that Matrix Authentication Service is installed correctly](#verify-that-matrix-authentication-service-is-installed-correctly)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:298 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:307 msgid "Migrating an existing Synapse homeserver to Matrix Authentication Service" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:300 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:309 msgid "Our migration guide is loosely based on the upstream [Migrating an existing homeserver](https://element-hq.github.io/matrix-authentication-service/setup/migration.html) guide." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:302 -msgid "Migration is done via a tool called `syn2mas`, which the playbook could run for you (in a container)." +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:311 +msgid "Migration is done via a sub-command called `syn2mas`, which the playbook could run for you (in a container)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:304 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:313 msgid "The installation + migration steps are like this:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:306 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:315 msgid "[Adjust your configuration](#adjusting-the-playbook-configuration) to **disable the integration between the homeserver and MAS**. This is done by **uncommenting** the `matrix_authentication_service_migration_in_progress: true` line." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:308 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:317 msgid "Perform the initial [installation](#installing). At this point:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:310 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:319 msgid "Matrix Authentication Service will be installed. Its database will be empty, so it cannot validate existing access tokens or authentication users yet." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:312 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:321 msgid "The homeserver will still continue to use its local database for validating existing access tokens." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:314 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:323 msgid "Various [compatibility layer URLs](https://element-hq.github.io/matrix-authentication-service/setup/homeserver.html#set-up-the-compatibility-layer) are not yet installed. New login sessions will still be forwarded to the homeserver, which is capable of completing them." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:316 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:325 msgid "The `matrix-user-creator` role would be suppressed, so that it doesn't automatically attempt to create users (for bots, etc.) in the MAS database. These user accounts likely already exist in Synapse's user database and could be migrated over (via syn2mas, as per the steps below), so creating them in the MAS database would have been unnecessary and potentially problematic (conflicts during the syn2mas migration)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:318 -msgid "Consider taking a full [backup of your Postgres database](./maintenance-postgres.md#backing-up-postgresql). This is done just in case. The **syn2mas migration tool does not delete any data**, so it should be possible to revert to your previous setup by merely disabling MAS and re-running the playbook (no need to restore a Postgres backup). However, do note that as users start logging in (creating new login sessions) via the new MAS setup, disabling MAS and reverting back to the Synapse user database will cause these new sessions to break." +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:327 +msgid "Consider taking a full [backup of your Postgres database](./maintenance-postgres.md#backing-up-postgresql). This is done just in case. The **syn2mas migration command does not delete any data**, so it should be possible to revert to your previous setup by merely disabling MAS and re-running the playbook (no need to restore a Postgres backup). However, do note that as users start logging in (creating new login sessions) via the new MAS setup, disabling MAS and reverting back to the Synapse user database will cause these new sessions to break." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:320 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:329 msgid "[Migrate your data from Synapse to Matrix Authentication Service using syn2mas](#migrate-your-data-from-synapse-to-matrix-authentication-service-using-syn2mas)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:322 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:331 msgid "[Adjust your configuration](#adjusting-the-playbook-configuration) again, to:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:324 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:333 msgid "remove the `matrix_authentication_service_migration_in_progress: false` line" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:326 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:335 msgid "if you had been using [OIDC providers configured in Synapse](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on), remove all Synapse OIDC-related configuration (`matrix_synapse_oidc_*`) to prevent it being in conflict with the MAS OIDC configuration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:328 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:337 msgid "Perform the [installation](#installing) again. At this point:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:330 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:339 msgid "The homeserver will start delegating authentication to MAS." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:332 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:341 msgid "The compatibility layer URLs will be installed. New login sessions will be completed by MAS." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:334 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:343 msgid "[Verify that Matrix Authentication Service is installed correctly](#verify-that-matrix-authentication-service-is-installed-correctly)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:336 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:345 msgid "Migrate your data from Synapse to Matrix Authentication Service using syn2mas" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:338 -msgid "We **don't** ask you to [run the `syn2mas` migration advisor command](https://element-hq.github.io/matrix-authentication-service/setup/migration.html#run-the-migration-advisor), because it only gives you the green light if your Synapse configuration (`homeserver.yaml`) is configured in a way that's compatible with MAS (delegating authentication to MAS; disabling Synapse's password config; etc.). Until we migrate your data with the `syn2mas` tool, we intentionally avoid doing these changes to allow existing user sessions to work." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:340 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:347 msgid "You can invoke the `syn2mas` tool via the playbook by running the playbook's `matrix-authentication-service-mas-cli-syn2mas` tag. We recommend first doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real migration](#performing-a-real-syn2mas-migration)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:342 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:349 msgid "Configuring syn2mas" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:344 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:351 msgid "If you're using [OIDC with Synapse](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on), you will need to [Configuring upstream OIDC provider mapping for syn2mas](#configuring-upstream-oidc-provider-mapping-for-syn2mas)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:346 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:353 msgid "If you only have local (non-OIDC) users in your Synapse database, you can likely run `syn2mas` as-is (without doing additional configuration changes)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:348 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:355 msgid "When you're done with potentially configuring `syn2mas`, proceed to doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real migration](#performing-a-real-syn2mas-migration)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:350 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:357 msgid "Configuring upstream OIDC provider mapping for syn2mas" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:352 -msgid "If you have existing OIDC users in your Synapse user database (which will be the case if when using [OIDC with Synapse](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on)), you may need to pass an additional `--upstreamProviderMapping` argument to the `syn2mas` tool to tell it which provider (on the Synapse side) maps to which other provider on the MAS side." +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:359 +msgid "Since Matrix Authentication Service v0.16.0 (which replaced the standalone `syn2mas` tool with a `mas-cli syn2mas` sub-command), OIDC configuration (mapping from your old OIDC configuration to your new one, etc) is meant to be configured in the Matrix Authentication Service configuration (via `matrix_authentication_service_config_upstream_oauth2_providers`) as a `synapse_idp_id` property for each provider." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:354 -msgid "If you don't do this, `syn2mas` would report errors like this one:" +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:361 +msgid "You can refer to the [Map any upstream SSO providers](https://element-hq.github.io/matrix-authentication-service/setup/migration.html#map-any-upstream-sso-providers) section of the MAS documentation for figuring out how to set the `synapse_idp_id` value in `matrix_authentication_service_config_upstream_oauth2_providers` correctly." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:356 -msgid "[FATAL] migrate - [Failed to import external id 4264b0f0-4f11-4ddd-aedb-b500e4d07c25 with oidc-keycloak for user @alice:example.com: Error: Unknown upstream provider oidc-keycloak]" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:358 -msgid "Below is an example situation and a guide for how to solve it." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:360 -msgid "If in `matrix_synapse_oidc_providers` your provider `idp_id` is (was) named `keycloak`, in the Synapse database users would be associated with the `oidc-keycloak` provider (note the `oidc-` prefix that was added automatically by Synapse to your `idp_id` value)." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:362 -msgid "The same OIDC provider may have an `id` of `01HFVBY12TMNTYTBV8W921M5FA` on the MAS side, as defined in `matrix_authentication_service_config_upstream_oauth2_providers` (see the [Upstream OAuth2 configuration](#upstream-oauth2-configuration) section above)." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:364 -msgid "To tell `syn2mas` how the Synapse-configured OIDC provider maps to the new MAS-configured OIDC provider, add this additional configuration to your `vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:373 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:363 msgid "Performing a syn2mas dry-run" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:375 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:365 msgid "Having [configured syn2mas](#configuring-syn2mas), we recommend doing a [dry-run](https://en.wikipedia.org/wiki/Dry_run_(testing)) first to verify that everything will work out as expected." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:377 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:367 msgid "A dry-run would not cause downtime, because it avoids stopping Synapse." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:379 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:369 msgid "To perform a dry-run, run:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:385 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:375 msgid "Observe the command output (especially the last line of the the syn2mas output). If you are confident that the migration will work out as expected, you can proceed with a [real migration](#performing-a-real-syn2mas-migration)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:387 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:377 msgid "Performing a real syn2mas migration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:389 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:379 msgid "Before performing a real migration make sure:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:391 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:381 msgid "you've familiarized yourself with the [expectations](#expectations)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:393 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:383 msgid "you've performed a Postgres backup, just in case" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:395 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:385 msgid "you're aware of the irreversibility of the migration process without disruption after users have created new login sessions via the new MAS setup" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:397 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:387 msgid "you've [configured syn2mas](#configuring-syn2mas), especially if you've used [OIDC with Synapse](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:399 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:389 msgid "you've performed a [syn2mas dry-run](#performing-a-syn2mas-dry-run) and don't see any issues in its output" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:401 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:391 msgid "To perform a real migration, run the `matrix-authentication-service-mas-cli-syn2mas` tag **without** the `matrix_authentication_service_syn2mas_migrate_dry_run` variable:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:407 -msgid "Having performed a `syn2mas` migration once, trying to do it again will report errors for users that were already migrated (e.g. \"Error: Unknown upstream provider oauth-delegated\")." +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:397 +msgid "Having performed a `syn2mas` migration once, trying to do it again will report errors (e.g. \"Error: The MAS database is not empty: rows found in at least `users`. Please drop and recreate the database, then try again.\")." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:409 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:399 msgid "Verify that Matrix Authentication Service is installed correctly" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:411 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:401 msgid "After [installation](#installing), run the `doctor` subcommand of the [`mas-cli` command-line tool](https://element-hq.github.io/matrix-authentication-service/reference/cli/index.html) to verify that MAS is installed correctly." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:413 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:403 msgid "You can do it:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:415 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:405 msgid "either via the Ansible playbook's `matrix-authentication-service-mas-cli-doctor` tag: `just run-tags matrix-authentication-service-mas-cli-doctor`" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:417 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:407 msgid "or by running the `mas-cli` script on the server (which invokes the `mas-cli` tool inside a container): `/matrix/matrix-authentication-service/bin/mas-cli doctor`" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:419 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:409 msgid "If successful, you should see some output that looks like this:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:431 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:421 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:423 msgid "Management" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:433 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:425 msgid "You can use the [`mas-cli` command-line tool](https://element-hq.github.io/matrix-authentication-service/reference/cli/index.html) (exposed via the `/matrix/matrix-authentication-service/bin/mas-cli` script) to perform administrative tasks against MAS." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:435 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:427 msgid "This documentation page already mentions:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:437 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:429 msgid "the `mas-cli doctor` sub-command in the [Verify that Matrix Authentication Service is installed correctly](#verify-that-matrix-authentication-service-is-installed-correctly) section, which you can run via the CLI and via the Ansible playbook's `matrix-authentication-service-mas-cli-doctor` tag" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:439 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:431 msgid "the `mas-cli manage register-user` sub-command in the [Registering users](./registering-users.md) documentation" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:441 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:433 msgid "There are other sub-commands available. Run `/matrix/matrix-authentication-service/bin/mas-cli` to get an overview." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:443 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:435 msgid "User registration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:445 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:437 msgid "After Matrix Authentication Service is [installed](#installing), users need to be managed there (unless you're managing them in an [upstream OAuth2 provider](#upstream-oauth2-configuration))." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:447 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:439 msgid "You can register users new users as described in the [Registering users](./registering-users.md) documentation (via `mas-cli manage register-user` or the Ansible playbook's `register-user` tag)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-authentication-service.md:449 +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:441 msgid "Working around email deliverability issues" msgstr "" +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:443 +msgid "Matrix Authentication Service only sends emails when:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:445 +msgid "it verifies email addresses for users who are self-registering with a password" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:447 +msgid "a user tries to add an email to their account" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-authentication-service.md:449 +msgid "If Matrix Authentication Service tries to send an email and it fails because [your email-sending configuration](./configuring-playbook-email.md) is not working, you may need to work around email deliverability." +msgstr "" + #: ../../../docs/configuring-playbook-matrix-authentication-service.md:451 -msgid "Because Matrix Authentication Service [still insists](https://github.com/element-hq/matrix-authentication-service/issues/1505) on having a verified email address for each user, you may need to work around email deliverability issues if [your email-sending configuration](./configuring-playbook-email.md) is not working." +msgid "If email delivery is not working, **you can retrieve the email verification code from the Matrix Authentication Service's logs** (`journalctl -fu matrix-authentication-service`)." msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:453 -msgid "Matrix Authentication Service attempts to verify email addresses by sending a verification email to the address specified by the user whenever they log in to an account without a verified email address." +msgid "Alternatively, you can use the [`mas-cli` management tool](#management) to manually verify email addresses for users. Example: `/matrix/matrix-authentication-service/bin/mas-cli manage verify-email some.username email@example.com`" msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:455 -msgid "If email delivery is not working, **you can retrieve the email configuration code from the Matrix Authentication Service's logs** (`journalctl -fu matrix-authentication-service`)." +msgid "Troubleshooting" msgstr "" #: ../../../docs/configuring-playbook-matrix-authentication-service.md:457 -msgid "Alternatively, you can use the [`mas-cli` management tool](#management) to manually verify email addresses for users. Example: `/matrix/matrix-authentication-service/bin/mas-cli manage verify-email some.username email@example.com`" +msgid "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-authentication-service`." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-matrix-corporal.pot b/i18n/translation-templates/docs/configuring-playbook-matrix-corporal.pot index 2281a42ef..ebd7f8f1b 100644 --- a/i18n/translation-templates/docs/configuring-playbook-matrix-corporal.pot +++ b/i18n/translation-templates/docs/configuring-playbook-matrix-corporal.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,110 +16,146 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-matrix-corporal.md:1 +#: ../../../docs/configuring-playbook-matrix-corporal.md:9 msgid "Setting up Matrix Corporal (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:5 +#: ../../../docs/configuring-playbook-matrix-corporal.md:11 msgid "[!WARNING] This is an advanced feature! It requires prior experience with Matrix and a specific need for using [Matrix Corporal](https://github.com/devture/matrix-corporal). If you're unsure whether you have such a need, you most likely don't." msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:10 +#: ../../../docs/configuring-playbook-matrix-corporal.md:14 msgid "The playbook can install and configure [matrix-corporal](https://github.com/devture/matrix-corporal) for you." msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:12 -msgid "In short, it's a sort of automation and firewalling service, which is helpful if you're instaling Matrix services in a controlled corporate environment." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-corporal.md:14 -msgid "See the project's [documentation](https://github.com/devture/matrix-corporal/blob/main/README.md) to learn what it does and why it might be useful to you." -msgstr "" - #: ../../../docs/configuring-playbook-matrix-corporal.md:16 -msgid "If you decide that you'd like to let this playbook install it for you, you'd need to also:" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-corporal.md:17 -msgid "(required) [set up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md)" +msgid "In short, it's a sort of automation and firewalling service, which is helpful if you're installing Matrix services in a controlled corporate environment." msgstr "" #: ../../../docs/configuring-playbook-matrix-corporal.md:18 -msgid "(optional, but encouraged) [set up the REST authentication password provider module](configuring-playbook-rest-auth.md)" +msgid "See the project's [documentation](https://github.com/devture/matrix-corporal/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" #: ../../../docs/configuring-playbook-matrix-corporal.md:20 -msgid "Adjusting the playbook configuration" +msgid "If you decide that you'd like to let this playbook install it for you, you'd need to also:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:21 +msgid "(required) [set up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md)" msgstr "" #: ../../../docs/configuring-playbook-matrix-corporal.md:22 +msgid "(optional, but encouraged) [set up the REST authentication password provider module](configuring-playbook-rest-auth.md)" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:24 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:26 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:75 +#: ../../../docs/configuring-playbook-matrix-corporal.md:79 msgid "Matrix Corporal operates with a specific Matrix user on your server. By default, it's `matrix-corporal` (controllable by the `matrix_corporal_reconciliation_user_id_local_part` setting, see above)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:77 +#: ../../../docs/configuring-playbook-matrix-corporal.md:81 msgid "No matter what Matrix user ID you configure to run it with, make sure that:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:79 +#: ../../../docs/configuring-playbook-matrix-corporal.md:83 msgid "the Matrix Corporal user is created by [registering it](registering-users.md) **with administrator privileges**. Use a password you remember, as you'll need to log in from time to time to create or join rooms" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:81 +#: ../../../docs/configuring-playbook-matrix-corporal.md:85 msgid "the Matrix Corporal user is joined and has Admin/Moderator-level access to any rooms you want it to manage" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:83 +#: ../../../docs/configuring-playbook-matrix-corporal.md:87 msgid "Using a locally-stored static policy" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:85 +#: ../../../docs/configuring-playbook-matrix-corporal.md:89 msgid "If you'd like to use a [static policy file](https://github.com/devture/matrix-corporal/blob/master/docs/policy-providers.md#static-file-pull-style-policy-provider), you can use a configuration like this:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:117 +#: ../../../docs/configuring-playbook-matrix-corporal.md:121 msgid "To learn more about what the policy configuration, see the matrix-corporal documentation on [policy](https://github.com/devture/matrix-corporal/blob/master/docs/policy.md)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:119 -msgid "Installing" +#: ../../../docs/configuring-playbook-matrix-corporal.md:123 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:121 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-matrix-corporal.md:125 +msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:128 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just run-tags setup-aux-files,setup-corporal,start` or `just setup-all`" +#: ../../../docs/configuring-playbook-matrix-corporal.md:127 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:129 +msgid "`roles/custom/matrix-corporal/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" #: ../../../docs/configuring-playbook-matrix-corporal.md:130 -msgid "`just run-tags setup-aux-files,setup-corporal,start` is useful for maintaining your setup quickly 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 `just setup-all` runs the `ensure-matrix-users-created` tag too." +msgid "`roles/custom/matrix-corporal/templates/config.json.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_corporal_configuration_extension_json` variable" msgstr "" #: ../../../docs/configuring-playbook-matrix-corporal.md:132 -msgid "Matrix Corporal files" +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-matrix-corporal.md:134 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:141 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just run-tags setup-aux-files,setup-corporal,start` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:143 +msgid "`just run-tags setup-aux-files,setup-corporal,start` is useful for maintaining your setup quickly 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 `just setup-all` runs the `ensure-matrix-users-created` tag too." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:145 +msgid "Matrix Corporal files" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:147 msgid "The following local filesystem paths are mounted in the `matrix-corporal` container and can be used in your configuration (or policy):" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:136 +#: ../../../docs/configuring-playbook-matrix-corporal.md:149 msgid "`/matrix/corporal/config` is mounted at `/etc/matrix-corporal` (read-only)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:138 +#: ../../../docs/configuring-playbook-matrix-corporal.md:151 msgid "`/matrix/corporal/var` is mounted at `/var/matrix-corporal` (read and write)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:140 +#: ../../../docs/configuring-playbook-matrix-corporal.md:153 msgid "`/matrix/corporal/cache` is mounted at `/var/cache/matrix-corporal` (read and write)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-corporal.md:142 +#: ../../../docs/configuring-playbook-matrix-corporal.md:155 msgid "As an example: you can create your own configuration files in `/matrix/corporal/config` and they will appear in `/etc/matrix-corporal` in the Docker container. Your configuration (stuff in `matrix_corporal_policy_provider_config`) needs to refer to these files via the local container paths — `/etc/matrix-corporal` (read-only), `/var/matrix-corporal` (read and write), `/var/cache/matrix-corporal` (read and write)." msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:157 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:159 +msgid "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-corporal`." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:161 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-corporal.md:163 +msgid "If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-matrix-ldap-registration-proxy.pot b/i18n/translation-templates/docs/configuring-playbook-matrix-ldap-registration-proxy.pot index dac8cafae..53e9bcf43 100644 --- a/i18n/translation-templates/docs/configuring-playbook-matrix-ldap-registration-proxy.pot +++ b/i18n/translation-templates/docs/configuring-playbook-matrix-ldap-registration-proxy.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,46 +16,74 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:1 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:9 msgid "Setting up matrix-ldap-registration-proxy (optional)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:3 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:11 msgid "The playbook can install and configure [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) for you." msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:5 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:13 msgid "This proxy handles Matrix registration requests and forwards them to LDAP." msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:7 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:15 +msgid "See the project's [documentation](https://gitlab.com/activism.international/matrix_ldap_registration_proxy/-/blob/main/README.md) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:17 msgid "**Note**: This does support the full Matrix specification for registrations. It only provide a very coarse implementation of a basic password registration." msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:9 -msgid "Quickstart" +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:19 +msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:11 -msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:21 +msgid "To enable the component, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:22 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:33 msgid "If you already use the [synapse external password provider via LDAP](configuring-playbook-ldap-auth.md) (that is, you have `matrix_synapse_ext_password_provider_ldap_enabled: true` and other options in your configuration) you can use the following values as configuration:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:35 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:46 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:48 +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:50 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:52 +msgid "`roles/custom/matrix-ldap-registration-proxy/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:54 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:37 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:56 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:44 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:63 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:46 +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:65 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:67 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:69 +msgid "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-ldap-registration-proxy`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-matrix-media-repo.pot b/i18n/translation-templates/docs/configuring-playbook-matrix-media-repo.pot index d5ed3ede6..3dec466dc 100644 --- a/i18n/translation-templates/docs/configuring-playbook-matrix-media-repo.pot +++ b/i18n/translation-templates/docs/configuring-playbook-matrix-media-repo.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,149 +16,209 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:1 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:10 msgid "Storing Matrix media files using matrix-media-repo (optional)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:3 -msgid "[matrix-media-repo](https://docs.t2bot.io/matrix-media-repo/) (often abbreviated \"MMR\") is a highly customizable multi-domain media repository for Matrix. Intended for medium to large environments consisting of several homeservers, this media repo de-duplicates media (including remote media) while being fully compliant with the specification." +#: ../../../docs/configuring-playbook-matrix-media-repo.md:12 +msgid "The playbook can install and configure [matrix-media-repo](https://docs.t2bot.io/matrix-media-repo/) (often abbreviated \"MMR\") for you." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:5 -msgid "Smaller/individual homeservers can still make use of this project's features, though it may be difficult to set up or have higher than expected resource consumption. Please do your research before deploying this as this project may not be useful for your environment." +#: ../../../docs/configuring-playbook-matrix-media-repo.md:14 +msgid "MMR is a highly customizable multi-domain media repository for Matrix. Intended for medium to large environments consisting of several homeservers, this media repo de-duplicates media (including remote media) while being fully compliant with the specification." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:7 -msgid "For a simpler alternative (which allows you to offload your media repository storage to S3, etc.), you can [configure S3 storage](configuring-playbook-s3.md) instead of setting up matrix-media-repo." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-media-repo.md:0 -msgid "**Table of Contents**" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-media-repo.md:0 -msgid "[Quickstart](#quickstart)" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-media-repo.md:0 -msgid "[Additional configuration options](#configuring-the-media-repo)" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-media-repo.md:0 -msgid "[Importing data from an existing media store](#importing-data-from-an-existing-media-store)" -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-media-repo.md:15 -msgid "Quickstart" +#: ../../../docs/configuring-playbook-matrix-media-repo.md:16 +msgid "**Notes**:" msgstr "" #: ../../../docs/configuring-playbook-matrix-media-repo.md:17 -msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file and [re-run the installation process](./installing.md) for the playbook:" +msgid "If MMR is enabled, other media store roles should be disabled (if using Synapse with other media store roles)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:26 -msgid "The repo is pre-configured for integrating with the Postgres database, Traefik proxy and [Prometheus/Grafana](configuring-playbook-prometheus-grafana.md) (if metrics enabled) from this playbook for all the available homeserver roles. When the media repo is enabled, other media store roles should be disabled (if using Synapse with other media store roles)." +#: ../../../docs/configuring-playbook-matrix-media-repo.md:18 +msgid "Smaller/individual homeservers can still make use of this project's features, though it may be difficult to set up or have higher than expected resource consumption. Please do your research before deploying this as this project may not be useful for your environment." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:28 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:19 +msgid "For a simpler alternative (which allows you to offload your media repository storage to S3, etc.), you can [configure S3 storage](configuring-playbook-s3.md) instead of setting up matrix-media-repo." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:21 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:23 +msgid "To enable matrix-media-repo, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:29 msgid "By default, the media-repo will use the local filesystem for data storage. You can alternatively use a `s3` cloud backend as well. Access token caching is also enabled by default since the logout endpoints are proxied through the media repo." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:30 -msgid "Configuring the media-repo" +#: ../../../docs/configuring-playbook-matrix-media-repo.md:31 +msgid "Enable metrics" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:32 -msgid "Additional common configuration options:" +#: ../../../docs/configuring-playbook-matrix-media-repo.md:33 +msgid "The playbook can enable and configure the metrics of the service for you." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:91 -msgid "Full list of configuration options with documentation can be found in [`roles/custom/matrix-media-repo/defaults/main.yml`](../roles/custom/matrix-media-repo/defaults/main.yml)" +#: ../../../docs/configuring-playbook-matrix-media-repo.md:35 +msgid "Metrics are **only enabled by default** if the builtin [Prometheus](configuring-playbook-prometheus-grafana.md) is enabled (by default, Prometheus isn't enabled). If so, metrics will automatically be collected by Prometheus and made available in Grafana. You will, however, need to set up your own Dashboard for displaying them." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:93 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:37 +msgid "To enable the metrics, add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:44 +msgid "**To collect metrics from an external Prometheus server**, besides enabling metrics as described above, you will also need to enable metrics exposure on `https://matrix.example.com/metrics/matrix-media-repo` by adding the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:50 +msgid "By default metrics are exposed publicly **without** password-protection. To password-protect the metrics with dedicated credentials, add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:57 +msgid "To `matrix_media_repo_container_labels_traefik_metrics_middleware_basic_auth_users`, set the Basic Authentication credentials (raw `htpasswd` file content) used to protect the endpoint. See https://doc.traefik.io/traefik/middlewares/http/basicauth/#users for details about it." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:59 +msgid "**Note**: alternatively, you can use `matrix_metrics_exposure_enabled` to expose all services on this `/metrics/*` feature, and you can use `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users` to password-protect the metrics of them. See [this section](configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) for more information." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:61 +msgid "Enable Grafana (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:63 +msgid "Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:65 +msgid "To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:67 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:69 +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:71 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:73 +msgid "`roles/custom/matrix-media-repo/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:75 +msgid "Here is a list of additional common configuration options:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:132 msgid "Signing Keys" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:95 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:134 msgid "Authenticated media endpoints ([MSC3916](https://github.com/matrix-org/matrix-spec-proposals/pull/3916)) requires MMR to have a configured signing key to authorize outbound federation requests. Additionally, the signing key must be merged with your homeserver's signing key file." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:97 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:136 msgid "The playbook default is to generate a MMR signing key when invoking the setup role and merge it with your homeserver if you are using Synapse or Dendrite. This can be disabled if desired by setting the option in your inventory:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:103 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:142 msgid "If you wish to manually generate the signing key and merge it with your homeserver's signing key file, see https://docs.t2bot.io/matrix-media-repo/v1.3.5/installation/signing-key/ for more details." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:105 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:144 msgid "**Note that if you uninstall MMR from the playbook, it will not remove the old MMR signing key from your homeserver's signing key file. You will have to remove it manually.**" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:107 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:146 msgid "Key backup and revoking" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:109 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:148 msgid "Since your homeserver signing key file is modified by the playbook, a backup will be created in `HOMESERVER_DIR/config/example.com.signing.key.backup`. If you need to remove/revoke old keys, you can restore from this backup or remove the MMR key ID from your `example.com.signing.key` file." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:111 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:150 msgid "Additionally, its recommended after revoking a signing key to update your homeserver config file (`old_signing_keys` field for Synapse and `old_private_keys` for Dendrite). See your homeserver config file for further documentation on how to populate the field." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:113 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:152 msgid "Importing data from an existing media store" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:115 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:154 msgid "If you want to add this repo to an existing homeserver managed by the playbook, you will need to import existing media into MMR's database or you will lose access to older media while it is active. MMR versions up to `v1.3.3` only support importing from Synapse, but newer versions (at time of writing: only `latest`) also support importing from Dendrite." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:117 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:156 msgid "**Before importing**: ensure you have an initial matrix-media-repo deployment by following the [quickstart](#quickstart) guide above" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:119 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:158 msgid "Depending on the homeserver implementation yu're using (Synapse, Dendrite), you'll need to use a different import tool (part of matrix-media-repo) and point it to the homeserver's database." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:121 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:160 msgid "Importing data from the Synapse media store" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:123 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:162 msgid "To import the Synapse media store, you're supposed to invoke the `import_synapse` tool which is part of the matrix-media-repo container image. Your Synapse database is called `synapse` by default, unless you've changed it by modifying `matrix_synapse_database_database`." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:125 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:164 msgid "This guide here is adapted from the [upstream documentation about the import_synapse script](https://github.com/turt2live/matrix-media-repo#importing-media-from-synapse)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:127 -#: ../../../docs/configuring-playbook-matrix-media-repo.md:149 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:166 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:188 msgid "Run the following command on the server (after replacing `postgres_connection_password` in it with the value found in your `vars.yml` file):" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:139 -#: ../../../docs/configuring-playbook-matrix-media-repo.md:161 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:178 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:200 msgid "Enter `1` for the Machine ID when prompted (you are not doing any horizontal scaling) unless you know what you're doing." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:141 -#: ../../../docs/configuring-playbook-matrix-media-repo.md:163 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:180 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:202 msgid "This should output a `msg=\"Import completed\"` when finished successfully!" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:143 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:182 msgid "Importing data from the Dendrite media store" msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:145 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:184 msgid "If you're using the [Dendrite](configuring-playbook-dendrite.md) homeserver instead of the default for this playbook (Synapse), follow this importing guide here." msgstr "" -#: ../../../docs/configuring-playbook-matrix-media-repo.md:147 +#: ../../../docs/configuring-playbook-matrix-media-repo.md:186 msgid "To import the Dendrite media store, you're supposed to invoke the `import_dendrite` tool which is part of the matrix-media-repo container image. Your Dendrite database is called `dendrite_mediaapi` by default, unless you've changed it by modifying `matrix_dendrite_media_api_database`." msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:204 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:206 +msgid "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-media-repo`." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:208 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-media-repo.md:210 +msgid "If you want to turn on sentry's built-in debugging, add the following configuration to your `vars.yml` file and re-run the playbook:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-matrix-registration.pot b/i18n/translation-templates/docs/configuring-playbook-matrix-registration.pot index 638eec50f..63565c1c9 100644 --- a/i18n/translation-templates/docs/configuring-playbook-matrix-registration.pot +++ b/i18n/translation-templates/docs/configuring-playbook-matrix-registration.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,138 +16,166 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-matrix-registration.md:1 +#: ../../../docs/configuring-playbook-matrix-registration.md:9 msgid "Setting up matrix-registration (optional)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:3 -msgid "⚠️ **Warnings**:" +#: ../../../docs/configuring-playbook-matrix-registration.md:11 +msgid "[!WARNING]" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:4 +#: ../../../docs/configuring-playbook-matrix-registration.md:12 msgid "This is a poorly maintained and buggy project. It's better to avoid using it." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:5 +#: ../../../docs/configuring-playbook-matrix-registration.md:13 msgid "This is not related to [matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:7 +#: ../../../docs/configuring-playbook-matrix-registration.md:15 msgid "The playbook can install and configure [matrix-registration](https://github.com/ZerataX/matrix-registration) for you. It is a simple python application to have a token based Matrix registration." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:9 +#: ../../../docs/configuring-playbook-matrix-registration.md:17 msgid "Use matrix-registration to **create unique registration links**, which people can use to register on your Matrix server. It allows certain people (these having a special link) to register a user account, **keeping your server's registration closed (private)**." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:11 +#: ../../../docs/configuring-playbook-matrix-registration.md:19 msgid "**matrix-registration** provides 2 things:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:13 +#: ../../../docs/configuring-playbook-matrix-registration.md:21 msgid "**an API for creating registration tokens** (unique registration links). This API can be used via `curl` or via the playbook (see [Usage](#usage) below)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:15 +#: ../../../docs/configuring-playbook-matrix-registration.md:23 msgid "**a user registration page**, where people can use these registration tokens. By default, exposed at `https://matrix.example.com/matrix-registration`" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:17 +#: ../../../docs/configuring-playbook-matrix-registration.md:25 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:19 +#: ../../../docs/configuring-playbook-matrix-registration.md:27 msgid "By default, this playbook installs the matrix-registration on the `matrix.` subdomain, at the `/matrix-registration` path (https://matrix.example.com/matrix-registration). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:21 +#: ../../../docs/configuring-playbook-matrix-registration.md:29 msgid "If you wish to adjust it, see the section [below](#adjusting-the-matrix-registration-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:23 +#: ../../../docs/configuring-playbook-matrix-registration.md:31 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:25 +#: ../../../docs/configuring-playbook-matrix-registration.md:33 msgid "To enable matrix-registration, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:34 +#: ../../../docs/configuring-playbook-matrix-registration.md:42 msgid "Adjusting the matrix-registration URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:36 +#: ../../../docs/configuring-playbook-matrix-registration.md:44 msgid "By tweaking the `matrix_registration_hostname` and `matrix_registration_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:38 +#: ../../../docs/configuring-playbook-matrix-registration.md:46 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:46 +#: ../../../docs/configuring-playbook-matrix-registration.md:54 msgid "If you've changed the default hostname, you may need to create a CNAME record for the matrix-registration domain (`registration.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:48 +#: ../../../docs/configuring-playbook-matrix-registration.md:56 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:50 -msgid "Installing" +#: ../../../docs/configuring-playbook-matrix-registration.md:58 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:52 -msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-matrix-registration.md:60 +msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:59 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +#: ../../../docs/configuring-playbook-matrix-registration.md:62 +msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:61 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-matrix-registration.md:63 -msgid "Usage" +#: ../../../docs/configuring-playbook-matrix-registration.md:64 +msgid "`roles/custom/matrix-registration/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:65 -msgid "**matrix-registration** gets exposed at `https://matrix.example.com/matrix-registration`" +msgid "`roles/custom/matrix-registration/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_registration_configuration_extension_yaml` variable" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:67 -msgid "It provides various [APIs](https://github.com/ZerataX/matrix-registration/wiki/api) — for creating registration tokens, listing tokens, disabling tokens, etc. To make use of all of its capabilities, consider using `curl`." +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-matrix-registration.md:69 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-registration.md:76 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-registration.md:78 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-registration.md:80 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-registration.md:82 +msgid "**matrix-registration** gets exposed at `https://matrix.example.com/matrix-registration`" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-registration.md:84 +msgid "It provides various [APIs](https://github.com/ZerataX/matrix-registration/wiki/api) — for creating registration tokens, listing tokens, disabling tokens, etc. To make use of all of its capabilities, consider using `curl`." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-registration.md:86 msgid "We make the most common APIs easy to use via the playbook (see below)." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:71 +#: ../../../docs/configuring-playbook-matrix-registration.md:88 msgid "Creating registration tokens" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:73 +#: ../../../docs/configuring-playbook-matrix-registration.md:90 msgid "To **create a new user registration token (link)**, use this command:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:81 +#: ../../../docs/configuring-playbook-matrix-registration.md:98 msgid "The above command creates and returns a **one-time use** token, which **expires** on the 31st of December 2021. Adjust the `one_time` and `ex_date` variables as you see fit." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:83 +#: ../../../docs/configuring-playbook-matrix-registration.md:100 msgid "Share the unique registration link (generated by the command above) with users to let them register on your Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:85 +#: ../../../docs/configuring-playbook-matrix-registration.md:102 msgid "Listing registration tokens" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:87 +#: ../../../docs/configuring-playbook-matrix-registration.md:104 msgid "To **list the existing user registration tokens**, use this command:" msgstr "" -#: ../../../docs/configuring-playbook-matrix-registration.md:94 +#: ../../../docs/configuring-playbook-matrix-registration.md:111 msgid "The shortcut command with `just` program is also available: `just run-tags list-matrix-registration-tokens`" msgstr "" + +#: ../../../docs/configuring-playbook-matrix-registration.md:113 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-registration.md:115 +msgid "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`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-matrix-rtc.pot b/i18n/translation-templates/docs/configuring-playbook-matrix-rtc.pot new file mode 100644 index 000000000..b3279103f --- /dev/null +++ b/i18n/translation-templates/docs/configuring-playbook-matrix-rtc.pot @@ -0,0 +1,105 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members +# This file is distributed under the same license as the matrix-docker-ansible-deploy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: matrix-docker-ansible-deploy \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:8 +msgid "Setting up the Matrix RTC stack (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:10 +msgid "The playbook can install and configure the Matrix RTC (Real-Time Communication) stack." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:12 +msgid "The Matrix RTC stack is a set of supporting components ([LiveKit Server](configuring-playbook-livekit-server.md) and [LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md)) that allow the new [Element Call](configuring-playbook-element-call.md) audio/video calls to function." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:14 +msgid "💡 If you only plan on doing audio/video calls via Matrix client (which typically embed the Element Call frontend UI within them), you only need to install the Matrix RTC stack and don't necessarily need to install [Element Call](configuring-playbook-element-call.md). See the [Decide between Element Call vs just the Matrix RTC stack](configuring-playbook-element-call.md#decide-between-element-call-vs-just-the-matrix-rtc-stack) section of the [Element Call documentation](configuring-playbook-element-call.md) for more details." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:16 +msgid "Prerequisites" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:18 +msgid "A [Synapse](configuring-playbook-synapse.md) homeserver (see the warning below)" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:19 +msgid "Various experimental features for the Synapse homeserver which Element Call [requires](https://github.com/element-hq/element-call/blob/93ae2aed9841e0b066d515c56bd4c122d2b591b2/docs/self-hosting.md#a-matrix-homeserver) (automatically done when Element Call is enabled)" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:20 +msgid "A [LiveKit Server](configuring-playbook-livekit-server.md) (automatically installed when [Element Call or the Matrix RTC stack is enabled](#decide-between-element-call-vs-just-the-matrix-rtc-stack))" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:21 +msgid "The [LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md) (automatically installed when [Element Call or the Matrix RTC stack is enabled](#decide-between-element-call-vs-just-the-matrix-rtc-stack))" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:22 +msgid "A client compatible with Element Call. As of 2025-03-15, that's just [Element Web](configuring-playbook-client-element-web.md) and the Element X mobile clients (iOS and Android)." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:24 +msgid "[!WARNING] Because Element Call [requires](https://github.com/element-hq/element-call/blob/93ae2aed9841e0b066d515c56bd4c122d2b591b2/docs/self-hosting.md#a-matrix-homeserver) a few experimental features in the Matrix protocol, it's **very likely that it only works with the Synapse homeserver**." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:27 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:29 +msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:37 +msgid "Adjusting firewall rules" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:39 +msgid "In addition to the HTTP/HTTPS ports (which you've already exposed as per the [prerequisites](prerequisites.md) document), you'll also need to open ports required by [LiveKit Server](configuring-playbook-livekit-server.md) as described in its own [Adjusting firewall rules](configuring-playbook-livekit-server.md#adjusting-firewall-rules) section." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:41 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:43 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records) and [adjusting firewall rules](#adjusting-firewall-rules), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:50 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:52 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:54 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:56 +msgid "Once installed, Matrix clients which support Element Call (like [Element Web](configuring-playbook-client-element-web.md) and Element X on mobile (iOS and Android)) will automatically use the Matrix RTC stack." +msgstr "" + +#: ../../../docs/configuring-playbook-matrix-rtc.md:58 +msgid "These clients typically embed the Element Call frontend UI within them, so installing [Element Call](configuring-playbook-element-call.md) is only necessary if you'd like to use it standalone - directly via a browser." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-nginx.pot b/i18n/translation-templates/docs/configuring-playbook-nginx.pot index 1c74a6daa..24dcf04c5 100644 --- a/i18n/translation-templates/docs/configuring-playbook-nginx.pot +++ b/i18n/translation-templates/docs/configuring-playbook-nginx.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,10 +16,10 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-nginx.md:1 +#: ../../../docs/configuring-playbook-nginx.md:12 msgid "Configure Nginx (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-nginx.md:3 +#: ../../../docs/configuring-playbook-nginx.md:14 msgid "Since 2024-01, this playbook no longer uses nginx as its reverse-proxy." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-ntfy.pot b/i18n/translation-templates/docs/configuring-playbook-ntfy.pot index cf5cfefce..cb046230a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-ntfy.pot +++ b/i18n/translation-templates/docs/configuring-playbook-ntfy.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,218 +16,258 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-ntfy.md:1 +#: ../../../docs/configuring-playbook-ntfy.md:12 msgid "Setting up the ntfy push notifications server (optional)" msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:3 -msgid "The playbook can install and configure the [ntfy](https://ntfy.sh/) push notifications server for you." +#: ../../../docs/configuring-playbook-ntfy.md:14 +msgid "The playbook can install and configure the [ntfy](https://ntfy.sh/) (pronounced \"notify\") push notifications server for you." msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:5 -msgid "Using the [UnifiedPush](https://unifiedpush.org) standard, ntfy enables self-hosted (Google-free) push notifications from Matrix (and other) servers to UnifiedPush-compatible Matrix compatible client apps running on Android and other devices." +#: ../../../docs/configuring-playbook-ntfy.md:16 +msgid "ntfy lets you send push notifications to your phone or desktop via scripts from any computer, using simple HTTP PUT or POST requests. It makes it possible to send/receive notifications, without relying on servers owned and controlled by third parties." msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:7 -msgid "This role is intended to support UnifiedPush notifications for use with the Matrix and Matrix-related services that this playbook installs. This role is not intended to support all of ntfy's other features." +#: ../../../docs/configuring-playbook-ntfy.md:18 +msgid "With the [UnifiedPush](https://unifiedpush.org) standard, ntfy also enables self-hosted push notifications from Matrix (and other) servers to UnifiedPush-compatible Matrix client apps running on Android devices." msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:9 -msgid "**Note**: In contrast to push notifications using Google's FCM or Apple's APNs, the use of UnifiedPush allows each end-user to choose the push notification server that they prefer. As a consequence, deploying this ntfy server does not by itself ensure any particular user or device or client app will use it." +#: ../../../docs/configuring-playbook-ntfy.md:20 +msgid "See the project's [documentation](https://docs.ntfy.sh/) to learn what ntfy does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:11 +#: ../../../docs/configuring-playbook-ntfy.md:22 +msgid "The [Ansible role for ntfy](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring ntfy, you can check them via:" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:23 +msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md) online" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:24 +msgid "📁 `roles/galaxy/ntfy/docs/configuring-ntfy.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:26 +msgid "**Note**: this playbook focuses on setting up a ntfy server for getting it send push notifications with UnifiedPush to Matrix-related services that this playbook installs, while the installed server will be available for other non-Matrix apps like [Tusky](https://tusky.app/) and [DAVx⁵](https://www.davx5.com/) as well. This playbook does not intend to support all of ntfy's features. If you want to use them as well, refer the role's documentation for details to configure them by yourself." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:28 +msgid "Improve push notification's privacy with ntfy" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:30 +msgid "By default, push notifications received on Matrix apps on Android/iOS act merely as \"wake-up calls\" for the application, which contain only event IDs, and do not transmit actual message payload such as text message data." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:32 +msgid "While your messages remain private even without ntfy, it makes it possible to improve privacy and sovereignty of your Matrix installation, offering greater control over your data, by avoiding routing these \"application wake-up calls\" through Google or Apple servers and having them pass through the self-hosted ntfy instance on your Matrix server." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:34 +msgid "How ntfy works with UnifiedPush" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:36 +msgid "⚠️ [UnifiedPush does not work on iOS.](https://unifiedpush.org/users/faq/#will-unifiedpush-ever-work-on-ios)" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:38 +msgid "ntfy implements UnifiedPush, the standard which makes it possible to send and receive push notifications without using Google's Firebase Cloud Messaging (FCM) service." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:40 +msgid "Working as a **Push Server**, a ntfy server can forward messages via [the ntfy Android app](https://docs.ntfy.sh/subscribe/phone/) as a **Distributor** to a UnifiedPush-compatible Matrix client such as Element Android and FluffyChat Android (see [here](https://unifiedpush.org/users/distributors/#definitions) for the definition of the Push Server and the Distributor)." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:42 +msgid "Note that UnifiedPush-compatible applications must be able to communicate with the ntfy Android app which works as the Distributor on the same device, in order to receive push notifications from the Push Server." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:44 +msgid "As the ntfy Android app functions as the Distributor, you do not have to install something else on your device, besides a UnifiedPush-compatible Matrix client." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:46 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:13 +#: ../../../docs/configuring-playbook-ntfy.md:48 msgid "By default, this playbook installs ntfy on the `ntfy.` subdomain (`ntfy.example.com`) and requires you to create a CNAME record for `ntfy`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:15 +#: ../../../docs/configuring-playbook-ntfy.md:50 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:17 +#: ../../../docs/configuring-playbook-ntfy.md:52 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:19 -msgid "To enable ntfy, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:33 -msgid "For a more complete list of variables that you could override, see the [`defaults/main.yml` file](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/defaults/main.yml) of the ntfy Ansible role." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:35 -msgid "For a complete list of ntfy config options that you could put in `ntfy_configuration_extension_yaml`, see the [ntfy config documentation](https://ntfy.sh/docs/config/#config-options)." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:37 -msgid "Adjusting the ntfy URL (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:39 -msgid "By tweaking the `ntfy_hostname` variable, you can easily make the service available at a **different hostname** than the default one." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:41 -msgid "Example additional configuration for your `vars.yml` file:" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:48 -msgid "After changing the domain, **you may need to adjust your DNS** records to point the ntfy domain to the Matrix server." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:50 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:52 -msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:59 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:61 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:63 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:65 -msgid "To make use of your ntfy installation, on Android for example, you need two things:" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:67 -msgid "the `ntfy` app" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:68 -msgid "a UnifiedPush-compatible Matrix app" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:70 -msgid "You need to install the `ntfy` app on each device on which you want to receive push notifications through your ntfy server. The `ntfy` app will provide UnifiedPush notifications to any number of UnifiedPush-compatible messaging apps installed on the same device." +#: ../../../docs/configuring-playbook-ntfy.md:54 +msgid "To enable a ntfy server, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:72 -msgid "Setting up the `ntfy` Android app" +msgid "As the most of the necessary settings for the role have been taken care of by the playbook, you can enable the ntfy server on your Matrix server with this minimum configuration." msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:74 -msgid "Install the [ntfy Android app](https://ntfy.sh/docs/subscribe/phone/) from F-droid or Google Play." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:75 -msgid "In its Settings -> `General: Default server`, enter your ntfy server URL, such as `https://ntfy.example.com`." +msgid "See the role's documentation for details about configuring ntfy per your preference (such as [setting access control with authentication](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#enable-access-control-with-authentication-optional))." msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:76 -msgid "In its Settings -> `Advanced: Connection protocol`, choose `WebSockets`." +msgid "Adjusting the ntfy URL (optional)" msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:78 -msgid "That is all you need to do in the ntfy app. It has many other features, but for our purposes you can ignore them. In particular you do not need to follow any instructions about subscribing to a notification topic as UnifiedPush will do that automatically." +msgid "By tweaking the `ntfy_hostname` variable, you can easily make the service available at a **different hostname** than the default one." msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:80 -msgid "Setting up a UnifiedPush-compatible Matrix app" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:82 -msgid "Install any UnifiedPush-enabled Matrix app on that same device. The Matrix app will learn from the `ntfy` app that you have configured UnifiedPush on this device, and then it will tell your Matrix server to use it." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:84 -msgid "Steps needed for specific Matrix apps:" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:86 -msgid "FluffyChat-android:" +msgid "Example additional configuration for your `vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:87 -msgid "Should auto-detect and use it. No manual settings." +msgid "After changing the domain, **you may need to adjust your DNS** records to point the ntfy domain to the Matrix server." msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:89 -msgid "SchildiChat-android:" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:90 -msgid "enable `Settings` -> `Notifications` -> `UnifiedPush: Force custom push gateway`." +msgid "Enable web app (optional)" msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:91 -msgid "choose `Settings` -> `Notifications` -> `UnifiedPush: Re-register push distributor`. *(For info, a more complex alternative to achieve the same is: delete the relevant unifiedpush registration in `ntfy` app, force-close SchildiChat, re-open it.)*" +msgid "The ntfy server can be accessed via its web app where you can subscribe to and push to \"topics\" from the browser. The web app may be helpful to troubleshoot notification issues or to use ntfy for other purposes than getting ntfy send UnifiedPush notifications to your Matrix-related services." msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:92 -msgid "verify `Settings` -> `Notifications` -> `UnifiedPush: Notification targets` as described below in the \"Troubleshooting\" section." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:94 -msgid "Element-android v1.4.26+:" +#: ../../../docs/configuring-playbook-ntfy.md:93 +msgid "**Note**: subscribing to a topic is not necessary for using the nfty server as the Push Server for UnifiedPush." msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:95 -msgid "choose `Settings` -> `Notifications` -> `Notification method` -> `ntfy`" +msgid "To enable the web app, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:96 -msgid "verify `Settings` -> `Troubleshoot` -> `Troubleshoot notification settings`" +#: ../../../docs/configuring-playbook-ntfy.md:101 +msgid "See [the official documentation](https://docs.ntfy.sh/subscribe/web/) for details about how to use it." msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:98 -msgid "If the Matrix app asks, \"Choose a distributor: FCM Fallback or ntfy\", then choose \"ntfy\"." +#: ../../../docs/configuring-playbook-ntfy.md:103 +msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-ntfy.md:100 -msgid "If the Matrix app doesn't seem to pick it up, try restarting it and try the Troubleshooting section below." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:102 -msgid "Web App" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:104 -msgid "ntfy also has a web app to subscribe to and push to topics from the browser. This may be helpful to further troubleshoot UnifiedPush problems or to use ntfy for other purposes. The web app only runs in the browser locally (after downloading the JavaScript)." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:106 -msgid "The web app is disabled in this playbook by default as the expectation is that most users won't use it. You can either use the [official hosted one](https://ntfy.sh/app) (it supports using other public reachable ntfy instances) or host it yourself by setting `ntfy_web_root: \"app\"` and re-running Ansible." -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:108 -msgid "Troubleshooting" -msgstr "" - -#: ../../../docs/configuring-playbook-ntfy.md:110 -msgid "First check that the Matrix client app you are using supports UnifiedPush. There may well be different variants of the app." +#: ../../../docs/configuring-playbook-ntfy.md:105 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:112 -msgid "Set the ntfy server's log level to 'DEBUG', as shown in the example settings above, and watch the server's logs with `sudo journalctl -fu matrix-ntfy`." +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:114 -msgid "To check if UnifiedPush is correctly configured on the client device, look at \"Settings -> Notifications -> Notification Targets\" in Element Android or SchildiChat Android, or \"Settings -> Notifications -> Devices\" in FluffyChat. There should be one entry for each Matrix client app that has enabled push notifications, and when that client is using UnifiedPush you should see a URL that begins with your ntfy server's URL." +msgid "`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." msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:116 -msgid "In the \"Notification Targets\" screen in Element Android or SchildiChat Android, two relevant URLs are shown, \"push\\_key\" and \"Url\", and both should begin with your ntfy server's URL. If \"push\\_key\" shows your server but \"Url\" shows an external server such as `up.schildi.chat` then push notifications will still work but are being routed through that external server before they reach your ntfy server. To rectify that, in SchildiChat (at least around version 1.4.20.sc55) you must enable the `Force custom push gateway` setting as described in the \"Usage\" section above." +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:118 -msgid "If it is not working, useful tools are \"Settings -> Notifications -> Re-register push distributor\" and \"Settings -> Notifications -> Troubleshoot Notifications\" in SchildiChat Android (possibly also Element Android). In particular the \"Endpoint/FCM\" step of that troubleshooter should display your ntfy server's URL that it has discovered from the ntfy client app." +msgid "To receive push notifications with UnifiedPush from the ntfy server, you need to **install [the ntfy Android app](https://docs.ntfy.sh/subscribe/phone/)** which works as the Distributor, **log in to the account on the ntfy app** if you have enabled the access control, and then **configure a UnifiedPush-compatible Matrix client**. After setting up the ntfy Android app, the Matrix client listens to it, and push notifications are \"distributed\" from it." msgstr "" #: ../../../docs/configuring-playbook-ntfy.md:120 +msgid "For details about installing and configuring the ntfy Android app, take a look at [this section](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#install-the-ntfy-androidios-app) on the role's documentation." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:122 +msgid "⚠️ Though the ntfy app is available for iOS ([App Store](https://apps.apple.com/us/app/ntfy/id1625396347); the app's source code can be retrieved from [here](https://github.com/binwiederhier/ntfy-ios)), **any Matrix clients for iOS currently do not support ntfy** due to [technical limitations of the iOS platform](https://github.com/binwiederhier/ntfy-ios/blob/main/docs/TECHNICAL_LIMITATIONS.md). If you develop your own Matrix client app for iOS, you may need to use the [Sygnal](configuring-playbook-sygnal.md) push gateway service to deliver push notifications to it." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:124 +msgid "Setting up a UnifiedPush-compatible Matrix client" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:126 +msgid "Having configured the ntfy Android app, you can configure a UnifiedPush-compatible Matrix client on the same device." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:128 +msgid "Steps needed for specific Matrix clients:" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:130 +msgid "FluffyChat-Android: this should auto-detect and use the app. No manual settings required." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:132 +msgid "SchildiChat-Android:" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:133 +msgid "enable `Settings` -> `Notifications` -> `UnifiedPush: Force custom push gateway`." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:134 +msgid "choose `Settings` -> `Notifications` -> `UnifiedPush: Re-register push distributor`. *(For info, a more complex alternative to achieve the same is: delete the relevant unifiedpush registration in the ntfy Android app, force-close SchildiChat, re-open it.)*" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:135 +msgid "verify `Settings` -> `Notifications` -> `UnifiedPush: Notification targets` as described below in the \"Troubleshooting\" section." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:137 +msgid "Element-Android v1.4.26+:" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:138 +msgid "choose `Settings` -> `Notifications` -> `Notification method` -> `ntfy`" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:139 +msgid "verify `Settings` -> `Troubleshoot` -> `Troubleshoot notification settings`" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:141 +msgid "If the Matrix client asks, \"Choose a distributor: FCM Fallback or ntfy\", then choose \"ntfy\"." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:143 +msgid "If the Matrix client doesn't seem to pick it up, try restarting it and try the Troubleshooting section below." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:145 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:147 msgid "The simple [UnifiedPush troubleshooting](https://unifiedpush.org/users/troubleshooting/) app [UP-Example](https://f-droid.org/en/packages/org.unifiedpush.example/) can be used to manually test UnifiedPush registration and operation on an Android device." msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:149 +msgid "Check the Matrix client" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:151 +msgid "Make sure that the Matrix client you are using supports UnifiedPush. There may well be different variants of the app." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:153 +msgid "To check if UnifiedPush is correctly configured on the client device, look at \"Settings -> Notifications -> Notification Targets\" in Element Android or SchildiChat Android, or \"Settings -> Notifications -> Devices\" in FluffyChat. There should be one entry for each Matrix client that has enabled push notifications, and when that client is using UnifiedPush you should see a URL that begins with your ntfy server's URL." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:155 +msgid "In the \"Notification Targets\" screen in Element Android or SchildiChat Android, two relevant URLs are shown, \"push\\_key\" and \"Url\", and both should begin with your ntfy server's URL. If \"push\\_key\" shows your server but \"Url\" shows an external server such as `up.schildi.chat` then push notifications will still work but are being routed through that external server before they reach your ntfy server. To rectify that, in SchildiChat (at least around version 1.4.20.sc55) you must enable the `Force custom push gateway` setting as described in the \"Usage\" section above." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:157 +msgid "If it is not working, useful tools are \"Settings -> Notifications -> Re-register push distributor\" and \"Settings -> Notifications -> Troubleshoot Notifications\" in SchildiChat Android (possibly also Element Android). In particular the \"Endpoint/FCM\" step of that troubleshooter should display your ntfy server's URL that it has discovered from the ntfy client app." +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:159 +msgid "Check the service's logs" +msgstr "" + +#: ../../../docs/configuring-playbook-ntfy.md:161 +msgid "See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#check-the-services-logs) on the role's documentation for details." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-own-webserver.pot b/i18n/translation-templates/docs/configuring-playbook-own-webserver.pot index 30f57b0ae..9347dbddb 100644 --- a/i18n/translation-templates/docs/configuring-playbook-own-webserver.pot +++ b/i18n/translation-templates/docs/configuring-playbook-own-webserver.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,174 +16,174 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-own-webserver.md:1 +#: ../../../docs/configuring-playbook-own-webserver.md:19 msgid "Using your own webserver, instead of this playbook's Traefik reverse-proxy (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:3 +#: ../../../docs/configuring-playbook-own-webserver.md:21 msgid "By default, this playbook installs its own [Traefik](https://traefik.io/) reverse-proxy server (in a Docker container) which listens on ports 80 and 443. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:5 +#: ../../../docs/configuring-playbook-own-webserver.md:23 msgid "Traefik" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:7 +#: ../../../docs/configuring-playbook-own-webserver.md:25 msgid "[Traefik](https://traefik.io/) is the default reverse-proxy for the playbook since [2023-02-26](../CHANGELOG.md/#2023-02-26) and serves **2 purposes**:" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:9 +#: ../../../docs/configuring-playbook-own-webserver.md:27 msgid "serving public traffic and providing SSL-termination with certificates obtained from [Let's Encrypt](https://letsencrypt.org/). See [Adjusting SSL certificate retrieval](./configuring-playbook-ssl-certificates.md)." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:11 -msgid "assists internal communication between addon services (briges, bots, etc.) and the homeserver via an internal entrypoint (`matrix-internal-matrix-client-api`)." +#: ../../../docs/configuring-playbook-own-webserver.md:29 +msgid "assists internal communication between addon services (bridges, bots, etc.) and the homeserver via an internal entrypoint (`matrix-internal-matrix-client-api`)." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:13 +#: ../../../docs/configuring-playbook-own-webserver.md:31 msgid "There are 2 ways to use Traefik with this playbook, as described below." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:15 +#: ../../../docs/configuring-playbook-own-webserver.md:33 msgid "Traefik managed by the playbook" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:17 +#: ../../../docs/configuring-playbook-own-webserver.md:35 msgid "To have the playbook install and use Traefik, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:25 +#: ../../../docs/configuring-playbook-own-webserver.md:41 msgid "Traefik will manage SSL certificates for all services seamlessly." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:27 +#: ../../../docs/configuring-playbook-own-webserver.md:43 msgid "Traefik managed by you" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:53 +#: ../../../docs/configuring-playbook-own-webserver.md:69 msgid "In this mode all roles will still have Traefik labels attached. You will, however, need to configure your Traefik instance and its entrypoints." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:55 +#: ../../../docs/configuring-playbook-own-webserver.md:71 msgid "By default, the playbook configured a `default` certificate resolver and multiple entrypoints." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:57 +#: ../../../docs/configuring-playbook-own-webserver.md:73 msgid "You need to configure 4 entrypoints for your Traefik server:" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:59 +#: ../../../docs/configuring-playbook-own-webserver.md:75 msgid "`web` (TCP port `80`) — used for redirecting to HTTPS (`web-secure`)" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:60 +#: ../../../docs/configuring-playbook-own-webserver.md:76 msgid "`web-secure` (TCP port `443`) — used for exposing the Matrix Client-Server API and all other services" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:61 +#: ../../../docs/configuring-playbook-own-webserver.md:77 msgid "`matrix-federation` (TCP port `8448`) — used for exposing the Matrix Federation API" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:62 +#: ../../../docs/configuring-playbook-own-webserver.md:78 msgid "`matrix-internal-matrix-client-api` (TCP port `8008`) — used internally for addon services (bridges, bots) to communicate with the homserver" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:64 +#: ../../../docs/configuring-playbook-own-webserver.md:80 msgid "Below is some configuration for running Traefik yourself, although we recommend using [Traefik managed by the playbook](#traefik-managed-by-the-playbook)." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:66 +#: ../../../docs/configuring-playbook-own-webserver.md:82 msgid "Note that this configuration on its own does **not** redirect traffic on port 80 (plain HTTP) to port 443 for HTTPS. If you are not already doing this in Traefik, it can be added to Traefik in a [file provider](https://docs.traefik.io/v2.0/providers/file/) as follows:" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:86 +#: ../../../docs/configuring-playbook-own-webserver.md:102 msgid "You can use the following `docker-compose.yml` as example to launch Traefik." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:122 +#: ../../../docs/configuring-playbook-own-webserver.md:138 msgid "Another webserver" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:124 +#: ../../../docs/configuring-playbook-own-webserver.md:140 msgid "If you don't wish to use Traefik, you can also use your own webserver." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:126 +#: ../../../docs/configuring-playbook-own-webserver.md:142 msgid "Doing this is possible, but requires manual work." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:128 +#: ../../../docs/configuring-playbook-own-webserver.md:144 msgid "There are 2 ways to go about it:" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:130 +#: ../../../docs/configuring-playbook-own-webserver.md:146 msgid "(recommended) [Fronting the integrated reverse-proxy webserver with another reverse-proxy](#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy) — using the playbook-managed reverse-proxy (Traefik), but disabling SSL termination for it, exposing this reverse-proxy on a few local ports (e.g. `127.0.0.1:81`, etc.) and forwarding traffic from your own webserver to those few ports" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:132 +#: ../../../docs/configuring-playbook-own-webserver.md:148 msgid "(difficult) [Using no reverse-proxy on the Matrix side at all](#using-no-reverse-proxy-on-the-matrix-side-at-all) disabling the playbook-managed reverse-proxy (Traefik), exposing services one by one using `_host_bind_port` variables and forwarding traffic from your own webserver to those ports" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:134 +#: ../../../docs/configuring-playbook-own-webserver.md:150 msgid "Fronting the integrated reverse-proxy webserver with another reverse-proxy" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:136 +#: ../../../docs/configuring-playbook-own-webserver.md:152 msgid "This method is about leaving the integrated reverse-proxy webserver be, but making it not get in the way (using up important ports, trying to retrieve SSL certificates, etc.)." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:138 +#: ../../../docs/configuring-playbook-own-webserver.md:154 msgid "If you wish to use another webserver, the integrated reverse-proxy webserver usually gets in the way because it attempts to fetch SSL certificates and binds to ports 80, 443 and 8448 (if Matrix Federation is enabled)." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:140 +#: ../../../docs/configuring-playbook-own-webserver.md:156 msgid "You can disable such behavior and make the integrated reverse-proxy webserver only serve traffic locally on the host itself (or over a local network)." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:142 +#: ../../../docs/configuring-playbook-own-webserver.md:158 msgid "This is the recommended way for using another reverse-proxy, because the integrated one would act as a black box and wire all Matrix services correctly. You would then only need to reverse-proxy a few individual domains and ports over to it." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:144 +#: ../../../docs/configuring-playbook-own-webserver.md:160 msgid "To front Traefik with another reverse-proxy, you would need some configuration like this:" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:194 +#: ../../../docs/configuring-playbook-own-webserver.md:210 msgid "Such a configuration would expose all services on a local port `81` and Matrix Federation on a local port `8449`. Your reverse-proxy configuration needs to send traffic to these ports. [`examples/reverse-proxies`](../examples/reverse-proxies/) contains examples for various webservers such as Apache2, Caddy, HAproxy, nginx and Nginx Proxy Manager." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:196 +#: ../../../docs/configuring-playbook-own-webserver.md:212 msgid "It's important that these webservers proxy-pass requests to the correct `ip:port` and also set the `Host` HTTP header appropriately. If you don't pass the `Host` header correctly, Traefik will return a `404 - not found` error." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:198 +#: ../../../docs/configuring-playbook-own-webserver.md:214 msgid "To put it another way:" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:199 +#: ../../../docs/configuring-playbook-own-webserver.md:215 msgid "`curl http://127.0.0.1:81` will result in a `404 - not found` error" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:200 +#: ../../../docs/configuring-playbook-own-webserver.md:216 msgid "but `curl -H 'Host: matrix.example.com' http://127.0.0.1:81` should work." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:202 +#: ../../../docs/configuring-playbook-own-webserver.md:218 msgid "Using no reverse-proxy on the Matrix side at all" msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:204 +#: ../../../docs/configuring-playbook-own-webserver.md:220 msgid "Instead of [Fronting the integrated reverse-proxy webserver with another reverse-proxy](#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy), you can also go another way — completely disabling the playbook-managed Traefik reverse-proxy. You would then need to reverse-proxy from your own webserver directly to each individual Matrix service." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:206 +#: ../../../docs/configuring-playbook-own-webserver.md:222 msgid "This is more difficult, as you would need to handle the configuration for each service manually. Enabling additional services would come with extra manual work you need to do." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:208 +#: ../../../docs/configuring-playbook-own-webserver.md:224 msgid "Also, the Traefik reverse-proxy, besides fronting everything is also serving a 2nd purpose of allowing addons services to communicate with the Matrix homeserver thanks to its `matrix-internal-matrix-client-api` entrypoint (read more about it above). Disabling Traefik completely means the playbook would wire services to directly talk to the homeserver. This can work for basic setups, but not for more complex setups involving [matrix-media-repo](./configuring-playbook-matrix-media-repo.md), [matrix-corporal](./configuring-playbook-matrix-corporal.md) or other such services that need to \"steal routes\" from the homeserver." msgstr "" -#: ../../../docs/configuring-playbook-own-webserver.md:210 +#: ../../../docs/configuring-playbook-own-webserver.md:226 msgid "If your webserver is on the same machine, ensure your web server user (something like `http`, `apache`, `www-data`, `nginx`) is part of the `matrix` group. You should run something like this: `usermod -a -G matrix nginx`. This allows your webserver user to access files owned by the `matrix` group, so that it can serve static files from `/matrix/static-files`." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-pantalaimon.pot b/i18n/translation-templates/docs/configuring-playbook-pantalaimon.pot index 99a4c93e7..8eb20b8f2 100644 --- a/i18n/translation-templates/docs/configuring-playbook-pantalaimon.pot +++ b/i18n/translation-templates/docs/configuring-playbook-pantalaimon.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,70 +16,70 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-pantalaimon.md:1 +#: ../../../docs/configuring-playbook-pantalaimon.md:8 msgid "Setting up Pantalaimon (E2EE aware proxy daemon) (optional)" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:3 +#: ../../../docs/configuring-playbook-pantalaimon.md:10 msgid "The playbook can install and configure the [pantalaimon](https://github.com/matrix-org/pantalaimon) E2EE aware proxy daemon for you." msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:5 +#: ../../../docs/configuring-playbook-pantalaimon.md:12 msgid "See the project's [documentation](https://github.com/matrix-org/pantalaimon/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:7 +#: ../../../docs/configuring-playbook-pantalaimon.md:14 msgid "This role exposes Pantalaimon's API only within the container network, so bots and clients installed on the same machine can use it. In particular the [Draupnir](configuring-playbook-bot-draupnir.md) and [Mjolnir](configuring-playbook-bot-mjolnir.md) roles (and possibly others) can use it." msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:9 +#: ../../../docs/configuring-playbook-pantalaimon.md:16 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:11 +#: ../../../docs/configuring-playbook-pantalaimon.md:18 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:17 +#: ../../../docs/configuring-playbook-pantalaimon.md:24 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:19 +#: ../../../docs/configuring-playbook-pantalaimon.md:26 msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:21 +#: ../../../docs/configuring-playbook-pantalaimon.md:28 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:23 +#: ../../../docs/configuring-playbook-pantalaimon.md:30 msgid "`roles/custom/matrix-pantalaimon/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_pantalaimon_configuration` variable" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:25 +#: ../../../docs/configuring-playbook-pantalaimon.md:32 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:27 +#: ../../../docs/configuring-playbook-pantalaimon.md:34 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:34 +#: ../../../docs/configuring-playbook-pantalaimon.md:41 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:36 +#: ../../../docs/configuring-playbook-pantalaimon.md:43 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:38 +#: ../../../docs/configuring-playbook-pantalaimon.md:45 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:40 +#: ../../../docs/configuring-playbook-pantalaimon.md:47 msgid "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-pantalaimon`." msgstr "" -#: ../../../docs/configuring-playbook-pantalaimon.md:42 +#: ../../../docs/configuring-playbook-pantalaimon.md:49 msgid "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:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-postgres-backup.pot b/i18n/translation-templates/docs/configuring-playbook-postgres-backup.pot index 29036ff40..588b221ad 100644 --- a/i18n/translation-templates/docs/configuring-playbook-postgres-backup.pot +++ b/i18n/translation-templates/docs/configuring-playbook-postgres-backup.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,138 +16,26 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-postgres-backup.md:1 -msgid "Setting up postgres backup (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:3 -msgid "The playbook can install and configure [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) for you via the [ansible-role-postgres-backup](https://github.com/mother-of-all-self-hosting/ansible-role-postgres-backup) Ansible role." -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:5 -msgid "For a more complete backup solution (one that includes not only Postgres, but also other configuration/data files), you may wish to look into [BorgBackup](configuring-playbook-backup-borg.md) instead." -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:7 -msgid "Adjusting the playbook configuration" -msgstr "" - #: ../../../docs/configuring-playbook-postgres-backup.md:9 -msgid "To enable Postgres backup, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +msgid "Setting up Postgres backup (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-postgres-backup.md:11 +msgid "The playbook can install and configure [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) for you." +msgstr "" + +#: ../../../docs/configuring-playbook-postgres-backup.md:13 +msgid "The [Ansible role for docker-postgres-backup-local](https://github.com/mother-of-all-self-hosting/ansible-role-postgres-backup) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring docker-postgres-backup-local, you can check them via:" +msgstr "" + +#: ../../../docs/configuring-playbook-postgres-backup.md:14 +msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-postgres-backup/blob/main/docs/configuring-postgres-backup.md) online" msgstr "" #: ../../../docs/configuring-playbook-postgres-backup.md:15 -msgid "Refer to the table below for additional configuration variables and their default values." +msgid "📁 `roles/galaxy/postgres_backup/docs/configuring-postgres-backup.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)" msgstr "" -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Name" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Default value" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Description" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`postgres_backup_enabled`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`false`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Set to true to use [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) to create automatic database backups" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`postgres_backup_schedule`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`'@daily'`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Cron-schedule specifying the interval between postgres backups." -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`postgres_backup_keep_days`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`7`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Number of daily backups to keep" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`postgres_backup_keep_weeks`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`4`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Number of weekly backups to keep" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`postgres_backup_keep_months`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`12`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Number of monthly backups to keep" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`postgres_backup_base_path`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`\"{{ matrix_base_data_path }}/postgres-backup\"`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Base path for postgres-backup. Also see `postgres_backup_data_path`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`postgres_backup_data_path`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "`\"{{ postgres_backup_base_path }}/data\"`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:0 -msgid "Storage path for postgres-backup database backups" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:27 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:29 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:36 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-postgres-backup.md:38 -msgid "`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." +#: ../../../docs/configuring-playbook-postgres-backup.md:17 +msgid "**Note**: for a more complete backup solution (one that includes not only Postgres, but also other configuration/data files), you may wish to look into [BorgBackup](configuring-playbook-backup-borg.md) instead." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-prometheus-grafana.pot b/i18n/translation-templates/docs/configuring-playbook-prometheus-grafana.pot index b1e49cb85..bd4abd9fb 100644 --- a/i18n/translation-templates/docs/configuring-playbook-prometheus-grafana.pot +++ b/i18n/translation-templates/docs/configuring-playbook-prometheus-grafana.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,76 +16,154 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:1 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:14 msgid "Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server (optional)" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:3 -msgid "The playbook can install [Grafana](https://grafana.com/) with [Prometheus](https://prometheus.io/) and configure performance metrics of your homeserver with graphs for you." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:16 +msgid "The playbook can install [Prometheus](https://prometheus.io/) with [Grafana](https://grafana.com/) and configure performance metrics of your homeserver with graphs for you." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:5 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:18 +msgid "[!WARNING] Metrics and graphs contain a lot of information, and anyone who has access to them can make an educated guess about your server usage patterns. This especially applies to small personal/family scale homeservers, where the number of samples is fairly limited. Analyzing the metrics over time, one might be able to figure out your life cycle, such as when you wake up, go to bed, etc. Before enabling (anonymous) access, you should carefully evaluate the risk, and if you do enable it, it is highly recommended to change your Grafana password from the default one." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:21 +msgid "Most of our Docker containers run with limited system access, but the `prometheus-node-exporter` can access the host network stack and (readonly) root filesystem. If it is fine, you can enable it and have it capture metrics about them (see [below](#enable-metrics-and-graphs-for-generic-system-information-optional) for the instruction). Even if `prometheus-node-exporter` is not enabled, you will still get Synapse homeserver metrics. Note that both of these dashboards are always be enabled, so you can still see historical data even after disabling either source." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:23 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:7 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:25 msgid "By default, this playbook installs Grafana web user-interface on the `stats.` subdomain (`stats.example.com`) and requires you to create a CNAME record for `stats`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:9 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:27 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:11 -msgid "Adjusting the playbook configuration" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:29 +msgid "**Note**: It is possible to install Prometheus without installing Grafana. In this case it is not required to create the CNAME record." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:13 -msgid "To enable Grafana and/or Prometheus, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:31 +msgid "Adjusting the playbook configuration — Prometheus" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:39 -msgid "The retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:33 +msgid "Prometheus is an open-source systems monitoring and alerting toolkit. It is a time series database, which holds all the data we're going to talk about." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:35 +msgid "To enable it, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:41 -msgid "Adjusting the Grafana URL (optional)" +msgid "**Note**: the retention policy of Prometheus metrics is [15 days by default](https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects). Older data gets deleted automatically." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:43 -msgid "By tweaking the `grafana_hostname` variable, you can easily make the service available at a **different hostname** than the default one." +msgid "Enable metrics and graphs for generic system information (optional)" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:45 -msgid "Example additional configuration for your `vars.yml` file:" +msgid "You can enable the [Node Exporter](https://prometheus.io/docs/guides/node-exporter/), an addon of sorts to Prometheus that collects generic system information such as CPU, memory, filesystem, and even system temperatures." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:52 -msgid "After changing the domain, **you may need to adjust your DNS** records to point the Grafana domain to the Matrix server." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:47 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:59 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:83 +msgid "To enable it, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:54 -msgid "**Note**: It is possible to install Prometheus without installing Grafana. This case it is not required to create the CNAME record." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:53 +msgid "Enable metrics and graphs for Postgres (optional)" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:56 -msgid "Installing" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:55 +msgid "Expanding on the metrics exposed by the Synapse exporter and the Node exporter, the playbook can also install and configure the [PostgreSQL Server Exporter](https://github.com/prometheus-community/postgres_exporter) that exposes more detailed information about what's happening on your Postgres database." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:58 -msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:57 +msgid "Enabling the exporter sets up the docker container, connects it to the database and adds a 'job' to the Prometheus config which tells Prometheus about this new exporter." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:65 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:61 +msgid "**Note**: `prometheus_postgres_exporter_database_username` has nothing to do with your Matrix user ID. It can be any string you'd like." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:67 -msgid "`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." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:75 +msgid "Enable metrics and graphs for nginx logs (optional)" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:69 -msgid "What does it do?" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:77 +msgid "The playbook can also install and configure the [prometheus-nginxlog-exporter](https://github.com/martin-helmich/prometheus-nginxlog-exporter/) service for you." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:79 +msgid "It is an addon of sorts to expose nginx logs to Prometheus. The exporter will collect access logs from various nginx reverse-proxies which may be used internally (e.g. `matrix-synapse-reverse-proxy-companion`, if Synapse workers are enabled) and will make them available at a Prometheus-compatible `/metrics` endpoint." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:81 +msgid "See the project's [documentation](https://github.com/martin-helmich/prometheus-nginxlog-exporter/blob/master/README.adoc) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:89 +msgid "If you enable Grafana, a dedicated `NGINX PROXY` Grafana dashboard will be created." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:91 +msgid "**Note**: nginx is only used internally by this Ansible playbook. With Traefik being our default reverse-proxy, collecting nginx metrics is less relevant." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:93 +msgid "Docker image compatibility (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:95 +msgid "At the moment of writing only images for `amd64` and `arm64` architectures are available. The playbook currently does not support [self-building](./self-building.md) a container image on other architectures. You can however use a custom-build image by setting:" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:102 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:104 +msgid "There are some additional things you may wish to configure about Prometheus and its add-on." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:106 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:108 +msgid "[Prometheus role](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus)'s [`defaults/main.yml`](https://github.com/mother-of-all-self-hosting/ansible-role-prometheus/blob/main/defaults/main.yml) for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `prometheus_configuration_extension_yaml` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:109 +msgid "`roles/custom/matrix-prometheus-nginxlog-exporter/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:111 +msgid "Adjusting the playbook configuration — Grafana" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:113 +msgid "Grafana is an open source visualization and analytics software. To enable it, add the following configuration to your `vars.yml` file. Make sure to replace `USERNAME_HERE` and `PASSWORD_HERE`." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:115 +msgid "**Notes**:" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:116 +msgid "`grafana_default_admin_user` has nothing to do with your Matrix user ID. It can be any string you'd like." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:117 +msgid "Changing the username/password subsequently won't work." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 @@ -96,44 +174,20 @@ msgstr "" msgid "Description" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`prometheus_enabled`" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "[Prometheus](https://prometheus.io) is a time series database. It holds all the data we're going to talk about." -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`prometheus_node_exporter_enabled`" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "[Node Exporter](https://prometheus.io/docs/guides/node-exporter/) is an addon of sorts to Prometheus that collects generic system information such as CPU, memory, filesystem, and even system temperatures" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`prometheus_postgres_exporter_enabled`" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "[Postgres Exporter](configuring-playbook-prometheus-postgres.md) is an addon of sorts to expose Postgres database metrics to Prometheus." -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_prometheus_nginxlog_exporter_enabled`" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "[NGINX Log Exporter](configuring-playbook-prometheus-nginxlog.md) is an addon of sorts to expose NGINX logs to Prometheus." -msgstr "" - #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 msgid "`grafana_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "[Grafana](https://grafana.com/) is the visual component. It shows (on the `stats.example.com` subdomain) the dashboards with the graphs that we're interested in" +msgid "[Grafana](https://grafana.com/) is the visual component. It shows (on the `stats.example.com` subdomain) the dashboards with the graphs that we're interested in." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 +msgid "`grafana_default_admin_user`
`grafana_default_admin_password`" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 +msgid "By default Grafana creates a user with `admin` as the username and password. You are asked to change the credentials on first login. If you feel this is insecure and you want to change them beforehand, you can do that here." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 @@ -144,47 +198,63 @@ msgstr "" msgid "By default you need to log in to see graphs. If you want to publicly share your graphs (e.g. when asking for help in [`#synapse:matrix.org`](https://matrix.to/#/#synapse:matrix.org?via=matrix.org&via=privacytools.io&via=mozilla.org)) you'll want to enable this option." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`grafana_default_admin_user`
`grafana_default_admin_password`" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:135 +msgid "Adjusting the Grafana URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "By default Grafana creates a user with `admin` as the username and password. If you feel this is insecure and you want to change it beforehand, you can do that here" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:137 +msgid "By tweaking the `grafana_hostname` variable, you can easily make the service available at a **different hostname** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:81 -msgid "Security and privacy" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:139 +msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:83 -msgid "Metrics and resulting graphs can contain a lot of information. This includes system specs but also usage patterns. This applies especially to small personal/family scale homeservers. Someone might be able to figure out when you wake up and go to sleep by looking at the graphs over time. Think about this before enabling anonymous access. And you should really not forget to change your Grafana password." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:146 +msgid "After changing the domain, **you may need to adjust your DNS** records to point the Grafana domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:85 -msgid "Most of our docker containers run with limited system access, but the `prometheus-node-exporter` has access to the host network stack and (readonly) root filesystem. This is required to report on them. If you don't like that, you can set `prometheus_node_exporter_enabled: false` (which is actually the default). You will still get Synapse metrics with this container disabled. Both of the dashboards will always be enabled, so you can still look at historical data after disabling either source." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:148 +msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:87 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:150 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:157 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:159 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:161 msgid "Collecting metrics to an external Prometheus server" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:89 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:163 msgid "**If the integrated Prometheus server is enabled** (`prometheus_enabled: true`), metrics are collected by it from each service via communication that happens over the container network. Each service does not need to expose its metrics \"publicly\"." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:91 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:165 msgid "When you'd like **to collect metrics from an external Prometheus server**, you need to expose service metrics outside of the container network." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:93 -msgid "The playbook provides a single endpoint (`https://matrix.example.com/metrics/*`), under which various services may expose their metrics (e.g. `/metrics/node-exporter`, `/metrics/postgres-exporter`, `/metrics/hookshot`, etc). To expose all services on this `/metrics/*` feature, use `matrix_metrics_exposure_enabled`. To protect access using [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), see `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users` below." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:167 +msgid "The playbook provides a single endpoint (`https://matrix.example.com/metrics/*`), under which various services may expose their metrics (e.g. `/metrics/node-exporter`, `/metrics/postgres-exporter`, `/metrics/nginxlog`, `/metrics/hookshot`, etc)." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:95 -msgid "When using `matrix_metrics_exposure_enabled`, you don't need to expose metrics for individual services one by one." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:169 +msgid "To expose all services on this `/metrics/*` feature, you can use `matrix_metrics_exposure_enabled`. When using it, you don't need to expose metrics for individual services one by one. If you think this is too much, refer [this section](#expose-metrics-of-other-services-roles) for details about exposing metrics on a per-service basis." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:97 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:171 +msgid "To protect access using [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), you can use `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users`. When enabled, all endpoints beneath `/metrics` will be protected with the same credentials. Alternatively, you can protect each endpoint with dedicated credentials. Refer [the section](#expose-metrics-of-other-services-roles) below for details about it." +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:173 msgid "The following variables may be of interest:" msgstr "" @@ -193,7 +263,7 @@ msgid "`matrix_metrics_exposure_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to **enable metrics exposure for all services** on `https://matrix.example.com/metrics/*`. If you think this is too much, refer to the helpful (but nonexhaustive) list of individual `matrix_SERVICE_metrics_proxying_enabled` (or similar) variables below for exposing metrics on a per-service basis." +msgid "Set this to `true` to **enable metrics exposure for all services** on `https://matrix.example.com/metrics/*`." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 @@ -201,7 +271,7 @@ msgid "`matrix_metrics_exposure_http_basic_auth_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to protect all `https://matrix.example.com/metrics/*` endpoints with [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) (see the other variables below for supplying the actual credentials). When enabled, all endpoints beneath `/metrics` will be protected with the same credentials" +msgid "Set this to `true` to protect all `https://matrix.example.com/metrics/*` endpoints with [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) (see the other variables below for supplying the actual credentials)." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 @@ -213,23 +283,11 @@ msgid "Set this to the Basic Authentication credentials (raw `htpasswd` file con msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_synapse_metrics_enabled`" +msgid "`prometheus_node_exporter_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to make Synapse expose metrics (locally, on the container network)" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_synapse_metrics_proxying_enabled`" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to expose Synapse's metrics on `https://matrix.example.com/metrics/synapse/main-process` and `https://matrix.example.com/metrics/synapse/worker/TYPE-ID`. Read [below](#collecting-synapse-worker-metrics-to-an-external-prometheus-server) if you're running a Synapse worker setup (`matrix_synapse_workers_enabled: true`). To password-protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above." -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to enable the node (general system stats) exporter (locally, on the container network)" +msgid "Set this to `true` to enable the node (general system stats) exporter (locally, on the container network)." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 @@ -237,11 +295,15 @@ msgid "`prometheus_node_exporter_container_labels_traefik_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to expose the node (general system stats) metrics on `https://matrix.example.com/metrics/node-exporter`. To password-protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above." +msgid "Set this to `true` to expose the node (general system stats) metrics on `https://matrix.example.com/metrics/node-exporter`." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to enable the [Postgres exporter](configuring-playbook-prometheus-postgres.md) (locally, on the container network)" +msgid "`prometheus_postgres_exporter_enabled`" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 +msgid "Set this to `true` to enable the [Postgres exporter](#enable-metrics-and-graphs-for-postgres-optional) (locally, on the container network)." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 @@ -249,93 +311,109 @@ msgid "`prometheus_postgres_exporter_container_labels_traefik_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to expose the [Postgres exporter](configuring-playbook-prometheus-postgres.md) metrics on `https://matrix.example.com/metrics/postgres-exporter`. To password-protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above." +msgid "Set this to `true` to expose the [Postgres exporter](#enable-metrics-and-graphs-for-postgres-optional) metrics on `https://matrix.example.com/metrics/postgres-exporter`." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to enable the [NGINX Log exporter](configuring-playbook-prometheus-nginxlog.md) (locally, on the container network)" +msgid "`matrix_prometheus_nginxlog_exporter_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_sliding_sync_metrics_enabled`" +msgid "Set this to `true` to enable the [nginx Log exporter](#enable-metrics-and-graphs-for-nginx-logs-optional) (locally, on the container network)." msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to make [Sliding Sync](configuring-playbook-sliding-sync-proxy.md) expose metrics (locally, on the container network)" +msgid "`matrix_prometheus_nginxlog_exporter_metrics_proxying_enabled`" msgstr "" #: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_sliding_sync_metrics_proxying_enabled`" +msgid "Set this to `true` to expose the [nginx Log exporter](#enable-metrics-and-graphs-for-nginx-logs-optional) metrics on `https://matrix.example.com/metrics/nginxlog`." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to expose the [Sliding Sync](configuring-playbook-sliding-sync-proxy.md) metrics on `https://matrix.example.com/metrics/sliding-sync`. To password-protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:187 +msgid "Expose metrics of other services/roles" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_bridge_hookshot_metrics_enabled`" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:189 +msgid "Various other services/roles may provide similar `_metrics_enabled` and `_metrics_proxying_enabled` variables for exposing their metrics. Refer to each role for details." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to make [Hookshot](configuring-playbook-bridge-hookshot.md) expose metrics (locally, on the container network)" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:191 +msgid "To password-protect the metrics of a specific role, you can use `matrix_SERVICE_container_labels_metrics_middleware_basic_auth_enabled` and `matrix_SERVICE_container_labels_metrics_middleware_basic_auth_users` variables provided by the role." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_bridge_hookshot_metrics_proxying_enabled`" +#: ../../../docs/configuring-playbook-prometheus-grafana.md:193 +msgid "**Note**: alternatively you can use `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users` in order to password-protect the metrics of all services." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to expose the [Hookshot](configuring-playbook-bridge-hookshot.md) metrics on `https://matrix.example.com/metrics/hookshot`. To password-protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above." +#: ../../../docs/configuring-playbook-prometheus-grafana.md:195 +msgid "For example, you can enable and expose metrics for Synapse protecting them with dedicated credentials by adding the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_SERVICE_metrics_proxying_enabled`" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Various other services/roles may provide similar `_metrics_enabled` and `_metrics_proxying_enabled` variables for exposing their metrics. Refer to each role for details. To password-protect the metrics, see `matrix_metrics_exposure_http_basic_auth_users` above or `matrix_SERVICE_container_labels_metrics_middleware_basic_auth_enabled`/`matrix_SERVICE_container_labels_metrics_middleware_basic_auth_users` variables provided by each role." -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "`matrix_media_repo_metrics_enabled`" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:0 -msgid "Set this to `true` to make media-repo expose metrics (locally, on the container network)" -msgstr "" - -#: ../../../docs/configuring-playbook-prometheus-grafana.md:118 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:213 msgid "Collecting Synapse worker metrics to an external Prometheus server" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:120 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:215 msgid "If you are using workers (`matrix_synapse_workers_enabled: true`) and have enabled `matrix_synapse_metrics_proxying_enabled` as described above, the playbook will also automatically expose all Synapse worker threads' metrics to `https://matrix.example.com/metrics/synapse/worker/ID`, where `ID` corresponds to the worker `id` as exemplified in `matrix_synapse_workers_enabled_list`." msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:122 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:217 msgid "The playbook also generates an exemplary config file (`/matrix/synapse/external_prometheus.yml.template`) with all the correct paths which you can copy to your Prometheus server and adapt to your needs. Make sure to edit the specified `password_file` path and contents and path to your `synapse-v2.rules`. It will look a bit like this:" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:150 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:245 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:247 +msgid "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:" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:248 +msgid "`journalctl -fu matrix-prometheus` for Prometheus" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:249 +msgid "`journalctl -fu matrix-prometheus-node-exporter` for Node Exporter" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:250 +msgid "`journalctl -fu matrix-prometheus-postgres-exporter` for PostgreSQL Server Exporter" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:251 +msgid "`journalctl -fu matrix-prometheus-nginxlog-exporter` for prometheus-nginxlog-exporter" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:252 +msgid "`journalctl -fu matrix-grafana` for Grafana" +msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:254 msgid "More information" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:152 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:256 msgid "[Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:153 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:257 msgid "[Understanding Synapse Performance Issues Through Grafana Graphs](https://element-hq.github.io/synapse/latest/usage/administration/understanding_synapse_through_grafana_graphs.html) at the Synapse Github Wiki" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:154 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:258 msgid "[The Prometheus scraping rules](https://github.com/element-hq/synapse/tree/master/contrib/prometheus) (we use v2)" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:155 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:259 msgid "[The Synapse Grafana dashboard](https://github.com/element-hq/synapse/tree/master/contrib/grafana)" msgstr "" -#: ../../../docs/configuring-playbook-prometheus-grafana.md:156 +#: ../../../docs/configuring-playbook-prometheus-grafana.md:260 msgid "[The Node Exporter dashboard](https://github.com/rfrail3/grafana-dashboards) (for generic non-synapse performance graphs)" msgstr "" + +#: ../../../docs/configuring-playbook-prometheus-grafana.md:261 +msgid "[The PostgreSQL dashboard](https://grafana.com/grafana/dashboards/9628) (generic Postgres dashboard)" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-rageshake.pot b/i18n/translation-templates/docs/configuring-playbook-rageshake.pot index 2f9cbd33e..b2eabbb7a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-rageshake.pot +++ b/i18n/translation-templates/docs/configuring-playbook-rageshake.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,90 +16,110 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-rageshake.md:1 +#: ../../../docs/configuring-playbook-rageshake.md:8 msgid "Setting up the rageshake bug report server (optional)" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:3 +#: ../../../docs/configuring-playbook-rageshake.md:10 msgid "The playbook can install and configure the [rageshake](https://github.com/matrix-org/rageshake) bug report server for you." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:5 +#: ../../../docs/configuring-playbook-rageshake.md:12 msgid "See the project's [documentation](https://github.com/matrix-org/rageshake/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:7 +#: ../../../docs/configuring-playbook-rageshake.md:14 msgid "**Note**: most people don't need to install rageshake to collect bug reports. This component is only useful to people who develop/build their own Matrix client applications themselves." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:9 +#: ../../../docs/configuring-playbook-rageshake.md:16 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:11 +#: ../../../docs/configuring-playbook-rageshake.md:18 msgid "By default, this playbook installs rageshake on the `rageshake.` subdomain (`rageshake.example.com`) and requires you to create a CNAME record for `rageshake`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:13 +#: ../../../docs/configuring-playbook-rageshake.md:20 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:15 +#: ../../../docs/configuring-playbook-rageshake.md:22 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:17 +#: ../../../docs/configuring-playbook-rageshake.md:24 msgid "To enable rageshake, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:23 -msgid "rageshake has various options which don't have dedicated Ansible variables. You can see the full list of options in the [`rageshake.sample.yaml` file](https://github.com/matrix-org/rageshake/blob/master/rageshake.sample.yaml)." -msgstr "" - -#: ../../../docs/configuring-playbook-rageshake.md:25 -msgid "To set these, you can make use of the `matrix_rageshake_configuration_extension_yaml` variable like this:" -msgstr "" - -#: ../../../docs/configuring-playbook-rageshake.md:35 +#: ../../../docs/configuring-playbook-rageshake.md:30 msgid "Adjusting the rageshake URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:37 +#: ../../../docs/configuring-playbook-rageshake.md:32 msgid "By tweaking the `matrix_rageshake_hostname` and `matrix_rageshake_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:39 +#: ../../../docs/configuring-playbook-rageshake.md:34 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:50 +#: ../../../docs/configuring-playbook-rageshake.md:45 msgid "After changing the domain, **you may need to adjust your DNS** records to point the rageshake domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:52 +#: ../../../docs/configuring-playbook-rageshake.md:47 msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:54 -msgid "Installing" +#: ../../../docs/configuring-playbook-rageshake.md:49 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-rageshake.md:51 +msgid "There are some additional things you may wish to configure about the server." +msgstr "" + +#: ../../../docs/configuring-playbook-rageshake.md:53 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-rageshake.md:55 +msgid "`roles/custom/matrix-rageshake/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" #: ../../../docs/configuring-playbook-rageshake.md:56 +msgid "`roles/custom/matrix-rageshake/templates/config.yaml.j2` for the server's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_rageshake_configuration_extension_yaml` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-rageshake.md:74 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-rageshake.md:76 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:63 +#: ../../../docs/configuring-playbook-rageshake.md:83 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:65 +#: ../../../docs/configuring-playbook-rageshake.md:85 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:67 +#: ../../../docs/configuring-playbook-rageshake.md:87 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-rageshake.md:69 +#: ../../../docs/configuring-playbook-rageshake.md:89 msgid "Refer to the project's [documentation](https://github.com/matrix-org/rageshake/blob/main/README.md) for available APIs, etc." msgstr "" + +#: ../../../docs/configuring-playbook-rageshake.md:91 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-rageshake.md:93 +msgid "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-rageshake`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-rest-auth.pot b/i18n/translation-templates/docs/configuring-playbook-rest-auth.pot index 71621b50c..6b918cde6 100644 --- a/i18n/translation-templates/docs/configuring-playbook-rest-auth.pot +++ b/i18n/translation-templates/docs/configuring-playbook-rest-auth.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,46 +16,62 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-rest-auth.md:1 +#: ../../../docs/configuring-playbook-rest-auth.md:9 msgid "Setting up the REST authentication password provider module (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:3 +#: ../../../docs/configuring-playbook-rest-auth.md:11 msgid "The playbook can install and configure [matrix-synapse-rest-auth](https://github.com/ma1uta/matrix-synapse-rest-password-provider) for you." msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:5 +#: ../../../docs/configuring-playbook-rest-auth.md:13 msgid "See the project's [documentation](https://github.com/ma1uta/matrix-synapse-rest-password-provider/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:7 +#: ../../../docs/configuring-playbook-rest-auth.md:15 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:9 +#: ../../../docs/configuring-playbook-rest-auth.md:17 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:19 +#: ../../../docs/configuring-playbook-rest-auth.md:27 msgid "Authenticating only using a password provider" msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:21 -msgid "If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, feel free to disable it:" +#: ../../../docs/configuring-playbook-rest-auth.md:29 +msgid "If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, you can disable it by adding the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:27 +#: ../../../docs/configuring-playbook-rest-auth.md:35 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:29 +#: ../../../docs/configuring-playbook-rest-auth.md:37 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:36 +#: ../../../docs/configuring-playbook-rest-auth.md:44 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-rest-auth.md:38 +#: ../../../docs/configuring-playbook-rest-auth.md:46 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-rest-auth.md:48 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-rest-auth.md:50 +msgid "Use ma1sd Identity Server for the backend (not recommended)" +msgstr "" + +#: ../../../docs/configuring-playbook-rest-auth.md:52 +msgid "This module does not provide direct integration with any backend. For the backend you can use [ma1sd](https://github.com/ma1uta/ma1sd) Identity Server, which can be configured with the playbook." +msgstr "" + +#: ../../../docs/configuring-playbook-rest-auth.md:54 +msgid "[!WARNING] We recommend not bothering with installing ma1sd as it has been unmaintained for years. If you wish to install it anyway, consult the [ma1sd Identity Server configuration](configuring-playbook-ma1sd.md)." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-riot-web.pot b/i18n/translation-templates/docs/configuring-playbook-riot-web.pot index b18006ead..fbdc4784a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-riot-web.pot +++ b/i18n/translation-templates/docs/configuring-playbook-riot-web.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,74 +16,74 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-riot-web.md:1 +#: ../../../docs/configuring-playbook-riot-web.md:9 msgid "Configuring Riot-web (optional)" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:3 +#: ../../../docs/configuring-playbook-riot-web.md:11 msgid "By default, this playbook **used to install** the [Riot-web](https://github.com/element-hq/riot-web) Matrix client web application." msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:5 +#: ../../../docs/configuring-playbook-riot-web.md:13 msgid "Riot has since been [renamed to Element](https://element.io/blog/welcome-to-element/)." msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:7 +#: ../../../docs/configuring-playbook-riot-web.md:15 msgid "to learn more about Element Web and its configuration, see our dedicated [Configuring Element Web](configuring-playbook-client-element-web.md) documentation page" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:8 +#: ../../../docs/configuring-playbook-riot-web.md:16 msgid "to learn how to migrate from Riot to Element Web, see [Migrating to Element Web](#migrating-to-element-web) below" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:10 +#: ../../../docs/configuring-playbook-riot-web.md:18 msgid "Migrating to Element Web" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:12 +#: ../../../docs/configuring-playbook-riot-web.md:20 msgid "Migrating your custom settings" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:14 +#: ../../../docs/configuring-playbook-riot-web.md:22 msgid "If you have custom `matrix_riot_web_` variables in your `inventory/host_vars/matrix.example.com/vars.yml` file, you'll need to rename them (`matrix_riot_web_` -> `matrix_client_element_`)." msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:16 +#: ../../../docs/configuring-playbook-riot-web.md:24 msgid "Some other playbook variables (but not all) with `riot` in their name are also renamed. The playbook checks and warns if you are using the old name for some commonly used ones." msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:18 +#: ../../../docs/configuring-playbook-riot-web.md:26 msgid "Domain migration" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:20 +#: ../../../docs/configuring-playbook-riot-web.md:28 msgid "We used to set up Riot at the `riot.example.com` domain. The playbook now sets up Element Web at `element.example.com` by default." msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:22 +#: ../../../docs/configuring-playbook-riot-web.md:30 msgid "There are a few options for handling this:" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:24 +#: ../../../docs/configuring-playbook-riot-web.md:32 msgid "(**avoiding changes** — using the old `riot.example.com` domain and avoiding DNS changes) — to keep using `riot.example.com` instead of `element.example.com`, override the domain at which the playbook serves Element Web: `matrix_server_fqn_element: \"riot.{{ matrix_domain }}\"`" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:26 +#: ../../../docs/configuring-playbook-riot-web.md:34 msgid "(**embracing changes** — using only `element.example.com`) — set up the `element.example.com` DNS record (see [Configuring DNS](configuring-dns.md)). You can drop the `riot.example.com` in this case." msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:28 +#: ../../../docs/configuring-playbook-riot-web.md:36 msgid "Re-running the playbook" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:30 +#: ../../../docs/configuring-playbook-riot-web.md:38 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:37 +#: ../../../docs/configuring-playbook-riot-web.md:45 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-riot-web.md:39 +#: ../../../docs/configuring-playbook-riot-web.md:47 msgid "`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." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-s3-goofys.pot b/i18n/translation-templates/docs/configuring-playbook-s3-goofys.pot index cce65ce00..301f924fd 100644 --- a/i18n/translation-templates/docs/configuring-playbook-s3-goofys.pot +++ b/i18n/translation-templates/docs/configuring-playbook-s3-goofys.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,163 +16,175 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-s3-goofys.md:1 -msgid "Storing Matrix media files on Amazon S3 with Goofys (optional)" +#: ../../../docs/configuring-playbook-s3-goofys.md:8 +msgid "Storing Synapse media files on Amazon S3 with Goofys (optional)" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:3 -msgid "If you'd like to store Synapse's content repository (`media_store`) files on Amazon S3 (or other S3-compatible service), you can let this playbook configure [Goofys](https://github.com/kahing/goofys) for you." +#: ../../../docs/configuring-playbook-s3-goofys.md:10 +msgid "The playbook can install and configure [Goofys](https://github.com/kahing/goofys) for you." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:5 -msgid "Another (and better performing) way to use S3 storage with Synapse is [synapse-s3-storage-provider](configuring-playbook-synapse-s3-storage-provider.md)." +#: ../../../docs/configuring-playbook-s3-goofys.md:12 +msgid "Goofys makes it possible to store Synapse's content repository (`media_store`) files on Amazon S3 (or other S3-compatible service) object storage." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:7 -msgid "Using a Goofys-backed media store works, but performance may not be ideal. If possible, try to use a region which is close to your Matrix server." +#: ../../../docs/configuring-playbook-s3-goofys.md:14 +msgid "See the project's [documentation](https://github.com/kahing/goofys/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:9 -msgid "If you'd like to move your locally-stored media store data to Amazon S3 (or another S3-compatible object store), we also provide some migration instructions below." +#: ../../../docs/configuring-playbook-s3-goofys.md:16 +msgid "**Note**: as performance of a Goofys-backed media store may not be ideal, you may wish to use [synapse-s3-storage-provider](configuring-playbook-synapse-s3-storage-provider.md) instead, another (and better performing) way to mount a S3 bucket for Synapse." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:11 +#: ../../../docs/configuring-playbook-s3-goofys.md:18 +msgid "If you'd like to move your locally-stored media store data to Amazon S3 (or another S3-compatible object store), you can refer our migration instructions below." +msgstr "" + +#: ../../../docs/configuring-playbook-s3-goofys.md:20 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:13 +#: ../../../docs/configuring-playbook-s3-goofys.md:22 msgid "After [creating the S3 bucket and configuring it](configuring-playbook-s3.md#bucket-creation-and-security-configuration), add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:23 +#: ../../../docs/configuring-playbook-s3-goofys.md:32 msgid "You can use any S3-compatible object store by **additionally** configuring these variables:" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:30 +#: ../../../docs/configuring-playbook-s3-goofys.md:39 msgid "If you have local media store files and wish to migrate to Backblaze B2 subsequently, follow our [migration guide to Backblaze B2](#migrating-to-backblaze-b2) below instead of applying this configuration as-is." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:32 +#: ../../../docs/configuring-playbook-s3-goofys.md:41 msgid "Migrating from local filesystem storage to S3" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:34 +#: ../../../docs/configuring-playbook-s3-goofys.md:43 msgid "It's a good idea to [make a complete server backup](faq.md#how-do-i-back-up-the-data-on-my-server) before migrating your local media store to an S3-backed one." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:36 +#: ../../../docs/configuring-playbook-s3-goofys.md:45 msgid "After making the backup, follow one of the guides below for a migration path from a locally-stored media store to one stored on S3-compatible storage:" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:38 +#: ../../../docs/configuring-playbook-s3-goofys.md:47 msgid "[Migrating to any S3-compatible storage (universal, but likely slow)](#migrating-to-any-s3-compatible-storage-universal-but-likely-slow)" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:39 +#: ../../../docs/configuring-playbook-s3-goofys.md:48 msgid "[Migrating to Backblaze B2](#migrating-to-backblaze-b2)" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:41 +#: ../../../docs/configuring-playbook-s3-goofys.md:50 msgid "Migrating to any S3-compatible storage (universal, but likely slow)" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:43 +#: ../../../docs/configuring-playbook-s3-goofys.md:52 msgid "Proceed with the steps below without stopping Matrix services" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:45 +#: ../../../docs/configuring-playbook-s3-goofys.md:54 msgid "Start by adding the base S3 configuration in your `vars.yml` file (seen above, may be different depending on the S3 provider of your choice)" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:47 +#: ../../../docs/configuring-playbook-s3-goofys.md:56 msgid "In addition to the base configuration you see above, add this to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:53 +#: ../../../docs/configuring-playbook-s3-goofys.md:62 msgid "This enables S3 support, but mounts the S3 storage bucket to `/matrix/s3-media-store` without hooking it to your homeserver yet. Your homeserver will still continue using your local filesystem for its media store." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:55 +#: ../../../docs/configuring-playbook-s3-goofys.md:64 msgid "Run the playbook to apply the changes: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:57 +#: ../../../docs/configuring-playbook-s3-goofys.md:66 msgid "Do an **initial sync of your files** by running this **on the server** (it may take a very long time):" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:63 +#: ../../../docs/configuring-playbook-s3-goofys.md:72 msgid "You may need to install `rsync` manually." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:65 -#: ../../../docs/configuring-playbook-s3-goofys.md:106 +#: ../../../docs/configuring-playbook-s3-goofys.md:74 +#: ../../../docs/configuring-playbook-s3-goofys.md:115 msgid "Stop all Matrix services (`ansible-playbook -i inventory/hosts setup.yml --tags=stop`)" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:67 +#: ../../../docs/configuring-playbook-s3-goofys.md:76 msgid "Start the S3 service by running this **on the server**: `systemctl start matrix-goofys`" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:69 +#: ../../../docs/configuring-playbook-s3-goofys.md:78 msgid "Sync the files again by re-running the `rsync` command you see in step #5" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:71 +#: ../../../docs/configuring-playbook-s3-goofys.md:80 msgid "Stop the S3 service by running this **on the server**: `systemctl stop matrix-goofys`" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:73 -#: ../../../docs/configuring-playbook-s3-goofys.md:114 +#: ../../../docs/configuring-playbook-s3-goofys.md:82 +#: ../../../docs/configuring-playbook-s3-goofys.md:123 msgid "Get the old media store out of the way by running this command on the server:" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:79 +#: ../../../docs/configuring-playbook-s3-goofys.md:88 msgid "Remove the `matrix_s3_media_store_path` configuration from your `vars.yml` file (undoing step #3 above)" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:81 -#: ../../../docs/configuring-playbook-s3-goofys.md:122 +#: ../../../docs/configuring-playbook-s3-goofys.md:90 +#: ../../../docs/configuring-playbook-s3-goofys.md:131 msgid "Run the playbook: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start`" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:83 -#: ../../../docs/configuring-playbook-s3-goofys.md:124 +#: ../../../docs/configuring-playbook-s3-goofys.md:92 +#: ../../../docs/configuring-playbook-s3-goofys.md:133 msgid "You're done! Verify that loading existing (old) media files works and that you can upload new ones." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:85 -#: ../../../docs/configuring-playbook-s3-goofys.md:126 +#: ../../../docs/configuring-playbook-s3-goofys.md:94 +#: ../../../docs/configuring-playbook-s3-goofys.md:135 msgid "When confident that it all works, get rid of the local media store directory: `rm -rf /matrix/synapse/storage/media-store-local-backup`" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:87 +#: ../../../docs/configuring-playbook-s3-goofys.md:96 msgid "Migrating to Backblaze B2" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:89 +#: ../../../docs/configuring-playbook-s3-goofys.md:98 msgid "While all Matrix services are running, run the following command on the server:" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:91 +#: ../../../docs/configuring-playbook-s3-goofys.md:100 msgid "(you need to adjust the 3 `--env` line below with your own data)" msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:104 +#: ../../../docs/configuring-playbook-s3-goofys.md:113 msgid "This is some initial file sync, which may take a very long time." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:108 +#: ../../../docs/configuring-playbook-s3-goofys.md:117 msgid "Run the command from step #1 again." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:110 +#: ../../../docs/configuring-playbook-s3-goofys.md:119 msgid "Doing this will sync any new files that may have been created locally in the meantime." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:112 +#: ../../../docs/configuring-playbook-s3-goofys.md:121 msgid "Now that Matrix services aren't running, we're sure to get Backblaze B2 and your local media store fully in sync." msgstr "" -#: ../../../docs/configuring-playbook-s3-goofys.md:120 +#: ../../../docs/configuring-playbook-s3-goofys.md:129 msgid "Put the [Backblaze B2 settings](configuring-playbook-s3.md#backblaze-b2) in your `vars.yml` file" msgstr "" + +#: ../../../docs/configuring-playbook-s3-goofys.md:137 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-s3-goofys.md:139 +msgid "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`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-s3.pot b/i18n/translation-templates/docs/configuring-playbook-s3.pot index 6952ccac2..16bc3b3d8 100644 --- a/i18n/translation-templates/docs/configuring-playbook-s3.pot +++ b/i18n/translation-templates/docs/configuring-playbook-s3.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,198 +16,194 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-s3.md:1 +#: ../../../docs/configuring-playbook-s3.md:9 msgid "Storing Synapse media files on Amazon S3 or another compatible Object Storage (optional)" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:3 +#: ../../../docs/configuring-playbook-s3.md:11 msgid "By default, this playbook configures your server to store Synapse's content repository (`media_store`) files on the local filesystem. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:5 +#: ../../../docs/configuring-playbook-s3.md:13 msgid "As an alternative to storing media files on the local filesystem, you can store them on [Amazon S3](https://aws.amazon.com/s3/) or another S3-compatible object store." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:7 +#: ../../../docs/configuring-playbook-s3.md:15 msgid "You can do this either by sticking to Synapse's media repository and making that use S3 (read below for this method), or by switching to an external media storage implementation like [matrix-media-repo](configuring-playbook-matrix-media-repo.md)." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:9 +#: ../../../docs/configuring-playbook-s3.md:17 msgid "First, [choose an Object Storage provider](#choosing-an-object-storage-provider)." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:11 +#: ../../../docs/configuring-playbook-s3.md:19 msgid "Then, [create the S3 bucket](#bucket-creation-and-security-configuration)." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:13 +#: ../../../docs/configuring-playbook-s3.md:21 msgid "Finally, [set up S3 storage for Synapse](#setting-up) (with [Goofys](configuring-playbook-s3-goofys.md), [synapse-s3-storage-provider](configuring-playbook-synapse-s3-storage-provider.md), or use s3 datastore with the [matrix-media-repo](https://docs.t2bot.io/matrix-media-repo/configuration/s3-datastore.html))." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:15 +#: ../../../docs/configuring-playbook-s3.md:23 msgid "Choosing an Object Storage provider" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:17 -msgid "You can create [Amazon S3](https://aws.amazon.com/s3/) or another S3-compatible object storage like [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html), [Storj](https://storj.io), [Wasabi](https://wasabi.com), [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces), etc." -msgstr "" - -#: ../../../docs/configuring-playbook-s3.md:19 -msgid "Amazon S3, Backblaze B2, and Storj are pay-as-you with no minimum charges for storing too little data." -msgstr "" - -#: ../../../docs/configuring-playbook-s3.md:21 -msgid "All these providers have different prices, with Storj appearing to be the cheapest (as of 2024-10, storage fee is $0.004 per GB/month, and egress fee is $0.007 per GB). Backblaze egress is free, but for only certain users for up to 3x the amount of data stored. Beyond that you will pay $0.01/GB of egress." -msgstr "" - -#: ../../../docs/configuring-playbook-s3.md:23 -msgid "Wasabi has a minimum charge of 1TB if you're storing less than 1TB, which becomes expensive if you need to store less data than that. Likewise, Digital Ocean Spaces has also a minimum charge of 250GB ($5/month as of 2022-10)." -msgstr "" - #: ../../../docs/configuring-playbook-s3.md:25 -msgid "Here are some of the important aspects of choosing the right provider:" +msgid "You can create [Amazon S3](https://aws.amazon.com/s3/) or another S3-compatible object storage like [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html), [Wasabi](https://wasabi.com), [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces), [Storj](https://storj.io), etc." msgstr "" #: ../../../docs/configuring-playbook-s3.md:27 -msgid "if a provider is a company you like and trust (or dislike less than the others)" -msgstr "" - -#: ../../../docs/configuring-playbook-s3.md:28 -msgid "if a provider implements end-to-end encryption of your data" +msgid "Amazon S3 and Backblaze B2 are pay-as-you with no minimum charges for storing too little data. Note that Backblaze egress is free, but for only certain users for up to 3x the amount of data stored. Beyond that you will pay $0.01/GB of egress." msgstr "" #: ../../../docs/configuring-playbook-s3.md:29 -msgid "if a provider has a data region close to your Matrix server (if it's farther away, high latency may cause slowdowns)" -msgstr "" - -#: ../../../docs/configuring-playbook-s3.md:30 -msgid "if a provider's infrastructure such as data center is centralized or distributed" +msgid "Wasabi has a minimum charge of 1TB if you're storing less than 1TB, which becomes expensive if you need to store less data than that. Likewise, Digital Ocean Spaces has also a minimum charge of 250GB ($5/month as of 2022-10). Though Storj does not set minimum amount of data to be stored, it also charges $5 minimum monthly usage fee since July 1, 2025, if your monthly usage (storage, bandwidth, and segments) totals less than $5." msgstr "" #: ../../../docs/configuring-playbook-s3.md:31 -msgid "if a provider's price model is transparent (whether it includes hidden costs like minimum charge, minimum storage term, etc.)" +msgid "Here are some of the important aspects of choosing the right provider:" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:32 -msgid "if a provider has free or cheap egress fee (in case you need to get the data out often, for some reason) — likely not too important for the common use-case" +#: ../../../docs/configuring-playbook-s3.md:33 +msgid "if a provider is a company you like and trust (or dislike less than the others)" msgstr "" #: ../../../docs/configuring-playbook-s3.md:34 -msgid "Bucket creation and Security Configuration" +msgid "if a provider implements end-to-end encryption of your data" +msgstr "" + +#: ../../../docs/configuring-playbook-s3.md:35 +msgid "if a provider has a data region close to your Matrix server (if it's farther away, high latency may cause slowdowns)" msgstr "" #: ../../../docs/configuring-playbook-s3.md:36 -msgid "Now that you've [chosen an Object Storage provider](#choosing-an-object-storage-provider), you need to create a storage bucket." +msgid "if a provider's infrastructure such as data center is centralized or distributed" +msgstr "" + +#: ../../../docs/configuring-playbook-s3.md:37 +msgid "if a provider's price model is transparent (whether it includes hidden costs like minimum charge, minimum storage term, etc.)" msgstr "" #: ../../../docs/configuring-playbook-s3.md:38 -msgid "How you do this varies from provider to provider, with Amazon S3 being the most complicated due to its vast number of services and complicated security policies." +msgid "if a provider has free or cheap egress fee (in case you need to get the data out often, for some reason) — likely not too important for the common use-case" msgstr "" #: ../../../docs/configuring-playbook-s3.md:40 -msgid "Below, we provider some guides for common providers. If you don't see yours, look at the others for inspiration or read some guides online about how to create a bucket. Feel free to contribute to this documentation with an update!" +msgid "Bucket creation and Security Configuration" msgstr "" #: ../../../docs/configuring-playbook-s3.md:42 -msgid "Amazon S3" +msgid "Now that you've [chosen an Object Storage provider](#choosing-an-object-storage-provider), you need to create a storage bucket." msgstr "" #: ../../../docs/configuring-playbook-s3.md:44 +msgid "How you do this varies from provider to provider, with Amazon S3 being the most complicated due to its vast number of services and complicated security policies." +msgstr "" + +#: ../../../docs/configuring-playbook-s3.md:46 +msgid "Below, we provider some guides for common providers. If you don't see yours, look at the others for inspiration or read some guides online about how to create a bucket. Feel free to contribute to this documentation with an update!" +msgstr "" + +#: ../../../docs/configuring-playbook-s3.md:48 +msgid "Amazon S3" +msgstr "" + +#: ../../../docs/configuring-playbook-s3.md:50 msgid "You'll need an Amazon S3 bucket and some IAM user credentials (access key + secret key) with full write access to the bucket. Example IAM security policy:" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:65 +#: ../../../docs/configuring-playbook-s3.md:71 msgid "**Note**: This policy needs to be attached to an IAM user created from the **Security Credentials** menu. This is not a **Bucket Policy**." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:67 +#: ../../../docs/configuring-playbook-s3.md:73 msgid "Backblaze B2" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:69 +#: ../../../docs/configuring-playbook-s3.md:75 msgid "To use [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html) you first need to sign up." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:71 +#: ../../../docs/configuring-playbook-s3.md:77 msgid "You [can't easily change which region (US, Europe) your Backblaze account stores files in](https://old.reddit.com/r/backblaze/comments/hi1v90/make_the_choice_for_the_b2_data_center_region/), so make sure to carefully choose the region when signing up (hint: it's a hard to see dropdown below the username/password fields in the signup form)." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:73 +#: ../../../docs/configuring-playbook-s3.md:79 msgid "After logging in to Backblaze:" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:75 +#: ../../../docs/configuring-playbook-s3.md:81 msgid "create a new **private** bucket through its user interface (you can call it something like `matrix-example-media-store`)" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:76 +#: ../../../docs/configuring-playbook-s3.md:82 msgid "note the **Endpoint** for your bucket (something like `s3.us-west-002.backblazeb2.com`)." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:77 +#: ../../../docs/configuring-playbook-s3.md:83 msgid "adjust its Lifecycle Rules to: Keep only the last version of the file" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:78 +#: ../../../docs/configuring-playbook-s3.md:84 msgid "go to [App Keys](https://secure.backblaze.com/app_keys.htm) and use the **Add a New Application Key** to create a new one" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:79 +#: ../../../docs/configuring-playbook-s3.md:85 msgid "restrict it to the previously created bucket (e.g. `matrix-example-media-store`)" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:80 +#: ../../../docs/configuring-playbook-s3.md:86 msgid "give it *Read & Write* access" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:82 +#: ../../../docs/configuring-playbook-s3.md:88 msgid "The `keyID` value is your **Access Key** and `applicationKey` is your **Secret Key**." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:84 +#: ../../../docs/configuring-playbook-s3.md:90 msgid "For configuring [Goofys](configuring-playbook-s3-goofys.md) or [s3-synapse-storage-provider](configuring-playbook-synapse-s3-storage-provider.md) you will need:" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:86 +#: ../../../docs/configuring-playbook-s3.md:92 msgid "**Endpoint URL** — this is the **Endpoint** value you saw above, but prefixed with `https://`" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:88 +#: ../../../docs/configuring-playbook-s3.md:93 msgid "**Region** — use the value you see in the Endpoint (e.g. `us-west-002`)" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:90 +#: ../../../docs/configuring-playbook-s3.md:94 msgid "**Storage Class** — use `STANDARD`. Backblaze B2 does not have different storage classes, so it doesn't make sense to use any other value." msgstr "" -#: ../../../docs/configuring-playbook-s3.md:92 +#: ../../../docs/configuring-playbook-s3.md:96 msgid "Other providers" msgstr "" -#: ../../../docs/configuring-playbook-s3.md:94 -msgid "For other S3-compatible providers, you may not need to configure security policies, etc. (just like for [Backblaze B2](#backblaze-b2))." -msgstr "" - -#: ../../../docs/configuring-playbook-s3.md:96 -msgid "You most likely just need to create an S3 bucket and get some credentials (access key and secret key) for accessing the bucket in a read/write manner." -msgstr "" - #: ../../../docs/configuring-playbook-s3.md:98 -msgid "Setting up" +msgid "For other S3-compatible providers, you most likely just need to create an S3 bucket and get some credentials (access key and secret key) for accessing the bucket in a read/write manner. You may not need to configure security policies, etc." msgstr "" #: ../../../docs/configuring-playbook-s3.md:100 -msgid "To set up Synapse to store files in S3, follow the instructions for the method of your choice:" +msgid "For details about setting up a bucket at Storj, please see the instruction [here](https://storj.dev/dcs/getting-started) to get started." msgstr "" #: ../../../docs/configuring-playbook-s3.md:102 -msgid "using [synapse-s3-storage-provider](configuring-playbook-synapse-s3-storage-provider.md) (recommended)" -msgstr "" - -#: ../../../docs/configuring-playbook-s3.md:103 -msgid "using [Goofys to mount the S3 store to the local filesystem](configuring-playbook-s3-goofys.md)" +msgid "Setting up" msgstr "" #: ../../../docs/configuring-playbook-s3.md:104 +msgid "To set up Synapse to store files in S3, follow the instructions for the method of your choice:" +msgstr "" + +#: ../../../docs/configuring-playbook-s3.md:106 +msgid "using [synapse-s3-storage-provider](configuring-playbook-synapse-s3-storage-provider.md) (recommended)" +msgstr "" + +#: ../../../docs/configuring-playbook-s3.md:107 +msgid "using [Goofys to mount the S3 store to the local filesystem](configuring-playbook-s3-goofys.md)" +msgstr "" + +#: ../../../docs/configuring-playbook-s3.md:108 msgid "using [matrix-media-repo](configuring-playbook-matrix-media-repo.md)" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-shared-secret-auth.pot b/i18n/translation-templates/docs/configuring-playbook-shared-secret-auth.pot index fe700a3c5..cf12b05bf 100644 --- a/i18n/translation-templates/docs/configuring-playbook-shared-secret-auth.pot +++ b/i18n/translation-templates/docs/configuring-playbook-shared-secret-auth.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,46 +16,46 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:1 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:9 msgid "Setting up the Shared Secret Auth password provider module (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:3 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:11 msgid "The playbook can install and configure [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) for you." msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:5 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:13 msgid "See the project's [documentation](https://github.com/devture/matrix-synapse-shared-secret-auth/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:7 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:15 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:9 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:17 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:18 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:26 msgid "Authenticating only using a password provider" msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:20 -msgid "If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, feel free to disable it:" +#: ../../../docs/configuring-playbook-shared-secret-auth.md:28 +msgid "If you wish for users to **authenticate only against configured password providers** (like this one), **without consulting Synapse's local database**, you can disable it by adding the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:26 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:34 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:28 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:36 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:35 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:43 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-shared-secret-auth.md:37 +#: ../../../docs/configuring-playbook-shared-secret-auth.md:45 msgid "`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." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-sliding-sync-proxy.pot b/i18n/translation-templates/docs/configuring-playbook-sliding-sync-proxy.pot index 43e70b574..cce3a1e42 100644 --- a/i18n/translation-templates/docs/configuring-playbook-sliding-sync-proxy.pot +++ b/i18n/translation-templates/docs/configuring-playbook-sliding-sync-proxy.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,98 +16,122 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:1 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:14 msgid "Setting up the Sliding Sync proxy (optional)" msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:3 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:16 msgid "**Note**: The sliding-sync proxy is **not required** anymore as it's been replaced with a different method (called Simplified Sliding Sync) which is integrated into newer homeservers by default (**Conduit** homeserver from version `0.6.0` or **Synapse** from version `1.114`). This component and documentation remain here for historical purposes, but **installing this old sliding-sync proxy is generally not recommended anymore**." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:5 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:18 msgid "The playbook can install and configure [sliding-sync](https://github.com/matrix-org/sliding-sync) proxy for you." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:7 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:20 msgid "Sliding Sync is an implementation of [MSC3575](https://github.com/matrix-org/matrix-spec-proposals/blob/kegan/sync-v3/proposals/3575-sync.md) and a prerequisite for running Element X clients ([Element X iOS](https://github.com/element-hq/element-x-ios) and [Element X Android](https://github.com/element-hq/element-x-android)). See the project's [documentation](https://github.com/matrix-org/sliding-sync) to learn more." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:9 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:22 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:11 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:24 msgid "By default, this playbook installs the Sliding Sync proxy on the `matrix.` subdomain, at the `/sliding-sync` path (https://matrix.example.com/sliding-sync). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:13 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:26 msgid "If you wish to adjust it, see the section [below](#adjusting-the-sliding-sync-proxy-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:15 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:28 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:17 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:30 msgid "To enable Sliding Sync proxy, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:23 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:36 msgid "Adjusting the Sliding Sync proxy URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:25 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:38 msgid "By tweaking the `matrix_sliding_sync_hostname` and `matrix_sliding_sync_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:27 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:40 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:35 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:48 msgid "If you've changed the default hostname, you may need to create a CNAME record for the Sliding Sync proxy domain (`ss.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:37 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:50 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:39 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:41 -msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:48 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:50 -msgid "`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." -msgstr "" - #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:52 -msgid "External databases" +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-sliding-sync-proxy.md:54 +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:56 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:58 +msgid "`roles/custom/matrix-sliding-sync/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:60 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:62 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:69 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:71 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:73 +msgid "External databases" +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:75 msgid "Please note that, if your setup utilizes an external database, you must also establish configuration for the sliding sync proxy. Alter the defaults below to suit your configuration:" msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:64 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:85 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:66 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:87 msgid "You **don't need to do anything special** to make use of the Sliding Sync proxy. Simply open your client which supports Sliding Sync (like Element X) and log in." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:68 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:89 msgid "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`)." msgstr "" -#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:70 +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:91 msgid "This allows clients which support Sliding Sync to detect the Sliding Sync proxy's URL and make use of it." msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:93 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-sliding-sync-proxy.md:95 +msgid "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`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-ssl-certificates.pot b/i18n/translation-templates/docs/configuring-playbook-ssl-certificates.pot index 7a34d19f9..249daf10d 100644 --- a/i18n/translation-templates/docs/configuring-playbook-ssl-certificates.pot +++ b/i18n/translation-templates/docs/configuring-playbook-ssl-certificates.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,106 +16,118 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-ssl-certificates.md:1 +#: ../../../docs/configuring-playbook-ssl-certificates.md:12 msgid "Adjusting SSL certificate retrieval (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:3 -msgid "By default, this playbook retrieves and auto-renews free SSL certificates from [Let's Encrypt](https://letsencrypt.org/) for the domains it needs (e.g. `matrix.example.com` and others)" +#: ../../../docs/configuring-playbook-ssl-certificates.md:14 +msgid "By default, the playbook retrieves and automatically renews free SSL certificates from [Let's Encrypt](https://letsencrypt.org/) via [ACME](https://en.wikipedia.org/wiki/Automatic_Certificate_Management_Environment) for the domains of the services it installs (e.g. `matrix.example.com` and others). Refer this guide if you want to modify settings about how it manages SSL certificates or have the Traefik server use yours." msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:5 -msgid "This guide is about using the integrated Traefik server and doesn't apply if you're using [your own webserver](configuring-playbook-own-webserver.md)." -msgstr "" - -#: ../../../docs/configuring-playbook-ssl-certificates.md:7 -msgid "Using staging Let's Encrypt certificates instead of real ones" -msgstr "" - -#: ../../../docs/configuring-playbook-ssl-certificates.md:9 -msgid "For testing purposes, you may wish to use staging certificates provide by Let's Encrypt." -msgstr "" - -#: ../../../docs/configuring-playbook-ssl-certificates.md:11 -msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +#: ../../../docs/configuring-playbook-ssl-certificates.md:16 +msgid "**Notes**:" msgstr "" #: ../../../docs/configuring-playbook-ssl-certificates.md:17 -msgid "Disabling SSL termination" +msgid "This guide is intended to be referred for configuring the integrated Traefik server with regard to SSL certificates retrieval. If you're using [your own webserver](configuring-playbook-own-webserver.md), consult its documentation about how to configure it." msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:19 -msgid "For testing or other purposes, you may wish to install services without SSL termination and have services exposed to `http://` instead of `https://`." +#: ../../../docs/configuring-playbook-ssl-certificates.md:18 +msgid "Let's Encrypt ends the expiration notification email service on June 4, 2025 (see: [the official announcement](https://letsencrypt.org/2025/01/22/ending-expiration-emails/)), and it recommends using a third party service for those who want to receive expiration notifications. If you are looking for a self-hosting service, you may be interested in a monitoring tool such as [Update Kuma](https://github.com/louislam/uptime-kuma/)." msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:21 -msgid "Add the following configuration to your `vars.yml` file:" +#: ../../../docs/configuring-playbook-ssl-certificates.md:20 +msgid "The [Mother-of-All-Self-Hosting (MASH)](https://github.com/mother-of-all-self-hosting/mash-playbook) Ansible playbook can be used to install and manage an Uptime Kuma instance. See [this page](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/uptime-kuma.md) for the instruction to install it with the MASH playbook. If you are wondering how to use the MASH playbook for your Matrix server, refer [this page](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/setting-up-services-on-mdad-server.md)." msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:27 -msgid "Using self-signed SSL certificates" +#: ../../../docs/configuring-playbook-ssl-certificates.md:22 +msgid "Use staging Let's Encrypt certificates" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:29 -msgid "If you'd like to use your own SSL certificates, instead of the default (SSL certificates obtained automatically via [ACME](https://en.wikipedia.org/wiki/Automatic_Certificate_Management_Environment) from [Let's Encrypt](https://letsencrypt.org/)):" +#: ../../../docs/configuring-playbook-ssl-certificates.md:24 +msgid "For testing purposes, you may wish to use staging certificates provided by Let's Encrypt to avoid hitting [its rate limits](https://letsencrypt.org/docs/rate-limits/)." msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:31 -msgid "generate your self-signed certificate files" +#: ../../../docs/configuring-playbook-ssl-certificates.md:26 +msgid "To use ones, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-ssl-certificates.md:32 -msgid "follow the [Using your own SSL certificates](#using-your-own-ssl-certificates) documentation below" +msgid "Disable SSL termination" msgstr "" #: ../../../docs/configuring-playbook-ssl-certificates.md:34 -msgid "Using your own SSL certificates" +msgid "For testing or other purposes, you may wish to install services without SSL termination and have services exposed to `http://` instead of `https://`." msgstr "" #: ../../../docs/configuring-playbook-ssl-certificates.md:36 -msgid "To use your own SSL certificates with Traefik, you need to:" +msgid "To do so, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:38 -msgid "disable [ACME](https://en.wikipedia.org/wiki/Automatic_Certificate_Management_Environment) / [Let's Encrypt](https://letsencrypt.org/) support" +#: ../../../docs/configuring-playbook-ssl-certificates.md:42 +msgid "Use self-signed SSL certificates" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:39 -msgid "put a custom Traefik configuration file on the server, with the help of this Ansible playbook (via the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux)) or manually" +#: ../../../docs/configuring-playbook-ssl-certificates.md:44 +msgid "To use self-signed certificates, generate them and follow the documentation below about using your own certificates." msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:40 -msgid "register your custom configuration file with Traefik, by adding an extra provider of type [file](https://doc.traefik.io/traefik/providers/file/)" +#: ../../../docs/configuring-playbook-ssl-certificates.md:46 +msgid "Use your own SSL certificates" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:41 -msgid "put the SSL files on the server, with the help of this Ansible playbook (via the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux)) or manually" +#: ../../../docs/configuring-playbook-ssl-certificates.md:48 +msgid "To use your own certificates, prepare them and follow the steps below:" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:89 -msgid "Using a DNS-01 ACME challenge type, instead of HTTP-01" +#: ../../../docs/configuring-playbook-ssl-certificates.md:50 +msgid "Disable [ACME](https://en.wikipedia.org/wiki/Automatic_Certificate_Management_Environment) / [Let's Encrypt](https://letsencrypt.org/) support" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:91 -msgid "You can configure Traefik to use the [DNS-01 challenge type](https://letsencrypt.org/docs/challenge-types/#dns-01-challenge) for Let's Encrypt. This is less commonly used than the default [HTTP-01 challenge type](https://letsencrypt.org/docs/challenge-types/#http-01-challenge), but it can be helpful to:" +#: ../../../docs/configuring-playbook-ssl-certificates.md:51 +msgid "Put a custom Traefik configuration file on the server, with the help of this Ansible playbook (via the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux)) or manually" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:93 +#: ../../../docs/configuring-playbook-ssl-certificates.md:52 +msgid "Register your custom configuration file with Traefik, by adding an extra provider of type [file](https://doc.traefik.io/traefik/providers/file/)" +msgstr "" + +#: ../../../docs/configuring-playbook-ssl-certificates.md:53 +msgid "Put the SSL files on the server, with the help of this Ansible playbook (via the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux)) or manually" +msgstr "" + +#: ../../../docs/configuring-playbook-ssl-certificates.md:55 +msgid "For those steps, you can add the following configuration to your `vars.yml` file (adapt to your needs). If you will put the custom configuration files manually, make sure to remove the `aux_file_definitions` variable." +msgstr "" + +#: ../../../docs/configuring-playbook-ssl-certificates.md:103 +msgid "Use a DNS-01 ACME challenge type, instead of HTTP-01" +msgstr "" + +#: ../../../docs/configuring-playbook-ssl-certificates.md:105 +msgid "You can configure Traefik to use the [DNS-01 challenge type](https://letsencrypt.org/docs/challenge-types/#dns-01-challenge) for Let's Encrypt. This is less commonly used than the default [HTTP-01 challenge type](https://letsencrypt.org/docs/challenge-types/#http-01-challenge), but can be helpful to:" +msgstr "" + +#: ../../../docs/configuring-playbook-ssl-certificates.md:107 msgid "hide your public IP from Let's Encrypt logs" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:94 +#: ../../../docs/configuring-playbook-ssl-certificates.md:108 msgid "allow you to obtain SSL certificates for servers which are not accessible (via HTTP) from the public internet (and for which the HTTP-01 challenge would fail)" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:96 -msgid "This is an example for how to edit the `vars.yml` file if you're using Cloudflare:" +#: ../../../docs/configuring-playbook-ssl-certificates.md:110 +msgid "Example: Cloudflare" msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:111 +#: ../../../docs/configuring-playbook-ssl-certificates.md:112 +msgid "Here is an example for configurations on the `vars.yml` file for Cloudflare. Please adjust it as necessary before applying it." +msgstr "" + +#: ../../../docs/configuring-playbook-ssl-certificates.md:127 msgid "Make sure to change the value of \"provider\" to your particular DNS solution, and provide the appropriate environment variables. The full list of supported providers is available [here](https://doc.traefik.io/traefik/https/acme/#providers)." msgstr "" -#: ../../../docs/configuring-playbook-ssl-certificates.md:113 +#: ../../../docs/configuring-playbook-ssl-certificates.md:129 msgid "This example assumes you're using Cloudflare to manage your DNS zone. Note that it requires the use of two tokens: one for reading all zones (`CF_ZONE_API_TOKEN`) and another that must be able to edit the particular domain you're using (`CF_DNS_API_TOKEN`). For security, it's recommended that you create two fine-grained tokens for this purpose, but you might choose to use the same token for both." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-sygnal.pot b/i18n/translation-templates/docs/configuring-playbook-sygnal.pot index 2739bd544..cd85894a7 100644 --- a/i18n/translation-templates/docs/configuring-playbook-sygnal.pot +++ b/i18n/translation-templates/docs/configuring-playbook-sygnal.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,130 +16,138 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-sygnal.md:1 +#: ../../../docs/configuring-playbook-sygnal.md:8 msgid "Setting up the Sygnal push gateway (optional)" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:3 +#: ../../../docs/configuring-playbook-sygnal.md:10 msgid "The playbook can install and configure the [Sygnal](https://github.com/matrix-org/sygnal) push gateway for you." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:5 +#: ../../../docs/configuring-playbook-sygnal.md:12 msgid "See the project's [documentation](https://github.com/matrix-org/sygnal/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:7 +#: ../../../docs/configuring-playbook-sygnal.md:14 msgid "**Note**: most people don't need to install their own gateway. As Sygnal's [Notes for application developers](https://github.com/matrix-org/sygnal/blob/master/docs/applications.md) documentation says:" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:9 +#: ../../../docs/configuring-playbook-sygnal.md:16 msgid "It is not feasible to allow end-users to configure their own Sygnal instance, because the Sygnal instance needs the appropriate FCM or APNs secrets that belong to the application." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:11 +#: ../../../docs/configuring-playbook-sygnal.md:18 msgid "This optional playbook component is only useful to people who develop/build their own Matrix client applications themselves." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:13 +#: ../../../docs/configuring-playbook-sygnal.md:20 msgid "Adjusting DNS records" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:15 +#: ../../../docs/configuring-playbook-sygnal.md:22 msgid "By default, this playbook installs Sygnal on the `sygnal.` subdomain (`sygnal.example.com`) and requires you to create a CNAME record for `sygnal`, which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:17 +#: ../../../docs/configuring-playbook-sygnal.md:24 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:19 +#: ../../../docs/configuring-playbook-sygnal.md:26 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:21 +#: ../../../docs/configuring-playbook-sygnal.md:28 msgid "To enable Sygnal, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:49 +#: ../../../docs/configuring-playbook-sygnal.md:56 msgid "Configuring [GCM/FCM](https://firebase.google.com/docs/cloud-messaging/) is easier, as it only requires that you provide some config values." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:51 +#: ../../../docs/configuring-playbook-sygnal.md:58 msgid "To configure [APNS](https://developer.apple.com/notifications/) (Apple Push Notification Service), you'd need to provide one or more certificate files. To do that, the above example configuration:" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:53 +#: ../../../docs/configuring-playbook-sygnal.md:60 msgid "makes use of the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) (and its `aux_file_definitions` variable) to make the playbook install files into `/matrix/sygnal/data` (the `matrix_sygnal_data_path` variable). See [`defaults/main.yml` file](https://github.com/mother-of-all-self-hosting/ansible-role-aux/blob/main/defaults/main.yml) of the `aux` role for usage examples. It also makes sure the files are owned by `matrix:matrix`, so that Sygnal can read them. Of course, you can also install these files manually yourself, if you'd rather not use `aux`." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:55 +#: ../../../docs/configuring-playbook-sygnal.md:62 msgid "references these files in the Sygnal configuration (`matrix_sygnal_apps`) using a path like `/data/…` (the `/matrix/sygnal/data` directory on the host system is mounted into the `/data` directory inside the container)" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:57 +#: ../../../docs/configuring-playbook-sygnal.md:64 msgid "Adjusting the Sygnal URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:59 +#: ../../../docs/configuring-playbook-sygnal.md:66 msgid "By tweaking the `matrix_sygnal_hostname` and `matrix_sygnal_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:61 +#: ../../../docs/configuring-playbook-sygnal.md:68 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:72 +#: ../../../docs/configuring-playbook-sygnal.md:79 msgid "After changing the domain, **you may need to adjust your DNS** records to point the Sygnal domain to the Matrix server." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:74 +#: ../../../docs/configuring-playbook-sygnal.md:81 msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:76 +#: ../../../docs/configuring-playbook-sygnal.md:83 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:78 +#: ../../../docs/configuring-playbook-sygnal.md:85 msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:80 +#: ../../../docs/configuring-playbook-sygnal.md:87 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:82 +#: ../../../docs/configuring-playbook-sygnal.md:89 msgid "`roles/custom/matrix-sygnal/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:83 +#: ../../../docs/configuring-playbook-sygnal.md:90 msgid "`roles/custom/matrix-sygnal/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_sygnal_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:85 +#: ../../../docs/configuring-playbook-sygnal.md:92 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:87 +#: ../../../docs/configuring-playbook-sygnal.md:94 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:94 +#: ../../../docs/configuring-playbook-sygnal.md:101 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:96 +#: ../../../docs/configuring-playbook-sygnal.md:103 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:98 +#: ../../../docs/configuring-playbook-sygnal.md:105 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:100 +#: ../../../docs/configuring-playbook-sygnal.md:107 msgid "To make use of your Sygnal installation, you'd need to build your own Matrix client application, which uses the same API keys (for [GCM/FCM](https://firebase.google.com/docs/cloud-messaging/)) and certificates (for [APNS](https://developer.apple.com/notifications/)) and is to your Sygnal URL endpoint (e.g. `https://sygnal.example.com`)." msgstr "" -#: ../../../docs/configuring-playbook-sygnal.md:102 +#: ../../../docs/configuring-playbook-sygnal.md:109 msgid "Refer to Sygnal's [Notes for application developers](https://github.com/matrix-org/sygnal/blob/master/docs/applications.md) document." msgstr "" + +#: ../../../docs/configuring-playbook-sygnal.md:111 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-sygnal.md:113 +msgid "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-sygnal`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-synapse-admin.pot b/i18n/translation-templates/docs/configuring-playbook-synapse-admin.pot index 185f0811f..9669bda40 100644 --- a/i18n/translation-templates/docs/configuring-playbook-synapse-admin.pot +++ b/i18n/translation-templates/docs/configuring-playbook-synapse-admin.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,106 +16,130 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-synapse-admin.md:1 +#: ../../../docs/configuring-playbook-synapse-admin.md:13 msgid "Setting up Synapse Admin (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:3 +#: ../../../docs/configuring-playbook-synapse-admin.md:15 msgid "The playbook can install and configure [etkecc/synapse-admin](https://github.com/etkecc/synapse-admin) (a [feature-rich](https://github.com/etkecc/synapse-admin#fork-differences) fork of [Awesome-Technologies/synapse-admin](https://github.com/Awesome-Technologies/synapse-admin), community room: [#synapse-admin:etke.cc](https://matrix.to/#/#synapse-admin:etke.cc)) for you." msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:5 +#: ../../../docs/configuring-playbook-synapse-admin.md:17 msgid "synapse-admin is a web UI tool you can use to **administrate users, rooms, media, etc. on your Matrix server**. It's designed to work with the Synapse homeserver implementation and WON'T work with Dendrite because [Dendrite Admin API](https://element-hq.github.io/dendrite/administration/adminapi) differs from [Synapse Admin API](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/)." msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:7 +#: ../../../docs/configuring-playbook-synapse-admin.md:19 msgid "💡 **Note**: the latest version of synapse-admin is hosted by [etke.cc](https://etke.cc/) at [admin.etke.cc](https://admin.etke.cc/). If you only need this service occasionally and trust giving your admin credentials to a 3rd party Single Page Application, you can consider using it from there and avoiding the (small) overhead of self-hosting." msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:9 -msgid "Adjusting DNS records (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-admin.md:11 -msgid "By default, this playbook installs Synapse Admin on the `matrix.` subdomain, at the `/synapse-admin` path (https://matrix.example.com/synapse-admin). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-admin.md:13 -msgid "If you wish to adjust it, see the section [below](#adjusting-the-synapse-admin-url-optional) for details about DNS configuration." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-admin.md:15 -msgid "Adjusting the playbook configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-admin.md:17 -msgid "To enable Synapse Admin, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" +#: ../../../docs/configuring-playbook-synapse-admin.md:21 +msgid "💡 **Note**: The playbook also supports an alternative management UI in the shape of [Element Admin](./configuring-playbook-element-admin.md). However, it's currently less feature-rich than Synapse Admin and has a dependency on [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md)." msgstr "" #: ../../../docs/configuring-playbook-synapse-admin.md:23 -msgid "**Note**: Synapse Admin requires Synapse's [Admin APIs](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html) to function. Access to them is restricted with a valid access token, so exposing them publicly should not be a real security concern. Still, for additional security, we normally leave them unexposed, following [official Synapse reverse-proxying recommendations](https://element-hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-endpoints). Because Synapse Admin needs these APIs to function, when installing Synapse Admin, the playbook **automatically** exposes the Synapse Admin API publicly for you. Depending on the homeserver implementation you're using (Synapse, Dendrite), this is equivalent to:" +msgid "Adjusting DNS records (optional)" msgstr "" #: ../../../docs/configuring-playbook-synapse-admin.md:25 -msgid "for [Synapse](./configuring-playbook-synapse.md) (our default homeserver implementation): `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true`" +msgid "By default, this playbook installs Synapse Admin on the `matrix.` subdomain, at the `/synapse-admin` path (https://matrix.example.com/synapse-admin). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:26 -msgid "for [Dendrite](./configuring-playbook-dendrite.md): `matrix_dendrite_container_labels_public_client_synapse_admin_api_enabled: true`" +#: ../../../docs/configuring-playbook-synapse-admin.md:27 +msgid "If you wish to adjust it, see the section [below](#adjusting-the-synapse-admin-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:28 -msgid "By default, synapse-admin installation will be [restricted to only work with one homeserver](https://github.com/etkecc/synapse-admin/blob/e21e44362c879ac41f47c580b04210842b6ff3d7/README.md#restricting-available-homeserver) — the one managed by the playbook. To adjust these restrictions, tweak the `matrix_synapse_admin_config_restrictBaseUrl` variable." +#: ../../../docs/configuring-playbook-synapse-admin.md:29 +msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:30 -msgid "[!WARNING] If you're using [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) (MAS) for authentication, you will be able to [log into synapse-admin with an access token](https://github.com/etkecc/synapse-admin/pull/58), but certain synapse-admin features (especially those around user management) will be limited or not work at all." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-admin.md:33 -msgid "Adjusting the Synapse Admin URL (optional)" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-admin.md:35 -msgid "By tweaking the `matrix_synapse_admin_hostname` and `matrix_synapse_admin_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." +#: ../../../docs/configuring-playbook-synapse-admin.md:31 +msgid "To enable Synapse Admin, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-synapse-admin.md:37 +msgid "**Note**: Synapse Admin requires Synapse's [Admin APIs](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html) to function. Access to them is restricted with a valid access token, so exposing them publicly should not be a real security concern. Still, for additional security, we normally leave them unexposed, following [official Synapse reverse-proxying recommendations](https://element-hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-endpoints). Because Synapse Admin needs these APIs to function, when installing Synapse Admin, the playbook **automatically** exposes the Synapse Admin API publicly for you. Depending on the homeserver implementation you're using (Synapse, Dendrite), this is equivalent to:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:39 +msgid "for [Synapse](./configuring-playbook-synapse.md) (our default homeserver implementation): `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true`" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:40 +msgid "for [Dendrite](./configuring-playbook-dendrite.md): `matrix_dendrite_container_labels_public_client_synapse_admin_api_enabled: true`" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:42 +msgid "By default, synapse-admin installation will be [restricted to only work with one homeserver](https://github.com/etkecc/synapse-admin/blob/e21e44362c879ac41f47c580b04210842b6ff3d7/README.md#restricting-available-homeserver) — the one managed by the playbook. To adjust these restrictions, tweak the `matrix_synapse_admin_config_restrictBaseUrl` variable." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:44 +msgid "Adjusting the Synapse Admin URL (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:46 +msgid "By tweaking the `matrix_synapse_admin_hostname` and `matrix_synapse_admin_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:48 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:45 +#: ../../../docs/configuring-playbook-synapse-admin.md:56 msgid "If you've changed the default hostname, you may need to create a CNAME record for the Synapse Admin domain (`admin.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:47 +#: ../../../docs/configuring-playbook-synapse-admin.md:58 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-synapse-admin.md:49 -msgid "Installing" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-admin.md:51 -msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-admin.md:58 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - #: ../../../docs/configuring-playbook-synapse-admin.md:60 -msgid "`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." +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-synapse-admin.md:62 -msgid "Usage" +msgid "There are some additional things you may wish to configure about the component." msgstr "" #: ../../../docs/configuring-playbook-synapse-admin.md:64 -msgid "After installation, Synapse Admin will be accessible at: `https://matrix.example.com/synapse-admin/`" +msgid "Take a look at:" msgstr "" #: ../../../docs/configuring-playbook-synapse-admin.md:66 +msgid "`roles/custom/matrix-synapse-admin/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_synapse_admin_configuration_extension_json` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:68 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:70 +msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:77 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:79 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:81 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:83 +msgid "After installation, Synapse Admin will be accessible at: `https://matrix.example.com/synapse-admin/`" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:85 msgid "To use Synapse Admin, you need to have [registered at least one administrator account](registering-users.md) on your server." msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:87 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-admin.md:89 +msgid "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-synapse-admin`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-synapse-auto-accept-invite.pot b/i18n/translation-templates/docs/configuring-playbook-synapse-auto-accept-invite.pot index e63740241..946a263eb 100644 --- a/i18n/translation-templates/docs/configuring-playbook-synapse-auto-accept-invite.pot +++ b/i18n/translation-templates/docs/configuring-playbook-synapse-auto-accept-invite.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,54 +16,54 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:1 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:9 msgid "Setting up Synapse Auto Invite Accept (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:3 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:11 msgid "The playbook can install and configure [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) for you." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:5 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:13 msgid "In short, it automatically accepts room invites. You can specify that only 1:1 room invites are auto-accepted. Defaults to false if not specified." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:7 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:15 msgid "See the project's [documentation](https://github.com/matrix-org/synapse-auto-accept-invite/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:9 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:17 msgid "**Note**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:11 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:19 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:13 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:21 msgid "If you decide that you'd like to let this playbook install the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite module for you, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:21 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:29 msgid "Synapse worker deployments" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:23 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:31 msgid "In a [workerized Synapse deployment](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/c9a842147e09647c355799ca024d65a5de66b099/docs/configuring-playbook-synapse.md#load-balancing-with-workers) it is possible to run this module on a worker to reduce the load on the main process (Default is `null`). For example, add this to your configuration:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:29 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:37 msgid "There might be an [issue with federation](https://github.com/matrix-org/synapse-auto-accept-invite/issues/18)." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:31 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:39 msgid "Native alternative" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:33 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:41 msgid "Since Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the functionality provided by the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module [has been made](https://github.com/element-hq/synapse/pull/17147) part of Synapse." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:35 +#: ../../../docs/configuring-playbook-synapse-auto-accept-invite.md:43 msgid "Here's example configuration for using the **native** Synapse feature:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-synapse-auto-compressor.pot b/i18n/translation-templates/docs/configuring-playbook-synapse-auto-compressor.pot index bf9e2a645..0befb1f74 100644 --- a/i18n/translation-templates/docs/configuring-playbook-synapse-auto-compressor.pot +++ b/i18n/translation-templates/docs/configuring-playbook-synapse-auto-compressor.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,66 +16,102 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:1 +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:9 msgid "Setting up synapse-auto-compressor (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:3 +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:11 msgid "The playbook can install and configure [synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) for you." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:5 +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:13 msgid "It's a CLI tool that automatically compresses Synapse's `state_groups` database table in the background." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:7 +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:15 msgid "See the project's [documentation](https://github.com/matrix-org/rust-synapse-compress-state/blob/master/README.md#automated-tool-synapse_auto_compressor) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:9 +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:17 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:11 +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:19 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:17 -msgid "Installing" +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:25 +msgid "Edit the schedule (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:19 -msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:27 +msgid "By default the task will around 0 a.m. every day based on the `matrix_synapse_auto_compressor_schedule` variable with a randomized delay of 6 hours (controlled by the `matrix_synapse_auto_compressor_schedule_randomized_delay_sec` variable). It is defined in the format of systemd timer calendar." msgstr "" -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:26 -msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:28 -msgid "`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." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:30 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:32 -msgid "After installation, `synapse_auto_compressor` will run automatically every day at `00:00:00` (as defined in `matrix_synapse_auto_compressor_calendar` by default)." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:34 -msgid "Manually execute compression" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:36 -msgid "Sometimes it can be helpful to execute compression as you'd like, avoiding to wait until 00:00, like when you test your configuration." +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:29 +msgid "To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):" msgstr "" #: ../../../docs/configuring-playbook-synapse-auto-compressor.md:38 -msgid "If you want to execute it immediately, log in to the server with SSH and run `systemctl start matrix-synapse-auto-compressor`." +msgid "Extending the configuration" msgstr "" #: ../../../docs/configuring-playbook-synapse-auto-compressor.md:40 +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:42 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:44 +msgid "`roles/custom/matrix-synapse-auto-compressor/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:46 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:48 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:55 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:57 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:59 +msgid "Usage" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:61 +msgid "After installation, `synapse_auto_compressor` will run automatically every day at `00:00:00` (as defined in `matrix_synapse_auto_compressor_schedule` by default)." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:63 +msgid "Manually start the task" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:65 +msgid "Sometimes it can be helpful to execute compression as you'd like, avoiding to wait until 00:00, like when you test your configuration." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:67 +msgid "If you want to execute it immediately, log in to the server with SSH and run `systemctl start matrix-synapse-auto-compressor`." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:69 msgid "This will not return until the compression is done, so it can possibly take a long time. Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable." msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:71 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-auto-compressor.md:73 +msgid "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-synapse-auto-compressor`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-synapse-s3-storage-provider.pot b/i18n/translation-templates/docs/configuring-playbook-synapse-s3-storage-provider.pot index 692d53c2a..6aeca47ec 100644 --- a/i18n/translation-templates/docs/configuring-playbook-synapse-s3-storage-provider.pot +++ b/i18n/translation-templates/docs/configuring-playbook-synapse-s3-storage-provider.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,258 +16,286 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:1 +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:10 msgid "Storing Synapse media files on Amazon S3 with synapse-s3-storage-provider (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:3 -msgid "If you'd like to store Synapse's content repository (`media_store`) files on Amazon S3 (or other S3-compatible service), you can use the [synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider) media provider module for Synapse." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:5 -msgid "An alternative (which has worse performance) is to use [Goofys to mount the S3 store to the local filesystem](configuring-playbook-s3-goofys.md)." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:7 -msgid "How it works?" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:9 -msgid "Summarized writings here are inspired by [this article](https://quentin.dufour.io/blog/2021-09-14/matrix-synapse-s3-storage/)." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:11 -msgid "The way media storage providers in Synapse work has some caveats:" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:13 -msgid "Synapse still continues to use locally-stored files (for creating thumbnails, serving files, etc)" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:12 +msgid "The playbook can install and configure the [synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider) for you." msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:14 -msgid "the media storage provider is just an extra storage mechanism (in addition to the local filesystem)" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:15 -msgid "all files are stored locally at first, and then copied to the media storage provider (either synchronously or asynchronously)" +msgid "It is a media provider module for Synapse to store Synapse's content repository (`media_store`) files on Amazon S3 (or other S3-compatible service) object storage." msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:16 -msgid "if a file is not available on the local filesystem, it's pulled from a media storage provider" +msgid "See the project's [documentation](https://github.com/matrix-org/synapse-s3-storage-provider/blob/main/README.md) to learn what it does and why it might be useful to you." msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:18 -msgid "You may be thinking **if all files are stored locally as well, what's the point**?" +msgid "**Note**: alternatively you can use [Goofys to mount the S3 store to the local filesystem](configuring-playbook-s3-goofys.md) despite worse performance." msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:20 -msgid "You can run some scripts to delete the local files once in a while (which we do automatically by default — see [Periodically cleaning up the local filesystem](#periodically-cleaning-up-the-local-filesystem)), thus freeing up local disk space. If these files are needed in the future (for serving them to users, etc.), Synapse will pull them from the media storage provider on demand." +msgid "How it works?" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:22 -msgid "While you will need some local disk space around, it's only to accommodate usage, etc., and won't grow as large as your S3 store." +msgid "Summarized writings here are inspired by [this article](https://quentin.dufour.io/blog/2021-09-14/matrix-synapse-s3-storage/)." msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:24 -msgid "Adjusting the playbook configuration" +msgid "The way media storage providers in Synapse work has some caveats:" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:26 +msgid "Synapse still continues to use locally-stored files (for creating thumbnails, serving files, etc)" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:27 +msgid "the media storage provider is just an extra storage mechanism (in addition to the local filesystem)" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:28 +msgid "all files are stored locally at first, and then copied to the media storage provider (either synchronously or asynchronously)" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:29 +msgid "if a file is not available on the local filesystem, it's pulled from a media storage provider" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:31 +msgid "You may be thinking **if all files are stored locally as well, what's the point**?" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:33 +msgid "You can run some scripts to delete the local files once in a while (which we do automatically by default — see [Periodically cleaning up the local filesystem](#periodically-cleaning-up-the-local-filesystem)), thus freeing up local disk space. If these files are needed in the future (for serving them to users, etc.), Synapse will pull them from the media storage provider on demand." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:35 +msgid "While you will need some local disk space around, it's only to accommodate usage, etc., and won't grow as large as your S3 store." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:37 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:39 msgid "After [creating the S3 bucket and configuring it](configuring-playbook-s3.md#bucket-creation-and-security-configuration), add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:48 +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:61 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:50 +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:63 msgid "There are some additional things you may wish to configure about the server." msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:52 +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:65 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:54 +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:67 msgid "`roles/custom/matrix-synapse/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:56 -msgid "Usage" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:58 -msgid "If you have existing files in Synapse's media repository (`/matrix/synapse/storage/media-store/…`):" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:60 -msgid "new files will start being stored both locally and on the S3 store" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:61 -msgid "the existing files will remain on the local filesystem only until [migrating them to the S3 store](#migrating-your-existing-media-files-to-the-s3-store)" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:62 -msgid "at some point (and periodically in the future), you can delete local files which have been uploaded to the S3 store already" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:64 -msgid "Regardless of whether you need to [Migrate your existing files to the S3 store](#migrating-your-existing-media-files-to-the-s3-store) or not, make sure you've familiarized yourself with [How it works?](#how-it-works) above and [Periodically cleaning up the local filesystem](#periodically-cleaning-up-the-local-filesystem) below." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:66 -msgid "Migrating your existing media files to the S3 store" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:68 -msgid "Migrating your existing data can happen in multiple ways:" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:70 -msgid "[using the `s3_media_upload` script from `synapse-s3-storage-provider`](#using-the-s3_media_upload-script-from-synapse-s3-storage-provider) (very slow when dealing with lots of data)" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:69 +msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:71 -msgid "[using another tool in combination with `s3_media_upload`](#using-another-tool-in-combination-with-s3_media_upload) (quicker when dealing with lots of data)" +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:73 -msgid "💡 **Note**: instead of using `s3_media_upload` directly, which is very slow and painful for an initial data migration, we recommend [using another tool in combination with `s3_media_upload`](#using-another-tool-in-combination-with-s3_media_upload)." +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:78 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:75 -msgid "Using the `s3_media_upload` script from `synapse-s3-storage-provider`" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:80 +msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:77 -msgid "To copy your existing files, SSH into the server and run `/matrix/synapse/ext/s3-storage-provider/bin/shell`." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:79 -msgid "This launches a Synapse container, which has access to the local media store, Postgres database, S3 store and has some convenient environment variables configured for you to use (`MEDIA_PATH`, `BUCKET`, `ENDPOINT`, `UPDATE_DB_DAYS`, etc)." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:81 -msgid "Then use the following commands (`$` values come from environment variables — they're **not placeholders** that you need to substitute):" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:83 -msgid "`s3_media_upload update-db $UPDATE_DB_DURATION` — create a local SQLite database (`cache.db`) with a list of media repository files (from the `synapse` Postgres database) eligible for operating on" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:82 +msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:84 -msgid "`$UPDATE_DB_DURATION` is influenced by the `matrix_synapse_ext_synapse_s3_storage_provider_update_db_day_count` variable (defaults to `0`)" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:85 -msgid "`$UPDATE_DB_DURATION` defaults to `0d` (0 days), which means **include files which haven't been accessed for more than 0 days** (that is, **all files will be included**)." +msgid "If you have existing files in Synapse's media repository (`/matrix/synapse/storage/media-store/…`):" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:86 -msgid "`s3_media_upload check-deleted $MEDIA_PATH` — check whether files in the local cache still exist in the local media repository directory" +msgid "new files will start being stored both locally and on the S3 store" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:87 -msgid "`s3_media_upload upload $MEDIA_PATH $BUCKET --delete --storage-class $STORAGE_CLASS --endpoint-url $ENDPOINT` — uploads locally-stored files to S3 and deletes them from the local media repository directory" +msgid "the existing files will remain on the local filesystem only until [migrating them to the S3 store](#migrating-your-existing-media-files-to-the-s3-store)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:89 -msgid "The `s3_media_upload upload` command may take a lot of time to complete." +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:88 +msgid "at some point (and periodically in the future), you can delete local files which have been uploaded to the S3 store already" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:91 -msgid "Instead of running the above commands manually in the shell, you can also run the `/matrix/synapse/ext/s3-storage-provider/bin/migrate` script which will run the same commands automatically. We demonstrate how to do it manually, because:" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:90 +msgid "Regardless of whether you need to [Migrate your existing files to the S3 store](#migrating-your-existing-media-files-to-the-s3-store) or not, make sure you've familiarized yourself with [How it works?](#how-it-works) above and [Periodically cleaning up the local filesystem](#periodically-cleaning-up-the-local-filesystem) below." msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:93 -msgid "it's what the upstream project demonstrates and it teaches you how to use the `s3_media_upload` tool" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:92 +msgid "Migrating your existing media files to the S3 store" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:94 -msgid "allows you to check and verify the output of each command, to catch mistakes" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:95 -msgid "includes progress bars and detailed output for each command" +msgid "Migrating your existing data can happen in multiple ways:" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:96 -msgid "allows you to easily interrupt slow-running commands, etc. (the `/matrix/synapse/ext/s3-storage-provider/bin/migrate` starts a container without interactive TTY support, so `Ctrl+C` may not work and you and require killing via `docker kill …`)" +msgid "[using the `s3_media_upload` script from `synapse-s3-storage-provider`](#using-the-s3_media_upload-script-from-synapse-s3-storage-provider) (very slow when dealing with lots of data)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:98 -msgid "Using another tool in combination with `s3_media_upload`" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:97 +msgid "[using another tool in combination with `s3_media_upload`](#using-another-tool-in-combination-with-s3_media_upload) (quicker when dealing with lots of data)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:100 -msgid "To migrate your existing local data to S3, we recommend to:" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:99 +msgid "💡 **Note**: instead of using `s3_media_upload` directly, which is very slow and painful for an initial data migration, we recommend [using another tool in combination with `s3_media_upload`](#using-another-tool-in-combination-with-s3_media_upload)." msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:102 -msgid "**first** use another tool ([`aws s3`](#copying-data-to-amazon-s3) or [`b2 sync`](#copying-data-to-backblaze-b2), etc.) to copy the local files to the S3 bucket" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:101 +msgid "Using the `s3_media_upload` script from `synapse-s3-storage-provider`" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:104 -msgid "**only then** [use the `s3_media_upload` tool to finish the migration](#using-the-s3_media_upload-script-from-synapse-s3-storage-provider) (this checks to ensure all files are uploaded and then deletes the local files)" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:103 +msgid "To copy your existing files, SSH into the server and run `/matrix/synapse/ext/s3-storage-provider/bin/shell`." msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:106 -msgid "Copying data to Amazon S3" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:105 +msgid "This launches a Synapse container, which has access to the local media store, Postgres database, S3 store and has some convenient environment variables configured for you to use (`MEDIA_PATH`, `BUCKET`, `ENDPOINT`, `UPDATE_DB_DAYS`, etc)." msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:108 -msgid "To copy to AWS S3, start a container on the Matrix server like this:" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:107 +msgid "Then use the following commands (`$` values come from environment variables — they're **not placeholders** that you need to substitute):" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:109 +msgid "`s3_media_upload update-db $UPDATE_DB_DURATION` — create a local SQLite database (`cache.db`) with a list of media repository files (from the `synapse` Postgres database) eligible for operating on" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:110 +msgid "`$UPDATE_DB_DURATION` is influenced by the `matrix_synapse_ext_synapse_s3_storage_provider_update_db_day_count` variable (defaults to `0`)" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:111 +msgid "`$UPDATE_DB_DURATION` defaults to `0d` (0 days), which means **include files which haven't been accessed for more than 0 days** (that is, **all files will be included**)." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:112 +msgid "`s3_media_upload check-deleted $MEDIA_PATH` — check whether files in the local cache still exist in the local media repository directory" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:113 +msgid "`s3_media_upload upload $MEDIA_PATH $BUCKET --delete --storage-class $STORAGE_CLASS --endpoint-url $ENDPOINT` — uploads locally-stored files to S3 and deletes them from the local media repository directory" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:115 +msgid "The `s3_media_upload upload` command may take a lot of time to complete." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:117 +msgid "Instead of running the above commands manually in the shell, you can also run the `/matrix/synapse/ext/s3-storage-provider/bin/migrate` script which will run the same commands automatically. We demonstrate how to do it manually, because:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:119 +msgid "it's what the upstream project demonstrates and it teaches you how to use the `s3_media_upload` tool" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:120 -msgid "Copying data to an S3 alternative using the aws-s3 tool" +msgid "allows you to check and verify the output of each command, to catch mistakes" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:121 +msgid "includes progress bars and detailed output for each command" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:122 -msgid "To copy to a provider other than AWS S3 (e.g. Storj, Wasabi, Digital Ocean Spaces, etc.), you can use the command for [Copying data to Amazon S3](#copying-data-to-amazon-s3) with an added `--endpoint-url=$ENDPOINT` argument." +msgid "allows you to easily interrupt slow-running commands, etc. (the `/matrix/synapse/ext/s3-storage-provider/bin/migrate` starts a container without interactive TTY support, so `Ctrl+C` may not work and you and require killing via `docker kill …`)" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:124 -msgid "Add this argument to the command **as-is** (`$ENDPOINT` is an environment variable corresponding to `matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url`, so you don't need to touch it). Make sure to add the argument **before** the final quote (`'`) of the command." +msgid "Using another tool in combination with `s3_media_upload`" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:126 -msgid "Copying data to Backblaze B2" +msgid "To migrate your existing local data to S3, we recommend to:" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:128 -msgid "You can copy files to Backblaze B2 either by following the [Copying data to an S3 alternative using the aws-s3 tool](#copying-data-to-an-s3-alternative-using-the-aws-s3-tool) or by using the B2-specific [b2 command-line tool](https://www.backblaze.com/b2/docs/quick_command_line.html) as described below." +msgid "**first** use another tool ([`aws s3`](#copying-data-to-amazon-s3) or [`b2 sync`](#copying-data-to-backblaze-b2), etc.) to copy the local files to the S3 bucket" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:130 -msgid "To copy the data using the `b2` tool, start a container on the Matrix server like this:" +msgid "**only then** [use the `s3_media_upload` tool to finish the migration](#using-the-s3_media_upload-script-from-synapse-s3-storage-provider) (this checks to ensure all files are uploaded and then deletes the local files)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:144 -msgid "Periodically cleaning up the local filesystem" +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:132 +msgid "Copying data to Amazon S3" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:134 +msgid "To copy to AWS S3, start a container on the Matrix server like this:" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:146 -msgid "As described in [How it works?](#how-it-works) above, when new media is uploaded to the Synapse homeserver, it's first stored locally and then also stored on the remote S3 storage." +msgid "Copying data to an S3 alternative using the aws-s3 tool" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:148 -msgid "By default, we periodically ensure that all local files are uploaded to S3 and are then removed from the local filesystem. This is done automatically using:" +msgid "To copy to a provider other than AWS S3 (e.g. Storj, Wasabi, Digital Ocean Spaces, etc.), you can use the command for [Copying data to Amazon S3](#copying-data-to-amazon-s3) with an added `--endpoint-url=$ENDPOINT` argument." msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:150 -msgid "the `/matrix/synapse/ext/s3-storage-provider/bin/migrate` script" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:151 -msgid "… invoked via the `matrix-synapse-s3-storage-provider-migrate.service` service" +msgid "Add this argument to the command **as-is** (`$ENDPOINT` is an environment variable corresponding to `matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url`, so you don't need to touch it). Make sure to add the argument **before** the final quote (`'`) of the command." msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:152 -msgid "… triggered by the `matrix-synapse-s3-storage-provider-migrate.timer` timer, every day at 05:00" +msgid "Copying data to Backblaze B2" msgstr "" #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:154 +msgid "You can copy files to Backblaze B2 either by following the [Copying data to an S3 alternative using the aws-s3 tool](#copying-data-to-an-s3-alternative-using-the-aws-s3-tool) or by using the B2-specific [b2 command-line tool](https://www.backblaze.com/b2/docs/quick_command_line.html) as described below." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:156 +msgid "To copy the data using the `b2` tool, start a container on the Matrix server like this:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:170 +msgid "Periodically cleaning up the local filesystem" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:172 +msgid "As described in [How it works?](#how-it-works) above, when new media is uploaded to the Synapse homeserver, it's first stored locally and then also stored on the remote S3 storage." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:174 +msgid "By default, we periodically ensure that all local files are uploaded to S3 and are then removed from the local filesystem. This is done automatically using:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:176 +msgid "the `/matrix/synapse/ext/s3-storage-provider/bin/migrate` script" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:177 +msgid "… invoked via the `matrix-synapse-s3-storage-provider-migrate.service` service" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:178 +msgid "… triggered by the `matrix-synapse-s3-storage-provider-migrate.timer` timer, every day at 05:00" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:180 msgid "So… you don't need to perform any maintenance yourself." msgstr "" + +#: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:182 +msgid "The schedule is defined in the format of systemd timer calendar. To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-synapse-simple-antispam.pot b/i18n/translation-templates/docs/configuring-playbook-synapse-simple-antispam.pot index 0933ef731..96e8dde27 100644 --- a/i18n/translation-templates/docs/configuring-playbook-synapse-simple-antispam.pot +++ b/i18n/translation-templates/docs/configuring-playbook-synapse-simple-antispam.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,26 +16,42 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:1 +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:8 msgid "Setting up Synapse Simple Antispam (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:3 +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:10 msgid "The playbook can install and configure [synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam) for you." msgstr "" -#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:5 -msgid "It lets you fight invite-spam by automatically blocking invitiations from a list of servers specified by you (blacklisting)." +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:12 +msgid "It lets you fight invite-spam by automatically blocking invitations from a list of servers specified by you (blacklisting)." msgstr "" -#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:7 +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:14 msgid "See the project's [documentation](https://github.com/t2bot/synapse-simple-antispam/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:9 +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:16 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:11 +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:18 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):" msgstr "" + +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:28 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:30 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:37 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-simple-antispam.md:39 +msgid "`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." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-synapse-usage-exporter.pot b/i18n/translation-templates/docs/configuring-playbook-synapse-usage-exporter.pot index 28f37115b..9fbd5187f 100644 --- a/i18n/translation-templates/docs/configuring-playbook-synapse-usage-exporter.pot +++ b/i18n/translation-templates/docs/configuring-playbook-synapse-usage-exporter.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,90 +16,126 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:1 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:9 msgid "Enabling synapse-usage-exporter for Synapse usage statistics (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:3 -msgid "[synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) allows you to export the usage statistics of a Synapse homeserver to this container service and for the collected metrics to later be scraped by Prometheus." +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:11 +msgid "The playbook can install and configure [synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) for you." msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:5 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:13 +msgid "It allows you to export the usage statistics of a Synapse homeserver to this container service and for the collected metrics to later be scraped by Prometheus." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:15 msgid "Synapse does not include usage statistics in its Prometheus metrics. They can be reported to an HTTP `PUT` endpoint 5 minutes after startup and from then on at a fixed interval of once every three hours. This role integrates a simple [Flask](https://flask.palletsprojects.com) project that offers an HTTP `PUT` endpoint and holds the most recent received record available to be scraped by Prometheus." msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:7 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:17 +msgid "See the project's [documentation](https://github.com/loelkes/synapse-usage-exporter/blob/main/README.md) to learn what it does and why it might be useful to you." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:19 +msgid "What does it do?" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:21 msgid "Enabling this service will automatically:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:9 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:23 msgid "install the synapse-usage-exporter service" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:10 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:24 msgid "re-configure Synapse to push (via HTTP `PUT`) usage statistics information to synapse-usage-exporter" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:11 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:25 msgid "re-configure [Prometheus](./configuring-playbook-prometheus-grafana.md) (if Prometheus is enabled), to periodically scrape metrics from synapse-usage-exporter" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:12 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:26 msgid "add a new [Grafana](./configuring-playbook-prometheus-grafana.md) dashboard (if Grafana is enabled) containing Synapse usage statistics" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:14 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:28 msgid "Adjusting DNS records (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:16 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:30 msgid "By default, this playbook installs synapse-usage-exporter on the `matrix.` subdomain, at the `/report-usage-stats/push` path (https://matrix.example.com/report-usage-stats/push). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section." msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:18 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:32 msgid "If you wish to adjust it, see the section [below](#adjusting-the-synapse-usage-exporter-url-optional) for details about DNS configuration." msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:20 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:34 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:22 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:36 msgid "To enable synapse-usage-exporter, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:34 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:48 msgid "Adjusting the synapse-usage-exporter URL (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:36 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:50 msgid "By tweaking the `matrix_synapse_usage_exporter_hostname` and `matrix_synapse_usage_exporter_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one." msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:38 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:52 msgid "Example additional configuration for your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:47 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:61 msgid "If you've changed the default hostname, you may need to create a CNAME record for the synapse-usage-exporter domain (`sue.example.com`), which targets `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:49 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:63 msgid "When setting, replace `example.com` with your own." msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:51 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:65 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:67 +msgid "There are some additional things you may wish to configure about the component." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:69 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:71 +msgid "`roles/custom/matrix-synapse-usage-exporter/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:73 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:53 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:75 msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:60 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:82 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:62 +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:84 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:86 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse-usage-exporter.md:88 +msgid "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-synapse-usage-exporter`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-synapse.pot b/i18n/translation-templates/docs/configuring-playbook-synapse.pot index 5fa37a2ab..901c0309f 100644 --- a/i18n/translation-templates/docs/configuring-playbook-synapse.pot +++ b/i18n/translation-templates/docs/configuring-playbook-synapse.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,258 +16,282 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-synapse.md:1 +#: ../../../docs/configuring-playbook-synapse.md:12 msgid "Configuring Synapse (optional)" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:3 +#: ../../../docs/configuring-playbook-synapse.md:14 msgid "By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, so that it works for the general case. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:5 +#: ../../../docs/configuring-playbook-synapse.md:16 +msgid "💡 See this page for details about maintaining Synapse: [Synapse maintenance](maintenance-synapse.md)" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:18 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:7 +#: ../../../docs/configuring-playbook-synapse.md:20 msgid "Load balancing with workers" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:9 +#: ../../../docs/configuring-playbook-synapse.md:22 msgid "To have Synapse gracefully handle thousands of users, worker support should be enabled. It factors out some homeserver tasks and spreads the load of incoming client and server-to-server traffic between multiple processes. More information can be found in the [official Synapse workers documentation](https://github.com/element-hq/synapse/blob/master/docs/workers.md) and [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html)." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:11 +#: ../../../docs/configuring-playbook-synapse.md:24 msgid "To enable Synapse worker support, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:19 +#: ../../../docs/configuring-playbook-synapse.md:32 msgid "By default, this enables the `one-of-each` [worker preset](#worker-presets), but you may wish to use another preset or [control the number of worker instances](#controlling-the-number-of-worker-instances)." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:21 +#: ../../../docs/configuring-playbook-synapse.md:34 msgid "Worker presets" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:23 +#: ../../../docs/configuring-playbook-synapse.md:36 msgid "We support a few configuration presets (`matrix_synapse_workers_preset: one-of-each` being the default configuration right now):" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:25 +#: ../../../docs/configuring-playbook-synapse.md:38 msgid "(federation-only) `little-federation-helper` — a very minimal worker configuration to improve federation performance" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:26 +#: ../../../docs/configuring-playbook-synapse.md:39 msgid "(generic) `one-of-each` — defaults to one worker of each supported type — no smart routing, just generic workers" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:27 +#: ../../../docs/configuring-playbook-synapse.md:40 msgid "(specialized) `specialized-workers` — defaults to one worker of each supported type, but disables generic workers and uses [specialized workers](#specialized-workers) instead" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:29 +#: ../../../docs/configuring-playbook-synapse.md:42 msgid "These presets represent a few common configurations. There are many worker types which can be mixed and matched based on your needs." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:31 +#: ../../../docs/configuring-playbook-synapse.md:44 msgid "Generic workers" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:33 +#: ../../../docs/configuring-playbook-synapse.md:46 msgid "Previously, the playbook only supported the most basic type of load-balancing. We call it **generic load-balancing** below, because incoming HTTP requests are sent to a generic worker. Load-balancing was done based on the requestor's IP address. This is simple, but not necessarily optimal. If you're accessing your account from multiple IP addresses (e.g. your mobile phone being on a different network than your PC), these separate requests may potentially be routed to different workers, each of which would need to cache roughly the same data." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:35 +#: ../../../docs/configuring-playbook-synapse.md:48 msgid "This is **still the default load-balancing method (preset) used by the playbook**." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:37 +#: ../../../docs/configuring-playbook-synapse.md:50 msgid "To use generic load-balancing, do not specify `matrix_synapse_workers_preset` to make it use the default value (`one-of-each`), or better yet — explicitly set it as `one-of-each`." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:39 +#: ../../../docs/configuring-playbook-synapse.md:52 msgid "You may also consider [tweaking the number of workers of each type](#controlling-the-number-of-worker-instances) from the default (one of each)." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:41 +#: ../../../docs/configuring-playbook-synapse.md:54 msgid "Specialized workers" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:43 -msgid "The playbook now supports a smarter **specialized load-balancing** inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). Instead of routing requests to one or more [generic workers](#generic-workers) based only on the requestor's IP adddress, specialized load-balancing routes to **4 different types of specialized workers** based on **smarter criteria** — the access token (username) of the requestor and/or on the resource (room, etc.) being requested." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse.md:45 -msgid "The playbook supports these **4 types** of specialized workers:" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse.md:47 -msgid "Room workers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) & [Federation](https://spec.matrix.org/v1.9/server-server-api) APIs dedicated to handling specific rooms" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse.md:48 -msgid "Sync workers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) APIs related to synchronization (most notably [the `/sync` endpoint](https://spec.matrix.org/v1.9/client-server-api/#get_matrixclientv3sync))" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse.md:49 -msgid "Client readers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) APIs which are not for specific rooms (handled by **room workers**) or for synchronization (handled by **sync workers**)" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse.md:50 -msgid "Federation readers — handles various [Federation](https://spec.matrix.org/v1.9/server-server-api) APIs which are not for specific rooms (handled by **room workers**)" -msgstr "" - -#: ../../../docs/configuring-playbook-synapse.md:52 -msgid "To use specialized load-balancing, consider enabling the `specialized-workers` [worker preset](#worker-presets) and potentially [tweaking the number of workers of each type](#controlling-the-number-of-worker-instances) from the default (one of each)." -msgstr "" - -#: ../../../docs/configuring-playbook-synapse.md:54 -msgid "Controlling the number of worker instances" -msgstr "" - #: ../../../docs/configuring-playbook-synapse.md:56 -msgid "If you'd like more customization power, you can start with one of the [worker presets](#worker-presets) and then tweak various `matrix_synapse_workers_*_count` variables manually." +msgid "The playbook now supports a smarter **specialized load-balancing** inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). Instead of routing requests to one or more [generic workers](#generic-workers) based only on the requester's IP address, specialized load-balancing routes to **4 different types of specialized workers** based on **smarter criteria** — the access token (username) of the requester and/or on the resource (room, etc.) being requested." msgstr "" #: ../../../docs/configuring-playbook-synapse.md:58 -msgid "To find what variables are available for you to override in your own `vars.yml` configuration file, see the [`defaults/main.yml` file for the `matrix-synapse` Ansible role](../roles/custom/matrix-synapse/defaults/main.yml)." +msgid "The playbook supports these **4 types** of specialized workers:" msgstr "" #: ../../../docs/configuring-playbook-synapse.md:60 -msgid "The only thing you **cannot** do is mix [generic workers](#generic-workers) and [specialized workers](#specialized-workers)." +msgid "Room workers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) & [Federation](https://spec.matrix.org/v1.9/server-server-api) APIs dedicated to handling specific rooms" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:61 +msgid "Sync workers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) APIs related to synchronization (most notably [the `/sync` endpoint](https://spec.matrix.org/v1.9/client-server-api/#get_matrixclientv3sync))" msgstr "" #: ../../../docs/configuring-playbook-synapse.md:62 +msgid "Client readers — handles various [Client-Server](https://spec.matrix.org/v1.9/client-server-api/) APIs which are not for specific rooms (handled by **room workers**) or for synchronization (handled by **sync workers**)" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:63 +msgid "Federation readers — handles various [Federation](https://spec.matrix.org/v1.9/server-server-api) APIs which are not for specific rooms (handled by **room workers**)" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:65 +msgid "To use specialized load-balancing, consider enabling the `specialized-workers` [worker preset](#worker-presets) and potentially [tweaking the number of workers of each type](#controlling-the-number-of-worker-instances) from the default (one of each)." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:67 +msgid "Controlling the number of worker instances" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:69 +msgid "If you'd like more customization power, you can start with one of the [worker presets](#worker-presets) and then tweak various `matrix_synapse_workers_*_count` variables manually." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:71 +msgid "To find what variables are available for you to override in your own `vars.yml` configuration file, see the [`defaults/main.yml` file for the `matrix-synapse` Ansible role](../roles/custom/matrix-synapse/defaults/main.yml)." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:73 +msgid "The only thing you **cannot** do is mix [generic workers](#generic-workers) and [specialized workers](#specialized-workers)." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:75 msgid "Effect of enabling workers on the rest of your server" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:64 +#: ../../../docs/configuring-playbook-synapse.md:77 msgid "When Synapse workers are enabled, the integrated [Postgres database is tuned](maintenance-postgres.md#tuning-postgresql), so that the maximum number of Postgres connections are increased from `200` to `500`. If you need to decrease or increase the number of maximum Postgres connections further, use the `postgres_max_connections` variable." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:66 +#: ../../../docs/configuring-playbook-synapse.md:79 msgid "A separate Ansible role (`matrix-synapse-reverse-proxy-companion`) and component handles load-balancing for workers. This role/component is automatically enabled when you enable workers. Make sure to use the `setup-all` tag (not `install-all`!) during the playbook's [installation](./installing.md) process, especially if you're disabling workers, so that components may be installed/uninstalled correctly." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:68 +#: ../../../docs/configuring-playbook-synapse.md:81 msgid "In case any problems occur, make sure to have a look at the [list of synapse issues about workers](https://github.com/element-hq/synapse/issues?q=workers+in%3Atitle) and your `journalctl --unit 'matrix-*'`." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:70 +#: ../../../docs/configuring-playbook-synapse.md:83 msgid "Synapse + OpenID Connect for Single-Sign-On" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:72 +#: ../../../docs/configuring-playbook-synapse.md:85 msgid "💡 An alternative to setting up OIDC in Synapse is to use [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) (MAS). Newer clients (like Element X) only support SSO-based authentication via MAS and not via the legacy Synapse OIDC setup described below. That said, MAS is still a new experimental service which comes with its own downsides. Consult its documentation to learn if it will be a good fit for your deployment." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:74 +#: ../../../docs/configuring-playbook-synapse.md:87 msgid "If you'd like to use OpenID Connect authentication with Synapse, you'll need some additional configuration." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:76 +#: ../../../docs/configuring-playbook-synapse.md:89 msgid "This example configuration is for [keycloak](https://www.keycloak.org/), an opensource Identity Provider maintained by Red Hat." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:78 +#: ../../../docs/configuring-playbook-synapse.md:91 msgid "For more detailed documentation on available options and how to setup keycloak, see the [Synapse documentation on OpenID Connect with keycloak](https://github.com/element-hq/synapse/blob/develop/docs/openid.md#keycloak)." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:80 +#: ../../../docs/configuring-playbook-synapse.md:93 msgid "In case you encounter errors regarding the parsing of the variables, you can try to add `{% raw %}` and `{% endraw %}` blocks around them. For example ;" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:101 +#: ../../../docs/configuring-playbook-synapse.md:114 msgid "Customizing templates" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:103 +#: ../../../docs/configuring-playbook-synapse.md:116 msgid "[Templates](https://github.com/element-hq/synapse/blob/develop/docs/templates.md) are used by Synapse for showing **certain web pages** handled by the server, as well as for **email notifications**." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:105 +#: ../../../docs/configuring-playbook-synapse.md:118 msgid "This playbook allows you to customize the default templates (see the [`synapse/res/templates` directory](https://github.com/element-hq/synapse/tree/develop/synapse/res/templates))." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:107 +#: ../../../docs/configuring-playbook-synapse.md:120 msgid "If template customization is enabled, the playbook will build a custom container image based on the official one." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:109 +#: ../../../docs/configuring-playbook-synapse.md:122 msgid "Your custom templates need to live in a public or private git repository. This repository will be cloned during Synapse image customization (during the playbook run)." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:111 +#: ../../../docs/configuring-playbook-synapse.md:124 msgid "To enable template customizations, add the following configuration to your `vars.yml` file (adapt to your needs):" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:137 +#: ../../../docs/configuring-playbook-synapse.md:150 msgid "As mentioned in Synapse's Templates documentation, Synapse will fall back to its own templates if a template is not found in that directory. Due to this, it's recommended to only store and maintain template files in your repository if you need to make custom changes. Other files (which you don't need to change), should not be duplicated, so that you don't need to worry about getting out-of-sync with the original Synapse templates." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:139 +#: ../../../docs/configuring-playbook-synapse.md:152 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:141 +#: ../../../docs/configuring-playbook-synapse.md:154 msgid "There are some additional things you may wish to configure about the server." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:143 +#: ../../../docs/configuring-playbook-synapse.md:156 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:145 +#: ../../../docs/configuring-playbook-synapse.md:158 msgid "`roles/custom/matrix-synapse/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:146 +#: ../../../docs/configuring-playbook-synapse.md:159 msgid "`roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2` for the server's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_synapse_configuration_extension_yaml` variable" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:148 +#: ../../../docs/configuring-playbook-synapse.md:161 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:150 +#: ../../../docs/configuring-playbook-synapse.md:163 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:157 +#: ../../../docs/configuring-playbook-synapse.md:170 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:159 +#: ../../../docs/configuring-playbook-synapse.md:172 msgid "`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." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:161 +#: ../../../docs/configuring-playbook-synapse.md:174 msgid "Usage" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:163 +#: ../../../docs/configuring-playbook-synapse.md:176 msgid "Synapse Admin" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:165 +#: ../../../docs/configuring-playbook-synapse.md:178 msgid "With [Synapse Admin](configuring-playbook-synapse-admin.md), certain Synapse administration tasks (managing users and rooms, etc.) can be performed via a web user-interace." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:167 +#: ../../../docs/configuring-playbook-synapse.md:180 msgid "The playbook can install and configure Synapse Admin for you. For details about it, see [this page](configuring-playbook-synapse-admin.md)." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:169 +#: ../../../docs/configuring-playbook-synapse.md:182 msgid "Monitoring Synapse Metrics with Prometheus and Grafana" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:171 +#: ../../../docs/configuring-playbook-synapse.md:184 msgid "This playbook allows you to enable Synapse metrics, which can provide insight into the performance and activity of Synapse." msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:173 -msgid "To enable Synapse runtime metrics see: [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)" +#: ../../../docs/configuring-playbook-synapse.md:186 +msgid "To enable Synapse runtime metrics, see: [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md) and [its subsection](configuring-playbook-prometheus-grafana.md#expose-metrics-of-other-services-roles)" msgstr "" -#: ../../../docs/configuring-playbook-synapse.md:175 +#: ../../../docs/configuring-playbook-synapse.md:188 msgid "To enable Synapse usage metrics, see: [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)" msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:190 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:192 +msgid "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-synapse`." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:194 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:196 +msgid "Because Synapse is originally very chatty when it comes to logging, we intentionally reduce its [logging level](https://docs.python.org/3/library/logging.html#logging-levels) from `INFO` to `WARNING`." +msgstr "" + +#: ../../../docs/configuring-playbook-synapse.md:198 +msgid "If you'd like to debug an issue or [report a Synapse bug](https://github.com/element-hq/synapse/issues/new/choose) to the developers, it'd be better if you temporarily increase the logging verbosity to `INFO`. To do so, add the following configuration to your `vars.yml` file and re-run the playbook:" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-telemetry.pot b/i18n/translation-templates/docs/configuring-playbook-telemetry.pot index e18e4a6c0..b55c28261 100644 --- a/i18n/translation-templates/docs/configuring-playbook-telemetry.pot +++ b/i18n/translation-templates/docs/configuring-playbook-telemetry.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,34 +16,34 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-telemetry.md:1 +#: ../../../docs/configuring-playbook-telemetry.md:11 msgid "Enabling Telemetry for your Matrix server (optional)" msgstr "" -#: ../../../docs/configuring-playbook-telemetry.md:3 +#: ../../../docs/configuring-playbook-telemetry.md:13 msgid "By default, this playbook configures your Matrix homeserver to not send any telemetry data anywhere." msgstr "" -#: ../../../docs/configuring-playbook-telemetry.md:5 +#: ../../../docs/configuring-playbook-telemetry.md:15 msgid "The [matrix.org](https://matrix.org) team would really appreciate it if you could help the project out by reporting usage statistics from your homeserver. Enabling usage statistics helps track the growth of the Matrix community, and helps to make Matrix a success." msgstr "" -#: ../../../docs/configuring-playbook-telemetry.md:7 +#: ../../../docs/configuring-playbook-telemetry.md:17 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-telemetry.md:9 +#: ../../../docs/configuring-playbook-telemetry.md:19 msgid "If you'd like to **help by enabling submission of general usage statistics** for your homeserver, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-telemetry.md:17 +#: ../../../docs/configuring-playbook-telemetry.md:27 msgid "Usage statistics being submitted" msgstr "" -#: ../../../docs/configuring-playbook-telemetry.md:19 +#: ../../../docs/configuring-playbook-telemetry.md:29 msgid "When enabled, your homeserver will regularly upload a few dozen statistics about your server. This data includes your homeserver's domain, the total number of users, the number of active users, the total number of rooms, and the number of messages sent per day on your homeserver." msgstr "" -#: ../../../docs/configuring-playbook-telemetry.md:21 +#: ../../../docs/configuring-playbook-telemetry.md:31 msgid "See [Synapse's documentation](https://github.com/element-hq/synapse/blob/develop/docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md#available-statistics) or [Dendrite's documentation](https://github.com/element-hq/dendrite/blob/main/docs/FAQ.md#what-is-being-reported-when-enabling-phone-home-statistics) for the full list of statistics that are reported." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-traefik.pot b/i18n/translation-templates/docs/configuring-playbook-traefik.pot index 291f07bde..824226870 100644 --- a/i18n/translation-templates/docs/configuring-playbook-traefik.pot +++ b/i18n/translation-templates/docs/configuring-playbook-traefik.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,119 +16,171 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-traefik.md:1 +#: ../../../docs/configuring-playbook-traefik.md:10 msgid "Configuring the Traefik reverse-proxy (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:3 -msgid "By default, this playbook installs and manages a [Traefik](https://doc.traefik.io/traefik/) reverse-proxy server, powered by the [ansible-role-traefik](https://github.com/mother-of-all-self-hosting/ansible-role-traefik) Ansible role." +#: ../../../docs/configuring-playbook-traefik.md:12 +msgid "By default, this playbook installs and manages a [Traefik](https://doc.traefik.io/traefik/) reverse-proxy server, powered by the [ansible-role-traefik](https://github.com/mother-of-all-self-hosting/ansible-role-traefik) Ansible role for you. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:5 +#: ../../../docs/configuring-playbook-traefik.md:14 +msgid "Adjusting the playbook configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:16 msgid "This Ansible role support various configuration options. Feel free to consult its `default/main.yml` variables file." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:7 -msgid "Adjusting SSL certificate retrieval" -msgstr "" - -#: ../../../docs/configuring-playbook-traefik.md:9 -msgid "See the dedicated [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) documentation page." -msgstr "" - -#: ../../../docs/configuring-playbook-traefik.md:11 -msgid "Increase logging verbosity" -msgstr "" - -#: ../../../docs/configuring-playbook-traefik.md:17 +#: ../../../docs/configuring-playbook-traefik.md:18 msgid "Disable access logs" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:19 -msgid "This will disable access logging." +#: ../../../docs/configuring-playbook-traefik.md:20 +msgid "To disable access logging, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:25 +#: ../../../docs/configuring-playbook-traefik.md:26 msgid "Enable Traefik Dashboard" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:27 -msgid "This will enable a Traefik [Dashboard](https://doc.traefik.io/traefik/operations/dashboard/) UI at `https://matrix.example.com/dashboard/` (note the trailing `/`)." +#: ../../../docs/configuring-playbook-traefik.md:28 +msgid "To enable a Traefik [Dashboard](https://doc.traefik.io/traefik/operations/dashboard/) UI at `https://matrix.example.com/dashboard/` (note the trailing `/`), add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:37 +#: ../../../docs/configuring-playbook-traefik.md:38 msgid "[!WARNING] Enabling the dashboard on a hostname you use for something else (like `matrix_server_fqn_matrix` in the configuration above) may cause conflicts. Enabling the Traefik Dashboard makes Traefik capture all `/dashboard` and `/api` requests and forward them to itself. If any of the services hosted on the same hostname requires any of these 2 URL prefixes, you will experience problems. So far, we're not aware of any playbook services which occupy these endpoints and are likely to cause conflicts." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:40 -msgid "Additional configuration" +#: ../../../docs/configuring-playbook-traefik.md:41 +msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:42 -msgid "Use the `traefik_configuration_extension_yaml` variable provided by the Traefik Ansible role to override or inject additional settings, even when no dedicated variable exists." +#: ../../../docs/configuring-playbook-traefik.md:43 +msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:52 +#: ../../../docs/configuring-playbook-traefik.md:45 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:47 +msgid "[Traefik role](https://github.com/mother-of-all-self-hosting/ansible-role-traefik)'s [`defaults/main.yml`](https://github.com/mother-of-all-self-hosting/ansible-role-traefik/blob/main/defaults/main.yml) for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `traefik_configuration_extension_yaml` variable" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:49 +msgid "For example, to enable and secure the Dashboard, you can add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:51 +msgid "**Note**: this is a contrived example as you can enable and secure the Dashboard using the dedicated variables. See above for details." +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:69 msgid "Reverse-proxying another service behind Traefik" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:54 +#: ../../../docs/configuring-playbook-traefik.md:71 msgid "The preferred way to reverse-proxy additional services behind Traefik would be to start the service as another container, configure the container with the corresponding Traefik [container labels](https://docs.docker.com/config/labels-custom-metadata/) (see [Traefik & Docker](https://doc.traefik.io/traefik/routing/providers/docker/)), and connect the service to the `traefik` network. Some services are also already available via the compatible [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook), but take a look at the minor [interoperability adjustments](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/interoperability.md)." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:56 +#: ../../../docs/configuring-playbook-traefik.md:73 msgid "However, if your service does not run on a container or runs on another machine, the following configuration might be what you are looking for." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:58 +#: ../../../docs/configuring-playbook-traefik.md:75 msgid "Reverse-proxying a remote HTTP/HTTPS service behind Traefik" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:60 +#: ../../../docs/configuring-playbook-traefik.md:77 msgid "If you want to host another webserver would be reachable via `my-fancy-website.example.net` from the internet and via `https://:` from inside your network, you can make the playbook's integrated Traefik instance reverse-proxy the traffic to the correct host." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:62 +#: ../../../docs/configuring-playbook-traefik.md:79 msgid "Prerequisites: DNS and routing for the domain `my-fancy-website.example.net` need to be set up correctly. In this case, you'd be pointing the domain name to your Matrix server — `my-fancy-website.example.net` would be a CNAME going to `matrix.example.com`." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:64 +#: ../../../docs/configuring-playbook-traefik.md:81 msgid "First, we have to adjust the static configuration of Traefik, so that we can add additional configuration files:" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:78 +#: ../../../docs/configuring-playbook-traefik.md:95 msgid "If you are using a self-signed certificate on your webserver, you can tell Traefik to trust your own backend servers by adding more configuration to the static configuration file. If you do so, bear in mind the security implications of disabling the certificate validity checks towards your back end." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:92 +#: ../../../docs/configuring-playbook-traefik.md:109 msgid "Next, you have to add a new dynamic configuration file for Traefik that contains the actual information of the server using the `aux_file_definitions` variable. In this example, we will terminate SSL at the Traefik instance and connect to the other server via HTTPS. Traefik will now take care of managing the certificates." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:111 -#: ../../../docs/configuring-playbook-traefik.md:134 +#: ../../../docs/configuring-playbook-traefik.md:128 +#: ../../../docs/configuring-playbook-traefik.md:151 msgid "Changing the `url` to one with an `http://` prefix would allow to connect to the server via HTTP." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:113 +#: ../../../docs/configuring-playbook-traefik.md:130 msgid "Reverse-proxying another service behind Traefik without terminating SSL" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:115 +#: ../../../docs/configuring-playbook-traefik.md:132 msgid "If you do not want to terminate SSL at the Traefik instance (for example, because you're already terminating SSL at other webserver), you need to adjust the static configuration in the same way as in the previous chapter in order to be able to add our own dynamic configuration files. Afterwards, you can add the following configuration to your `vars.yml` configuration file:" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:136 +#: ../../../docs/configuring-playbook-traefik.md:153 msgid "With these changes, all TCP traffic will be reverse-proxied to the target system." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:138 +#: ../../../docs/configuring-playbook-traefik.md:155 msgid "[!WARNING] This configuration might lead to problems or need additional steps when a [certbot](https://certbot.eff.org/) behind Traefik also tries to manage [Let's Encrypt](https://letsencrypt.org/) certificates, as Traefik captures all traffic to ```PathPrefix(`/.well-known/acme-challenge/`)```." msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:141 +#: ../../../docs/configuring-playbook-traefik.md:158 msgid "Traefik behind a `proxy_protocol` reverse-proxy" msgstr "" -#: ../../../docs/configuring-playbook-traefik.md:143 -msgid "If you run a reverse-proxy which speaks `proxy_protocol`, add the following to your configuration file:" +#: ../../../docs/configuring-playbook-traefik.md:160 +msgid "If you run a reverse-proxy which speaks `proxy_protocol`, add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:179 +msgid "Other configurations" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:181 +msgid "Adjusting SSL certificate retrieval" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:183 +msgid "See the dedicated [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) documentation page." +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:185 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:187 +msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:194 +msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:196 +msgid "`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." +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:198 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:200 +msgid "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-traefik`." +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:202 +msgid "Increase logging verbosity" +msgstr "" + +#: ../../../docs/configuring-playbook-traefik.md:204 +msgid "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:" msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-turn.pot b/i18n/translation-templates/docs/configuring-playbook-turn.pot index 434f1f4ea..45471515c 100644 --- a/i18n/translation-templates/docs/configuring-playbook-turn.pot +++ b/i18n/translation-templates/docs/configuring-playbook-turn.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,118 +16,142 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-turn.md:1 +#: ../../../docs/configuring-playbook-turn.md:11 msgid "Configuring a TURN server (optional, advanced)" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:3 +#: ../../../docs/configuring-playbook-turn.md:13 msgid "By default, this playbook installs and configures the [coturn](https://github.com/coturn/coturn) as a TURN server, through which clients can make audio/video calls even from [NAT](https://en.wikipedia.org/wiki/Network_address_translation)-ed networks. It also configures the Synapse chat server by default, so that it points to the coturn TURN server installed by the playbook. If that's okay, you can skip this document." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:5 +#: ../../../docs/configuring-playbook-turn.md:15 msgid "If you'd like to stop the playbook installing the server, see the section [below](#disabling-coturn) to check the configuration for disabling it." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:7 +#: ../../../docs/configuring-playbook-turn.md:17 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:9 +#: ../../../docs/configuring-playbook-turn.md:19 msgid "Define public IP manually (optional)" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:11 +#: ../../../docs/configuring-playbook-turn.md:21 msgid "In the `hosts` file we explicitly ask for your server's external IP address when defining `ansible_host`, because the same value is used for configuring coturn." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:13 +#: ../../../docs/configuring-playbook-turn.md:23 msgid "If you'd rather use a local IP for `ansible_host`, add the following configuration to your `vars.yml` file. Make sure to replace `YOUR_PUBLIC_IP` with the pubic IP used by the server." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:19 +#: ../../../docs/configuring-playbook-turn.md:29 msgid "If you'd like to rely on external IP address auto-detection (not recommended unless you need it), set an empty value to the variable. The playbook will automatically contact an [EchoIP](https://github.com/mpolden/echoip)-compatible service (`https://ifconfig.co/json` by default) to determine your server's IP address. This API endpoint is configurable via the `matrix_coturn_turn_external_ip_address_auto_detection_echoip_service_url` variable." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:21 +#: ../../../docs/configuring-playbook-turn.md:31 msgid "If your server has multiple external IP addresses, the coturn role offers a different variable for specifying them:" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:28 +#: ../../../docs/configuring-playbook-turn.md:38 msgid "Change the authentication mechanism (optional)" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:30 +#: ../../../docs/configuring-playbook-turn.md:40 msgid "The playbook uses the [`auth-secret` authentication method](https://github.com/coturn/coturn/blob/873cabd6a2e5edd7e9cc5662cac3ffe47fe87a8e/README.turnserver#L186-L199) by default, but you may switch to the [`lt-cred-mech` method](https://github.com/coturn/coturn/blob/873cabd6a2e5edd7e9cc5662cac3ffe47fe87a8e/README.turnserver#L178) which [some report](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3191) to be working better." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:32 +#: ../../../docs/configuring-playbook-turn.md:42 msgid "To do so, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:38 +#: ../../../docs/configuring-playbook-turn.md:48 msgid "Regardless of the selected authentication method, the playbook generates secrets automatically and passes them to the homeserver and coturn." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:40 +#: ../../../docs/configuring-playbook-turn.md:50 msgid "If [Jitsi](configuring-playbook-jitsi.md) is installed, note that switching to `lt-cred-mech` will disable the integration between Jitsi and your coturn server, as Jitsi seems to support the `auth-secret` authentication method only." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:42 +#: ../../../docs/configuring-playbook-turn.md:52 msgid "Use your own external coturn server (optional)" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:44 +#: ../../../docs/configuring-playbook-turn.md:54 msgid "If you'd like to use another TURN server (be it coturn or some other one), add the following configuration to your `vars.yml` file. Make sure to replace `HOSTNAME_OR_IP` with your own." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:58 +#: ../../../docs/configuring-playbook-turn.md:68 msgid "If you have or want to enable Jitsi, you might want to enable the TURN server there too. If you do not do it, Jitsi will fall back to an upstream service." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:65 +#: ../../../docs/configuring-playbook-turn.md:75 msgid "You can put multiple host/port combinations if you'd like to." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:67 -msgid "Extending the configuration" -msgstr "" - -#: ../../../docs/configuring-playbook-turn.md:69 -msgid "There are some additional things you may wish to configure about the TURN server." -msgstr "" - -#: ../../../docs/configuring-playbook-turn.md:71 -msgid "Take a look at:" -msgstr "" - -#: ../../../docs/configuring-playbook-turn.md:73 -msgid "`roles/custom/matrix-coturn/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" -msgstr "" - -#: ../../../docs/configuring-playbook-turn.md:75 -msgid "Disabling coturn" -msgstr "" - #: ../../../docs/configuring-playbook-turn.md:77 -msgid "If, for some reason, you'd like for the playbook to not install coturn (or to uninstall it if it was previously installed), add the following configuration to your `vars.yml` file:" +msgid "Edit the reloading schedule (optional)" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:83 -msgid "In that case, Synapse would not point to any coturn servers and audio/video call functionality may fail." +#: ../../../docs/configuring-playbook-turn.md:79 +msgid "By default the service is reloaded on 6:30 a.m. every day based on the `matrix_coturn_reload_schedule` variable so that new SSL certificates can kick in. It is defined in the format of systemd timer calendar." msgstr "" -#: ../../../docs/configuring-playbook-turn.md:85 -msgid "Installing" +#: ../../../docs/configuring-playbook-turn.md:81 +msgid "To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):" msgstr "" #: ../../../docs/configuring-playbook-turn.md:87 +msgid "**Note**: the actual job may run with a delay. See `matrix_coturn_reload_schedule_randomized_delay_sec` for its default value." +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:89 +msgid "Extending the configuration" +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:91 +msgid "There are some additional things you may wish to configure about the TURN server." +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:93 +msgid "Take a look at:" +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:95 +msgid "`roles/custom/matrix-coturn/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:97 +msgid "Disabling coturn" +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:99 +msgid "If, for some reason, you'd like for the playbook to not install coturn (or to uninstall it if it was previously installed), add the following configuration to your `vars.yml` file:" +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:105 +msgid "In that case, Synapse would not point to any coturn servers and audio/video call functionality may fail." +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:107 +msgid "Installing" +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:109 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:94 +#: ../../../docs/configuring-playbook-turn.md:116 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-turn.md:96 +#: ../../../docs/configuring-playbook-turn.md:118 msgid "`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." msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:120 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/configuring-playbook-turn.md:122 +msgid "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`." +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-user-verification-service.pot b/i18n/translation-templates/docs/configuring-playbook-user-verification-service.pot index ed5328346..ba4f3a01a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-user-verification-service.pot +++ b/i18n/translation-templates/docs/configuring-playbook-user-verification-service.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,214 +16,214 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook-user-verification-service.md:1 +#: ../../../docs/configuring-playbook-user-verification-service.md:8 msgid "Setting up Matrix User Verification Service (optional)" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:3 +#: ../../../docs/configuring-playbook-user-verification-service.md:10 msgid "The playbook can install and configure [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (hereafter: UVS) for you." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:5 +#: ../../../docs/configuring-playbook-user-verification-service.md:12 msgid "See the project's [documentation](https://github.com/matrix-org/matrix-user-verification-service/blob/master/README.md) to learn what it does and why it might be useful to you." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:7 +#: ../../../docs/configuring-playbook-user-verification-service.md:14 msgid "Currently, the main purpose of this role is to allow Jitsi to authenticate Matrix users and check if they are authorized to join a conference. If the Jitsi server is also configured by this playbook, all plugging of variables and secrets is handled in `group_vars/matrix_servers`." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:9 +#: ../../../docs/configuring-playbook-user-verification-service.md:16 msgid "What does it do?" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:11 +#: ../../../docs/configuring-playbook-user-verification-service.md:18 msgid "UVS can be used to verify two claims:" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:13 +#: ../../../docs/configuring-playbook-user-verification-service.md:20 msgid "(A) Whether a given OpenID token is valid for a given server and" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:14 +#: ../../../docs/configuring-playbook-user-verification-service.md:21 msgid "(B) whether a user is member of a given room and the corresponding PowerLevel" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:16 +#: ../../../docs/configuring-playbook-user-verification-service.md:23 msgid "Verifying an OpenID token ID done by finding the corresponding Homeserver via `/.well-known/matrix/server` for the given domain. The configured `matrix_user_verification_service_uvs_homeserver_url` does **not** factor into this. By default, this playbook only checks against `matrix_server_fqn_matrix`. Therefore, the request will be made against the public `openid` API for `matrix_server_fqn_matrix`." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:18 +#: ../../../docs/configuring-playbook-user-verification-service.md:25 msgid "Verifying RoomMembership and PowerLevel is done against `matrix_user_verification_service_uvs_homeserver_url` which is by default done via the docker network. UVS will verify the validity of the token beforehand though." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:20 +#: ../../../docs/configuring-playbook-user-verification-service.md:27 msgid "Prerequisites" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:22 +#: ../../../docs/configuring-playbook-user-verification-service.md:29 msgid "Open Matrix Federation port" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:24 +#: ../../../docs/configuring-playbook-user-verification-service.md:31 msgid "Enabling the UVS service will automatically reconfigure your Synapse homeserver to expose the `openid` API endpoints on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. If you enable the component, make sure that the port is accessible." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:26 +#: ../../../docs/configuring-playbook-user-verification-service.md:33 msgid "Install Matrix services" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:28 +#: ../../../docs/configuring-playbook-user-verification-service.md:35 msgid "UVS can only be installed after Matrix services are installed and running. If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) and come back here later." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:30 +#: ../../../docs/configuring-playbook-user-verification-service.md:37 msgid "Register a dedicated Matrix user (optional, recommended)" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:32 +#: ../../../docs/configuring-playbook-user-verification-service.md:39 msgid "We recommend that you create a dedicated Matrix user for uvs (`uvs` is a good username). **Because UVS requires an access token as an admin user, that user needs to be an admin.**" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:34 +#: ../../../docs/configuring-playbook-user-verification-service.md:41 msgid "Generate a strong password for the user. You can create one with a command like `pwgen -s 64 1`." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:36 +#: ../../../docs/configuring-playbook-user-verification-service.md:43 msgid "You can use the playbook to [register a new user](registering-users.md):" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:42 +#: ../../../docs/configuring-playbook-user-verification-service.md:49 msgid "Obtain an access token" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:44 +#: ../../../docs/configuring-playbook-user-verification-service.md:51 msgid "UVS requires an access token as an admin user to verify RoomMembership and PowerLevel against `matrix_user_verification_service_uvs_homeserver_url`. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:46 +#: ../../../docs/configuring-playbook-user-verification-service.md:53 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:49 +#: ../../../docs/configuring-playbook-user-verification-service.md:56 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:51 +#: ../../../docs/configuring-playbook-user-verification-service.md:58 msgid "To enable UVS, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#obtain-an-access-token)." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:59 +#: ../../../docs/configuring-playbook-user-verification-service.md:66 msgid "In the default configuration, the UVS Server is only reachable via the docker network, which is fine if e.g. Jitsi is also running in a container on the host. However, it is possible to expose UVS via setting `matrix_user_verification_service_container_http_host_bind_port`." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:61 +#: ../../../docs/configuring-playbook-user-verification-service.md:68 msgid "Custom Auth Token (optional)" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:63 +#: ../../../docs/configuring-playbook-user-verification-service.md:70 msgid "It is possible to set an API Auth Token to restrict access to the UVS. If this is enabled, anyone making a request to UVS must provide it via the header `Authorization: Bearer YOUR_TOKEN_HERE`." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:65 +#: ../../../docs/configuring-playbook-user-verification-service.md:72 msgid "By default, the token (`YOUR_TOKEN_HERE`) will be derived from `matrix_homeserver_generic_secret_key` in `group_vars/matrix_servers`." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:67 +#: ../../../docs/configuring-playbook-user-verification-service.md:74 msgid "To set your own token, add the following configuration to your `vars.yml` file. Make sure to replace `YOUR_TOKEN_HERE` with your own." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:73 +#: ../../../docs/configuring-playbook-user-verification-service.md:80 msgid "If a Jitsi instance is also managed by this playbook and [`matrix` authentication](configuring-playbook-jitsi.md#authenticate-using-matrix-openid-auth-type-matrix) is enabled there, this collection will automatically configure Jitsi to use the configured auth token." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:75 +#: ../../../docs/configuring-playbook-user-verification-service.md:82 msgid "Disable Authorization (optional)" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:77 +#: ../../../docs/configuring-playbook-user-verification-service.md:84 msgid "Authorization is enabled by default. To disable it, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:83 +#: ../../../docs/configuring-playbook-user-verification-service.md:90 msgid "Federation (optional)" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:85 +#: ../../../docs/configuring-playbook-user-verification-service.md:92 msgid "In theory (however currently untested), UVS can handle federation. To enable it, add the following configuration to your `vars.yml` file:" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:91 +#: ../../../docs/configuring-playbook-user-verification-service.md:98 msgid "This will instruct UVS to verify the OpenID token against any domain given in a request. Homeserver discovery is done via `.well-known/matrix/server` of the given domain." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:93 +#: ../../../docs/configuring-playbook-user-verification-service.md:100 msgid "Extending the configuration" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:95 +#: ../../../docs/configuring-playbook-user-verification-service.md:102 msgid "There are some additional things you may wish to configure about the component." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:97 +#: ../../../docs/configuring-playbook-user-verification-service.md:104 msgid "Take a look at:" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:99 +#: ../../../docs/configuring-playbook-user-verification-service.md:106 msgid "`roles/custom/matrix-user-verification-service/defaults/main.yml` for some variables that you can customize via your `vars.yml` file" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:101 +#: ../../../docs/configuring-playbook-user-verification-service.md:108 msgid "Installing" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:103 +#: ../../../docs/configuring-playbook-user-verification-service.md:110 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:110 +#: ../../../docs/configuring-playbook-user-verification-service.md:117 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-service matrix-user-verification-service` or `just setup-all`" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:112 +#: ../../../docs/configuring-playbook-user-verification-service.md:119 msgid "`just install-service matrix-user-verification-service` is useful for maintaining your setup quickly 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 `just setup-all` runs the `ensure-matrix-users-created` tag too." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:114 +#: ../../../docs/configuring-playbook-user-verification-service.md:121 msgid "Troubleshooting" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:116 +#: ../../../docs/configuring-playbook-user-verification-service.md:123 msgid "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-user-verification-service`." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:118 +#: ../../../docs/configuring-playbook-user-verification-service.md:125 msgid "Increase logging verbosity" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:120 +#: ../../../docs/configuring-playbook-user-verification-service.md:127 msgid "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:" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:127 +#: ../../../docs/configuring-playbook-user-verification-service.md:134 msgid "TLS Certificate Checking" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:129 +#: ../../../docs/configuring-playbook-user-verification-service.md:136 msgid "If the Matrix Homeserver does not provide a valid TLS certificate, UVS will fail with the following error message:" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:131 +#: ../../../docs/configuring-playbook-user-verification-service.md:138 msgid "message: 'No response received: [object Object]'," msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:133 +#: ../../../docs/configuring-playbook-user-verification-service.md:140 msgid "This also applies to self-signed and Let's Encrypt staging certificates." msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:135 +#: ../../../docs/configuring-playbook-user-verification-service.md:142 msgid "To disable certificate validation altogether (INSECURE! Not suitable for production use!) set: `NODE_TLS_REJECT_UNAUTHORIZED=0`" msgstr "" -#: ../../../docs/configuring-playbook-user-verification-service.md:137 +#: ../../../docs/configuring-playbook-user-verification-service.md:144 msgid "Alternatively, it is possible to inject your own CA certificates into the container by mounting a PEM file with additional trusted CAs into the container and pointing the `NODE_EXTRA_CA_CERTS` environment variable to it." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook.pot b/i18n/translation-templates/docs/configuring-playbook.pot index 0d05eeda4..1c46dc75d 100644 --- a/i18n/translation-templates/docs/configuring-playbook.pot +++ b/i18n/translation-templates/docs/configuring-playbook.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,526 +16,558 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-playbook.md:1 +#: ../../../docs/configuring-playbook.md:17 msgid "Configuring the playbook" msgstr "" -#: ../../../docs/configuring-playbook.md:3 -msgid "[Prerequisites](prerequisites.md) > [Configuring your DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:5 -msgid "If you've configured your DNS records and retrieved the playbook's source code to your computer, you can start configuring the playbook. To do so, follow these steps inside the playbook directory:" -msgstr "" - -#: ../../../docs/configuring-playbook.md:7 -msgid "create a directory to hold your configuration (`mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your \"base domain\")" -msgstr "" - -#: ../../../docs/configuring-playbook.md:9 -msgid "copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:11 -msgid "edit the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) to your liking. You may also take a look at the various `roles/*/ROLE_NAME_HERE/defaults/main.yml` files and see if there's something you'd like to copy over and override in your `vars.yml` configuration file." -msgstr "" - -#: ../../../docs/configuring-playbook.md:13 -msgid "copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:15 -msgid "edit the inventory hosts file (`inventory/hosts`) to your liking" -msgstr "" - -#: ../../../docs/configuring-playbook.md:17 -msgid "(optional, advanced) you may wish to keep your `inventory` directory under version control with [git](https://git-scm.com/) or any other version-control system." -msgstr "" - #: ../../../docs/configuring-playbook.md:19 -msgid "(optional, advanced) to run Ansible against multiple servers with different `sudo` credentials, you can copy the sample inventory hosts yaml file for each of your hosts: (`cp examples/host.yml inventory/my_host1.yml` …) and use the [`ansible-all-hosts.sh`](../bin/ansible-all-hosts.sh) script [in the installation step](installing.md)." +msgid "[Prerequisites](prerequisites.md) > [Configuring DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > Configuring the playbook > [Installing](installing.md)" msgstr "" #: ../../../docs/configuring-playbook.md:21 -msgid "For a basic Matrix installation, that's all you need." +msgid "If you've configured your DNS records and retrieved the playbook's source code to your computer, you can start configuring the playbook. To do so, follow these steps inside the playbook directory:" msgstr "" #: ../../../docs/configuring-playbook.md:23 -msgid "For a more custom setup, see the [Other configuration options](#other-configuration-options) below." +msgid "create a directory to hold your configuration (`mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your \"base domain\")" msgstr "" #: ../../../docs/configuring-playbook.md:25 -msgid "[▶️](installing.md) When you're done with all the configuration you'd like to do, continue with [Installing](installing.md)." +msgid "copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`)" msgstr "" #: ../../../docs/configuring-playbook.md:27 -msgid "Other configuration options" +msgid "edit the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) to your liking. You may also take a look at the various `roles/*/ROLE_NAME_HERE/defaults/main.yml` files (after importing external roles with `just update` into `roles/galaxy`) and see if there's something you'd like to copy over and override in your `vars.yml` configuration file." msgstr "" #: ../../../docs/configuring-playbook.md:29 -msgid "**Note**: some of the roles like one for integrating Etherpad or Jitsi are managed by their own repositories, and the configuration files for them cannot be found locally (in `roles/galaxy`) until those roles are fetched from the upstream projects. Check [requirements.yml](../requirements.yml) for the URLs of those roles." +msgid "copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)" msgstr "" #: ../../../docs/configuring-playbook.md:31 -msgid "Core service adjustments" +msgid "edit the inventory hosts file (`inventory/hosts`) to your liking" msgstr "" #: ../../../docs/configuring-playbook.md:33 -msgid "Homeserver configuration:" +msgid "(optional, advanced) you may wish to keep your `inventory` directory under version control with [git](https://git-scm.com/) or any other version-control system. The `inventory` directory path is ignored via `.gitignore`, so it won't be part of the playbook repository. You can safely create a new git repository inside that directory with `git init`, etc." msgstr "" -#: ../../../docs/configuring-playbook.md:34 -msgid "[Configuring Synapse](configuring-playbook-synapse.md), if you're going with the default/recommended homeserver implementation" +#: ../../../docs/configuring-playbook.md:35 +msgid "(optional, advanced) to run Ansible against multiple servers with different `sudo` credentials, you can copy the sample inventory hosts yaml file for each of your hosts: (`cp examples/host.yml inventory/my_host1.yml` …) and use the [`ansible-all-hosts.sh`](../bin/ansible-all-hosts.sh) script [in the installation step](installing.md)." msgstr "" -#: ../../../docs/configuring-playbook.md:36 -msgid "[Configuring Conduit](configuring-playbook-conduit.md), if you've switched to the [Conduit](https://conduit.rs) homeserver implementation" +#: ../../../docs/configuring-playbook.md:37 +msgid "For a basic Matrix installation, that's all you need." msgstr "" -#: ../../../docs/configuring-playbook.md:38 -msgid "[Configuring conduwuit](configuring-playbook-conduwuit.md), if you've switched to the [conduwuit](https://conduwuit.puppyirl.gay/) homeserver implementation" +#: ../../../docs/configuring-playbook.md:39 +msgid "For a more custom setup, see the [Other configuration options](#other-configuration-options) below." msgstr "" -#: ../../../docs/configuring-playbook.md:40 -msgid "[Configuring Dendrite](configuring-playbook-dendrite.md), if you've switched to the [Dendrite](https://matrix-org.github.io/dendrite) homeserver implementation" -msgstr "" - -#: ../../../docs/configuring-playbook.md:42 -msgid "Server components:" +#: ../../../docs/configuring-playbook.md:41 +msgid "[▶️](installing.md) When you're done with all the configuration you'd like to do, continue with [Installing](installing.md)." msgstr "" #: ../../../docs/configuring-playbook.md:43 -msgid "[Using an external PostgreSQL server](configuring-playbook-external-postgres.md)" +msgid "Other configuration options" msgstr "" #: ../../../docs/configuring-playbook.md:45 -msgid "[Configuring a TURN server](configuring-playbook-turn.md) (advanced)" +msgid "**Note**: some of the roles like one for integrating Etherpad or Jitsi are managed by their own repositories, and the configuration files for them cannot be found locally (in `roles/galaxy`) until those roles are fetched from the upstream projects. Check [requirements.yml](../requirements.yml) for the URLs of those roles." msgstr "" #: ../../../docs/configuring-playbook.md:47 -msgid "[Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced)" +msgid "Core service adjustments" msgstr "" #: ../../../docs/configuring-playbook.md:49 -msgid "[Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (advanced)" +msgid "Homeserver configuration:" msgstr "" -#: ../../../docs/configuring-playbook.md:51 -msgid "[Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (advanced)" +#: ../../../docs/configuring-playbook.md:50 +msgid "[Configuring Synapse](configuring-playbook-synapse.md), if you're going with the default/recommended homeserver implementation" msgstr "" -#: ../../../docs/configuring-playbook.md:53 -msgid "[Adjusting email-sending settings](configuring-playbook-email.md)" +#: ../../../docs/configuring-playbook.md:52 +msgid "[Configuring Conduit](configuring-playbook-conduit.md), if you've switched to the [Conduit](https://conduit.rs) homeserver implementation" msgstr "" -#: ../../../docs/configuring-playbook.md:55 -msgid "[Setting up ma1sd Identity Server](configuring-playbook-ma1sd.md)" +#: ../../../docs/configuring-playbook.md:54 +msgid "[Configuring conduwuit](configuring-playbook-conduwuit.md), if you've switched to the [conduwuit](https://conduwuit.puppyirl.gay/) homeserver implementation" msgstr "" -#: ../../../docs/configuring-playbook.md:57 -msgid "[Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md)" +#: ../../../docs/configuring-playbook.md:56 +msgid "[Configuring continuwuity](configuring-playbook-continuwuity.md), if you've switched to the [continuwuity](https://continuwuity.org) homeserver implementation" msgstr "" -#: ../../../docs/configuring-playbook.md:59 -msgid "Server connectivity:" +#: ../../../docs/configuring-playbook.md:58 +msgid "[Configuring Dendrite](configuring-playbook-dendrite.md), if you've switched to the [Dendrite](https://matrix-org.github.io/dendrite) homeserver implementation" msgstr "" #: ../../../docs/configuring-playbook.md:60 -msgid "[Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md)" +msgid "Server components:" msgstr "" -#: ../../../docs/configuring-playbook.md:62 -msgid "[Controlling Matrix federation](configuring-playbook-federation.md)" +#: ../../../docs/configuring-playbook.md:61 +msgid "[Using an external PostgreSQL server](configuring-playbook-external-postgres.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:64 -msgid "Clients" +#: ../../../docs/configuring-playbook.md:63 +msgid "[Configuring a TURN server](configuring-playbook-turn.md) (advanced)" msgstr "" -#: ../../../docs/configuring-playbook.md:66 -msgid "Web clients for Matrix that you can host on your own domains." +#: ../../../docs/configuring-playbook.md:65 +msgid "[Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced)" msgstr "" -#: ../../../docs/configuring-playbook.md:68 -msgid "[Configuring Element Web](configuring-playbook-client-element-web.md), if you're going with the default/recommended client" +#: ../../../docs/configuring-playbook.md:67 +msgid "[Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (advanced)" msgstr "" -#: ../../../docs/configuring-playbook.md:70 -msgid "[Setting up Hydrogen](configuring-playbook-client-hydrogen.md), if you've enabled [Hydrogen](https://github.com/element-hq/hydrogen-web), a lightweight Matrix client with legacy and mobile browser support" +#: ../../../docs/configuring-playbook.md:69 +msgid "[Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (advanced)" msgstr "" -#: ../../../docs/configuring-playbook.md:72 -msgid "[Setting up Cinny](configuring-playbook-client-cinny.md), if you've enabled [Cinny](https://github.com/ajbura/cinny), a web client focusing primarily on simple, elegant and secure interface" +#: ../../../docs/configuring-playbook.md:71 +msgid "[Adjusting email-sending settings](configuring-playbook-email.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:74 -msgid "[Setting up SchildiChat Web](configuring-playbook-client-schildichat-web.md), if you've enabled [SchildiChat Web](https://schildi.chat/), a web client based on [Element Web](https://element.io/) with some extras and tweaks" +#: ../../../docs/configuring-playbook.md:73 +msgid "[Setting up ma1sd Identity Server](configuring-playbook-ma1sd.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:76 -msgid "Authentication and user-related" +#: ../../../docs/configuring-playbook.md:75 +msgid "[Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:77 +msgid "Server connectivity:" msgstr "" #: ../../../docs/configuring-playbook.md:78 -msgid "Extend and modify how users are authenticated on your homeserver." +msgid "[Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md)" msgstr "" #: ../../../docs/configuring-playbook.md:80 -msgid "[Setting up Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (Next-generation auth for Matrix, based on OAuth 2.0/OIDC)" +msgid "[Controlling Matrix federation](configuring-playbook-federation.md)" msgstr "" #: ../../../docs/configuring-playbook.md:82 -msgid "[Setting up Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md)" +msgid "[Configuring IPv6](./configuring-ipv6.md)" msgstr "" #: ../../../docs/configuring-playbook.md:84 -msgid "[Setting up Synapse Admin](configuring-playbook-synapse-admin.md)" +msgid "Clients" msgstr "" #: ../../../docs/configuring-playbook.md:86 -msgid "[Setting up matrix-registration](configuring-playbook-matrix-registration.md)" +msgid "Web clients for Matrix that you can host on your own domains." msgstr "" #: ../../../docs/configuring-playbook.md:88 -msgid "[Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (advanced)" +msgid "[Configuring Element Web](configuring-playbook-client-element-web.md), if you're going with the default/recommended client" msgstr "" #: ../../../docs/configuring-playbook.md:90 -msgid "[Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (advanced)" +msgid "[Setting up Hydrogen](configuring-playbook-client-hydrogen.md), if you've enabled [Hydrogen](https://github.com/element-hq/hydrogen-web), a lightweight Matrix client with legacy and mobile browser support" msgstr "" #: ../../../docs/configuring-playbook.md:92 -msgid "[Setting up the LDAP authentication password provider module](configuring-playbook-ldap-auth.md) (advanced)" +msgid "[Setting up Cinny](configuring-playbook-client-cinny.md), if you've enabled [Cinny](https://github.com/ajbura/cinny), a web client focusing primarily on simple, elegant and secure interface" msgstr "" #: ../../../docs/configuring-playbook.md:94 -msgid "[Setting up matrix-ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) (advanced)" +msgid "[Setting up SchildiChat Web](configuring-playbook-client-schildichat-web.md), if you've enabled [SchildiChat Web](https://schildi.chat/), a web client based on [Element Web](https://element.io/) with some extras and tweaks" msgstr "" #: ../../../docs/configuring-playbook.md:96 +msgid "[Setting up FluffyChat Web](configuring-playbook-client-fluffychat-web.md), if you've enabled [FluffyChat Web](https://github.com/krille-chan/fluffychat), a cute cross-platform messenger (web, iOS, Android) for Matrix written in [Flutter](https://flutter.dev/)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:99 +msgid "Authentication and user-related" +msgstr "" + +#: ../../../docs/configuring-playbook.md:101 +msgid "Extend and modify how users are authenticated on your homeserver." +msgstr "" + +#: ../../../docs/configuring-playbook.md:103 +msgid "[Setting up Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (Next-generation auth for Matrix, based on OAuth 2.0/OIDC)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:105 +msgid "[Setting up Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:107 +msgid "[Setting up Synapse Admin](configuring-playbook-synapse-admin.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:109 +msgid "[Setting up matrix-registration](configuring-playbook-matrix-registration.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:111 +msgid "[Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (advanced)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:113 +msgid "[Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (advanced)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:115 +msgid "[Setting up the LDAP authentication password provider module](configuring-playbook-ldap-auth.md) (advanced)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:117 +msgid "[Setting up matrix-ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) (advanced)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:119 msgid "[Setting up Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.md) (advanced)" msgstr "" -#: ../../../docs/configuring-playbook.md:98 +#: ../../../docs/configuring-playbook.md:121 msgid "[Setting up Matrix User Verification Service](configuring-playbook-user-verification-service.md) (advanced)" msgstr "" -#: ../../../docs/configuring-playbook.md:100 +#: ../../../docs/configuring-playbook.md:123 msgid "File Storage" msgstr "" -#: ../../../docs/configuring-playbook.md:102 +#: ../../../docs/configuring-playbook.md:125 msgid "Use alternative file storage to the default `media_store` folder." msgstr "" -#: ../../../docs/configuring-playbook.md:104 -msgid "[Storing Matrix media files on Amazon S3 with Goofys](configuring-playbook-s3-goofys.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:106 -msgid "[Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:108 +#: ../../../docs/configuring-playbook.md:127 msgid "[Storing Matrix media files using matrix-media-repo](configuring-playbook-matrix-media-repo.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:110 +#: ../../../docs/configuring-playbook.md:129 +msgid "[Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:131 +msgid "[Storing Synapse media files on Amazon S3 with Goofys](configuring-playbook-s3-goofys.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:133 +msgid "[Storing Synapse media files on Amazon S3 with synapse-s3-storage-provider](configuring-playbook-synapse-s3-storage-provider.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:135 msgid "Bridging other networks" msgstr "" -#: ../../../docs/configuring-playbook.md:112 +#: ../../../docs/configuring-playbook.md:137 msgid "Bridges can be used to connect your Matrix installation with third-party communication networks." msgstr "" -#: ../../../docs/configuring-playbook.md:114 +#: ../../../docs/configuring-playbook.md:139 msgid "[Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md) — a common guide for configuring mautrix bridges" msgstr "" -#: ../../../docs/configuring-playbook.md:116 +#: ../../../docs/configuring-playbook.md:141 +msgid "[Setting up Mautrix Bluesky bridging](configuring-playbook-bridge-mautrix-bluesky.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:143 msgid "[Setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:118 +#: ../../../docs/configuring-playbook.md:145 msgid "[Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:120 +#: ../../../docs/configuring-playbook.md:147 msgid "[Setting up Mautrix Slack bridging](configuring-playbook-bridge-mautrix-slack.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:122 +#: ../../../docs/configuring-playbook.md:149 msgid "[Setting up Mautrix Google Messages bridging](configuring-playbook-bridge-mautrix-gmessages.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:124 +#: ../../../docs/configuring-playbook.md:151 msgid "[Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:126 +#: ../../../docs/configuring-playbook.md:153 msgid "[Setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:128 +#: ../../../docs/configuring-playbook.md:155 msgid "[Setting up Messenger bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-messenger.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:130 +#: ../../../docs/configuring-playbook.md:157 msgid "[Setting up Mautrix Google Chat bridging](configuring-playbook-bridge-mautrix-googlechat.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:132 +#: ../../../docs/configuring-playbook.md:159 msgid "[Setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:134 +#: ../../../docs/configuring-playbook.md:161 msgid "[Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:136 +#: ../../../docs/configuring-playbook.md:163 msgid "[Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage](configuring-playbook-bridge-mautrix-wsproxy.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:138 +#: ../../../docs/configuring-playbook.md:165 msgid "[Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:140 +#: ../../../docs/configuring-playbook.md:167 msgid "[Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:142 +#: ../../../docs/configuring-playbook.md:169 msgid "[Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:144 +#: ../../../docs/configuring-playbook.md:171 msgid "[Setting up Appservice Kakaotalk bridging](configuring-playbook-bridge-appservice-kakaotalk.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:146 +#: ../../../docs/configuring-playbook.md:173 msgid "[Setting up Beeper LinkedIn bridging](configuring-playbook-bridge-beeper-linkedin.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:148 +#: ../../../docs/configuring-playbook.md:175 msgid "[Setting up matrix-hookshot](configuring-playbook-bridge-hookshot.md) — a bridge between Matrix and multiple project management services, such as [GitHub](https://github.com), [GitLab](https://about.gitlab.com) and [JIRA](https://www.atlassian.com/software/jira)." msgstr "" -#: ../../../docs/configuring-playbook.md:150 -msgid "[Setting up MX Puppet Slack bridging](configuring-playbook-bridge-mx-puppet-slack.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:152 -msgid "[Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:154 -msgid "[Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:156 -msgid "[Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:158 +#: ../../../docs/configuring-playbook.md:177 msgid "[Setting up MX Puppet GroupMe bridging](configuring-playbook-bridge-mx-puppet-groupme.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:160 +#: ../../../docs/configuring-playbook.md:179 +msgid "[Setting up Steam bridging](configuring-playbook-bridge-steam.md)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:181 msgid "[Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:162 -msgid "[Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:164 +#: ../../../docs/configuring-playbook.md:183 msgid "[Setting up Postmoogle email bridging](configuring-playbook-bridge-postmoogle.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:166 +#: ../../../docs/configuring-playbook.md:185 msgid "[Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:168 +#: ../../../docs/configuring-playbook.md:187 msgid "[Setting up Heisenbridge bouncer-style IRC bridging](configuring-playbook-bridge-heisenbridge.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:170 +#: ../../../docs/configuring-playbook.md:189 msgid "[Setting up WeChat bridging](configuring-playbook-bridge-wechat.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:172 +#: ../../../docs/configuring-playbook.md:191 msgid "Bots" msgstr "" -#: ../../../docs/configuring-playbook.md:174 +#: ../../../docs/configuring-playbook.md:193 msgid "Bots provide various additional functionality to your installation." msgstr "" -#: ../../../docs/configuring-playbook.md:176 +#: ../../../docs/configuring-playbook.md:195 msgid "[Setting up baibot](configuring-playbook-bot-baibot.md) — a bot through which you can talk to various [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) services ([OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) and [others](https://github.com/etkecc/baibot/blob/main/docs/providers.md))" msgstr "" -#: ../../../docs/configuring-playbook.md:178 +#: ../../../docs/configuring-playbook.md:197 msgid "[Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) — a bot to remind you about stuff" msgstr "" -#: ../../../docs/configuring-playbook.md:180 +#: ../../../docs/configuring-playbook.md:199 msgid "[Setting up matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md) — a bot to create and manage registration tokens to invite users" msgstr "" -#: ../../../docs/configuring-playbook.md:182 +#: ../../../docs/configuring-playbook.md:201 msgid "[Setting up maubot](configuring-playbook-bot-maubot.md) — a plugin-based Matrix bot system" msgstr "" -#: ../../../docs/configuring-playbook.md:184 +#: ../../../docs/configuring-playbook.md:203 msgid "[Setting up Honoroit](configuring-playbook-bot-honoroit.md) — a helpdesk bot" msgstr "" -#: ../../../docs/configuring-playbook.md:186 +#: ../../../docs/configuring-playbook.md:205 msgid "[Setting up Mjolnir](configuring-playbook-bot-mjolnir.md) — a moderation tool/bot" msgstr "" -#: ../../../docs/configuring-playbook.md:188 +#: ../../../docs/configuring-playbook.md:207 msgid "[Setting up Draupnir](configuring-playbook-bot-draupnir.md) — a moderation tool/bot, forked from Mjolnir and maintained by its former leader developer" msgstr "" -#: ../../../docs/configuring-playbook.md:190 +#: ../../../docs/configuring-playbook.md:209 msgid "[Setting up Draupnir for all/D4A](configuring-playbook-appservice-draupnir-for-all.md) — like the [Draupnir bot](configuring-playbook-bot-draupnir.md) mentioned above, but running in appservice mode and supporting multiple instances" msgstr "" -#: ../../../docs/configuring-playbook.md:192 +#: ../../../docs/configuring-playbook.md:211 msgid "[Setting up Buscarron](configuring-playbook-bot-buscarron.md) — a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room" msgstr "" -#: ../../../docs/configuring-playbook.md:194 +#: ../../../docs/configuring-playbook.md:213 msgid "Administration" msgstr "" -#: ../../../docs/configuring-playbook.md:196 +#: ../../../docs/configuring-playbook.md:215 msgid "Services that help you in administrating and monitoring your Matrix installation." msgstr "" -#: ../../../docs/configuring-playbook.md:198 +#: ../../../docs/configuring-playbook.md:217 msgid "[Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:200 +#: ../../../docs/configuring-playbook.md:219 msgid "[Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:202 -msgid "[Enabling metrics and graphs for NginX logs](configuring-playbook-prometheus-nginxlog.md)" -msgstr "" - -#: ../../../docs/configuring-playbook.md:204 +#: ../../../docs/configuring-playbook.md:221 msgid "[Setting up the rageshake bug report server](configuring-playbook-rageshake.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:206 +#: ../../../docs/configuring-playbook.md:223 msgid "[Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:208 +#: ../../../docs/configuring-playbook.md:225 msgid "Backups:" msgstr "" -#: ../../../docs/configuring-playbook.md:209 +#: ../../../docs/configuring-playbook.md:226 msgid "[Setting up BorgBackup](configuring-playbook-backup-borg.md) — a full Matrix server backup solution, including the Postgres database" msgstr "" -#: ../../../docs/configuring-playbook.md:211 -msgid "[Setting up postgres backup](configuring-playbook-postgres-backup.md) — a Postgres-database backup solution (note: does not include other files)" +#: ../../../docs/configuring-playbook.md:228 +msgid "[Setting up Postgres backup](configuring-playbook-postgres-backup.md) — a Postgres-database backup solution (note: does not include other files)" msgstr "" -#: ../../../docs/configuring-playbook.md:213 +#: ../../../docs/configuring-playbook.md:230 msgid "Other specialized services" msgstr "" -#: ../../../docs/configuring-playbook.md:215 +#: ../../../docs/configuring-playbook.md:232 msgid "Various services that don't fit any other categories." msgstr "" -#: ../../../docs/configuring-playbook.md:217 +#: ../../../docs/configuring-playbook.md:234 +msgid "[Setting up Element Call](configuring-playbook-element-call.md) — a native Matrix video conferencing application, built on top of the [Matrix RTC stack](configuring-playbook-matrix-rtc.md) (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:236 +msgid "[Setting up LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md) - a component of the [Matrix RTC stack](configuring-playbook-matrix-rtc.md) (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:238 +msgid "[Setting up LiveKit Server](configuring-playbook-livekit-server.md) - a component of the [Matrix RTC stack](configuring-playbook-matrix-rtc.md) (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:240 +msgid "[Setting up Matrix RTC](configuring-playbook-matrix-rtc.md) (optional)" +msgstr "" + +#: ../../../docs/configuring-playbook.md:242 msgid "[Setting up Synapse Auto Invite Accept](configuring-playbook-synapse-auto-accept-invite.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:219 +#: ../../../docs/configuring-playbook.md:244 msgid "[Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md) for compressing the database on Synapse homeservers" msgstr "" -#: ../../../docs/configuring-playbook.md:221 +#: ../../../docs/configuring-playbook.md:246 msgid "[Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced)" msgstr "" -#: ../../../docs/configuring-playbook.md:223 +#: ../../../docs/configuring-playbook.md:248 msgid "[Setting up Etherpad](configuring-playbook-etherpad.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:225 +#: ../../../docs/configuring-playbook.md:250 msgid "[Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:227 +#: ../../../docs/configuring-playbook.md:252 msgid "[Setting up Cactus Comments](configuring-playbook-cactus-comments.md) — a federated comment system built on Matrix" msgstr "" -#: ../../../docs/configuring-playbook.md:229 +#: ../../../docs/configuring-playbook.md:254 msgid "[Setting up Pantalaimon (E2EE aware proxy daemon)](configuring-playbook-pantalaimon.md) (advanced)" msgstr "" -#: ../../../docs/configuring-playbook.md:231 +#: ../../../docs/configuring-playbook.md:256 msgid "[Setting up the Sygnal push gateway](configuring-playbook-sygnal.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:233 +#: ../../../docs/configuring-playbook.md:258 msgid "[Setting up the ntfy push notifications server](configuring-playbook-ntfy.md)" msgstr "" -#: ../../../docs/configuring-playbook.md:235 +#: ../../../docs/configuring-playbook.md:260 msgid "Deprecated / unmaintained / removed services" msgstr "" -#: ../../../docs/configuring-playbook.md:237 +#: ../../../docs/configuring-playbook.md:262 msgid "**Note**: since a deprecated or unmaintained service will not be updated, its bug or vulnerability will be unlikely to get patched. It is recommended to migrate from the service to an alternative if any, and make sure to do your own research before you decide to keep it running nonetheless." msgstr "" -#: ../../../docs/configuring-playbook.md:239 +#: ../../../docs/configuring-playbook.md:264 msgid "[Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like old Element X versions, before it got switched to Simplified Sliding Sync)" msgstr "" -#: ../../../docs/configuring-playbook.md:241 -msgid "[Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.md) (deprecated; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md))" +#: ../../../docs/configuring-playbook.md:266 +msgid "[Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.md) (deprecated; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md))" msgstr "" -#: ../../../docs/configuring-playbook.md:243 +#: ../../../docs/configuring-playbook.md:268 msgid "[Setting up the Dimension integration manager](configuring-playbook-dimension.md) ([unmaintained](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806#issuecomment-1673559299); after [installing](installing.md))" msgstr "" -#: ../../../docs/configuring-playbook.md:245 -msgid "[Setting up Email2Matrix](configuring-playbook-email2matrix.md) (unmaintained; the author suggests taking a look at [Postmoogle](https://github.com/etkecc/postmoogle) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-postmoogle.md))" +#: ../../../docs/configuring-playbook.md:270 +msgid "[Setting up Email2Matrix](configuring-playbook-email2matrix.md) (removed; the author suggests taking a look at [Postmoogle](https://github.com/etkecc/postmoogle) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-postmoogle.md))" msgstr "" -#: ../../../docs/configuring-playbook.md:247 -msgid "[Setting up Go-NEB](configuring-playbook-bot-go-neb.md) (unmaintained; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md))" +#: ../../../docs/configuring-playbook.md:272 +msgid "[Setting up Go-NEB](configuring-playbook-bot-go-neb.md) (unmaintained; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md))" msgstr "" -#: ../../../docs/configuring-playbook.md:249 -msgid "[Setting up matrix-bot-chatgpt](configuring-playbook-bot-chatgpt.md) (unmaintained; the bridge's author suggests taking a look at [baibot](https://github.com/etkecc/baibot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bot-baibot.md))" +#: ../../../docs/configuring-playbook.md:274 +msgid "[Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md) (removed; Skype has been discontinued since May 2025)" msgstr "" -#: ../../../docs/configuring-playbook.md:251 +#: ../../../docs/configuring-playbook.md:276 +msgid "[Setting up matrix-bot-chatgpt](configuring-playbook-bot-chatgpt.md) (unmaintained; the bridge's author suggests taking a look at [baibot](https://github.com/etkecc/baibot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bot-baibot.md))" +msgstr "" + +#: ../../../docs/configuring-playbook.md:278 msgid "[Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-messenger](configuring-playbook-bridge-mautrix-meta-messenger.md))" msgstr "" -#: ../../../docs/configuring-playbook.md:253 -msgid "[Setting up Mautrix Hangouts bridging](configuring-playbook-bridge-mautrix-hangouts.md) (deprecated in favor of the Google Chat bridge with [mautrix-googlechat](configuring-playbook-bridge-mautrix-googlechat.md))" -msgstr "" - -#: ../../../docs/configuring-playbook.md:255 +#: ../../../docs/configuring-playbook.md:280 msgid "[Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-instagram](configuring-playbook-bridge-mautrix-meta-instagram.md))" msgstr "" -#: ../../../docs/configuring-playbook.md:257 +#: ../../../docs/configuring-playbook.md:282 +msgid "[Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md))" +msgstr "" + +#: ../../../docs/configuring-playbook.md:284 +msgid "[Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md))" +msgstr "" + +#: ../../../docs/configuring-playbook.md:286 msgid "[Setting up MX Puppet Skype bridging](configuring-playbook-bridge-mx-puppet-skype.md) (removed; this component has been broken for a long time, so it has been removed from the playbook. Consider [setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md))" msgstr "" + +#: ../../../docs/configuring-playbook.md:288 +msgid "[Setting up MX Puppet Slack bridging](configuring-playbook-bridge-mx-puppet-slack.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Mautrix Slack bridging](configuring-playbook-bridge-mautrix-slack.md))" +msgstr "" + +#: ../../../docs/configuring-playbook.md:290 +msgid "[Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md))" +msgstr "" diff --git a/i18n/translation-templates/docs/configuring-well-known.pot b/i18n/translation-templates/docs/configuring-well-known.pot index 39428a23e..7ce9d69db 100644 --- a/i18n/translation-templates/docs/configuring-well-known.pot +++ b/i18n/translation-templates/docs/configuring-well-known.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,238 +16,238 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/configuring-well-known.md:1 +#: ../../../docs/configuring-well-known.md:14 msgid "Configuring Service Discovery via .well-known" msgstr "" -#: ../../../docs/configuring-well-known.md:3 +#: ../../../docs/configuring-well-known.md:16 msgid "This documentation page explains how to configure Service discovery via `/.well-known/` files. Service discovery is a way for the Matrix network to discover where a Matrix server is." msgstr "" -#: ../../../docs/configuring-well-known.md:5 +#: ../../../docs/configuring-well-known.md:18 msgid "Types of well-known service discovery mechanism" msgstr "" -#: ../../../docs/configuring-well-known.md:7 +#: ../../../docs/configuring-well-known.md:20 msgid "There are 3 types of well-known service discovery mechanism that Matrix makes use of:" msgstr "" -#: ../../../docs/configuring-well-known.md:9 +#: ../../../docs/configuring-well-known.md:22 msgid "(important) **Federation Server discovery** (`/.well-known/matrix/server`) — assists other servers in the Matrix network with finding your server. With the default playbook configuration specified on the sample `vars.yml` ([`examples/vars.yml`](../examples/vars.yml)), this is necessary for federation to work. Without a proper configuration, your server will effectively not be part of the Matrix network." msgstr "" -#: ../../../docs/configuring-well-known.md:11 +#: ../../../docs/configuring-well-known.md:24 msgid "(less important) **Client Server discovery** (`/.well-known/matrix/client`) — assists programs that you use to connect to your server (e.g. Element Web), so that they can make it more convenient for you by automatically configuring the \"Homeserver URL\" and \"Identity Server URL\" addresses." msgstr "" -#: ../../../docs/configuring-well-known.md:13 +#: ../../../docs/configuring-well-known.md:26 msgid "(optional) **Support service discovery** (`/.well-known/matrix/support`) — returns server admin contact and support page of the domain." msgstr "" -#: ../../../docs/configuring-well-known.md:15 +#: ../../../docs/configuring-well-known.md:28 msgid "Federation Server Discovery" msgstr "" -#: ../../../docs/configuring-well-known.md:17 +#: ../../../docs/configuring-well-known.md:30 msgid "All services created by this playbook are meant to be installed on their own server (such as `matrix.example.com`), instead of the base domain (`example.com`)." msgstr "" -#: ../../../docs/configuring-well-known.md:19 +#: ../../../docs/configuring-well-known.md:32 msgid "As [per the Server-Server specification](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), in order to use a short Matrix user ID like `@alice:example.com` instead of `@alice:matrix.example.com` while hosting services on a subdomain such as `matrix.example.com`, the Matrix network needs to be instructed of [server delegation](howto-server-delegation.md) / redirection." msgstr "" -#: ../../../docs/configuring-well-known.md:21 +#: ../../../docs/configuring-well-known.md:34 msgid "For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file." msgstr "" -#: ../../../docs/configuring-well-known.md:23 +#: ../../../docs/configuring-well-known.md:36 msgid "If you set up the DNS SRV record for server delegation instead, take a look at this documentation for more information: [Server Delegation via a DNS SRV record (advanced)](howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced)" msgstr "" -#: ../../../docs/configuring-well-known.md:25 +#: ../../../docs/configuring-well-known.md:38 msgid "Client Server Discovery" msgstr "" -#: ../../../docs/configuring-well-known.md:27 +#: ../../../docs/configuring-well-known.md:40 msgid "Client Server Service discovery lets various client programs which support it, to receive a full user ID (e.g. `@alice:example.com`) and determine where the Matrix server is automatically (e.g. `https://matrix.example.com`)." msgstr "" -#: ../../../docs/configuring-well-known.md:29 +#: ../../../docs/configuring-well-known.md:42 msgid "This lets you (and your users) easily connect to your Matrix server without having to customize connection URLs. When using client programs that support it, you won't need to point them to `https://matrix.example.com` in Custom Server options manually anymore. The connection URL would be discovered automatically from your full username." msgstr "" -#: ../../../docs/configuring-well-known.md:31 +#: ../../../docs/configuring-well-known.md:44 msgid "Without /.well-known/matrix/client, the client will make the wrong \"homeserver URL\" assumption (it will default to using https://example.com, and users will need to notice and adjust it manually (changing it to https://matrix.example.com)." msgstr "" -#: ../../../docs/configuring-well-known.md:33 +#: ../../../docs/configuring-well-known.md:46 msgid "As [per the Client-Server specification](https://matrix.org/docs/spec/client_server/r0.4.0.html#server-discovery) Matrix does Client Server service discovery using a `/.well-known/matrix/client` file hosted on the base domain (e.g. `example.com`)." msgstr "" -#: ../../../docs/configuring-well-known.md:35 +#: ../../../docs/configuring-well-known.md:48 msgid "However, this playbook installs your Matrix server on another domain (e.g. `matrix.example.com`) and not on the base domain (e.g. `example.com`), so it takes a little extra manual effort to set up the file." msgstr "" -#: ../../../docs/configuring-well-known.md:37 +#: ../../../docs/configuring-well-known.md:50 msgid "Support Service Discovery (optional)" msgstr "" -#: ../../../docs/configuring-well-known.md:39 +#: ../../../docs/configuring-well-known.md:52 msgid "[MSC 1929](https://github.com/matrix-org/matrix-spec-proposals/pull/1929), which was added to [Matrix Specification version v1.10](https://spec.matrix.org/v1.10/client-server-api/#getwell-knownmatrixsupport), specifies a way to add contact details of admins, as well as a link to a support page for users who are having issues with the service. Automated services may also index this information and use it for abuse reports, etc." msgstr "" -#: ../../../docs/configuring-well-known.md:41 +#: ../../../docs/configuring-well-known.md:54 msgid "To enable it, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/configuring-well-known.md:62 +#: ../../../docs/configuring-well-known.md:75 msgid "Installing well-known files on the base domain's server" msgstr "" -#: ../../../docs/configuring-well-known.md:64 +#: ../../../docs/configuring-well-known.md:77 msgid "To implement the service discovery mechanisms, your base domain's server (e.g. `example.com`) needs to run an HTTPS-capable webserver." msgstr "" -#: ../../../docs/configuring-well-known.md:66 +#: ../../../docs/configuring-well-known.md:79 msgid "Serving the base domain from the Matrix server via the playbook" msgstr "" -#: ../../../docs/configuring-well-known.md:68 +#: ../../../docs/configuring-well-known.md:81 msgid "If you don't have a server for your base domain at all, you can use the Matrix server for this. If you don't need the base domain (e.g. `example.com`) for anything else (hosting a website, etc.), you can point it to the Matrix server's IP address and tell the playbook to configure it." msgstr "" -#: ../../../docs/configuring-well-known.md:70 +#: ../../../docs/configuring-well-known.md:83 msgid "**This is the easiest way to set up well-known serving** — letting the playbook handle the whole base domain for you (including SSL certificates, etc.) and take care to serve the appropriate well-known files automatically." msgstr "" -#: ../../../docs/configuring-well-known.md:72 +#: ../../../docs/configuring-well-known.md:85 msgid "If you decide to go this route, you don't need to read ahead in this document. Instead, go to [Serving the base domain](configuring-playbook-base-domain-serving.md) to learn how the playbook can help you set it up." msgstr "" -#: ../../../docs/configuring-well-known.md:74 +#: ../../../docs/configuring-well-known.md:87 msgid "However, if you need to use the base domain for other things, this method is less suitable than the one explained below." msgstr "" -#: ../../../docs/configuring-well-known.md:76 +#: ../../../docs/configuring-well-known.md:89 msgid "Manually installing well-known files on the base domain's server" msgstr "" -#: ../../../docs/configuring-well-known.md:78 +#: ../../../docs/configuring-well-known.md:91 msgid "If you're managing the base domain by yourself somehow, you'll need to set up serving of some `/.well-known/matrix/*` files from it via HTTPS." msgstr "" -#: ../../../docs/configuring-well-known.md:80 +#: ../../../docs/configuring-well-known.md:93 msgid "To make things easy for you to set up, this playbook generates and hosts a few well-known files on the Matrix domain's server. The files are generated at the `/matrix/static-files/public/.well-known/matrix/` path on the server and hosted at URLs like `https://matrix.example.com/.well-known/matrix/server` and `https://matrix.example.com/.well-known/matrix/client`, even though this is the wrong place to host them." msgstr "" -#: ../../../docs/configuring-well-known.md:82 +#: ../../../docs/configuring-well-known.md:95 msgid "You have two options when it comes to installing the files on the base domain's server:" msgstr "" -#: ../../../docs/configuring-well-known.md:84 +#: ../../../docs/configuring-well-known.md:97 msgid "(Option 1): **Copying the files manually** to your base domain's server" msgstr "" -#: ../../../docs/configuring-well-known.md:86 +#: ../../../docs/configuring-well-known.md:99 msgid "**Hint**: Option 2 is generally a better way to do this. Make sure to go with it, if possible." msgstr "" -#: ../../../docs/configuring-well-known.md:88 +#: ../../../docs/configuring-well-known.md:101 msgid "All you need to do is:" msgstr "" -#: ../../../docs/configuring-well-known.md:90 +#: ../../../docs/configuring-well-known.md:103 msgid "copy `/.well-known/matrix/server` and `/.well-known/matrix/client` from the Matrix server (e.g. `matrix.example.com`) to your base domain's server (`example.com`). You can find these files in the `/matrix/static-files/.well-known/matrix` directory on the Matrix server. They are also accessible on URLs like this: `https://matrix.example.com/.well-known/matrix/server` (same for `client`)." msgstr "" -#: ../../../docs/configuring-well-known.md:92 +#: ../../../docs/configuring-well-known.md:105 msgid "set up the server at your base domain (e.g. `example.com`) so that it adds an extra HTTP header when serving the `/.well-known/matrix/client` file. [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), the `Access-Control-Allow-Origin` header should be set with a value of `*`. If you don't do this step, web-based Matrix clients (like Element Web) may fail to work. Setting up headers for the `/.well-known/matrix/server` file is not necessary, as this file is only consumed by non-browsers, which don't care about CORS." msgstr "" -#: ../../../docs/configuring-well-known.md:94 +#: ../../../docs/configuring-well-known.md:107 msgid "This is relatively easy to do and possibly your only choice if you can only host static files from the base domain's server. It is, however, **a little fragile**, as future updates performed by this playbook may regenerate the well-known files and you may need to notice that and copy them over again." msgstr "" -#: ../../../docs/configuring-well-known.md:96 +#: ../../../docs/configuring-well-known.md:109 msgid "(Option 2): **Setting up reverse-proxying** of the well-known files from the base domain's server to the Matrix server" msgstr "" -#: ../../../docs/configuring-well-known.md:98 +#: ../../../docs/configuring-well-known.md:111 msgid "This option is less fragile and generally better." msgstr "" -#: ../../../docs/configuring-well-known.md:100 -msgid "On the base domain's server (e.g. `example.com`), you can set up reverse-proxying, so that any access for the `/.well-known/matrix` location prefix is forwarded to the Matrix domain's server (e.g. `matrix.example.com`)." +#: ../../../docs/configuring-well-known.md:113 +msgid "On the base domain's server (e.g. `example.com`), you can set up reverse-proxying (or simply a 302 redirect), so that any access for the `/.well-known/matrix` location prefix is forwarded to the Matrix domain's server (e.g. `matrix.example.com`)." msgstr "" -#: ../../../docs/configuring-well-known.md:102 +#: ../../../docs/configuring-well-known.md:115 msgid "With this method, you **don't need** to add special HTTP headers for [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) reasons (like `Access-Control-Allow-Origin`), because your Matrix server (where requests ultimately go) will be configured by this playbook correctly." msgstr "" -#: ../../../docs/configuring-well-known.md:104 +#: ../../../docs/configuring-well-known.md:117 msgid "**For nginx**, it would be something like this:" msgstr "" -#: ../../../docs/configuring-well-known.md:121 +#: ../../../docs/configuring-well-known.md:134 msgid "**For Apache2**, it would be something like this:" msgstr "" -#: ../../../docs/configuring-well-known.md:135 +#: ../../../docs/configuring-well-known.md:148 msgid "**For Caddy 2**, it would be something like this:" msgstr "" -#: ../../../docs/configuring-well-known.md:145 +#: ../../../docs/configuring-well-known.md:158 msgid "**For HAProxy**, it would be something like this:" msgstr "" -#: ../../../docs/configuring-well-known.md:164 +#: ../../../docs/configuring-well-known.md:177 msgid "**For Netlify**, configure a [redirect](https://docs.netlify.com/routing/redirects/) using a `_redirects` file in the [publish directory](https://docs.netlify.com/configure-builds/overview/#definitions) with contents like this:" msgstr "" -#: ../../../docs/configuring-well-known.md:170 +#: ../../../docs/configuring-well-known.md:183 msgid "**For AWS CloudFront**" msgstr "" -#: ../../../docs/configuring-well-known.md:172 +#: ../../../docs/configuring-well-known.md:185 msgid "Add a custom origin with matrix.example.com to your distribution" msgstr "" -#: ../../../docs/configuring-well-known.md:173 +#: ../../../docs/configuring-well-known.md:186 msgid "Add two behaviors, one for `.well-known/matrix/client` and one for `.well-known/matrix/server` and point them to your new origin." msgstr "" -#: ../../../docs/configuring-well-known.md:175 +#: ../../../docs/configuring-well-known.md:188 msgid "Make sure to:" msgstr "" -#: ../../../docs/configuring-well-known.md:177 +#: ../../../docs/configuring-well-known.md:190 msgid "**replace `example.com`** in the server configuration with your actual domain name" msgstr "" -#: ../../../docs/configuring-well-known.md:178 +#: ../../../docs/configuring-well-known.md:191 msgid "and: to **do this for the HTTPS-enabled server block**, as that's where Matrix expects the file to be" msgstr "" -#: ../../../docs/configuring-well-known.md:180 +#: ../../../docs/configuring-well-known.md:193 msgid "Confirming it works" msgstr "" -#: ../../../docs/configuring-well-known.md:182 +#: ../../../docs/configuring-well-known.md:195 msgid "No matter which method you've used to set up the well-known files, if you've done it correctly you should be able to see a JSON file at these URLs:" msgstr "" -#: ../../../docs/configuring-well-known.md:184 +#: ../../../docs/configuring-well-known.md:197 msgid "`https://example.com/.well-known/matrix/server`" msgstr "" -#: ../../../docs/configuring-well-known.md:185 +#: ../../../docs/configuring-well-known.md:198 msgid "`https://example.com/.well-known/matrix/client`" msgstr "" -#: ../../../docs/configuring-well-known.md:186 +#: ../../../docs/configuring-well-known.md:199 msgid "`https://example.com/.well-known/matrix/support`" msgstr "" -#: ../../../docs/configuring-well-known.md:188 -msgid "You can also check if everything is configured correctly, by [checking if services work](maintenance-checking-services.md)." +#: ../../../docs/configuring-well-known.md:201 +msgid "You can also check if everything is configured correctly, by [checking if services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work)." msgstr "" diff --git a/i18n/translation-templates/docs/container-images.pot b/i18n/translation-templates/docs/container-images.pot index 16c488a54..c73300768 100644 --- a/i18n/translation-templates/docs/container-images.pot +++ b/i18n/translation-templates/docs/container-images.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,19 +16,19 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/container-images.md:1 +#: ../../../docs/container-images.md:18 msgid "Container images used by the playbook" msgstr "" -#: ../../../docs/container-images.md:3 +#: ../../../docs/container-images.md:20 msgid "This page summarizes the container ([Docker](https://www.docker.com/)) images used by the playbook when setting up your server." msgstr "" -#: ../../../docs/container-images.md:5 +#: ../../../docs/container-images.md:22 msgid "We try to stick to official images (provided by their respective projects) as much as possible." msgstr "" -#: ../../../docs/container-images.md:7 +#: ../../../docs/container-images.md:24 msgid "Homeserver" msgstr "" @@ -92,6 +92,18 @@ msgstr "" msgid "Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. conduwuit is a fork of Conduit." msgstr "" +#: ../../../docs/container-images.md:0 +msgid "[continuwuity](configuring-playbook-continuwuity.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[continuwuation/continuwuity](https://forgejo.ellis.link/continuwuation/continuwuity)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. continuwuity is a continuation of conduwuit." +msgstr "" + #: ../../../docs/container-images.md:0 msgid "[Dendrite](configuring-playbook-dendrite.md)" msgstr "" @@ -104,11 +116,11 @@ msgstr "" msgid "Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. Dendrite is a second-generation Matrix homeserver written in Go, an alternative to Synapse." msgstr "" -#: ../../../docs/container-images.md:16 +#: ../../../docs/container-images.md:34 msgid "Clients" msgstr "" -#: ../../../docs/container-images.md:18 +#: ../../../docs/container-images.md:36 msgid "Web clients for Matrix that you can host on your own domains." msgstr "" @@ -160,11 +172,11 @@ msgstr "" msgid "Based on Element Web, with a more traditional instant messaging experience" msgstr "" -#: ../../../docs/container-images.md:27 +#: ../../../docs/container-images.md:45 msgid "Server Components" msgstr "" -#: ../../../docs/container-images.md:29 +#: ../../../docs/container-images.md:47 msgid "Services that run on the server to make the various parts of your installation work." msgstr "" @@ -201,7 +213,7 @@ msgid "[Traefik](https://hub.docker.com/_/traefik/)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "Web server, listening on ports 80, 443 and 8448 — standing in front of all the other services. Using your own webserver [is possible](configuring-playbook-own-webserver.md)" +msgid "Web server, listening on ports 80, 443 and 8448 — standing in front of all the other services. [Using your own webserver](configuring-playbook-own-webserver.md) is also possible." msgstr "" #: ../../../docs/container-images.md:0 @@ -213,7 +225,7 @@ msgid "[certbot/certbot](https://hub.docker.com/r/certbot/certbot/)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "The [certbot](https://certbot.eff.org/) tool for obtaining SSL certificates from [Let's Encrypt](https://letsencrypt.org/)" +msgid "[Certbot](https://certbot.eff.org/) tool for obtaining SSL certificates from [Let's Encrypt](https://letsencrypt.org/)" msgstr "" #: ../../../docs/container-images.md:0 @@ -252,11 +264,35 @@ msgstr "" msgid "Update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider" msgstr "" -#: ../../../docs/container-images.md:41 +#: ../../../docs/container-images.md:0 +msgid "[LiveKit Server](configuring-playbook-livekit-server.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[livekit/livekit-server](https://hub.docker.com/r/livekit/livekit-server/)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "WebRTC server for audio/video calls" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[Livekit JWT Service](configuring-playbook-livekit-jwt-service.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[element-hq/lk-jwt-service](https://ghcr.io/element-hq/lk-jwt-service)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "JWT service for integrating [Element Call](./configuring-playbook-element-call.md) with [LiveKit Server](./configuring-playbook-livekit-server.md)" +msgstr "" + +#: ../../../docs/container-images.md:61 msgid "Authentication" msgstr "" -#: ../../../docs/container-images.md:43 +#: ../../../docs/container-images.md:63 msgid "Extend and modify how users are authenticated on your homeserver." msgstr "" @@ -297,7 +333,7 @@ msgid "[activism.international/matrix_ldap_registration_proxy](https://gitlab.co msgstr "" #: ../../../docs/container-images.md:0 -msgid "A proxy that handles Matrix registration requests and forwards them to LDAP." +msgid "Proxy that handles Matrix registration requests and forwards them to LDAP" msgstr "" #: ../../../docs/container-images.md:0 @@ -309,11 +345,11 @@ msgid "[zeratax/matrix-registration](https://hub.docker.com/r/devture/zeratax-ma msgstr "" #: ../../../docs/container-images.md:0 -msgid "A simple python application to have a token based Matrix registration" +msgid "Simple python application to have a token based Matrix registration" msgstr "" #: ../../../docs/container-images.md:0 -msgid "[Matrix User Verification Service](configuring-playbook-user-verification-service.md) (UVS)" +msgid "[Matrix User Verification Service](configuring-playbook-user-verification-service.md)" msgstr "" #: ../../../docs/container-images.md:0 @@ -329,14 +365,14 @@ msgid "[synapse-simple-antispam](configuring-playbook-synapse-simple-antispam.md msgstr "" #: ../../../docs/container-images.md:0 -msgid "A spam checker module" +msgid "Spam checker module" msgstr "" -#: ../../../docs/container-images.md:55 +#: ../../../docs/container-images.md:75 msgid "File Storage" msgstr "" -#: ../../../docs/container-images.md:57 +#: ../../../docs/container-images.md:77 msgid "Use alternative file storage to the default `media_store` folder." msgstr "" @@ -365,17 +401,29 @@ msgid "[t2bot/matrix-media-repo](https://ghcr.io/t2bot/matrix-media-repo)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "matrix-media-repo is a highly customizable multi-domain media repository for Matrix. Intended for medium to large deployments, this media repo de-duplicates media while being fully compliant with the specification." +msgid "Highly customizable multi-domain media repository for Matrix. Intended for medium to large deployments, this media repo de-duplicates media while being fully compliant with the specification." msgstr "" -#: ../../../docs/container-images.md:65 +#: ../../../docs/container-images.md:85 msgid "Bridges" msgstr "" -#: ../../../docs/container-images.md:67 +#: ../../../docs/container-images.md:87 msgid "Bridges can be used to connect your Matrix installation with third-party communication networks." msgstr "" +#: ../../../docs/container-images.md:0 +msgid "[mautrix-bluesky](configuring-playbook-bridge-mautrix-bluesky.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[mautrix/bluesky](https://mau.dev/mautrix/bluesky/container_registry)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "Bridge to [Bluesky](https://bsky.social/about)" +msgstr "" + #: ../../../docs/container-images.md:0 msgid "[mautrix-discord](configuring-playbook-bridge-mautrix-discord.md)" msgstr "" @@ -600,62 +648,6 @@ msgstr "" msgid "Bouncer-style bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat)" msgstr "" -#: ../../../docs/container-images.md:0 -msgid "[go-skype-bridge](configuring-playbook-bridge-go-skype-bridge.md)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[nodefyme/go-skype-bridge](https://hub.docker.com/r/nodefyme/go-skype-bridge)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "Bridge to [Skype](https://www.skype.com)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[mx-puppet/slack/mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack/container_registry)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "Bridge to [Slack](https://slack.com)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[mx-puppet-instagram](configuring-playbook-bridge-mx-puppet-instagram.md)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[sorunome/mx-puppet-instagram](https://hub.docker.com/r/sorunome/mx-puppet-instagram)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/))" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[sorunome/mx-puppet-twitter](https://hub.docker.com/r/sorunome/mx-puppet-twitter)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "Bridge for Twitter-DMs ([Twitter](https://twitter.com/))" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry)" -msgstr "" - #: ../../../docs/container-images.md:0 msgid "[mx-puppet-groupme](configuring-playbook-bridge-mx-puppet-groupme.md)" msgstr "" @@ -668,6 +660,18 @@ msgstr "" msgid "Bridge to [GroupMe](https://groupme.com/)" msgstr "" +#: ../../../docs/container-images.md:0 +msgid "[matrix-steam-bridge](configuring-playbook-bridge-steam.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[jasonlaguidice/matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge/pkgs/container/matrix-steam-bridge)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "Bridge to [Steam](https://steampowered.com/)" +msgstr "" + #: ../../../docs/container-images.md:0 msgid "[mx-puppet-steam](configuring-playbook-bridge-mx-puppet-steam.md)" msgstr "" @@ -692,11 +696,11 @@ msgstr "" msgid "Email to Matrix bridge" msgstr "" -#: ../../../docs/container-images.md:99 +#: ../../../docs/container-images.md:116 msgid "Bots" msgstr "" -#: ../../../docs/container-images.md:101 +#: ../../../docs/container-images.md:118 msgid "Bots provide various additional functionality to your installation." msgstr "" @@ -709,7 +713,7 @@ msgid "[etke.cc/baibot](https://ghcr.io/etkecc/baibot)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "A bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you" +msgid "Bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you" msgstr "" #: ../../../docs/container-images.md:0 @@ -745,7 +749,7 @@ msgid "[dock.mau.dev/maubot/maubot](https://mau.dev/maubot/maubot/container_regi msgstr "" #: ../../../docs/container-images.md:0 -msgid "A plugin-based Matrix bot system" +msgid "Plugin-based Matrix bot system" msgstr "" #: ../../../docs/container-images.md:0 @@ -757,7 +761,7 @@ msgid "[etke.cc/honoroit](https://github.com/etkecc/honoroit/container_registry) msgstr "" #: ../../../docs/container-images.md:0 -msgid "A helpdesk bot" +msgid "Helpdesk bot" msgstr "" #: ../../../docs/container-images.md:0 @@ -769,7 +773,7 @@ msgid "[matrixdotorg/mjolnir](https://hub.docker.com/r/matrixdotorg/mjolnir)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "A moderation tool for Matrix" +msgid "Moderation tool for Matrix" msgstr "" #: ../../../docs/container-images.md:0 @@ -781,7 +785,7 @@ msgid "[gnuxie/draupnir](https://hub.docker.com/r/gnuxie/draupnir)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "A moderation tool for Matrix (Fork of Mjolnir)" +msgid "Moderation tool for Matrix (Fork of Mjolnir)" msgstr "" #: ../../../docs/container-images.md:0 @@ -796,11 +800,11 @@ msgstr "" msgid "Web forms (HTTP POST) to Matrix" msgstr "" -#: ../../../docs/container-images.md:114 +#: ../../../docs/container-images.md:131 msgid "Administration" msgstr "" -#: ../../../docs/container-images.md:116 +#: ../../../docs/container-images.md:133 msgid "Services that help you in administrating and monitoring your Matrix installation." msgstr "" @@ -837,7 +841,7 @@ msgid "[etke.cc/synapse-admin](https://ghcr.io/etkecc/synapse-admin)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "A web UI tool for administrating users and rooms on your Matrix server" +msgid "Web UI tool for administrating users and rooms on your Matrix server" msgstr "" #: ../../../docs/container-images.md:0 @@ -869,7 +873,7 @@ msgid "Graphing tool that works well with the above two images. Our playbook als msgstr "" #: ../../../docs/container-images.md:0 -msgid "[Metrics and Graphs](configuring-playbook-prometheus-nginxlog.md)" +msgid "[Metrics and Graphs](configuring-playbook-prometheus-grafana.md#enable-metrics-and-graphs-for-nginx-logs-optional)" msgstr "" #: ../../../docs/container-images.md:0 @@ -888,6 +892,18 @@ msgstr "" msgid "Backups" msgstr "" +#: ../../../docs/container-images.md:0 +msgid "[postgres-backup-local](configuring-playbook-postgres-backup.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[prodrigestivill/postgres-backup-local](https://hub.docker.com/r/prodrigestivill/postgres-backup-local)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "Create automatic database backups" +msgstr "" + #: ../../../docs/container-images.md:0 msgid "[rageshake](configuring-playbook-rageshake.md)" msgstr "" @@ -908,11 +924,11 @@ msgstr "" msgid "Export the usage statistics of a Synapse homeserver to be scraped by Prometheus." msgstr "" -#: ../../../docs/container-images.md:131 +#: ../../../docs/container-images.md:149 msgid "Misc" msgstr "" -#: ../../../docs/container-images.md:133 +#: ../../../docs/container-images.md:151 msgid "Various services that don't fit any other categories." msgstr "" @@ -933,7 +949,7 @@ msgid "[synapse_auto_accept_invite](configuring-playbook-synapse-auto-accept-inv msgstr "" #: ../../../docs/container-images.md:0 -msgid "A Synapse module to automatically accept invites." +msgid "Synapse module to automatically accept invites" msgstr "" #: ../../../docs/container-images.md:0 @@ -941,11 +957,11 @@ msgid "[synapse_auto_compressor](configuring-playbook-synapse-auto-compressor.md msgstr "" #: ../../../docs/container-images.md:0 -msgid "[etke.cc/rust-synapse-compress-state](https://gitlab.com/etke.cc/rust-synapse-compress-state/container_registry)" +msgid "[mb-saces/rust-synapse-tools](https://gitlab.com/mb-saces/rust-synapse-tools/container_registry)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "A cli tool that automatically compresses `state_groups` database table in background." +msgid "Cli tool that automatically compresses Synapse's `state_groups` database table in background" msgstr "" #: ../../../docs/container-images.md:0 @@ -969,7 +985,7 @@ msgid "[etherpad/etherpad](https://hub.docker.com/r/etherpad/etherpad/)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "An open source collaborative text editor" +msgid "Open source collaborative text editor" msgstr "" #: ../../../docs/container-images.md:0 @@ -981,7 +997,7 @@ msgid "[jitsi/web](https://hub.docker.com/r/jitsi/web)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "the [Jitsi](https://jitsi.org/) web UI" +msgid "[Jitsi](https://jitsi.org/) web UI" msgstr "" #: ../../../docs/container-images.md:0 @@ -989,7 +1005,7 @@ msgid "[jitsi/jicofo](https://hub.docker.com/r/jitsi/jicofo)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "the [Jitsi](https://jitsi.org/) Focus component" +msgid "[Jitsi](https://jitsi.org/) Focus component" msgstr "" #: ../../../docs/container-images.md:0 @@ -997,7 +1013,7 @@ msgid "[jitsi/prosody](https://hub.docker.com/r/jitsi/prosody)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "the [Jitsi](https://jitsi.org/) Prosody XMPP server component" +msgid "[Jitsi](https://jitsi.org/) Prosody XMPP server component" msgstr "" #: ../../../docs/container-images.md:0 @@ -1005,7 +1021,7 @@ msgid "[jitsi/jvb](https://hub.docker.com/r/jitsi/jvb)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "the [Jitsi](https://jitsi.org/) Video Bridge component" +msgid "[Jitsi](https://jitsi.org/) Video Bridge component" msgstr "" #: ../../../docs/container-images.md:0 @@ -1017,7 +1033,7 @@ msgid "[cactuscomments/cactus-appservice](https://hub.docker.com/r/cactuscomment msgstr "" #: ../../../docs/container-images.md:0 -msgid "A federated comment system built on Matrix" +msgid "Federated comment system built on Matrix" msgstr "" #: ../../../docs/container-images.md:0 @@ -1033,7 +1049,7 @@ msgid "[matrixdotorg/pantalaimon](https://hub.docker.com/r/matrixdotorg/pantalai msgstr "" #: ../../../docs/container-images.md:0 -msgid "An E2EE aware proxy daemon" +msgid "E2EE aware proxy daemon" msgstr "" #: ../../../docs/container-images.md:0 @@ -1060,11 +1076,23 @@ msgstr "" msgid "Self-hosted, UnifiedPush-compatible push notifications server" msgstr "" -#: ../../../docs/container-images.md:152 +#: ../../../docs/container-images.md:0 +msgid "[Element Call](configuring-playbook-element-call.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[element-hq/element-call](https://ghcr.io/element-hq/element-call)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "A native Matrix video conferencing application" +msgstr "" + +#: ../../../docs/container-images.md:171 msgid "Container images of deprecated / unmaintained services" msgstr "" -#: ../../../docs/container-images.md:154 +#: ../../../docs/container-images.md:173 msgid "The list of the deprecated or unmaintained services is available [here](configuring-playbook.md#deprecated--unmaintained--removed-services)." msgstr "" @@ -1089,7 +1117,7 @@ msgid "[turt2live/matrix-dimension](https://hub.docker.com/r/turt2live/matrix-di msgstr "" #: ../../../docs/container-images.md:0 -msgid "An open source integration manager for Matrix clients" +msgid "Open source integration manager for Matrix clients" msgstr "" #: ../../../docs/container-images.md:0 @@ -1113,7 +1141,7 @@ msgid "[matrixdotorg/go-neb](https://hub.docker.com/r/matrixdotorg/go-neb)" msgstr "" #: ../../../docs/container-images.md:0 -msgid "A multi functional bot written in Go" +msgid "Multi functional bot written in Go" msgstr "" #: ../../../docs/container-images.md:0 @@ -1140,18 +1168,6 @@ msgstr "" msgid "Bridge to [Facebook](https://facebook.com/)" msgstr "" -#: ../../../docs/container-images.md:0 -msgid "[mautrix-hangouts](configuring-playbook-bridge-mautrix-hangouts.md)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "[mautrix/hangouts](https://mau.dev/mautrix/hangouts/container_registry)" -msgstr "" - -#: ../../../docs/container-images.md:0 -msgid "Bridge to [Google Hangouts](https://en.wikipedia.org/wiki/Google_Hangouts)" -msgstr "" - #: ../../../docs/container-images.md:0 msgid "[mautrix-instagram](configuring-playbook-bridge-mautrix-instagram.md)" msgstr "" @@ -1163,3 +1179,47 @@ msgstr "" #: ../../../docs/container-images.md:0 msgid "Bridge to [Instagram](https://instagram.com/)" msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[mx-puppet-instagram](configuring-playbook-bridge-mx-puppet-instagram.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[sorunome/mx-puppet-instagram](https://hub.docker.com/r/sorunome/mx-puppet-instagram)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/))" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[mx-puppet/slack/mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack/container_registry)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "Bridge to [Slack](https://slack.com)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "[sorunome/mx-puppet-twitter](https://hub.docker.com/r/sorunome/mx-puppet-twitter)" +msgstr "" + +#: ../../../docs/container-images.md:0 +msgid "Bridge for Twitter-DMs ([Twitter](https://twitter.com/))" +msgstr "" diff --git a/i18n/translation-templates/docs/faq.pot b/i18n/translation-templates/docs/faq.pot index 96ada43bb..fd506b25d 100644 --- a/i18n/translation-templates/docs/faq.pot +++ b/i18n/translation-templates/docs/faq.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,875 +16,783 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/faq.md:1 +#: ../../../docs/faq.md:13 msgid "Frequently Asked Questions" msgstr "" -#: ../../../docs/faq.md:3 +#: ../../../docs/faq.md:15 msgid "This documentation page tries to answer various Frequently Asked Questions about all things [Matrix](https://matrix.org/), with a focus on this [Ansible](https://www.ansible.com/) playbook ([What is Ansible? How does it work?](#what-is-ansible-how-does-it-work))." msgstr "" -#: ../../../docs/faq.md:5 +#: ../../../docs/faq.md:17 msgid "This FAQ page does not intend to replace the [matrix.org FAQ](https://matrix.org/faq/) (please see that one too)." msgstr "" -#: ../../../docs/faq.md:7 +#: ../../../docs/faq.md:19 msgid "We've only started this FAQ recently, so it's still somewhat empty." msgstr "" -#: ../../../docs/faq.md:9 +#: ../../../docs/faq.md:21 msgid "Also, we encourage you to not dig yourself into a hole by reading way too much. When you've heard enough, proceed to installation. To get started, see [below](#how-do-i-run-the-installation) about our installation guides." msgstr "" -#: ../../../docs/faq.md:11 +#: ../../../docs/faq.md:23 msgid "Introductory" msgstr "" -#: ../../../docs/faq.md:13 +#: ../../../docs/faq.md:25 msgid "Where do I find more questions and answers about Matrix?" msgstr "" -#: ../../../docs/faq.md:15 +#: ../../../docs/faq.md:27 msgid "This is a Frequently Asked Questions page focused on this [Ansible](https://www.ansible.com/) playbook ([What is Ansible? How does it work?](#what-is-ansible-how-does-it-work)) for deploying a [Matrix](https://matrix.org/) server." msgstr "" -#: ../../../docs/faq.md:17 +#: ../../../docs/faq.md:29 msgid "For a lot more generic questions and answers, see the [matrix.org FAQ](https://matrix.org/faq/)." msgstr "" -#: ../../../docs/faq.md:19 +#: ../../../docs/faq.md:31 msgid "What is Matrix? What is Element? What is Synapse? Why are you confusing me with so many terms?" msgstr "" -#: ../../../docs/faq.md:21 +#: ../../../docs/faq.md:33 msgid "[Matrix](https://matrix.org/) is a new type of realtime communication (chat) network, the closest analogy to which is probably \"email\"." msgstr "" -#: ../../../docs/faq.md:23 +#: ../../../docs/faq.md:35 msgid "You don't just use the \"email\" protocols (SMTP, POP3, IMAP) directly though. There's a *server* somewhere which stores your data (`@gmail.com`, `@yahoo.com`, `@hotmail.com`, `@your-company.com`) and you access it by using these \"email\" protocols via some *client* program (Outlook, Thunderbird, some website, etc)." msgstr "" -#: ../../../docs/faq.md:25 +#: ../../../docs/faq.md:37 msgid "In the world of the Matrix chat protocol, there are various client programs. The first and currently most full-featured one is called [Element](https://element.io/) (used to be called Riot.im and Vector.im in the past). There are [many other clients](https://matrix.org/clients/). You can switch clients as much as you want until you find the one that is right for you on a given platform (you may use Element Desktop on your desktop, but Fluffychat on your phone, etc)." msgstr "" -#: ../../../docs/faq.md:27 +#: ../../../docs/faq.md:39 msgid "Matrix is also like email due to the fact that there are many servers around the world which can all talk to each other (you can send email from `@gmail.com` addresses to `@yahoo.com` and `@hotmail.com` addresses). It's the same with Matrix (`@bob:example.com` can talk to `@alice:example.org`)." msgstr "" -#: ../../../docs/faq.md:29 +#: ../../../docs/faq.md:41 msgid "If someone else is hosting your Matrix server (you being `@alice:matrix.org` or some other public server like this), all you need is a Matrix client program, like Element Web or Element X Android." msgstr "" -#: ../../../docs/faq.md:31 +#: ../../../docs/faq.md:43 msgid "If you'd like to host your own server (you being `@alice:example.com`), you'd need to set up a Matrix server program, like Synapse." msgstr "" -#: ../../../docs/faq.md:33 +#: ../../../docs/faq.md:45 msgid "In short:" msgstr "" -#: ../../../docs/faq.md:35 +#: ../../../docs/faq.md:47 msgid "Matrix is the protocol — a set of rules about how the chat network operates" msgstr "" -#: ../../../docs/faq.md:36 +#: ../../../docs/faq.md:48 msgid "Element is a client program you can use to participate on the Matrix chat network via some server (yours or someone else's). There are also [many other client programs](https://matrix.org/clients/)." msgstr "" -#: ../../../docs/faq.md:37 +#: ../../../docs/faq.md:49 msgid "Synapse is a server program you can use to host your very own Matrix server." msgstr "" -#: ../../../docs/faq.md:39 +#: ../../../docs/faq.md:51 msgid "This FAQ here mostly focuses on installing various Matrix services using the Ansible automation tool. You can learn much more about Matrix in the [matrix.org FAQ](https://matrix.org/faq/)." msgstr "" -#: ../../../docs/faq.md:41 +#: ../../../docs/faq.md:53 msgid "People I wish to talk to are not on Matrix. Can I talk to them?" msgstr "" -#: ../../../docs/faq.md:43 +#: ../../../docs/faq.md:55 msgid "You most likely can. Besides Matrix-native chats, Matrix also supports the concept of \"bridging\", which allows you to plug other networks into it." msgstr "" -#: ../../../docs/faq.md:45 +#: ../../../docs/faq.md:57 msgid "This Ansible playbook can help you install [tens of bridges for various networks](configuring-playbook.md#bridging-other-networks)." msgstr "" -#: ../../../docs/faq.md:47 +#: ../../../docs/faq.md:59 msgid "Besides setting up your own bridges (preferable), you can also use some [public bridges hosted by others](https://publiclist.anchel.nl/#bridges)." msgstr "" -#: ../../../docs/faq.md:49 +#: ../../../docs/faq.md:61 msgid "How do I get started with Matrix?" msgstr "" -#: ../../../docs/faq.md:51 +#: ../../../docs/faq.md:63 msgid "One of [Matrix](https://matrix.org/)'s distinguishing strengths (compared to other chat networks) is its decentralized nature. There's not just one entity (company, organization) controlling the servers. Rather there's thousands of servers operated by different people — one server being insecure, slow or disrespective toward its users does not affect the rest of the network. To participate in that decentralization in its fullest, consider hosting your own server or using some public server other than the largest/default one (`matrix.org`)." msgstr "" -#: ../../../docs/faq.md:53 +#: ../../../docs/faq.md:65 msgid "There are 3 ways to get into Matrix, depending on your technical ability and needs:" msgstr "" -#: ../../../docs/faq.md:55 +#: ../../../docs/faq.md:67 msgid "**using the existing default server** — the easiest way is to use an existing server. The largest public Matrix server is `matrix.org` and it's configured as a default server in clients such as [Element Web](https://app.element.io) and many others. Just use Element Web on the browser via that link (or [download client apps for your Desktop or smartphone](https://element.io/app-for-productivity)), create an account and start chatting." msgstr "" -#: ../../../docs/faq.md:57 +#: ../../../docs/faq.md:69 msgid "**using some other server** — instead of using the largest public server (`matrix.org`), you can use another public one. Here's a [list of public Matrix servers](https://joinmatrix.org/servers/) to choose from. Go to [Element Web](https://app.element.io) or download [some other client](https://matrix.org/clients/) of your choosing and adjust the homeserver URL during login." msgstr "" -#: ../../../docs/faq.md:59 +#: ../../../docs/faq.md:71 msgid "**using your own server** — running your own server puts you in ultimate control of your data. It also lets you have your own user IDs (e.g. `@bob:example.com`). See [How do I set up my own Matrix server](#how-do-i-set-up-my-own-matrix-server)." msgstr "" -#: ../../../docs/faq.md:61 +#: ../../../docs/faq.md:73 msgid "How do I set up my own Matrix server?" msgstr "" -#: ../../../docs/faq.md:63 +#: ../../../docs/faq.md:75 msgid "Normally, you'd first choose the [Matrix](https://matrix.org/) server software you'd like to run. At the time of this writing (January/2021), there's only one fully-featured server program, so there's only one reasonable choice. That's [Synapse](https://github.com/element-hq/synapse)." msgstr "" -#: ../../../docs/faq.md:65 +#: ../../../docs/faq.md:77 msgid "There are [many guides about installing Synapse](https://matrix.org/docs/guides/#installing-synapse). Using this Ansible playbook is just one way of doing it." msgstr "" -#: ../../../docs/faq.md:67 +#: ../../../docs/faq.md:79 msgid "Naturally, we're biased, so our usual recommendation is to go with this [Ansible](https://www.ansible.com/) playbook, instead of installing Synapse (and many many other things around it) manually." msgstr "" -#: ../../../docs/faq.md:69 +#: ../../../docs/faq.md:81 msgid "To get started with the playbook, check out the [Quick start](quick-start.md) or full installation guide (starting at the [Prerequisites](prerequisites.md) page)." msgstr "" -#: ../../../docs/faq.md:71 +#: ../../../docs/faq.md:83 msgid "What is Ansible? How does it work?" msgstr "" -#: ../../../docs/faq.md:73 +#: ../../../docs/faq.md:85 msgid "[Ansible](https://www.ansible.com/) is an automation program. This \"playbook\" is a collection of tasks/scripts that will set up a [Matrix](https://matrix.org/) server for you, so you don't have to perform these tasks manually." msgstr "" -#: ../../../docs/faq.md:75 +#: ../../../docs/faq.md:87 msgid "We have written these automated tasks for you and all you need to do is execute them using the Ansible program." msgstr "" -#: ../../../docs/faq.md:77 +#: ../../../docs/faq.md:89 msgid "You can install Ansible and this playbook code repository on your own computer and tell it to install Matrix services at the server living at `matrix.example.com`. We recommend installing Ansible on your own computer." msgstr "" -#: ../../../docs/faq.md:79 +#: ../../../docs/faq.md:91 msgid "Alternatively, you can download Ansible and the playbook itself directly on the `matrix.example.com` server." msgstr "" -#: ../../../docs/faq.md:81 +#: ../../../docs/faq.md:93 msgid "To learn more, see our [dedicated Ansible documentation page](ansible.md)." msgstr "" -#: ../../../docs/faq.md:83 +#: ../../../docs/faq.md:95 msgid "What is `just`?" msgstr "" -#: ../../../docs/faq.md:85 +#: ../../../docs/faq.md:97 msgid "[`just`](https://github.com/casey/just) is a modern command-runner alternative to [make](https://www.gnu.org/software/make/). It can be used to invoke commands with less typing." msgstr "" -#: ../../../docs/faq.md:87 +#: ../../../docs/faq.md:99 msgid "The `just` utility executes shortcut commands (called \"recipes\"), which invoke `ansible-playbook`, `ansible-galaxy` or [`agru`](https://github.com/etkecc/agru) (depending on what is available in your system). The targets of the recipes are defined in [`justfile`](../justfile)." msgstr "" -#: ../../../docs/faq.md:89 +#: ../../../docs/faq.md:101 msgid "For details about `just` commands, take a look at: [Running `just` commands](just.md)." msgstr "" -#: ../../../docs/faq.md:91 +#: ../../../docs/faq.md:103 msgid "The playbook also contains a `Makefile` for the `make` tool, but most of the just recipes are not available as targets in the `Makefile`." msgstr "" -#: ../../../docs/faq.md:93 +#: ../../../docs/faq.md:105 msgid "Why use this playbook and not install Synapse and other things manually?" msgstr "" -#: ../../../docs/faq.md:95 +#: ../../../docs/faq.md:107 msgid "There are various guides telling you how easy it is to install [Synapse](https://github.com/element-hq/synapse)." msgstr "" -#: ../../../docs/faq.md:97 +#: ../../../docs/faq.md:109 msgid "Reading the documentation of this Ansible playbook, you may also be thinking:" msgstr "" -#: ../../../docs/faq.md:99 +#: ../../../docs/faq.md:111 msgid "I don't know what [Ansible](https://www.ansible.com/) is. I don't know what [Docker](https://www.docker.com/) is. This looks more complicated." msgstr "" -#: ../../../docs/faq.md:101 +#: ../../../docs/faq.md:113 msgid "… so you may be leaning toward [installing Synapse manually](https://github.com/element-hq/synapse/blob/master/INSTALL.md)." msgstr "" -#: ../../../docs/faq.md:103 +#: ../../../docs/faq.md:115 msgid "The problem with a manual installation is:" msgstr "" -#: ../../../docs/faq.md:105 +#: ../../../docs/faq.md:117 msgid "Synapse is written in Python. If not packaged for your distribution, you'd need to install various Python modules, etc., and keep them updated." msgstr "" -#: ../../../docs/faq.md:106 +#: ../../../docs/faq.md:118 msgid "Synapse requires a [Postgres](https://www.postgresql.org/) database (it can run on SQLite, but that's very much discouraged). So you'd need to install Postgres as well." msgstr "" -#: ../../../docs/faq.md:107 +#: ../../../docs/faq.md:119 msgid "you may also need a reverse-proxy server in front of it (nginx, Apache), so you'd need to be familiar with that" msgstr "" -#: ../../../docs/faq.md:108 +#: ../../../docs/faq.md:120 msgid "SSL is required, so you'd need to obtain Let's Encrypt (or other free or non-free) certificates for one or more domain names. You'd need to be familiar with [certbot](https://certbot.eff.org/) (when using Let's Encrypt) or similar software." msgstr "" -#: ../../../docs/faq.md:109 +#: ../../../docs/faq.md:121 msgid "for each additional component you'd like to add (client like [Element](https://element.io), bridge to some other chat network, integration manager (stickers, other services, Identity Manager, etc.), you'll need to spend extra time installing and wiring it with the rest of the system in a way that works." msgstr "" -#: ../../../docs/faq.md:110 +#: ../../../docs/faq.md:122 msgid "you'll likely get slower updates for all of these components, depending on your distro packaging or your own time and ability" msgstr "" -#: ../../../docs/faq.md:112 +#: ../../../docs/faq.md:124 msgid "The playbook, on the other hand, installs a bunch of components for you by default, obtains SSL certificates for you, etc. If you'd like, you can enable various bridges and other services with very little effort. All the components are wired to work together." msgstr "" -#: ../../../docs/faq.md:114 +#: ../../../docs/faq.md:126 msgid "All services run in Docker containers (most being officially provided by each component's developers), so we're not at the mercy of distro packaging." msgstr "" -#: ../../../docs/faq.md:116 +#: ../../../docs/faq.md:128 msgid "Why use this playbook and not just use the Docker image directly?" msgstr "" -#: ../../../docs/faq.md:118 +#: ../../../docs/faq.md:130 msgid "Reasons are similar to the reasons for not installing manually." msgstr "" -#: ../../../docs/faq.md:120 +#: ../../../docs/faq.md:132 msgid "Besides Synapse, you'd need other things — a Postgres database, likely the [Element](https://element.io) client, etc., etc." msgstr "" -#: ../../../docs/faq.md:122 +#: ../../../docs/faq.md:134 msgid "Using the playbook, you get all these components in a way that works well together out of the box." msgstr "" -#: ../../../docs/faq.md:124 +#: ../../../docs/faq.md:136 msgid "Occasionally I see some people are talking about \"MDAD\". What is it?" msgstr "" -#: ../../../docs/faq.md:126 +#: ../../../docs/faq.md:138 msgid "It is the acronym of us: **m**atrix-**d**ocker-**a**nsible-**d**eploy." msgstr "" -#: ../../../docs/faq.md:128 +#: ../../../docs/faq.md:140 msgid "What's different about this Ansible playbook compared to [EMnify/matrix-synapse-auto-deploy](https://github.com/EMnify/matrix-synapse-auto-deploy)?" msgstr "" -#: ../../../docs/faq.md:130 +#: ../../../docs/faq.md:142 msgid "This is similar to the [EMnify/matrix-synapse-auto-deploy](https://github.com/EMnify/matrix-synapse-auto-deploy) Ansible deployment, but:" msgstr "" -#: ../../../docs/faq.md:132 +#: ../../../docs/faq.md:144 msgid "this one is a complete Ansible playbook (instead of just a role), so it's **easier to run** — especially for folks not familiar with Ansible" msgstr "" -#: ../../../docs/faq.md:134 +#: ../../../docs/faq.md:146 msgid "this one installs and hooks together **a lot more Matrix-related services** for you (see above)" msgstr "" -#: ../../../docs/faq.md:136 +#: ../../../docs/faq.md:148 msgid "this one **can be executed more than once** without causing trouble" msgstr "" -#: ../../../docs/faq.md:138 +#: ../../../docs/faq.md:150 msgid "works on various distros: **CentOS** (7.0+), Debian-based distributions (**Debian** 10/Buster+, **Ubuntu** 18.04+), **Archlinux**" msgstr "" -#: ../../../docs/faq.md:140 +#: ../../../docs/faq.md:152 msgid "this one installs everything in a single directory (`/matrix` by default) and **doesn't \"contaminate\" your server** with files all over the place" msgstr "" -#: ../../../docs/faq.md:142 +#: ../../../docs/faq.md:154 msgid "this one **doesn't necessarily take over** ports 80 and 443. By default, it sets up [Traefik](https://doc.traefik.io/traefik/) for you there, but you can also [use your own webserver](configuring-playbook-own-webserver.md)" msgstr "" -#: ../../../docs/faq.md:144 +#: ../../../docs/faq.md:156 msgid "this one **runs everything in Docker containers**, so it's likely more predictable and less fragile (see [Docker images used by this playbook](container-images.md))" msgstr "" -#: ../../../docs/faq.md:146 +#: ../../../docs/faq.md:158 msgid "this one retrieves and automatically renews free [Let's Encrypt](https://letsencrypt.org/) **SSL certificates** for you" msgstr "" -#: ../../../docs/faq.md:148 +#: ../../../docs/faq.md:160 msgid "this one optionally can store the `media_store` content repository files on [Amazon S3](https://aws.amazon.com/s3/) (but defaults to storing files on the server's filesystem)" msgstr "" -#: ../../../docs/faq.md:150 +#: ../../../docs/faq.md:162 msgid "this one optionally **allows you to use an external PostgreSQL server** for Synapse's database (but defaults to running one in a container)" msgstr "" -#: ../../../docs/faq.md:152 +#: ../../../docs/faq.md:164 msgid "helps you **import data from a previous installation** (so you can migrate your manual virtualenv/Docker setup to a more managed one)" msgstr "" -#: ../../../docs/faq.md:154 +#: ../../../docs/faq.md:166 msgid "this one is actually **maintained**" msgstr "" -#: ../../../docs/faq.md:156 +#: ../../../docs/faq.md:168 msgid "Server-related" msgstr "" -#: ../../../docs/faq.md:158 +#: ../../../docs/faq.md:170 msgid "What kind of server do I need to install Matrix using this Ansible playbook?" msgstr "" -#: ../../../docs/faq.md:160 +#: ../../../docs/faq.md:172 msgid "We list our server requirements in [Prerequisites](prerequisites.md)." msgstr "" -#: ../../../docs/faq.md:162 +#: ../../../docs/faq.md:174 msgid "Why not run Matrix on Kubernetes?" msgstr "" -#: ../../../docs/faq.md:164 +#: ../../../docs/faq.md:176 msgid "There's no reason not to run Matrix on [Kubernetes](https://kubernetes.io/)." msgstr "" -#: ../../../docs/faq.md:166 +#: ../../../docs/faq.md:178 msgid "However, that's overly complicated for thousands of us who just want to run a single small (and sometimes not so small) Matrix server, either using \"cloud\" servers or even a [Raspberry Pi](https://www.raspberrypi.org/) at home." msgstr "" -#: ../../../docs/faq.md:168 +#: ../../../docs/faq.md:180 msgid "For us, a Kubernetes-based setup which requires a cluster of multiple computers and is more technically-involved is a no-go." msgstr "" -#: ../../../docs/faq.md:170 +#: ../../../docs/faq.md:182 msgid "There are others working on automating a Matrix-on-Kubernetes setup, such as this [Helm](https://helm.sh/) chart: https://github.com/dacruz21/matrix-chart." msgstr "" -#: ../../../docs/faq.md:172 +#: ../../../docs/faq.md:184 msgid "Why don't you use Podman instead of Docker?" msgstr "" -#: ../../../docs/faq.md:174 +#: ../../../docs/faq.md:186 msgid "We like the philosophy of a daemonless container runtime, but [Podman](https://podman.io) is just not ready for our use case yet." msgstr "" -#: ../../../docs/faq.md:176 +#: ../../../docs/faq.md:188 msgid "Learn more about our past experiences/attempts to give Podman a chance, by reading [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/520)." msgstr "" -#: ../../../docs/faq.md:178 +#: ../../../docs/faq.md:190 msgid "In short, `alias podman=docker` is a lie (for us)." msgstr "" -#: ../../../docs/faq.md:180 +#: ../../../docs/faq.md:192 msgid "Why use Docker?" msgstr "" -#: ../../../docs/faq.md:182 +#: ../../../docs/faq.md:194 msgid "[Docker](https://www.docker.com/) is one of our 2 hard dependencies (the other one being [systemd](https://systemd.io/))." msgstr "" -#: ../../../docs/faq.md:184 +#: ../../../docs/faq.md:196 msgid "It lets us run services in an isolated manner and independently of the (usually old) packages available for distributions." msgstr "" -#: ../../../docs/faq.md:186 +#: ../../../docs/faq.md:198 msgid "It also lets us have a unified setup which runs the same across various supported distros (see them on [Prerequisites](prerequisites.md))." msgstr "" -#: ../../../docs/faq.md:188 +#: ../../../docs/faq.md:200 msgid "Is Docker a hard requirement?" msgstr "" -#: ../../../docs/faq.md:190 +#: ../../../docs/faq.md:202 msgid "Yes. See [Why don't you use Podman instead of Docker?](#why-dont-you-use-podman-instead-of-docker) for why we're not using another container runtime." msgstr "" -#: ../../../docs/faq.md:192 +#: ../../../docs/faq.md:204 msgid "All of our services run in containers. It's how we achieve predictability and also how we support tens of different services across lots of distros." msgstr "" -#: ../../../docs/faq.md:194 +#: ../../../docs/faq.md:206 msgid "The only thing we need on the distro is systemd and Python (we install Docker ourselves, unless you ask us not to)." msgstr "" -#: ../../../docs/faq.md:196 +#: ../../../docs/faq.md:208 msgid "Why don't you use docker-compose?" msgstr "" -#: ../../../docs/faq.md:198 +#: ../../../docs/faq.md:210 msgid "Instead of using [docker-compose](https://docs.docker.com/compose/), we prefer installing systemd services and scheduling those independently." msgstr "" -#: ../../../docs/faq.md:200 +#: ../../../docs/faq.md:212 msgid "There are people who have worked on turning this setup into a docker-compose-based one. See these experiments [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/64#issuecomment-603164625). There is also a demo project ([element-docker-demo](https://github.com/element-hq/element-docker-demo)) by Element." msgstr "" -#: ../../../docs/faq.md:202 +#: ../../../docs/faq.md:214 msgid "Can I run this on a distro without systemd?" msgstr "" -#: ../../../docs/faq.md:204 +#: ../../../docs/faq.md:216 msgid "No. [systemd](https://systemd.io/) is one of our 2 hard dependencies (the other one being [Docker](https://www.docker.com/))." msgstr "" -#: ../../../docs/faq.md:206 +#: ../../../docs/faq.md:218 msgid "Can I install this on a Raspberry Pi?" msgstr "" -#: ../../../docs/faq.md:208 +#: ../../../docs/faq.md:220 msgid "Yes, you can. See our [Alternative Architectures](alternative-architectures.md) documentation page." msgstr "" -#: ../../../docs/faq.md:210 +#: ../../../docs/faq.md:222 msgid "Whether a Raspberry Pi has enough power to give you a good experience is another question. It depends on your use case." msgstr "" -#: ../../../docs/faq.md:212 +#: ../../../docs/faq.md:224 msgid "Also see: [What kind of server specs do I need?](#what-kind-of-server-specs-do-i-need)." msgstr "" -#: ../../../docs/faq.md:214 +#: ../../../docs/faq.md:226 msgid "What kind of server specs do I need?" msgstr "" -#: ../../../docs/faq.md:216 +#: ../../../docs/faq.md:228 msgid "This largely depends on your use case. It's not so much the number of users that you plan to host, but rather the number of large rooms they will join." msgstr "" -#: ../../../docs/faq.md:218 +#: ../../../docs/faq.md:230 msgid "Federated rooms with lots of history and containing hundreds of other servers are very heavy CPU-wise and memory-wise." msgstr "" -#: ../../../docs/faq.md:220 +#: ../../../docs/faq.md:232 msgid "You can probably use a 1 CPU + 1GB memory server to host hundreds of local users just fine, but as soon as one of them joins a federated room like `#matrix:matrix.org` (Matrix HQ) or some IRC-bridged room (say `##linux`), your server will get the need for a lot more power (at least 2GB RAM, etc)." msgstr "" -#: ../../../docs/faq.md:222 +#: ../../../docs/faq.md:234 msgid "Running Matrix on a server with 1GB of memory is possible (especially if you disable some not-so-important services). See [How do I optimize this setup for a low-power server?](#how-do-i-optimize-this-setup-for-a-low-power-server)." msgstr "" -#: ../../../docs/faq.md:224 +#: ../../../docs/faq.md:236 msgid "**We recommend starting with a server having at least 2GB of memory** and even then using it sparingly. If you know for sure you'll be joining various large rooms, etc., then going for 4GB of memory or more is a good idea." msgstr "" -#: ../../../docs/faq.md:226 -msgid "Besides the regular Matrix stuff, we also support things like video-conferencing using [Jitsi](configuring-playbook-jitsi.md) and other additional services which (when installed) may use up a lot of memory. Things do add up. Besides the Synapse Matrix server, Jitsi is especially notorious for consuming a lot of resources. If you plan on running Jitsi, we recommend a server with at least 2GB of memory (preferrably more). See our [Jitsi documentation page](configuring-playbook-jitsi.md) to learn how to optimize its memory/CPU usage." -msgstr "" - -#: ../../../docs/faq.md:228 -msgid "Can I run this in an LXC container?" -msgstr "" - -#: ../../../docs/faq.md:230 -msgid "If your distro runs within an [LXC container](https://linuxcontainers.org/), you may hit [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/703). It can be worked around, if absolutely necessary, but we suggest that you avoid running from within an LXC container." -msgstr "" - -#: ../../../docs/faq.md:232 -msgid "Configuration" -msgstr "" - -#: ../../../docs/faq.md:234 -msgid "Why install my server at matrix.example.com and not at the base domain?" -msgstr "" - -#: ../../../docs/faq.md:236 -msgid "It's the same with email servers. Your email address is likely `name@company.com`, not `name@mail.company.com`, even though it's `mail.company.com` that is really handling your data for `@company.com` email to work." -msgstr "" - #: ../../../docs/faq.md:238 -msgid "Using a separate domain name is easier to manage (although it's a little hard to get right at first) and keeps your Matrix server isolated from your website (if you have one), from your email server (if you have one), etc. Therefore, this playbook sets up services on your Matrix server (`matrix.example.com`) by default." +msgid "Besides the regular Matrix stuff, we also support things like video-conferencing using [Jitsi](configuring-playbook-jitsi.md) and other additional services which (when installed) may use up a lot of memory. Things do add up. Besides the Synapse Matrix server, Jitsi is especially notorious for consuming a lot of resources. If you plan on running Jitsi, we recommend a server with at least 2GB of memory (preferably more). See our [Jitsi documentation page](configuring-playbook-jitsi.md) to learn how to optimize its memory/CPU usage." msgstr "" #: ../../../docs/faq.md:240 -msgid "I don't control anything on the base domain and can't set up delegation to matrix.example.com. What do I do?" +msgid "Can I run this in an LXC container?" msgstr "" #: ../../../docs/faq.md:242 -msgid "If you're not in control of your base domain (or the server handling it) at all, you can take a look at [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain)" +msgid "If your distro runs within an [LXC container](https://linuxcontainers.org/), you may hit [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/703). It can be worked around, if absolutely necessary, but we suggest that you avoid running from within an LXC container." msgstr "" #: ../../../docs/faq.md:244 -msgid "I can't set up HTTPS on the base domain. How will I get Matrix federating?" +msgid "Configuration" msgstr "" #: ../../../docs/faq.md:246 -msgid "If you really can't obtain an HTTPS certificate for your base domain, you can take a look at [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain)" +msgid "Why install my server at matrix.example.com and not at the base domain?" msgstr "" #: ../../../docs/faq.md:248 -msgid "How do I install on matrix.example.com without involving the base domain?" +msgid "It's the same with email servers. Your email address is likely `name@company.com`, not `name@mail.company.com`, even though it's `mail.company.com` that is really handling your data for `@company.com` email to work." msgstr "" #: ../../../docs/faq.md:250 +msgid "Using a separate domain name is easier to manage (although it's a little hard to get right at first) and keeps your Matrix server isolated from your website (if you have one), from your email server (if you have one), etc. Therefore, this playbook sets up services on your Matrix server (`matrix.example.com`) by default." +msgstr "" + +#: ../../../docs/faq.md:252 +msgid "I don't control anything on the base domain and can't set up delegation to matrix.example.com. What do I do?" +msgstr "" + +#: ../../../docs/faq.md:254 +msgid "If you're not in control of your base domain (or the server handling it) at all, you can take a look at [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain)" +msgstr "" + +#: ../../../docs/faq.md:256 +msgid "I can't set up HTTPS on the base domain. How will I get Matrix federating?" +msgstr "" + +#: ../../../docs/faq.md:258 +msgid "If you really can't obtain an HTTPS certificate for your base domain, you can take a look at [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain)" +msgstr "" + +#: ../../../docs/faq.md:260 +msgid "How do I install on matrix.example.com without involving the base domain?" +msgstr "" + +#: ../../../docs/faq.md:262 msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/faq.md:271 +#: ../../../docs/faq.md:283 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/faq.md:278 +#: ../../../docs/faq.md:290 msgid "**Notes**:" msgstr "" -#: ../../../docs/faq.md:280 +#: ../../../docs/faq.md:292 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/faq.md:282 +#: ../../../docs/faq.md:294 msgid "`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." msgstr "" -#: ../../../docs/faq.md:284 +#: ../../../docs/faq.md:296 msgid "Without setting up [server delegation](howto-server-delegation.md) to `matrix.example.com`, your user IDs will be like `@alice:matrix.example.com`. This is equivalent to having an email address like `bob@mail.company.com`, instead of just `bob@company.com`." msgstr "" -#: ../../../docs/faq.md:286 +#: ../../../docs/faq.md:298 msgid "I don't use the base domain for anything. How am I supposed to set up Server Delegation for Matrix services?" msgstr "" -#: ../../../docs/faq.md:288 +#: ../../../docs/faq.md:300 msgid "If you don't use your base domain for anything, then it's hard for you to \"serve files over HTTPS\" on it — something we ask you to do for the [.well-known](configuring-well-known.md) setup (needed for [Server Delegation](howto-server-delegation.md))." msgstr "" -#: ../../../docs/faq.md:290 +#: ../../../docs/faq.md:302 msgid "Luckily, the playbook can set up your Matrix server (at `matrix.example.com`) to also handle traffic for the base domain (`example.com`)." msgstr "" -#: ../../../docs/faq.md:292 +#: ../../../docs/faq.md:304 msgid "See [Serving the base domain](configuring-playbook-base-domain-serving.md)." msgstr "" -#: ../../../docs/faq.md:294 +#: ../../../docs/faq.md:306 msgid "How do I optimize this setup for a low-power server?" msgstr "" -#: ../../../docs/faq.md:296 +#: ../../../docs/faq.md:308 msgid "You can disable some not-so-important services to save on memory." msgstr "" -#: ../../../docs/faq.md:318 +#: ../../../docs/faq.md:327 msgid "You can also consider implementing a restriction on room complexity, in order to prevent users from joining very heavy rooms:" msgstr "" -#: ../../../docs/faq.md:328 +#: ../../../docs/faq.md:337 msgid "If you've installed [Jitsi](configuring-playbook-jitsi.md) (not installed by default), there are additional optimizations listed on its documentation page that you can perform." msgstr "" -#: ../../../docs/faq.md:330 +#: ../../../docs/faq.md:339 msgid "I already have Docker on my server. Can you stop installing Docker via the playbook?" msgstr "" -#: ../../../docs/faq.md:332 +#: ../../../docs/faq.md:341 msgid "Yes, we can stop installing Docker ourselves. Just use this in your `vars.yml` file:" msgstr "" -#: ../../../docs/faq.md:338 +#: ../../../docs/faq.md:347 msgid "I run another webserver on the same server where I wish to install Matrix. What now?" msgstr "" -#: ../../../docs/faq.md:340 +#: ../../../docs/faq.md:349 msgid "By default, we install a webserver for you ([Traefik](https://doc.traefik.io/traefik/)), but you can also use [your own webserver](configuring-playbook-own-webserver.md)." msgstr "" -#: ../../../docs/faq.md:342 +#: ../../../docs/faq.md:351 msgid "How is the effective configuration determined?" msgstr "" -#: ../../../docs/faq.md:344 +#: ../../../docs/faq.md:353 msgid "Configuration variables are defined in multiple places in this playbook and are considered in this order:" msgstr "" -#: ../../../docs/faq.md:346 +#: ../../../docs/faq.md:355 msgid "there are defaults coming from each role's defaults file (`role/matrix*/defaults/main.yml`). These variable values aim to be good defaults for when the role is used standalone (outside of this collection of roles, also called playbook)." msgstr "" -#: ../../../docs/faq.md:348 +#: ../../../docs/faq.md:357 msgid "then, there are overrides in `group_vars/matrix_servers`, which aim to adjust these \"standalone role defaults\" to something which better fits the playbook in its entirety." msgstr "" -#: ../../../docs/faq.md:350 +#: ../../../docs/faq.md:359 msgid "finally, there's your `inventory/host_vars/matrix.example.com/vars.yml` file, which is the ultimate override" msgstr "" -#: ../../../docs/faq.md:352 +#: ../../../docs/faq.md:361 msgid "What configuration variables are available?" msgstr "" -#: ../../../docs/faq.md:354 +#: ../../../docs/faq.md:363 msgid "You can discover the variables you can override in each role (`roles/*/*/defaults/main.yml`)." msgstr "" -#: ../../../docs/faq.md:356 -msgid "As described in [How is the effective configuration determined?](#how-is-the-effective-configuration-determined), these role-defaults may be overriden by values defined in `group_vars/matrix_servers`." +#: ../../../docs/faq.md:365 +msgid "As described in [How is the effective configuration determined?](#how-is-the-effective-configuration-determined), these role-defaults may be overridden by values defined in `group_vars/matrix_servers`." msgstr "" -#: ../../../docs/faq.md:358 +#: ../../../docs/faq.md:367 msgid "Refer to both of these for inspiration. Still, as mentioned in [Configuring the playbook](configuring-playbook.md), you're only ever supposed to edit your own `inventory/host_vars/matrix.example.com/vars.yml` file and nothing else inside the playbook (unless you're meaning to contribute new features)." msgstr "" -#: ../../../docs/faq.md:360 -#: ../../../docs/faq.md:372 +#: ../../../docs/faq.md:369 +#: ../../../docs/faq.md:381 msgid "**Note**: some of the roles (`roles/galaxy/*`) live in separate repositories and are only installed after your run `just roles` (or `make roles`) or `just update` (which automatically does `git pull` and `just roles`)." msgstr "" -#: ../../../docs/faq.md:362 +#: ../../../docs/faq.md:371 msgid "I'd like to adjust some configuration which doesn't have a corresponding variable. How do I do it?" msgstr "" -#: ../../../docs/faq.md:364 +#: ../../../docs/faq.md:373 msgid "The playbook doesn't aim to expose all configuration settings for all services using variables. Doing so would amount to hundreds of variables that we have to create and maintain." msgstr "" -#: ../../../docs/faq.md:366 +#: ../../../docs/faq.md:375 msgid "Instead, we only try to make some important basics configurable using dedicated variables you can see in each role. See [What configuration variables are available?](#what-configuration-variables-are-available)." msgstr "" -#: ../../../docs/faq.md:368 +#: ../../../docs/faq.md:377 msgid "Besides that, each role (component) aims to provide a `matrix_SOME_COMPONENT_configuration_extension_yaml` (or `matrix_SOME_COMPONENT_configuration_extension_json`) variable, which can be used to override the configuration." msgstr "" -#: ../../../docs/faq.md:370 +#: ../../../docs/faq.md:379 msgid "Check each role's `roles/*/*/defaults/main.yml` for the corresponding variable and an example for how use it." msgstr "" -#: ../../../docs/faq.md:374 +#: ../../../docs/faq.md:383 msgid "Installation" msgstr "" -#: ../../../docs/faq.md:376 +#: ../../../docs/faq.md:385 msgid "How do I run the installation?" msgstr "" -#: ../../../docs/faq.md:378 +#: ../../../docs/faq.md:387 msgid "See [Installing](installing.md) to learn how to use Ansible to install Matrix services." msgstr "" -#: ../../../docs/faq.md:380 +#: ../../../docs/faq.md:389 msgid "However, we recommend you to follow our installation guide, instead of jumping straight to installing." msgstr "" -#: ../../../docs/faq.md:382 +#: ../../../docs/faq.md:391 msgid "There are two guides available:" msgstr "" -#: ../../../docs/faq.md:384 +#: ../../../docs/faq.md:393 msgid "⚡ **[Quick start](quick-start.md)** (for beginners): this is recommended for those who do not have an existing Matrix server and want to start quickly with \"opinionated defaults\"." msgstr "" -#: ../../../docs/faq.md:386 +#: ../../../docs/faq.md:395 msgid "**Full installation guide (for advanced users)**: if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide by starting with the **[Prerequisites](prerequisites.md)** documentation page." msgstr "" -#: ../../../docs/faq.md:388 +#: ../../../docs/faq.md:397 msgid "I installed Synapse some other way. Can I migrate such a setup to the playbook?" msgstr "" -#: ../../../docs/faq.md:390 +#: ../../../docs/faq.md:399 msgid "Yes, you can." msgstr "" -#: ../../../docs/faq.md:392 +#: ../../../docs/faq.md:401 msgid "You generally need to do a playbook installation. It's recommended to follow the full installation guide (starting at the [Prerequisites](prerequisites.md) page), not the [Quick start](quick-start.md) guide. The full installation guide will tell you when it's time to import your existing data into the newly-prepared server." msgstr "" -#: ../../../docs/faq.md:394 +#: ../../../docs/faq.md:403 msgid "This Ansible playbook guides you into installing a server for `example.com` (user IDs are like this: `@alice:example.com`), while the server is at `matrix.example.com`. If your existing setup has a server name (`server_name` configuration setting in Synapse's `homeserver.yaml` file) other than the base `example.com`, you may need to tweak some additional variables. This FAQ entry may be of use if you're dealing with a more complicated setup — [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain)" msgstr "" -#: ../../../docs/faq.md:396 +#: ../../../docs/faq.md:405 msgid "After configuring the playbook and installing and **before starting** services (done with `ansible-playbook … --tags=start`) you'd import [your SQLite](importing-synapse-sqlite.md) (or [Postgres](importing-postgres.md)) database and also [import your media store](importing-synapse-media-store.md)." msgstr "" -#: ../../../docs/faq.md:398 +#: ../../../docs/faq.md:407 msgid "I've downloaded Ansible and the playbook on the server. It can't connect using SSH." msgstr "" -#: ../../../docs/faq.md:400 +#: ../../../docs/faq.md:409 msgid "If you're using the playbook directly on the server, then Ansible doesn't need to connect using SSH." msgstr "" -#: ../../../docs/faq.md:402 +#: ../../../docs/faq.md:411 msgid "It can perform a local connection instead. Just set `ansible_connection=local` at the end of the server line in `inventory/hosts` and re-run the playbook." msgstr "" -#: ../../../docs/faq.md:404 +#: ../../../docs/faq.md:413 msgid "If you're running Ansible from within a container (one of the possibilities we list on our [dedicated Ansible documentation page](ansible.md)), then using `ansible_connection=local` is not possible." msgstr "" -#: ../../../docs/faq.md:406 -msgid "Troubleshooting" +#: ../../../docs/faq.md:415 +msgid "Maintenance and Troubleshooting" msgstr "" -#: ../../../docs/faq.md:408 -msgid "I get \"Error response from daemon: configured logging driver does not support reading\" when I do `docker logs matrix-synapse`." +#: ../../../docs/faq.md:417 +msgid "💡 Also see this page for generic information about maintaining the services and troubleshooting: [Maintenance and Troubleshooting](maintenance-and-troubleshooting.md)" msgstr "" -#: ../../../docs/faq.md:410 -msgid "See [How can I see the logs?](#how-can-i-see-the-logs)." -msgstr "" - -#: ../../../docs/faq.md:412 -msgid "How can I see the logs?" -msgstr "" - -#: ../../../docs/faq.md:414 -msgid "We utilize [systemd/journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html#Description) for logging." -msgstr "" - -#: ../../../docs/faq.md:416 -msgid "To see logs for Synapse, run `journalctl -fu matrix-synapse.service`. You may wish to see the [manual page for journalctl](https://www.commandlinux.com/man-page/man1/journalctl.1.html)." -msgstr "" - -#: ../../../docs/faq.md:418 -msgid "Available service names can be seen by doing `ls /etc/systemd/system/matrix*.service` on the server." -msgstr "" - -#: ../../../docs/faq.md:420 -msgid "Some services also log to files in `/matrix/*/data/..`, but we're slowly moving away from that." -msgstr "" - -#: ../../../docs/faq.md:422 -msgid "We also disable Docker logging, so you can't use `docker logs matrix-*` either. We do this to prevent useless double (or even triple) logging and to avoid having to rotate log files." -msgstr "" - -#: ../../../docs/faq.md:424 -msgid "We just simply delegate logging to journald and it takes care of persistence and expiring old data." -msgstr "" - -#: ../../../docs/faq.md:426 -msgid "Also see: [How long do systemd/journald logs persist for?](#how-long-do-systemdjournald-logs-persist-for)" -msgstr "" - -#: ../../../docs/faq.md:428 -msgid "How long do systemd/journald logs persist for?" -msgstr "" - -#: ../../../docs/faq.md:430 -msgid "On some distros, the journald logs are just in-memory and not persisted to disk." -msgstr "" - -#: ../../../docs/faq.md:432 -msgid "Consult (and feel free to adjust) your distro's journald logging configuration in `/etc/systemd/journald.conf`." -msgstr "" - -#: ../../../docs/faq.md:434 -msgid "To enable persistence and put some limits on how large the journal log files can become, adjust your configuration like this:" -msgstr "" - -#: ../../../docs/faq.md:445 -msgid "Maintenance" -msgstr "" - -#: ../../../docs/faq.md:447 +#: ../../../docs/faq.md:419 msgid "Do I need to do anything to keep my Matrix server updated?" msgstr "" -#: ../../../docs/faq.md:449 +#: ../../../docs/faq.md:421 msgid "Yes. We don't update anything for you automatically." msgstr "" -#: ../../../docs/faq.md:451 +#: ../../../docs/faq.md:423 msgid "See our [documentation page about upgrading services](maintenance-upgrading-services.md)." msgstr "" -#: ../../../docs/faq.md:453 +#: ../../../docs/faq.md:425 msgid "How do I move my existing installation to another (VM) server?" msgstr "" -#: ../../../docs/faq.md:455 -msgid "If you have an existing installation done using this Ansible playbook, you can easily migrate that to another server using [our dedicated server migration guide](maintenance-migrating.md)." +#: ../../../docs/faq.md:427 +msgid "If you have an existing installation done using this Ansible playbook, you can easily migrate that to another server following [our dedicated server migration guide](maintenance-migrating.md)." msgstr "" -#: ../../../docs/faq.md:457 +#: ../../../docs/faq.md:429 msgid "If your previous installation is done in some other way (not using this Ansible playbook), see [I installed Synapse some other way. Can I migrate such a setup to the playbook?](#i-installed-synapse-some-other-way-can-i-migrate-such-a-setup-to-the-playbook)." msgstr "" -#: ../../../docs/faq.md:459 -msgid "How do I back up the data on my server?" -msgstr "" - -#: ../../../docs/faq.md:461 -msgid "We haven't documented this properly yet, but the general advice is to:" -msgstr "" - -#: ../../../docs/faq.md:463 -msgid "back up Postgres by making a database dump. See [Backing up PostgreSQL](maintenance-postgres.md#backing-up-postgresql)" -msgstr "" - -#: ../../../docs/faq.md:465 -msgid "back up all `/matrix` files, except for `/matrix/postgres/data` (you already have a dump) and `/matrix/postgres/data-auto-upgrade-backup` (this directory may exist and contain your old data if you've [performed a major Postgres upgrade](maintenance-postgres.md#upgrading-postgresql))." -msgstr "" - -#: ../../../docs/faq.md:467 -msgid "You can later restore these by:" -msgstr "" - -#: ../../../docs/faq.md:469 -msgid "Restoring the `/matrix` directory and files on the new server manually" -msgstr "" - -#: ../../../docs/faq.md:470 -msgid "Following the instruction described on [Installing a server into which you'll import old data](installing.md#installing-a-server-into-which-youll-import-old-data)" -msgstr "" - -#: ../../../docs/faq.md:472 -msgid "If your server's IP address has changed, you may need to [set up DNS](configuring-dns.md) again." -msgstr "" - -#: ../../../docs/faq.md:474 +#: ../../../docs/faq.md:431 msgid "What is this `/matrix/postgres/data-auto-upgrade-backup` directory that is taking up so much space?" msgstr "" -#: ../../../docs/faq.md:476 +#: ../../../docs/faq.md:433 msgid "When you [perform a major Postgres upgrade](maintenance-postgres.md#upgrading-postgresql), we save the the old data files in `/matrix/postgres/data-auto-upgrade-backup`, just so you could easily restore them should something have gone wrong." msgstr "" -#: ../../../docs/faq.md:478 +#: ../../../docs/faq.md:435 msgid "After verifying that everything still works after the Postgres upgrade, you can safely delete `/matrix/postgres/data-auto-upgrade-backup`" msgstr "" -#: ../../../docs/faq.md:480 -msgid "How do I debug or force SSL certificate renewal?" +#: ../../../docs/faq.md:437 +msgid "I get \"Error response from daemon: configured logging driver does not support reading\" when I run `docker logs matrix-synapse`. Why?" msgstr "" -#: ../../../docs/faq.md:482 -msgid "SSL certificates are managed automatically by the [Traefik](https://doc.traefik.io/traefik/) reverse-proxy server." +#: ../../../docs/faq.md:439 +msgid "To prevent double-logging, Docker logging is disabled by explicitly passing `--log-driver=none` to all containers. Due to this, you cannot view logs using `docker logs matrix-*`." msgstr "" -#: ../../../docs/faq.md:484 -msgid "If you're having trouble with SSL certificate renewal, check the Traefik logs (`journalctl -fu matrix-traefik`)." +#: ../../../docs/faq.md:441 +msgid "See [this section](maintenance-and-troubleshooting.md#how-to-see-the-logs) on the page for maintenance and troubleshooting for more details to see the logs." msgstr "" -#: ../../../docs/faq.md:486 -msgid "If you're [using your own webserver](configuring-playbook-own-webserver.md) instead of the integrated one (Traefik), you should investigate in another way." -msgstr "" - -#: ../../../docs/faq.md:488 +#: ../../../docs/faq.md:443 msgid "Miscellaneous" msgstr "" -#: ../../../docs/faq.md:490 +#: ../../../docs/faq.md:445 msgid "I would like to see this favorite service of mine integrated and become available on my Matrix server. How can I request it?" msgstr "" -#: ../../../docs/faq.md:492 -msgid "You can freely create an issue for feature request on the repository at GitHub [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/new). Note this is a community project with no financial backing, and there is not assurance that your request would be eventually picked up by others and the requested feature would become available. The easiest way to get a feature into this project is to just develop it yourself." +#: ../../../docs/faq.md:447 +msgid "You can freely create an issue for feature request on the repository at GitHub [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/new/choose). Note this is a community project with no financial backing, and there is not assurance that your request would be eventually picked up by others and the requested feature would become available. The easiest way to get a feature into this project is to just develop it yourself." msgstr "" -#: ../../../docs/faq.md:494 +#: ../../../docs/faq.md:449 msgid "Also, please note that this playbook intends to focus solely on Matrix and Matrix-related services. If your request is not specific to Matrix, you may as well to consider to submit it to the [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook), maintained by the members behind this matrix-docker-ansible-deploy project. [This document on the interoperability](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/interoperability.md) describes how to deploy services along with the Matrix services easily." msgstr "" diff --git a/i18n/translation-templates/docs/getting-the-playbook.pot b/i18n/translation-templates/docs/getting-the-playbook.pot index 8138929a9..efbf72c2d 100644 --- a/i18n/translation-templates/docs/getting-the-playbook.pot +++ b/i18n/translation-templates/docs/getting-the-playbook.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,66 +16,66 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/getting-the-playbook.md:1 +#: ../../../docs/getting-the-playbook.md:8 msgid "Getting the playbook" msgstr "" -#: ../../../docs/getting-the-playbook.md:3 -msgid "[Prerequisites](prerequisites.md) > [Configuring your DNS settings](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)" +#: ../../../docs/getting-the-playbook.md:10 +msgid "[Prerequisites](prerequisites.md) > [Configuring DNS settings](configuring-dns.md) > Getting the playbook > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)" msgstr "" -#: ../../../docs/getting-the-playbook.md:5 +#: ../../../docs/getting-the-playbook.md:12 msgid "This Ansible playbook is meant to be executed on your own computer (not the Matrix server)." msgstr "" -#: ../../../docs/getting-the-playbook.md:7 +#: ../../../docs/getting-the-playbook.md:14 msgid "In special cases (if your computer cannot run Ansible, etc.) you may put the playbook on the server as well." msgstr "" -#: ../../../docs/getting-the-playbook.md:9 +#: ../../../docs/getting-the-playbook.md:16 msgid "You can retrieve the playbook's source code by:" msgstr "" -#: ../../../docs/getting-the-playbook.md:11 +#: ../../../docs/getting-the-playbook.md:17 msgid "[Using git to get the playbook](#using-git-to-get-the-playbook) (recommended)" msgstr "" -#: ../../../docs/getting-the-playbook.md:13 +#: ../../../docs/getting-the-playbook.md:18 msgid "[Downloading the playbook as a ZIP archive](#downloading-the-playbook-as-a-zip-archive) (not recommended)" msgstr "" -#: ../../../docs/getting-the-playbook.md:15 +#: ../../../docs/getting-the-playbook.md:20 msgid "Using git to get the playbook" msgstr "" -#: ../../../docs/getting-the-playbook.md:17 +#: ../../../docs/getting-the-playbook.md:22 msgid "We recommend using the [git](https://git-scm.com/) tool to get the playbook's source code, because it lets you easily keep up to date in the future when [Maintaining services](maintenance-upgrading-services.md)." msgstr "" -#: ../../../docs/getting-the-playbook.md:19 +#: ../../../docs/getting-the-playbook.md:24 msgid "Once you've installed git on your computer, you can go to any directory of your choosing and run the following command to retrieve the playbook's source code:" msgstr "" -#: ../../../docs/getting-the-playbook.md:25 +#: ../../../docs/getting-the-playbook.md:30 msgid "This will create a new `matrix-docker-ansible-deploy` directory. You're supposed to execute all other installation commands inside that directory." msgstr "" -#: ../../../docs/getting-the-playbook.md:27 +#: ../../../docs/getting-the-playbook.md:32 msgid "Downloading the playbook as a ZIP archive" msgstr "" -#: ../../../docs/getting-the-playbook.md:29 +#: ../../../docs/getting-the-playbook.md:34 msgid "Alternatively, you can download the playbook as a ZIP archive. This is not recommended, as it's not easy to keep up to date with future updates. We suggest you [use git](#using-git-to-get-the-playbook) instead." msgstr "" -#: ../../../docs/getting-the-playbook.md:31 +#: ../../../docs/getting-the-playbook.md:36 msgid "The latest version is always at the following URL: https://github.com/spantaleev/matrix-docker-ansible-deploy/archive/master.zip" msgstr "" -#: ../../../docs/getting-the-playbook.md:33 +#: ../../../docs/getting-the-playbook.md:38 msgid "You can extract this archive anywhere. You'll get a directory called `matrix-docker-ansible-deploy-master`. You're supposed to execute all other installation commands inside that directory." msgstr "" -#: ../../../docs/getting-the-playbook.md:37 +#: ../../../docs/getting-the-playbook.md:42 msgid "[▶️](configuring-playbook.md) No matter which method you've used to download the playbook, you can proceed by [Configuring the playbook](configuring-playbook.md)." msgstr "" diff --git a/i18n/translation-templates/docs/howto-server-delegation.pot b/i18n/translation-templates/docs/howto-server-delegation.pot index 0808068c2..bf6c553df 100644 --- a/i18n/translation-templates/docs/howto-server-delegation.pot +++ b/i18n/translation-templates/docs/howto-server-delegation.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,170 +16,170 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/howto-server-delegation.md:1 +#: ../../../docs/howto-server-delegation.md:13 msgid "Server Delegation" msgstr "" -#: ../../../docs/howto-server-delegation.md:3 +#: ../../../docs/howto-server-delegation.md:15 msgid "By default, this playbook sets up services on your Matrix server (`matrix.example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection." msgstr "" -#: ../../../docs/howto-server-delegation.md:5 +#: ../../../docs/howto-server-delegation.md:17 msgid "Server delegation can be configured in either of these ways:" msgstr "" -#: ../../../docs/howto-server-delegation.md:7 +#: ../../../docs/howto-server-delegation.md:19 msgid "[Setting up a `/.well-known/matrix/server` file](#server-delegation-via-a-well-known-file) on the base domain (`example.com`)" msgstr "" -#: ../../../docs/howto-server-delegation.md:8 +#: ../../../docs/howto-server-delegation.md:20 msgid "[Setting up a `_matrix._tcp` DNS SRV record](#server-delegation-via-a-dns-srv-record-advanced)" msgstr "" -#: ../../../docs/howto-server-delegation.md:10 +#: ../../../docs/howto-server-delegation.md:22 msgid "Both methods have their place and will continue to do so. You only need to use just one of these delegation methods." msgstr "" -#: ../../../docs/howto-server-delegation.md:12 +#: ../../../docs/howto-server-delegation.md:24 msgid "For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file. However, that method may have some downsides that are not to your liking. Hence this guide about alternative ways to set up Server Delegation." msgstr "" -#: ../../../docs/howto-server-delegation.md:14 +#: ../../../docs/howto-server-delegation.md:26 msgid "**Note**: as an alternative, it is possible to install the server such that it uses only the `matrix.example.com` domain (instead of identifying as the shorter base domain — `example.com`). This should be helpful if you are not in control of anything on the base domain (`example.com`). In this case, you would not need to configure server delegation, but you would need to add other configuration. For more information, see [How do I install on matrix.example.com without involving the base domain?](faq.md#how-do-i-install-on-matrix-example-com-without-involving-the-base-domain) on our FAQ." msgstr "" -#: ../../../docs/howto-server-delegation.md:16 +#: ../../../docs/howto-server-delegation.md:28 msgid "Server Delegation via a well-known file" msgstr "" -#: ../../../docs/howto-server-delegation.md:18 +#: ../../../docs/howto-server-delegation.md:30 msgid "This playbook recommends you to set up server delegation by means of a `/.well-known/matrix/server` file served from the base domain (`example.com`), as this is the most straightforward way to set up the delegation." msgstr "" -#: ../../../docs/howto-server-delegation.md:20 +#: ../../../docs/howto-server-delegation.md:32 msgid "To configure server delegation with the well-known file, check this section on [Configuring Service Discovery via .well-known](configuring-well-known.md): [Installing well-known files on the base domain's server](configuring-well-known.md#installing-well-known-files-on-the-base-domain-s-server)" msgstr "" -#: ../../../docs/howto-server-delegation.md:22 +#: ../../../docs/howto-server-delegation.md:34 msgid "Downsides of well-known-based Server Delegation" msgstr "" -#: ../../../docs/howto-server-delegation.md:24 +#: ../../../docs/howto-server-delegation.md:36 msgid "Server Delegation by means of a `/.well-known/matrix/server` file is the most straightforward, but suffers from the following downsides:" msgstr "" -#: ../../../docs/howto-server-delegation.md:26 +#: ../../../docs/howto-server-delegation.md:38 msgid "you need to have a working HTTPS server for the base domain (`example.com`). If you don't have any server for the base domain at all, you can easily solve it by making the playbook [serve the base domain from the Matrix server](configuring-playbook-base-domain-serving.md)." msgstr "" -#: ../../../docs/howto-server-delegation.md:28 +#: ../../../docs/howto-server-delegation.md:40 msgid "any downtime on the base domain (`example.com`) or network trouble between the Matrix subdomain (`matrix.example.com`) and the base `example.com` may cause Matrix Federation outages. As the [Server-Server spec says](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery):" msgstr "" -#: ../../../docs/howto-server-delegation.md:30 +#: ../../../docs/howto-server-delegation.md:42 msgid "Errors are recommended to be cached for up to an hour, and servers are encouraged to exponentially back off for repeated failures." msgstr "" -#: ../../../docs/howto-server-delegation.md:32 +#: ../../../docs/howto-server-delegation.md:44 msgid "**For most people, this is a reasonable tradeoff** given that it's easy and straightforward to set up. We recommend you stay on this path." msgstr "" -#: ../../../docs/howto-server-delegation.md:34 +#: ../../../docs/howto-server-delegation.md:46 msgid "Otherwise, you can decide to go against the default for this playbook, and instead set up [Server Delegation via a DNS SRV record (advanced)](#server-delegation-via-a-dns-srv-record-advanced) (much more complicated)." msgstr "" -#: ../../../docs/howto-server-delegation.md:36 +#: ../../../docs/howto-server-delegation.md:48 msgid "Server Delegation via a DNS SRV record (advanced)" msgstr "" -#: ../../../docs/howto-server-delegation.md:38 +#: ../../../docs/howto-server-delegation.md:50 msgid "**Note**: doing Server Delegation via a DNS SRV record is a more **advanced** way to do it and is not the default for this playbook. This is usually **much more complicated** to set up, so **we don't recommend it**. If you're not an experienced sysadmin, you'd better stay away from this." msgstr "" -#: ../../../docs/howto-server-delegation.md:40 +#: ../../../docs/howto-server-delegation.md:52 msgid "As per the [Server-Server spec](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), it's possible to do Server Delegation using only a SRV record (without a `/.well-known/matrix/server` file)." msgstr "" -#: ../../../docs/howto-server-delegation.md:42 +#: ../../../docs/howto-server-delegation.md:54 msgid "This prevents you from suffering the [Downsides of well-known-based Server Delegation](#downsides-of-well-known-based-server-delegation)." msgstr "" -#: ../../../docs/howto-server-delegation.md:44 +#: ../../../docs/howto-server-delegation.md:56 msgid "To use DNS SRV record validation, you need to:" msgstr "" -#: ../../../docs/howto-server-delegation.md:46 +#: ../../../docs/howto-server-delegation.md:58 msgid "ensure that `/.well-known/matrix/server` is **not served** from the base domain, as that would interfere with DNS SRV record Server Delegation. To make the playbook **not** generate and serve the file, use the following configuration: `matrix_static_files_file_matrix_server_enabled: false`." msgstr "" -#: ../../../docs/howto-server-delegation.md:48 +#: ../../../docs/howto-server-delegation.md:60 msgid "ensure that you have a `_matrix._tcp` DNS SRV record for your base domain (`example.com`) with a value of `10 0 8448 matrix.example.com`" msgstr "" -#: ../../../docs/howto-server-delegation.md:50 +#: ../../../docs/howto-server-delegation.md:62 msgid "ensure that you are serving the Matrix Federation API (tcp/8448) with a certificate for `example.com` (not `matrix.example.com`!). Getting this certificate to the `matrix.example.com` server may be complicated. The playbook's automatic SSL obtaining/renewal flow will likely not work and you'll need to copy certificates around manually. See below." msgstr "" -#: ../../../docs/howto-server-delegation.md:52 +#: ../../../docs/howto-server-delegation.md:64 msgid "For more details on how to configure the playbook to work with SRV delegation, take a look at this documentation: [Server Delegation via a DNS SRV record (advanced)](howto-srv-server-delegation.md)" msgstr "" -#: ../../../docs/howto-server-delegation.md:54 +#: ../../../docs/howto-server-delegation.md:66 msgid "Obtain certificates" msgstr "" -#: ../../../docs/howto-server-delegation.md:56 +#: ../../../docs/howto-server-delegation.md:68 msgid "How you can obtain a valid certificate for `example.com` on the `matrix.example.com` server is up to you." msgstr "" -#: ../../../docs/howto-server-delegation.md:58 +#: ../../../docs/howto-server-delegation.md:70 msgid "If `example.com` and `matrix.example.com` are hosted on the same machine, you can let the playbook obtain the certificate for you, by following our [Obtaining SSL certificates for additional domains](configuring-playbook-ssl-certificates.md#obtaining-ssl-certificates-for-additional-domains) guide." msgstr "" -#: ../../../docs/howto-server-delegation.md:60 +#: ../../../docs/howto-server-delegation.md:72 msgid "If `example.com` and `matrix.example.com` are not hosted on the same machine, you can copy over the certificate files manually. Don't forget that they may get renewed once in a while, so you may also have to transfer them periodically. How often you do that is up to you, as long as the certificate files don't expire." msgstr "" -#: ../../../docs/howto-server-delegation.md:62 +#: ../../../docs/howto-server-delegation.md:74 msgid "Serving the Federation API with your certificates" msgstr "" -#: ../../../docs/howto-server-delegation.md:64 +#: ../../../docs/howto-server-delegation.md:76 msgid "Regardless of which method for obtaining certificates you've used, once you've managed to get certificates for your base domain onto the `matrix.example.com` machine you can put them to use." msgstr "" -#: ../../../docs/howto-server-delegation.md:66 +#: ../../../docs/howto-server-delegation.md:78 msgid "Based on your setup, you have different ways to go about it:" msgstr "" -#: ../../../docs/howto-server-delegation.md:68 +#: ../../../docs/howto-server-delegation.md:80 msgid "Serving the Federation API with your certificates and Synapse handling Federation" msgstr "" -#: ../../../docs/howto-server-delegation.md:70 +#: ../../../docs/howto-server-delegation.md:82 msgid "You can let Synapse handle Federation by itself." msgstr "" -#: ../../../docs/howto-server-delegation.md:72 +#: ../../../docs/howto-server-delegation.md:84 msgid "To do that, make sure the certificate files are mounted into the Synapse container:" msgstr "" -#: ../../../docs/howto-server-delegation.md:79 +#: ../../../docs/howto-server-delegation.md:91 msgid "You can then tell Synapse to serve Federation traffic over TLS on `tcp/8448`:" msgstr "" -#: ../../../docs/howto-server-delegation.md:87 +#: ../../../docs/howto-server-delegation.md:99 msgid "Make sure to reload Synapse once in a while (`systemctl reload matrix-synapse`), so that newer certificates can kick in. Reloading doesn't cause any downtime." msgstr "" -#: ../../../docs/howto-server-delegation.md:89 +#: ../../../docs/howto-server-delegation.md:101 msgid "Serving the Federation API with your certificates and another webserver" msgstr "" -#: ../../../docs/howto-server-delegation.md:91 +#: ../../../docs/howto-server-delegation.md:103 msgid "**Alternatively**, if you are using another webserver, you can set up reverse-proxying for the `tcp/8448` port by yourself. Make sure to use the proper certificates for `example.com` (not for `matrix.example.com`) when serving the `tcp/8448` port." msgstr "" -#: ../../../docs/howto-server-delegation.md:93 +#: ../../../docs/howto-server-delegation.md:105 msgid "As recommended in our [Fronting the integrated reverse-proxy webserver with another reverse-proxy](./configuring-playbook-own-webserver.md#fronting-the-integrated-reverse-proxy-webserver-with-another-reverse-proxy) documentation section, we recommend you to expose the Matrix Federation entrypoint from traffic at a local port (e.g. `127.0.0.1:8449`), so your reverese-proxy should send traffic there." msgstr "" diff --git a/i18n/translation-templates/docs/howto-srv-server-delegation.pot b/i18n/translation-templates/docs/howto-srv-server-delegation.pot index 62abff6ab..ad6e307a3 100644 --- a/i18n/translation-templates/docs/howto-srv-server-delegation.pot +++ b/i18n/translation-templates/docs/howto-srv-server-delegation.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,130 +16,130 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/howto-srv-server-delegation.md:1 +#: ../../../docs/howto-srv-server-delegation.md:9 msgid "Server Delegation via a DNS SRV record (advanced)" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:3 +#: ../../../docs/howto-srv-server-delegation.md:11 msgid "**Reminder** : unless you are affected by the [Downsides of well-known-based Server Delegation](howto-server-delegation.md#downsides-of-well-known-based-server-delegation), we suggest you **stay on the simple/default path**: [Server Delegation](howto-server-delegation.md) by [configuring well-known files](configuring-well-known.md) at the base domain." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:5 +#: ../../../docs/howto-srv-server-delegation.md:13 msgid "This guide is about configuring Server Delegation using DNS SRV records (for the [Traefik](https://doc.traefik.io/traefik/) webserver). This method has special requirements when it comes to SSL certificates, so various changes are required." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:7 +#: ../../../docs/howto-srv-server-delegation.md:15 msgid "Prerequisites" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:9 +#: ../../../docs/howto-srv-server-delegation.md:17 msgid "SRV delegation while still using the playbook provided Traefik to get / renew the certificate requires a wildcard certificate." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:11 +#: ../../../docs/howto-srv-server-delegation.md:19 msgid "To obtain / renew one from [Let's Encrypt](https://letsencrypt.org/), one needs to use a [DNS-01 challenge](https://letsencrypt.org/docs/challenge-types/#dns-01-challenge) method instead of the default [HTTP-01](https://letsencrypt.org/docs/challenge-types/#http-01-challenge)." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:13 +#: ../../../docs/howto-srv-server-delegation.md:21 msgid "This means that this is **limited to the list of DNS providers supported by Traefik**, unless you bring in your own certificate." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:15 +#: ../../../docs/howto-srv-server-delegation.md:23 msgid "The up-to-date list can be accessed on [traefik's documentation](https://doc.traefik.io/traefik/https/acme/#providers)" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:17 +#: ../../../docs/howto-srv-server-delegation.md:25 msgid "Adjusting the playbook configuration" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:19 +#: ../../../docs/howto-srv-server-delegation.md:27 msgid "**Note**: the changes below instruct you how to do this for a basic Synapse installation. You will need to adapt the variable name and the content of the labels:" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:21 -msgid "if you're using another homeserver implementation (e.g. [Conduit](./configuring-playbook-conduit.md), [conduwuit](./configuring-playbook-conduwuit.md) or [Dendrite](./configuring-playbook-dendrite.md))" +#: ../../../docs/howto-srv-server-delegation.md:29 +msgid "if you're using another homeserver implementation (e.g. [Conduit](./configuring-playbook-conduit.md), [conduwuit](./configuring-playbook-conduwuit.md), [continuwuity](./configuring-playbook-continuwuity.md) or [Dendrite](./configuring-playbook-dendrite.md))" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:22 +#: ../../../docs/howto-srv-server-delegation.md:30 msgid "if you're using [Synapse with workers enabled](./configuring-playbook-synapse.md#load-balancing-with-workers) (`matrix_synapse_workers_enabled: true`). In that case, it's actually the `matrix-synapse-reverse-proxy-companion` service which has Traefik labels attached" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:24 +#: ../../../docs/howto-srv-server-delegation.md:32 msgid "Also, all instructions below are from an older version of the playbook and may not work anymore." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:26 +#: ../../../docs/howto-srv-server-delegation.md:34 msgid "Federation Endpoint" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:33 +#: ../../../docs/howto-srv-server-delegation.md:41 msgid "This is because with SRV federation, some servers / tools (one of which being the federation tester) try to access the federation API using the resolved IP address instead of the domain name (or they are not using SNI). This change will make Traefik route all traffic for which the path match this rule go to the federation endpoint." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:35 +#: ../../../docs/howto-srv-server-delegation.md:43 msgid "Tell Traefik which certificate to serve for the federation endpoint" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:37 -msgid "Now that the federation endpoint is not bound to a domain anymore we need to explicitely tell Traefik to use a wildcard certificate in addition to one containing the base name." +#: ../../../docs/howto-srv-server-delegation.md:45 +msgid "Now that the federation endpoint is not bound to a domain anymore we need to explicitly tell Traefik to use a wildcard certificate in addition to one containing the base name." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:39 +#: ../../../docs/howto-srv-server-delegation.md:47 msgid "This is because the Matrix specification expects the federation endpoint to be served using a certificate compatible with the base domain, however, the other resources on the endpoint still need a valid certificate to work." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:48 +#: ../../../docs/howto-srv-server-delegation.md:56 msgid "Configure the DNS-01 challenge for let's encrypt" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:50 +#: ../../../docs/howto-srv-server-delegation.md:58 msgid "Since we're now requesting a wildcard certificate, we need to change the ACME challenge method. To request a wildcard certificate from Let's Encrypt we are required to use the DNS-01 challenge." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:52 +#: ../../../docs/howto-srv-server-delegation.md:60 msgid "This will need 3 changes:" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:53 +#: ../../../docs/howto-srv-server-delegation.md:61 msgid "Add a new certificate resolver that works with DNS-01" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:54 +#: ../../../docs/howto-srv-server-delegation.md:62 msgid "Configure the resolver to allow access to the DNS zone to configure the records to answer the challenge (refer to [Traefik's documentation](https://doc.traefik.io/traefik/https/acme/#providers) to know which environment variables to set)" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:55 +#: ../../../docs/howto-srv-server-delegation.md:63 msgid "Tell the playbook to use the new resolver as default" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:57 +#: ../../../docs/howto-srv-server-delegation.md:65 msgid "We cannot just disable the default resolver as that would disable SSL in quite a few places in the playbook." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:86 +#: ../../../docs/howto-srv-server-delegation.md:93 msgid "Adjust coturn's configuration" msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:88 +#: ../../../docs/howto-srv-server-delegation.md:95 msgid "The last step is to alter the generated coturn configuration." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:90 +#: ../../../docs/howto-srv-server-delegation.md:97 msgid "By default, coturn is configured to wait on the certificate for the `matrix.` subdomain using an [instantiated systemd service](https://www.freedesktop.org/software/systemd/man/systemd.service.html#Service%20Templates) using the domain name as the parameter for this service. However, we need to serve the wildcard certificate, which is incompatible with systemd, it will try to expand the `*`, which will break and prevent coturn from starting." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:92 +#: ../../../docs/howto-srv-server-delegation.md:99 msgid "We also need to indicate to coturn where the wildcard certificate is." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:94 +#: ../../../docs/howto-srv-server-delegation.md:101 msgid "⚠️ **Warning** : On first start of the services, coturn might still fail to start because Traefik is still in the process of obtaining the certificates. If you still get an error, make sure Traefik obtained the certificates and restart the coturn service (`just start-group coturn`)." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:96 +#: ../../../docs/howto-srv-server-delegation.md:103 msgid "This should not happen again afterwards as Traefik will renew certificates well before their expiry date, and the coturn service is setup to restart periodically." msgstr "" -#: ../../../docs/howto-srv-server-delegation.md:122 +#: ../../../docs/howto-srv-server-delegation.md:129 msgid "Full example of a working configuration" msgstr "" diff --git a/i18n/translation-templates/docs/importing-postgres.pot b/i18n/translation-templates/docs/importing-postgres.pot index 7f1432e78..5300ac6ee 100644 --- a/i18n/translation-templates/docs/importing-postgres.pot +++ b/i18n/translation-templates/docs/importing-postgres.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,130 +16,139 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/importing-postgres.md:1 +#: ../../../docs/importing-postgres.md:10 msgid "Importing an existing Postgres database from another installation (optional)" msgstr "" -#: ../../../docs/importing-postgres.md:3 -msgid "Run this if you'd like to import your database from a previous installation. (don't forget to import your Synapse `media_store` files as well — see [the importing-synape-media-store guide](importing-synapse-media-store.md))." -msgstr "" - -#: ../../../docs/importing-postgres.md:6 -msgid "Prerequisites" -msgstr "" - -#: ../../../docs/importing-postgres.md:8 -msgid "For this to work, **the database name in Postgres must match** what this playbook uses. This playbook uses a Postgres database name of `synapse` by default (controlled by the `matrix_synapse_database_database` variable). If your database name differs, be sure to change `matrix_synapse_database_database` to your desired name and to re-run the playbook before proceeding." -msgstr "" - -#: ../../../docs/importing-postgres.md:10 -msgid "The playbook supports importing Postgres dump files in **text** (e.g. `pg_dump > dump.sql`) or **gzipped** formats (e.g. `pg_dump | gzip -c > dump.sql.gz`). Importing multiple databases (as dumped by `pg_dumpall`) is also supported." -msgstr "" - #: ../../../docs/importing-postgres.md:12 -msgid "The migration might be a good moment, to \"reset\" a not properly working bridge. Be aware, that it might affect all users (new link to bridge, new rooms, …)" +msgid "You can manually import your database from a previous default installation of Synapse." msgstr "" #: ../../../docs/importing-postgres.md:14 -msgid "Before doing the actual import, **you need to upload your Postgres dump file to the server** (any path is okay)." -msgstr "" - -#: ../../../docs/importing-postgres.md:16 -msgid "Importing" -msgstr "" - -#: ../../../docs/importing-postgres.md:18 -msgid "To import, run this command (make sure to replace `SERVER_PATH_TO_POSTGRES_DUMP_FILE` with a file path on your server):" -msgstr "" - -#: ../../../docs/importing-postgres.md:26 +#: ../../../docs/importing-postgres.md:38 msgid "**Notes**:" msgstr "" -#: ../../../docs/importing-postgres.md:28 -msgid "`SERVER_PATH_TO_POSTGRES_DUMP_FILE` must be a file path to a Postgres dump file on the server (not on your local machine!)" +#: ../../../docs/importing-postgres.md:15 +msgid "Don't forget to import your Synapse `media_store` files as well — see [the importing-synapse-media-store guide](importing-synapse-media-store.md) for more details." msgstr "" -#: ../../../docs/importing-postgres.md:29 -msgid "`postgres_default_import_database` defaults to `matrix`, which is useful for importing multiple databases (for dumps made with `pg_dumpall`). If you're importing a single database (e.g. `synapse`), consider changing `postgres_default_import_database` accordingly" +#: ../../../docs/importing-postgres.md:16 +msgid "If you have an existing installation done using this Ansible playbook, you can easily migrate that to another server following [our dedicated server migration guide](maintenance-migrating.md)." +msgstr "" + +#: ../../../docs/importing-postgres.md:18 +msgid "Prerequisites" +msgstr "" + +#: ../../../docs/importing-postgres.md:20 +msgid "For this to work, **the database name in Postgres must match** what this playbook uses. This playbook uses a Postgres database name of `synapse` by default (controlled by the `matrix_synapse_database_database` variable). If your database name differs, be sure to change `matrix_synapse_database_database` to your desired name and to re-run the playbook before proceeding." +msgstr "" + +#: ../../../docs/importing-postgres.md:22 +msgid "The playbook supports importing Postgres dump files in **text** (e.g. `pg_dump > dump.sql`) or **gzipped** formats (e.g. `pg_dump | gzip -c > dump.sql.gz`). Importing multiple databases (as dumped by `pg_dumpall`) is also supported." +msgstr "" + +#: ../../../docs/importing-postgres.md:24 +msgid "The migration might be a good moment, to \"reset\" a not properly working bridge. Be aware, that it might affect all users (new link to bridge, new rooms, …)" +msgstr "" + +#: ../../../docs/importing-postgres.md:26 +msgid "Before doing the actual import, **you need to upload your Postgres dump file to the server** (any path is okay)." +msgstr "" + +#: ../../../docs/importing-postgres.md:28 +msgid "Importing" msgstr "" #: ../../../docs/importing-postgres.md:30 -msgid "after importing a large database, it's a good idea to run [an `ANALYZE` operation](https://www.postgresql.org/docs/current/sql-analyze.html) to make Postgres rebuild its database statistics and optimize its query planner. You can easily do this via the playbook by running `just run-tags run-postgres-vacuum -e postgres_vacuum_preset=analyze` (see [Vacuuming PostgreSQL](maintenance-postgres.md#vacuuming-postgresql) for more details)." +msgid "To import, run this command (make sure to replace `SERVER_PATH_TO_POSTGRES_DUMP_FILE` with a file path on your server):" msgstr "" -#: ../../../docs/importing-postgres.md:32 -msgid "Troubleshooting" -msgstr "" - -#: ../../../docs/importing-postgres.md:34 -msgid "Table Ownership" -msgstr "" - -#: ../../../docs/importing-postgres.md:36 -msgid "A table ownership issue can occur if you are importing from a Synapse installation which was both:" -msgstr "" - -#: ../../../docs/importing-postgres.md:38 -msgid "migrated from SQLite to Postgres, and" -msgstr "" - -#: ../../../docs/importing-postgres.md:39 -msgid "used a username other than 'synapse'" +#: ../../../docs/importing-postgres.md:40 +msgid "`SERVER_PATH_TO_POSTGRES_DUMP_FILE` must be a file path to a Postgres dump file on the server (not on your local machine!)" msgstr "" #: ../../../docs/importing-postgres.md:41 +msgid "`postgres_default_import_database` defaults to `matrix`, which is useful for importing multiple databases (for dumps made with `pg_dumpall`). If you're importing a single database (e.g. `synapse`), consider changing `postgres_default_import_database` accordingly" +msgstr "" + +#: ../../../docs/importing-postgres.md:42 +msgid "after importing a large database, it's a good idea to run [an `ANALYZE` operation](https://www.postgresql.org/docs/current/sql-analyze.html) to make Postgres rebuild its database statistics and optimize its query planner. You can easily do this via the playbook by running `just run-tags run-postgres-vacuum -e postgres_vacuum_preset=analyze` (see [Vacuuming PostgreSQL](maintenance-postgres.md#vacuuming-postgresql) for more details)." +msgstr "" + +#: ../../../docs/importing-postgres.md:44 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/importing-postgres.md:46 +msgid "Table Ownership" +msgstr "" + +#: ../../../docs/importing-postgres.md:48 +msgid "A table ownership issue can occur if you are importing from a Synapse installation which was both:" +msgstr "" + +#: ../../../docs/importing-postgres.md:50 +msgid "migrated from SQLite to Postgres, and" +msgstr "" + +#: ../../../docs/importing-postgres.md:51 +msgid "used a username other than 'synapse'" +msgstr "" + +#: ../../../docs/importing-postgres.md:53 msgid "In this case you may run into the following error during the import task:" msgstr "" -#: ../../../docs/importing-postgres.md:47 +#: ../../../docs/importing-postgres.md:59 msgid "where `synapse_user` is the database username from the previous Synapse installation." msgstr "" -#: ../../../docs/importing-postgres.md:49 +#: ../../../docs/importing-postgres.md:61 msgid "This can be verified by examining the dump for ALTER TABLE statements which set OWNER TO that username:" msgstr "" -#: ../../../docs/importing-postgres.md:61 +#: ../../../docs/importing-postgres.md:73 msgid "It can be worked around by changing the username to `synapse`, for example by using `sed`:" msgstr "" -#: ../../../docs/importing-postgres.md:67 +#: ../../../docs/importing-postgres.md:79 msgid "This uses sed to perform an 'in-place' (`-i`) replacement globally (`/g`), searching for `synapse_user` and replacing with `synapse` (`s/synapse_user/synapse`). If your database username was different, change `synapse_user` to that username instead. Expand search/replace statement as shown in example above, in case of old user name like `matrix` — replacing `matrix` only would… well — you can imagine." msgstr "" -#: ../../../docs/importing-postgres.md:69 +#: ../../../docs/importing-postgres.md:81 msgid "Note that if the previous import failed with an error it may have made changes which are incompatible with re-running the import task right away; if you do so it may fail with an error such as:" msgstr "" -#: ../../../docs/importing-postgres.md:75 +#: ../../../docs/importing-postgres.md:87 msgid "Repeat import" msgstr "" -#: ../../../docs/importing-postgres.md:77 +#: ../../../docs/importing-postgres.md:89 msgid "In this case you can use the command suggested in the import task to clear the database before retrying the import:" msgstr "" -#: ../../../docs/importing-postgres.md:85 +#: ../../../docs/importing-postgres.md:97 msgid "Now on your local machine run `just run-tags setup-postgres` to prepare the database roles etc." msgstr "" -#: ../../../docs/importing-postgres.md:87 +#: ../../../docs/importing-postgres.md:99 msgid "If not, you probably get this error. `synapse` is the correct table owner, but the role is missing in database." msgstr "" -#: ../../../docs/importing-postgres.md:93 +#: ../../../docs/importing-postgres.md:105 msgid "Once the database is clear and the ownership of the tables has been fixed in the SQL file, the import task should succeed." msgstr "" -#: ../../../docs/importing-postgres.md:95 +#: ../../../docs/importing-postgres.md:107 msgid "Check, if `--dbname` is set to `synapse` (not `matrix`) and replace paths (or even better, copy this line from your terminal)" msgstr "" -#: ../../../docs/importing-postgres.md:101 +#: ../../../docs/importing-postgres.md:113 msgid "Hints" msgstr "" -#: ../../../docs/importing-postgres.md:103 +#: ../../../docs/importing-postgres.md:115 msgid "To open psql terminal run `/matrix/postgres/bin/cli`" msgstr "" diff --git a/i18n/translation-templates/docs/importing-synapse-media-store.pot b/i18n/translation-templates/docs/importing-synapse-media-store.pot index 7a06764e8..66c9190ed 100644 --- a/i18n/translation-templates/docs/importing-synapse-media-store.pot +++ b/i18n/translation-templates/docs/importing-synapse-media-store.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,42 +16,42 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/importing-synapse-media-store.md:1 +#: ../../../docs/importing-synapse-media-store.md:8 msgid "Importing `media_store` data files from an existing Synapse installation (optional)" msgstr "" -#: ../../../docs/importing-synapse-media-store.md:3 -msgid "Run this if you'd like to import your `media_store` files from a previous installation of Synapse." +#: ../../../docs/importing-synapse-media-store.md:10 +msgid "You can manually import your `media_store` files from a previous installation of Synapse." msgstr "" -#: ../../../docs/importing-synapse-media-store.md:5 +#: ../../../docs/importing-synapse-media-store.md:12 msgid "Prerequisites" msgstr "" -#: ../../../docs/importing-synapse-media-store.md:7 +#: ../../../docs/importing-synapse-media-store.md:14 msgid "Before doing the actual data restore, **you need to upload your media store directory to the server** (any path is okay)." msgstr "" -#: ../../../docs/importing-synapse-media-store.md:9 +#: ../../../docs/importing-synapse-media-store.md:16 msgid "If you are [storing Matrix media files on Amazon S3](configuring-playbook-s3.md) (optional), restoring with this tool is not possible right now." msgstr "" -#: ../../../docs/importing-synapse-media-store.md:11 +#: ../../../docs/importing-synapse-media-store.md:18 msgid "As an alternative, you can perform a manual restore using the [AWS CLI tool](https://aws.amazon.com/cli/) (e.g. `aws s3 sync /path/to/server/media_store/. s3://name-of-bucket/`)" msgstr "" -#: ../../../docs/importing-synapse-media-store.md:13 +#: ../../../docs/importing-synapse-media-store.md:20 msgid "**Note for Mac users**: Due to case-sensitivity issues on certain Mac filesystems (HFS or HFS+), filename corruption may occur if you copy a `media_store` directory to your Mac. If you're transferring a `media_store` directory between 2 servers, make sure you do it directly (from server to server with a tool such as [rsync](https://rsync.samba.org/)), and not by downloading the files to your Mac." msgstr "" -#: ../../../docs/importing-synapse-media-store.md:15 +#: ../../../docs/importing-synapse-media-store.md:22 msgid "Importing" msgstr "" -#: ../../../docs/importing-synapse-media-store.md:17 +#: ../../../docs/importing-synapse-media-store.md:24 msgid "Run this command (make sure to replace `` with a path on your server):" msgstr "" -#: ../../../docs/importing-synapse-media-store.md:23 +#: ../../../docs/importing-synapse-media-store.md:30 msgid "**Note**: `` must be a file path to a `media_store` directory on the server (not on your local machine!)." msgstr "" diff --git a/i18n/translation-templates/docs/importing-synapse-sqlite.pot b/i18n/translation-templates/docs/importing-synapse-sqlite.pot index 93ddd975e..0c94e9fbf 100644 --- a/i18n/translation-templates/docs/importing-synapse-sqlite.pot +++ b/i18n/translation-templates/docs/importing-synapse-sqlite.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,58 +16,62 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/importing-synapse-sqlite.md:1 +#: ../../../docs/importing-synapse-sqlite.md:9 msgid "Importing an existing SQLite database from another Synapse installation (optional)" msgstr "" -#: ../../../docs/importing-synapse-sqlite.md:3 -msgid "Run this if you'd like to import your database from a previous default installation of Synapse (don't forget to import your `media_store` files as well — see [the importing-synapse-media-store guide](importing-synapse-media-store.md))." -msgstr "" - -#: ../../../docs/importing-synapse-sqlite.md:5 -msgid "While this playbook only supports running Synapse in combination with PostgreSQL, a Synapse instance installed manually usually defaults to using an SQLite database." -msgstr "" - -#: ../../../docs/importing-synapse-sqlite.md:7 -msgid "If you have such a Synapse setup and wish to migrate it to one managed by the playbook (and over to PostgreSQL), this documentation page is for you." -msgstr "" - -#: ../../../docs/importing-synapse-sqlite.md:9 -msgid "Prerequisites" -msgstr "" - #: ../../../docs/importing-synapse-sqlite.md:11 -msgid "Before doing the actual import:" +msgid "You can manually import your database from a previous default installation of Synapse." msgstr "" #: ../../../docs/importing-synapse-sqlite.md:13 -msgid "**ensure you have NOT started Synapse yet**. That is, make sure you have followed the [Installing step](installing.md), but haven't run the playbook's `start` tag yet. If you had started your new Synapse instance, it may have already initialized your Postgres database and importing onto it may not work. In such cases, you may need to clean up the `synapse` database first." -msgstr "" - -#: ../../../docs/importing-synapse-sqlite.md:14 -msgid "**ensure you have uploaded your SQLite database file to the server** (any path is okay)" +msgid "While this playbook only supports running Synapse in combination with PostgreSQL, a Synapse instance installed manually usually defaults to using an SQLite database." msgstr "" #: ../../../docs/importing-synapse-sqlite.md:15 -msgid "if you're using the integrated Postgres server (**by default, you are** using it, unless you've explicitly switched to [Using an external PostgreSQL server](configuring-playbook-external-postgres.md)), **make sure Postgres is started** by running `just start-group postgres`" +msgid "If you have such a Synapse setup and wish to migrate it to one managed by the playbook (and over to PostgreSQL), this documentation page is for you." msgstr "" #: ../../../docs/importing-synapse-sqlite.md:17 -msgid "Importing" +msgid "**Note**: don't forget to import your Synapse `media_store` files as well — see [the importing-synapse-media-store guide](importing-synapse-media-store.md) for more details." msgstr "" #: ../../../docs/importing-synapse-sqlite.md:19 -msgid "Run this command (make sure to replace `` with a file path on your server):" +msgid "Prerequisites" +msgstr "" + +#: ../../../docs/importing-synapse-sqlite.md:21 +msgid "Before doing the actual import:" +msgstr "" + +#: ../../../docs/importing-synapse-sqlite.md:23 +msgid "**ensure you have NOT started Synapse yet**. That is, make sure you have followed the [Installing step](installing.md), but haven't run the playbook's `start` tag yet. If you had started your new Synapse instance, it may have already initialized your Postgres database and importing onto it may not work. In such cases, you may need to clean up the `synapse` database first." +msgstr "" + +#: ../../../docs/importing-synapse-sqlite.md:24 +msgid "**ensure you have uploaded your SQLite database file to the server** (any path is okay)" msgstr "" #: ../../../docs/importing-synapse-sqlite.md:25 -msgid "**Notes**:" +msgid "if you're using the integrated Postgres server (**by default, you are** using it, unless you've explicitly switched to [Using an external PostgreSQL server](configuring-playbook-external-postgres.md)), **make sure Postgres is started** by running `just start-group postgres`" msgstr "" #: ../../../docs/importing-synapse-sqlite.md:27 +msgid "Importing" +msgstr "" + +#: ../../../docs/importing-synapse-sqlite.md:29 +msgid "Run this command (make sure to replace `` with a file path on your server):" +msgstr "" + +#: ../../../docs/importing-synapse-sqlite.md:35 +msgid "**Notes**:" +msgstr "" + +#: ../../../docs/importing-synapse-sqlite.md:37 msgid "`` must be replaced with a file path to a `homeserver.db` **file on the server** (not on your local machine!)." msgstr "" -#: ../../../docs/importing-synapse-sqlite.md:28 +#: ../../../docs/importing-synapse-sqlite.md:38 msgid "if the SQLite database is from an older version of Synapse, the **importing procedure may run migrations on it to bring it up to date**. That is, your SQLite database file may get modified and become unusable with your older Synapse version. Keeping a copy of the original is probably wise." msgstr "" diff --git a/i18n/translation-templates/docs/installing.pot b/i18n/translation-templates/docs/installing.pot index 8dc026129..5ad8d492c 100644 --- a/i18n/translation-templates/docs/installing.pot +++ b/i18n/translation-templates/docs/installing.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,286 +16,294 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/installing.md:1 +#: ../../../docs/installing.md:15 msgid "Installing" msgstr "" -#: ../../../docs/installing.md:3 -msgid "[Prerequisites](prerequisites.md) > [Configuring your DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing" +#: ../../../docs/installing.md:17 +msgid "[Prerequisites](prerequisites.md) > [Configuring DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > Installing" msgstr "" -#: ../../../docs/installing.md:5 +#: ../../../docs/installing.md:19 msgid "If you've configured your DNS records and the playbook, you can start the installation procedure." msgstr "" -#: ../../../docs/installing.md:7 +#: ../../../docs/installing.md:21 msgid "Update Ansible roles" msgstr "" -#: ../../../docs/installing.md:9 +#: ../../../docs/installing.md:23 msgid "Before installing, you need to update the Ansible roles that this playbook uses and fetches from outside." msgstr "" -#: ../../../docs/installing.md:11 +#: ../../../docs/installing.md:25 msgid "To update your playbook directory and all upstream Ansible roles (defined in the `requirements.yml` file), run:" msgstr "" -#: ../../../docs/installing.md:13 +#: ../../../docs/installing.md:27 msgid "either: `just update`" msgstr "" -#: ../../../docs/installing.md:14 +#: ../../../docs/installing.md:28 msgid "or: a combination of `git pull` and `just roles` (or `make roles` if you have `make` program on your computer instead of `just`)" msgstr "" -#: ../../../docs/installing.md:16 +#: ../../../docs/installing.md:30 msgid "If you don't have either `just` tool or `make` program, you can run the `ansible-galaxy` tool directly: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force`" msgstr "" -#: ../../../docs/installing.md:18 +#: ../../../docs/installing.md:32 msgid "For details about `just` commands, take a look at: [Running `just` commands](just.md)." msgstr "" -#: ../../../docs/installing.md:20 +#: ../../../docs/installing.md:34 msgid "Install Matrix server and services" msgstr "" -#: ../../../docs/installing.md:22 +#: ../../../docs/installing.md:36 msgid "The Ansible playbook's tasks are tagged, so that certain parts of the Ansible playbook can be run without running all other tasks." msgstr "" -#: ../../../docs/installing.md:24 +#: ../../../docs/installing.md:38 msgid "The general command syntax for installation (and also maintenance) is: `ansible-playbook -i inventory/hosts setup.yml --tags=COMMA_SEPARATED_TAGS_GO_HERE`. It is recommended to get yourself familiar with the [playbook tags](playbook-tags.md) before proceeding." msgstr "" -#: ../../../docs/installing.md:26 +#: ../../../docs/installing.md:40 msgid "If you **don't** use SSH keys for authentication, but rather a regular password, you may need to add `--ask-pass` to the all Ansible commands." msgstr "" -#: ../../../docs/installing.md:28 +#: ../../../docs/installing.md:42 msgid "If you **do** use SSH keys for authentication, **and** use a non-root user to *become* root (sudo), you may need to add `-K` (`--ask-become-pass`) to all Ansible commands." msgstr "" -#: ../../../docs/installing.md:30 +#: ../../../docs/installing.md:44 msgid "There 2 ways to start the installation process — depending on whether you're [Installing a brand new server (without importing data)](#installing-a-brand-new-server-without-importing-data) or [Installing a server into which you'll import old data](#installing-a-server-into-which-youll-import-old-data)." msgstr "" -#: ../../../docs/installing.md:32 +#: ../../../docs/installing.md:46 msgid "**Note**: if you are migrating from an old server to a new one, take a look at [this guide](maintenance-migrating.md) instead. This is an easier and more straightforward way than installing a server and importing old data into it." msgstr "" -#: ../../../docs/installing.md:34 +#: ../../../docs/installing.md:48 msgid "Installing a brand new server (without importing data)" msgstr "" -#: ../../../docs/installing.md:36 +#: ../../../docs/installing.md:50 msgid "If this is **a brand new** Matrix server and you **won't be importing old data into it**, run all these tags:" msgstr "" -#: ../../../docs/installing.md:42 +#: ../../../docs/installing.md:56 msgid "This will do a full installation and start all Matrix services." msgstr "" -#: ../../../docs/installing.md:44 +#: ../../../docs/installing.md:58 msgid "**Note**: if the command does not work as expected, make sure that you have properly installed and configured software required to run the playbook, as described on [Prerequisites](prerequisites.md)." msgstr "" -#: ../../../docs/installing.md:46 +#: ../../../docs/installing.md:60 msgid "Installing a server into which you'll import old data" msgstr "" -#: ../../../docs/installing.md:48 +#: ../../../docs/installing.md:62 msgid "If you will be importing data into your newly created Matrix server, install it, but **do not** start its services just yet. Starting its services or messing with its database now will affect your data import later on." msgstr "" -#: ../../../docs/installing.md:50 +#: ../../../docs/installing.md:64 msgid "To do the installation **without** starting services, run `ansible-playbook` with the `install-all` tag only:" msgstr "" -#: ../../../docs/installing.md:56 +#: ../../../docs/installing.md:70 msgid "[!WARNING] Do not run the just \"recipe\" `just install-all` instead, because it automatically starts services at the end of execution. See: [Difference between playbook tags and shortcuts](just.md#difference-between-playbook-tags-and-shortcuts)" msgstr "" -#: ../../../docs/installing.md:59 +#: ../../../docs/installing.md:73 msgid "When this command completes, services won't be running yet." msgstr "" -#: ../../../docs/installing.md:61 +#: ../../../docs/installing.md:75 msgid "You can now:" msgstr "" -#: ../../../docs/installing.md:63 +#: ../../../docs/installing.md:77 msgid "[Importing an existing SQLite database (from another Synapse installation)](importing-synapse-sqlite.md) (optional)" msgstr "" -#: ../../../docs/installing.md:65 +#: ../../../docs/installing.md:79 msgid "[Importing an existing Postgres database (from another installation)](importing-postgres.md) (optional)" msgstr "" -#: ../../../docs/installing.md:67 +#: ../../../docs/installing.md:81 msgid "[Importing `media_store` data files from an existing Synapse installation](importing-synapse-media-store.md) (optional)" msgstr "" -#: ../../../docs/installing.md:69 +#: ../../../docs/installing.md:83 msgid "… and then proceed to starting all services:" msgstr "" -#: ../../../docs/installing.md:75 +#: ../../../docs/installing.md:89 msgid "Create your user account" msgstr "" -#: ../../../docs/installing.md:77 +#: ../../../docs/installing.md:91 msgid "ℹ️ *You can skip this step if you have installed a server and imported old data to it.*" msgstr "" -#: ../../../docs/installing.md:79 +#: ../../../docs/installing.md:93 msgid "As you have configured your brand new server and the client, you need to **create your user account** on your Matrix server." msgstr "" -#: ../../../docs/installing.md:81 +#: ../../../docs/installing.md:95 msgid "After creating the user account, you can log in to it with [Element Web](configuring-playbook-client-element-web.md) that this playbook has installed for you at this URL: `https://element.example.com/`." msgstr "" -#: ../../../docs/installing.md:83 +#: ../../../docs/installing.md:97 msgid "To create your user account (as an administrator of the server) via this Ansible playbook, run the command below on your local computer." msgstr "" -#: ../../../docs/installing.md:85 +#: ../../../docs/installing.md:99 msgid "**Notes**:" msgstr "" -#: ../../../docs/installing.md:86 +#: ../../../docs/installing.md:100 msgid "Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE`" msgstr "" -#: ../../../docs/installing.md:87 +#: ../../../docs/installing.md:101 msgid "For `YOUR_USERNAME_HERE`, use a plain username like `alice`, not your full ID (`@alice:example.com`)" msgstr "" -#: ../../../docs/installing.md:88 +#: ../../../docs/installing.md:102 msgid "Use `admin=yes` to make your user account an administrator of the Matrix server" msgstr "" -#: ../../../docs/installing.md:96 +#: ../../../docs/installing.md:110 msgid "Feel free to create as many accounts (for friends, family, etc.) as you want. Still, perhaps you should grant full administrative access to your account only (with `admin=yes`), and others should be created with `admin=no`." msgstr "" -#: ../../../docs/installing.md:98 +#: ../../../docs/installing.md:112 msgid "For more information, see the documentation for [registering users](registering-users.md)." msgstr "" -#: ../../../docs/installing.md:100 +#: ../../../docs/installing.md:114 msgid "Finalize the installation" msgstr "" -#: ../../../docs/installing.md:102 +#: ../../../docs/installing.md:116 msgid "Now you've configured Matrix services and your user account, you need to **finalize the installation process** by [setting up Matrix delegation (redirection)](howto-server-delegation.md), so that your Matrix server (`matrix.example.com`) can present itself as the base domain (`example.com`) in the Matrix network." msgstr "" -#: ../../../docs/installing.md:104 +#: ../../../docs/installing.md:118 msgid "This is required for federation to work! Without a proper configuration, your server will effectively not be part of the Matrix network." msgstr "" -#: ../../../docs/installing.md:106 +#: ../../../docs/installing.md:120 msgid "To configure the delegation, you have these two options. Choose one of them according to your situation." msgstr "" -#: ../../../docs/installing.md:108 +#: ../../../docs/installing.md:122 msgid "If you can afford to point the base domain at the Matrix server, follow the instructions below which guide you into [serving the base domain](configuring-playbook-base-domain-serving.md) from the integrated web server. It will enable you to use a Matrix user ID like `@alice:example.com` while hosting services on a subdomain like `matrix.example.com`." msgstr "" -#: ../../../docs/installing.md:109 +#: ../../../docs/installing.md:123 msgid "Alternatively, if you're using the base domain for other purposes and cannot point it to the Matrix server (and thus cannot \"serve the base domain\" from it), you most likely need to [manually install well-known files on the base domain's server](configuring-well-known.md#manually-installing-well-known-files-on-the-base-domains-server), but feel free to familiarize yourself with all [server delegation (redirection) options](howto-server-delegation.md)." msgstr "" -#: ../../../docs/installing.md:111 +#: ../../../docs/installing.md:125 msgid "To have the base domain served from the integrated web server, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/installing.md:117 +#: ../../../docs/installing.md:131 msgid "After configuring the playbook, run the command below:" msgstr "" -#: ../../../docs/installing.md:123 +#: ../../../docs/installing.md:137 +msgid "**If an error is not returned, the installation has completed and the services have been started successfully**🎉" +msgstr "" + +#: ../../../docs/installing.md:139 msgid "Things to do next" msgstr "" -#: ../../../docs/installing.md:125 -msgid "After finilizing the installation, you can:" +#: ../../../docs/installing.md:141 +msgid "After completing the installation, you can:" msgstr "" -#: ../../../docs/installing.md:127 -msgid "[check if services work](maintenance-checking-services.md)" -msgstr "" - -#: ../../../docs/installing.md:128 -msgid "or [set up additional services](configuring-playbook.md#other-configuration-options) (bridges to other chat networks, bots, etc.)" -msgstr "" - -#: ../../../docs/installing.md:129 -msgid "or learn how to [upgrade services when new versions are released](maintenance-upgrading-services.md)" -msgstr "" - -#: ../../../docs/installing.md:130 -msgid "or learn how to [maintain your server](faq.md#maintenance)" -msgstr "" - -#: ../../../docs/installing.md:131 -msgid "or join some Matrix rooms:" -msgstr "" - -#: ../../../docs/installing.md:132 -msgid "via the *Explore rooms* feature in Element Web or some other clients, or by discovering them using this [matrix-static list](https://view.matrix.org). **Note**: joining large rooms may overload small servers." -msgstr "" - -#: ../../../docs/installing.md:133 -msgid "or come say Hi in our support room — [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting." -msgstr "" - -#: ../../../docs/installing.md:134 -msgid "or help make this playbook better by contributing (code, documentation, or [coffee/beer](https://liberapay.com/s.pantaleev/donate))" -msgstr "" - -#: ../../../docs/installing.md:136 -msgid "Maintaining your setup in the future" -msgstr "" - -#: ../../../docs/installing.md:138 -msgid "While this playbook helps you to set up Matrix services and maintain them, it will **not** automatically run the maintenance task for you. You will need to update the playbook and re-run it **manually**." -msgstr "" - -#: ../../../docs/installing.md:140 -msgid "The upstream projects, which this playbook makes use of, occasionally if not often suffer from security vulnerabilities." -msgstr "" - -#: ../../../docs/installing.md:142 -msgid "Since it is unsafe to keep outdated services running on the server connected to the internet, please consider to update the playbook and re-run it periodically, in order to keep the services up-to-date." +#: ../../../docs/installing.md:143 +msgid "[check if services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work)" msgstr "" #: ../../../docs/installing.md:144 -msgid "For more information about upgrading or maintaining services with the playbook, take at look at this page: [Upgrading the Matrix services](maintenance-upgrading-services.md)" +msgid "or [set up additional services](configuring-playbook.md#other-configuration-options) (bridges to other chat networks, bots, etc.)" +msgstr "" + +#: ../../../docs/installing.md:145 +msgid "or learn how to [upgrade services when new versions are released](maintenance-upgrading-services.md)" msgstr "" #: ../../../docs/installing.md:146 -msgid "Feel free to **re-run the setup command any time** you think something is wrong with the server configuration. Ansible will take your configuration and update your server to match." +msgid "or learn how to [maintain your server](faq.md#maintenance)" +msgstr "" + +#: ../../../docs/installing.md:147 +msgid "or join some Matrix rooms:" +msgstr "" + +#: ../../../docs/installing.md:148 +msgid "via the *Explore rooms* feature in Element Web or some other clients, or by discovering them using this [matrix-static list](https://view.matrix.org). **Note**: joining large rooms may overload small servers." +msgstr "" + +#: ../../../docs/installing.md:149 +msgid "or come say Hi in our support room — [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting." +msgstr "" + +#: ../../../docs/installing.md:150 +msgid "or help make this playbook better by contributing (code, documentation, or [coffee/beer](https://liberapay.com/s.pantaleev/donate))" msgstr "" #: ../../../docs/installing.md:152 -msgid "**Note**: see [this page on the playbook tags](playbook-tags.md) for more information about those tags." +msgid "⚠️ Keep the playbook and services up-to-date" msgstr "" #: ../../../docs/installing.md:154 -msgid "Make full use of `just` shortcut commands" +msgid "While this playbook helps you to set up Matrix services and maintain them, it will **not** automatically run the maintenance task for you. You will need to update the playbook and re-run it **manually**." msgstr "" #: ../../../docs/installing.md:156 -msgid "After you get familiar with reconfiguring and re-running the playbook to maintain the server, upgrade its services, etc., you probably would like to make use of `just` shortcut commands for faster input." +msgid "The upstream projects, which this playbook makes use of, occasionally if not often suffer from security vulnerabilities." msgstr "" #: ../../../docs/installing.md:158 -msgid "For example, `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." +msgid "Since it is unsafe to keep outdated services running on the server connected to the internet, please consider to update the playbook and re-run it periodically, in order to keep the services up-to-date." msgstr "" #: ../../../docs/installing.md:160 +msgid "Also, do not forget to update your system regularly. While this playbook may install basic services, such as Docker, it will not interfere further with system maintenance. Keeping the system itself up-to-date is out of scope for this playbook." +msgstr "" + +#: ../../../docs/installing.md:162 +msgid "For more information about upgrading or maintaining services with the playbook, take a look at this page: [Upgrading the Matrix services](maintenance-upgrading-services.md)" +msgstr "" + +#: ../../../docs/installing.md:164 +msgid "Feel free to **re-run the setup command any time** you think something is wrong with the server configuration. Ansible will take your configuration and update your server to match." +msgstr "" + +#: ../../../docs/installing.md:170 +msgid "**Note**: see [this page on the playbook tags](playbook-tags.md) for more information about those tags." +msgstr "" + +#: ../../../docs/installing.md:172 +msgid "Make full use of `just` shortcut commands" +msgstr "" + +#: ../../../docs/installing.md:174 +msgid "After you get familiar with reconfiguring and re-running the playbook to maintain the server, upgrade its services, etc., you probably would like to make use of `just` shortcut commands for faster input." +msgstr "" + +#: ../../../docs/installing.md:176 +msgid "For example, `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." +msgstr "" + +#: ../../../docs/installing.md:178 msgid "You can learn about the shortcut commands on this page: [Running `just` commands](just.md)" msgstr "" diff --git a/i18n/translation-templates/docs/just.pot b/i18n/translation-templates/docs/just.pot index 65a4e7e1c..18a17950e 100644 --- a/i18n/translation-templates/docs/just.pot +++ b/i18n/translation-templates/docs/just.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,27 +16,27 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/just.md:1 +#: ../../../docs/just.md:8 msgid "Running `just` commands" msgstr "" -#: ../../../docs/just.md:3 +#: ../../../docs/just.md:10 msgid "We have previously used [make](https://www.gnu.org/software/make/) for easily running some playbook commands (e.g. `make roles` which triggers [`ansible-galaxy`](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html)). Our [`Makefile`](../Makefile) is still around, and you can still run these commands." msgstr "" -#: ../../../docs/just.md:5 +#: ../../../docs/just.md:12 msgid "In addition, we have added support for running commands via [`just`](https://github.com/casey/just) — a more modern command-runner alternative to `make`. It can be used to invoke `ansible-playbook` commands with less typing." msgstr "" -#: ../../../docs/just.md:7 +#: ../../../docs/just.md:14 msgid "The `just` utility executes shortcut commands (called as \"recipes\"), which invoke `ansible-playbook`, `ansible-galaxy` or [`agru`](https://github.com/etkecc/agru) (depending on what is available in your system). The targets of the recipes are defined in [`justfile`](../justfile). Most of the just recipes have no corresponding `Makefile` targets." msgstr "" -#: ../../../docs/just.md:9 -msgid "For some recipes such as `just update`, our `justfile` recommends installing [`agru`](https://github.com/etkecc/agru) (a faster alternative to `ansible-galaxy`) to speed up the process." +#: ../../../docs/just.md:16 +msgid "For some recipes such as `just update`, our `justfile` recommends installing `agru` (a faster alternative to `ansible-galaxy`) to speed up the process." msgstr "" -#: ../../../docs/just.md:11 +#: ../../../docs/just.md:18 msgid "Here are some examples of shortcuts:" msgstr "" @@ -65,7 +65,7 @@ msgid "Run `git pull` (to update the playbook) and install the Ansible roles" msgstr "" #: ../../../docs/just.md:0 -#: ../../../docs/just.md:33 +#: ../../../docs/just.md:40 msgid "`just install-all`" msgstr "" @@ -129,30 +129,30 @@ msgstr "" msgid "Registers an `alice` user with the `secret-password` password and admin access (admin = `yes`)" msgstr "" -#: ../../../docs/just.md:26 +#: ../../../docs/just.md:33 msgid "While [our documentation on prerequisites](prerequisites.md) lists `just` as one of the requirements for installation, using `just` is optional. If you find it difficult to install it, do not find it useful, or want to prefer raw `ansible-playbook` commands for some reason, feel free to run all commands manually. For example, you can run `ansible-galaxy` directly to install the Ansible roles: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force`." msgstr "" -#: ../../../docs/just.md:28 +#: ../../../docs/just.md:35 msgid "Difference between playbook tags and shortcuts" msgstr "" -#: ../../../docs/just.md:30 +#: ../../../docs/just.md:37 msgid "It is worth noting that `just` \"recipes\" are different from [playbook tags](playbook-tags.md). The recipes are shortcuts of commands defined in `justfile` and can be executed by the `just` program only, while the playbook tags are available for the raw `ansible-playbook` commands as well. Please be careful not to confuse them." msgstr "" -#: ../../../docs/just.md:32 +#: ../../../docs/just.md:39 msgid "For example, these two commands are different:" msgstr "" -#: ../../../docs/just.md:34 +#: ../../../docs/just.md:41 msgid "`ansible-playbook -i inventory/hosts setup.yml --tags=install-all`" msgstr "" -#: ../../../docs/just.md:36 +#: ../../../docs/just.md:43 msgid "The just recipe runs `ensure-matrix-users-created` and `start` tags after `install-all`, while the latter runs only `install-all` tag. The correct shortcut of the latter is `just run-tags install-all`." msgstr "" -#: ../../../docs/just.md:38 -msgid "Such kind of difference sometimes matters. For example, when you install a Matrix server into which you will import old data (see [here](installing.md#installing-a-server-into-which-youll-import-old-data)), you are not supposed to run `just install-all` or `just setup-all`, because these commands start services immediately after installing components which may prevent your from importing old data." +#: ../../../docs/just.md:45 +msgid "Such kind of difference sometimes matters. For example, when you install a Matrix server into which you will import old data (see [here](installing.md#installing-a-server-into-which-youll-import-old-data)), you are not supposed to run `just install-all` or `just setup-all`, because these commands start services immediately after installing components, which may prevent you from importing the data." msgstr "" diff --git a/i18n/translation-templates/docs/maintenance-and-troubleshooting.pot b/i18n/translation-templates/docs/maintenance-and-troubleshooting.pot index d6f179db5..dfbc8d42b 100644 --- a/i18n/translation-templates/docs/maintenance-and-troubleshooting.pot +++ b/i18n/translation-templates/docs/maintenance-and-troubleshooting.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,66 +16,158 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/maintenance-and-troubleshooting.md:1 +#: ../../../docs/maintenance-and-troubleshooting.md:12 msgid "Maintenance and Troubleshooting" msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:3 -msgid "How to see the current status of your services" +#: ../../../docs/maintenance-and-troubleshooting.md:14 +msgid "Maintenance" msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:5 -msgid "You can check the status of your services by using `systemctl status`. Example:" +#: ../../../docs/maintenance-and-troubleshooting.md:16 +msgid "How to back up the data on your server" msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:15 -msgid "Docker containers that the playbook configures are supervised by [systemd](https://wiki.archlinux.org/title/Systemd) and their logs are configured to go to [systemd-journald](https://wiki.archlinux.org/title/Systemd/Journal)." +#: ../../../docs/maintenance-and-troubleshooting.md:18 +msgid "We haven't documented this properly yet, but the general advice is to:" msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:17 -msgid "To prevent double-logging, Docker logging is disabled by explicitly passing `--log-driver=none` to all containers. Due to this, you **cannot** view logs using `docker logs`." +#: ../../../docs/maintenance-and-troubleshooting.md:20 +msgid "back up Postgres by making a database dump. See [Backing up PostgreSQL](maintenance-postgres.md#backing-up-postgresql)" msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:19 -msgid "To view systemd-journald logs using [journalctl](https://man.archlinux.org/man/journalctl.1), run a command like this:" +#: ../../../docs/maintenance-and-troubleshooting.md:22 +msgid "back up all `/matrix` files, except for `/matrix/postgres/data` (you already have a dump) and `/matrix/postgres/data-auto-upgrade-backup` (this directory may exist and contain your old data if you've [performed a major Postgres upgrade](maintenance-postgres.md#upgrading-postgresql))." msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:25 -msgid "Increase logging verbosity" +#: ../../../docs/maintenance-and-troubleshooting.md:24 +msgid "You can later restore these by:" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:26 +msgid "Restoring the `/matrix` directory and files on the new server manually" msgstr "" #: ../../../docs/maintenance-and-troubleshooting.md:27 -msgid "Because the [Synapse](https://github.com/element-hq/synapse) Matrix server is originally very chatty when it comes to logging, we intentionally reduce its [logging level](https://docs.python.org/3/library/logging.html#logging-levels) from `INFO` to `WARNING`." +msgid "Following the instruction described on [Installing a server into which you'll import old data](installing.md#installing-a-server-into-which-youll-import-old-data)" msgstr "" #: ../../../docs/maintenance-and-troubleshooting.md:29 -msgid "If you'd like to debug an issue or [report a Synapse bug](https://github.com/element-hq/synapse/issues/new/choose) to the developers, it'd be better if you temporarily increasing the logging level to `INFO`." +msgid "If your server's IP address has changed, you may need to [set up DNS](configuring-dns.md) again." msgstr "" #: ../../../docs/maintenance-and-troubleshooting.md:31 -msgid "Example configuration (`inventory/host_vars/matrix.example.com/vars.yml`):" -msgstr "" - -#: ../../../docs/maintenance-and-troubleshooting.md:39 -msgid "Re-run the playbook after making these configuration changes." -msgstr "" - -#: ../../../docs/maintenance-and-troubleshooting.md:41 msgid "Remove unused Docker data" msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:43 -msgid "You can free some disk space from Docker, see [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information." +#: ../../../docs/maintenance-and-troubleshooting.md:33 +msgid "You can free some disk space from Docker by removing its unused data. See [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information." msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:49 +#: ../../../docs/maintenance-and-troubleshooting.md:39 msgid "The shortcut command with `just` program is also available: `just run-tags run-docker-prune`" msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:51 +#: ../../../docs/maintenance-and-troubleshooting.md:41 msgid "Postgres" msgstr "" -#: ../../../docs/maintenance-and-troubleshooting.md:53 -msgid "See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page." +#: ../../../docs/maintenance-and-troubleshooting.md:43 +msgid "See the dedicated [PostgreSQL maintenance](maintenance-postgres.md) documentation page." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:45 +msgid "Synapse" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:47 +msgid "See the dedicated [Synapse maintenance](maintenance-synapse.md) documentation page." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:49 +msgid "Troubleshooting" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:51 +msgid "How to see the current status of your services" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:53 +msgid "You can check the status of your services by using `systemctl status`. Example:" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:63 +msgid "How to see the logs" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:65 +msgid "Docker containers that the playbook configures are supervised by [systemd](https://wiki.archlinux.org/title/Systemd) and their logs are configured to go to [systemd-journald](https://wiki.archlinux.org/title/Systemd/Journal)." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:67 +msgid "For example, you can find the logs of `matrix-synapse` in `systemd-journald` by logging in to the server with SSH and running the command as below:" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:73 +msgid "Available service names can be seen by doing `ls /etc/systemd/system/matrix*.service` on the server. Some services also log to files in `/matrix/*/data/..`, but we're slowly moving away from that." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:75 +msgid "We just simply delegate logging to journald and it takes care of persistence and expiring old data." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:77 +msgid "Enable systemd/journald logs persistence" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:79 +msgid "On some distros, the journald logs are just in-memory and not persisted to disk." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:81 +msgid "Consult (and feel free to adjust) your distro's journald logging configuration in `/etc/systemd/journald.conf`." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:83 +msgid "To enable persistence and put some limits on how large the journal log files can become, adjust your configuration like this:" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:94 +msgid "How to check if services work" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:96 +msgid "The playbook can perform a check to ensure that you've configured things correctly and that services are running." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:98 +msgid "To perform the check, run:" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:104 +msgid "The shortcut command with `just` program is also available: `just run-tags self-check`" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:106 +msgid "If it's all green, everything is probably running correctly." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:108 +msgid "Besides this self-check, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:110 +msgid "How to debug or force SSL certificate renewal" +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:112 +msgid "SSL certificates are managed automatically by the [Traefik](https://doc.traefik.io/traefik/) reverse-proxy server." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:114 +msgid "If you're having trouble with SSL certificate renewal, check the Traefik logs (`journalctl -fu matrix-traefik`)." +msgstr "" + +#: ../../../docs/maintenance-and-troubleshooting.md:116 +msgid "If you're [using your own webserver](configuring-playbook-own-webserver.md) instead of the integrated one (Traefik), you should investigate in another way." msgstr "" diff --git a/i18n/translation-templates/docs/maintenance-migrating.pot b/i18n/translation-templates/docs/maintenance-migrating.pot index 5cd731bdf..f331220e3 100644 --- a/i18n/translation-templates/docs/maintenance-migrating.pot +++ b/i18n/translation-templates/docs/maintenance-migrating.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,118 +16,118 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/maintenance-migrating.md:1 +#: ../../../docs/maintenance-migrating.md:10 msgid "Migrating to new server" msgstr "" -#: ../../../docs/maintenance-migrating.md:3 +#: ../../../docs/maintenance-migrating.md:12 msgid "This documentation explains how to migrate your Matrix services (server, client, bridges, etc.) and data **from an old server to a new server**." msgstr "" -#: ../../../docs/maintenance-migrating.md:5 +#: ../../../docs/maintenance-migrating.md:14 msgid "**Notes**:" msgstr "" -#: ../../../docs/maintenance-migrating.md:6 +#: ../../../docs/maintenance-migrating.md:15 msgid "This migration guide is applicable if you migrate from one server to another server having the same CPU architecture (e.g. both servers being `amd64`)." msgstr "" -#: ../../../docs/maintenance-migrating.md:8 +#: ../../../docs/maintenance-migrating.md:17 msgid "If you're trying to migrate between different architectures (e.g. `amd64` --> `arm64`), simply copying the complete `/matrix` directory is **not** possible as it would move the raw PostgreSQL data (`/matrix/postgres/data`) between different architectures. In this specific case, you can use the guide below as a reference, but you would also need to avoid syncing `/matrix/postgres/data` to the new host, and also dump the database on your current server and import it properly on the new server. See our [Backing up PostgreSQL](maintenance-postgres.md#backing-up-postgresql) docs for help with PostgreSQL backup/restore." msgstr "" -#: ../../../docs/maintenance-migrating.md:9 +#: ../../../docs/maintenance-migrating.md:18 msgid "If you have any questions about migration or encountered an issue during migration, do not hesitate to ask for help on [our Matrix room](https://matrix.to/#/%23matrix-docker-ansible-deploy:devture.com). You probably might want to prepare a temporary/sub account on another Matrix server in case it becomes impossible to use your server due to migration failure by any chance." msgstr "" -#: ../../../docs/maintenance-migrating.md:11 +#: ../../../docs/maintenance-migrating.md:20 msgid "You can't change the domain (specified in the `matrix_domain` variable) after the initial deployment." msgstr "" -#: ../../../docs/maintenance-migrating.md:13 +#: ../../../docs/maintenance-migrating.md:22 msgid "Lower DNS TTL" msgstr "" -#: ../../../docs/maintenance-migrating.md:15 +#: ../../../docs/maintenance-migrating.md:24 msgid "Prepare by lowering DNS TTL for your domains (`matrix.example.com`, etc.), so that DNS record changes would happen faster, leading to less downtime." msgstr "" -#: ../../../docs/maintenance-migrating.md:17 +#: ../../../docs/maintenance-migrating.md:26 msgid "Stop services on the old server completely" msgstr "" -#: ../../../docs/maintenance-migrating.md:19 +#: ../../../docs/maintenance-migrating.md:28 msgid "Before migrating, you need to stop all services on the old server and make sure they won't be starting again." msgstr "" -#: ../../../docs/maintenance-migrating.md:21 +#: ../../../docs/maintenance-migrating.md:30 msgid "To do so, it is recommended to run the `systemctl` command on the server. Running the playbook's `stop` tag also stops the services, but just once; they will start again if you reboot the server." msgstr "" -#: ../../../docs/maintenance-migrating.md:23 +#: ../../../docs/maintenance-migrating.md:32 msgid "Log in to the old server and run the command as `root` (or a user that can run it with `sudo`):" msgstr "" -#: ../../../docs/maintenance-migrating.md:29 +#: ../../../docs/maintenance-migrating.md:38 msgid "Copy data directory to the new server" msgstr "" -#: ../../../docs/maintenance-migrating.md:31 +#: ../../../docs/maintenance-migrating.md:40 msgid "After you've confirmed that all services were stopped, copy the `/matrix` directory from the old server to the new server. When copying, make sure to preserve ownership and permissions (use `cp -p` or `rsync -ar`)!" msgstr "" -#: ../../../docs/maintenance-migrating.md:33 +#: ../../../docs/maintenance-migrating.md:42 msgid "Adjust DNS records" msgstr "" -#: ../../../docs/maintenance-migrating.md:35 +#: ../../../docs/maintenance-migrating.md:44 msgid "Make sure your DNS records are adjusted to point to the new server's IP address." msgstr "" -#: ../../../docs/maintenance-migrating.md:37 +#: ../../../docs/maintenance-migrating.md:46 msgid "Update `inventory/hosts` file" msgstr "" -#: ../../../docs/maintenance-migrating.md:39 +#: ../../../docs/maintenance-migrating.md:48 msgid "Having adjusted DNS records, replace the old server's external IP address on the `inventory/hosts` file with that of the new server." msgstr "" -#: ../../../docs/maintenance-migrating.md:41 +#: ../../../docs/maintenance-migrating.md:50 msgid "Create `matrix` user and group on the new server" msgstr "" -#: ../../../docs/maintenance-migrating.md:43 +#: ../../../docs/maintenance-migrating.md:52 msgid "Then, run the command below on your local computer to create the `matrix` user and group on the new server:" msgstr "" -#: ../../../docs/maintenance-migrating.md:49 +#: ../../../docs/maintenance-migrating.md:58 msgid "The shortcut command with `just` program is also available: `just run-tags setup-system-user`" msgstr "" -#: ../../../docs/maintenance-migrating.md:51 +#: ../../../docs/maintenance-migrating.md:60 msgid "**Note**: because the `matrix` user and group are created dynamically on each server, the user/group ID may differ between the old and new server. We suggest that you adjust ownership of `/matrix` files. To adjust the ownership, log in to the new server and run the command:" msgstr "" -#: ../../../docs/maintenance-migrating.md:57 +#: ../../../docs/maintenance-migrating.md:66 msgid "Install and start all services on the new server" msgstr "" -#: ../../../docs/maintenance-migrating.md:59 +#: ../../../docs/maintenance-migrating.md:68 msgid "Finally, run the command below on your local computer to finish the installation and start all services:" msgstr "" -#: ../../../docs/maintenance-migrating.md:65 +#: ../../../docs/maintenance-migrating.md:74 msgid "The shortcut command with `just` program is also available: `just run-tags install-all,start`" msgstr "" -#: ../../../docs/maintenance-migrating.md:67 +#: ../../../docs/maintenance-migrating.md:76 msgid "Check if services work" msgstr "" -#: ../../../docs/maintenance-migrating.md:69 -msgid "After starting the services, you probably might want to ensure that you've migrated things correctly and that services are running. For instructions, see: [check if services work](maintenance-checking-services.md)" +#: ../../../docs/maintenance-migrating.md:78 +msgid "After starting the services, you probably might want to ensure that you've migrated things correctly and that services are running. For instructions, see: [check if services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work)" msgstr "" -#: ../../../docs/maintenance-migrating.md:71 +#: ../../../docs/maintenance-migrating.md:80 msgid "Having make sure that both services and federation work as expected, you can safely shutdown the old server." msgstr "" diff --git a/i18n/translation-templates/docs/maintenance-postgres.pot b/i18n/translation-templates/docs/maintenance-postgres.pot index fd6ebc337..6a3941152 100644 --- a/i18n/translation-templates/docs/maintenance-postgres.pot +++ b/i18n/translation-templates/docs/maintenance-postgres.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,202 +16,202 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/maintenance-postgres.md:1 +#: ../../../docs/maintenance-postgres.md:13 msgid "PostgreSQL maintenance" msgstr "" -#: ../../../docs/maintenance-postgres.md:3 +#: ../../../docs/maintenance-postgres.md:15 msgid "This document shows you how to perform various maintenance tasks related to the Postgres database server used by Matrix." msgstr "" -#: ../../../docs/maintenance-postgres.md:5 +#: ../../../docs/maintenance-postgres.md:17 msgid "Table of contents:" msgstr "" -#: ../../../docs/maintenance-postgres.md:7 +#: ../../../docs/maintenance-postgres.md:18 msgid "[Getting a database terminal](#getting-a-database-terminal), for when you wish to execute SQL queries" msgstr "" -#: ../../../docs/maintenance-postgres.md:9 +#: ../../../docs/maintenance-postgres.md:19 msgid "[Vacuuming PostgreSQL](#vacuuming-postgresql), for when you wish to run a Postgres [VACUUM](https://www.postgresql.org/docs/current/sql-vacuum.html) (optimizing disk space)" msgstr "" -#: ../../../docs/maintenance-postgres.md:11 +#: ../../../docs/maintenance-postgres.md:20 msgid "[Backing up PostgreSQL](#backing-up-postgresql), for when you wish to make a backup" msgstr "" -#: ../../../docs/maintenance-postgres.md:13 +#: ../../../docs/maintenance-postgres.md:21 msgid "[Upgrading PostgreSQL](#upgrading-postgresql), for upgrading to new major versions of PostgreSQL. Such **manual upgrades are sometimes required**." msgstr "" -#: ../../../docs/maintenance-postgres.md:15 +#: ../../../docs/maintenance-postgres.md:22 msgid "[Tuning PostgreSQL](#tuning-postgresql) to make it run faster" msgstr "" -#: ../../../docs/maintenance-postgres.md:17 +#: ../../../docs/maintenance-postgres.md:24 msgid "Getting a database terminal" msgstr "" -#: ../../../docs/maintenance-postgres.md:19 -msgid "You can use the `/matrix/postgres/bin/cli` tool to get interactive terminal access ([psql](https://www.postgresql.org/docs/11/app-psql.html)) to the PostgreSQL server." +#: ../../../docs/maintenance-postgres.md:26 +msgid "You can use the `/matrix/postgres/bin/cli` tool to get interactive terminal access ([psql](https://www.postgresql.org/docs/current/app-psql.html)) to the PostgreSQL server." msgstr "" -#: ../../../docs/maintenance-postgres.md:21 +#: ../../../docs/maintenance-postgres.md:28 msgid "If you are using an [external Postgres server](configuring-playbook-external-postgres.md), the above tool will not be available." msgstr "" -#: ../../../docs/maintenance-postgres.md:23 +#: ../../../docs/maintenance-postgres.md:30 msgid "By default, this tool puts you in the `matrix` database, which contains nothing." msgstr "" -#: ../../../docs/maintenance-postgres.md:25 +#: ../../../docs/maintenance-postgres.md:32 msgid "To see the available databases, run `\\list` (or just `\\l`)." msgstr "" -#: ../../../docs/maintenance-postgres.md:27 +#: ../../../docs/maintenance-postgres.md:34 msgid "To change to another database (for example `synapse`), run `\\connect synapse` (or just `\\c synapse`)." msgstr "" -#: ../../../docs/maintenance-postgres.md:29 +#: ../../../docs/maintenance-postgres.md:36 msgid "You can then proceed to write queries. Example: `SELECT COUNT(*) FROM users;`" msgstr "" -#: ../../../docs/maintenance-postgres.md:31 -msgid "**Be careful**. Modifying the database directly (especially as services are running) is dangerous and may lead to irreversible database corruption. When in doubt, consider [making a backup](#backing-up-postgresql)." -msgstr "" - -#: ../../../docs/maintenance-postgres.md:33 -msgid "Vacuuming PostgreSQL" -msgstr "" - -#: ../../../docs/maintenance-postgres.md:35 -msgid "Deleting lots data from Postgres does not make it release disk space, until you perform a [`VACUUM` operation](https://www.postgresql.org/docs/current/sql-vacuum.html)." -msgstr "" - -#: ../../../docs/maintenance-postgres.md:37 -msgid "You can run different `VACUUM` operations via the playbook, with the default preset being `vacuum-complete`:" -msgstr "" - -#: ../../../docs/maintenance-postgres.md:39 -msgid "(default) `vacuum-complete`: stops all services temporarily and runs `VACUUM FULL VERBOSE ANALYZE`." -msgstr "" - -#: ../../../docs/maintenance-postgres.md:40 -msgid "`vacuum-full`: stops all services temporarily and runs `VACUUM FULL VERBOSE`" +#: ../../../docs/maintenance-postgres.md:38 +msgid "[!WARNING] **Modifying the database directly (especially as services are running) is dangerous and may lead to irreversible database corruption.** When in doubt, consider [making a backup](#backing-up-postgresql)." msgstr "" #: ../../../docs/maintenance-postgres.md:41 -msgid "`vacuum`: runs `VACUUM VERBOSE` without stopping any services" -msgstr "" - -#: ../../../docs/maintenance-postgres.md:42 -msgid "`vacuum-analyze` runs `VACUUM VERBOSE ANALYZE` without stopping any services" +msgid "Vacuuming PostgreSQL" msgstr "" #: ../../../docs/maintenance-postgres.md:43 -msgid "`analyze` runs `ANALYZE VERBOSE` without stopping any services (this is just [ANALYZE](https://www.postgresql.org/docs/current/sql-analyze.html) without doing a vacuum, so it's faster)" +msgid "Deleting lots data from Postgres does not make it release disk space, until you perform a [`VACUUM` operation](https://www.postgresql.org/docs/current/sql-vacuum.html)." msgstr "" #: ../../../docs/maintenance-postgres.md:45 -msgid "**Note**: for the `vacuum-complete` and `vacuum-full` presets, you'll need plenty of available disk space in your Postgres data directory (usually `/matrix/postgres/data`). These presets also stop all services (e.g. Synapse, etc.) while the vacuum operation is running." +msgid "You can run different `VACUUM` operations via the playbook, with the default preset being `vacuum-complete`:" msgstr "" #: ../../../docs/maintenance-postgres.md:47 -msgid "Example playbook invocations:" +msgid "(default) `vacuum-complete`: stops all services temporarily and runs `VACUUM FULL VERBOSE ANALYZE`." +msgstr "" + +#: ../../../docs/maintenance-postgres.md:48 +msgid "`vacuum-full`: stops all services temporarily and runs `VACUUM FULL VERBOSE`" msgstr "" #: ../../../docs/maintenance-postgres.md:49 -msgid "`just run-tags run-postgres-vacuum`: runs the default `vacuum-complete` preset and restarts all services" +msgid "`vacuum`: runs `VACUUM VERBOSE` without stopping any services" msgstr "" #: ../../../docs/maintenance-postgres.md:50 +msgid "`vacuum-analyze` runs `VACUUM VERBOSE ANALYZE` without stopping any services" +msgstr "" + +#: ../../../docs/maintenance-postgres.md:51 +msgid "`analyze` runs `ANALYZE VERBOSE` without stopping any services (this is just [ANALYZE](https://www.postgresql.org/docs/current/sql-analyze.html) without doing a vacuum, so it's faster)" +msgstr "" + +#: ../../../docs/maintenance-postgres.md:53 +msgid "**Note**: for the `vacuum-complete` and `vacuum-full` presets, you'll need plenty of available disk space in your Postgres data directory (usually `/matrix/postgres/data`). These presets also stop all services (e.g. Synapse, etc.) while the vacuum operation is running." +msgstr "" + +#: ../../../docs/maintenance-postgres.md:55 +msgid "Example playbook invocations:" +msgstr "" + +#: ../../../docs/maintenance-postgres.md:57 +msgid "`just run-tags run-postgres-vacuum`: runs the default `vacuum-complete` preset and restarts all services" +msgstr "" + +#: ../../../docs/maintenance-postgres.md:58 msgid "`just run-tags run-postgres-vacuum -e postgres_vacuum_preset=analyze`: runs the `analyze` preset with all services remaining operational at all times" msgstr "" -#: ../../../docs/maintenance-postgres.md:52 +#: ../../../docs/maintenance-postgres.md:60 msgid "Backing up PostgreSQL" msgstr "" -#: ../../../docs/maintenance-postgres.md:54 -msgid "To automatically make Postgres database backups on a fixed schedule, see [Setting up postgres backup](configuring-playbook-postgres-backup.md)." +#: ../../../docs/maintenance-postgres.md:62 +msgid "To automatically make Postgres database backups on a fixed schedule, consider enabling the [Postgres Backup](configuring-playbook-postgres-backup.md) service." msgstr "" -#: ../../../docs/maintenance-postgres.md:56 -msgid "To make a one off back up of the current PostgreSQL database, make sure it's running and then execute a command like this on the server:" -msgstr "" - -#: ../../../docs/maintenance-postgres.md:67 -msgid "If you are using an [external Postgres server](configuring-playbook-external-postgres.md), the above command will not work, because neither the credentials file (`/matrix/postgres/env-postgres-psql`), nor the `matrix-postgres` container is available." -msgstr "" - -#: ../../../docs/maintenance-postgres.md:69 -msgid "Restoring a backup made this way can be done by [importing it](importing-postgres.md)." -msgstr "" - -#: ../../../docs/maintenance-postgres.md:71 -msgid "Upgrading PostgreSQL" -msgstr "" - -#: ../../../docs/maintenance-postgres.md:73 -msgid "Unless you are using an [external Postgres server](configuring-playbook-external-postgres.md), this playbook initially installs Postgres for you." +#: ../../../docs/maintenance-postgres.md:64 +msgid "To make a one-off back up of the current PostgreSQL database, make sure it's running and then execute a command like this on the server:" msgstr "" #: ../../../docs/maintenance-postgres.md:75 -msgid "Once installed, the playbook attempts to preserve the Postgres version it starts with. This is because newer Postgres versions cannot start with data generated by older Postgres versions." +msgid "If you are using an [external Postgres server](configuring-playbook-external-postgres.md), the above command will not work, because neither the credentials file (`/matrix/postgres/env-postgres-psql`), nor the `matrix-postgres` container is available." msgstr "" #: ../../../docs/maintenance-postgres.md:77 -msgid "Upgrades must be performed manually." +msgid "Restoring a backup made this way can be done by [importing it](importing-postgres.md)." msgstr "" #: ../../../docs/maintenance-postgres.md:79 -msgid "The playbook can upgrade your existing Postgres setup with the following command:" +msgid "Upgrading PostgreSQL" +msgstr "" + +#: ../../../docs/maintenance-postgres.md:81 +msgid "Unless you are using an [external Postgres server](configuring-playbook-external-postgres.md), this playbook initially installs Postgres for you." +msgstr "" + +#: ../../../docs/maintenance-postgres.md:83 +msgid "Once installed, the playbook attempts to preserve the Postgres version it starts with. This is because newer Postgres versions cannot start with data generated by older Postgres versions." msgstr "" #: ../../../docs/maintenance-postgres.md:85 -msgid "**The old Postgres data directory is backed up** automatically, by renaming it to `/matrix/postgres/data-auto-upgrade-backup`. To rename to a different path, pass some extra flags to the command above, like this: `--extra-vars=\"postgres_auto_upgrade_backup_data_path=/another/disk/matrix-postgres-before-upgrade\"`" +msgid "Upgrades must be performed manually." msgstr "" #: ../../../docs/maintenance-postgres.md:87 -msgid "The auto-upgrade-backup directory stays around forever, until you **manually decide to delete it**." -msgstr "" - -#: ../../../docs/maintenance-postgres.md:89 -msgid "As part of the upgrade, the database is dumped to `/tmp`, an upgraded and empty Postgres server is started, and then the dump is restored into the new server. To use a different directory for the dump, pass some extra flags to the command above, like this: `--extra-vars=\"postgres_dump_dir=/directory/to/dump/here\"`" -msgstr "" - -#: ../../../docs/maintenance-postgres.md:91 -msgid "To save disk space in `/tmp`, the dump file is gzipped on the fly at the expense of CPU usage. If you have plenty of space in `/tmp` and would rather avoid gzipping, you can explicitly pass a dump filename which doesn't end in `.gz`. Example: `--extra-vars=\"postgres_dump_name=matrix-postgres-dump.sql\"`" +msgid "The playbook can upgrade your existing Postgres setup with the following command:" msgstr "" #: ../../../docs/maintenance-postgres.md:93 -msgid "**All databases, roles, etc. on the Postgres server are migrated**." +msgid "**The old Postgres data directory is backed up** automatically, by renaming it to `/matrix/postgres/data-auto-upgrade-backup`. To rename to a different path, pass some extra flags to the command above, like this: `--extra-vars=\"postgres_auto_upgrade_backup_data_path=/another/disk/matrix-postgres-before-upgrade\"`" msgstr "" #: ../../../docs/maintenance-postgres.md:95 -msgid "Tuning PostgreSQL" +msgid "The auto-upgrade-backup directory stays around forever, until you **manually decide to delete it**." msgstr "" #: ../../../docs/maintenance-postgres.md:97 -msgid "PostgreSQL can be [tuned](https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server) to make it run faster. This is done by passing extra arguments to the Postgres process." +msgid "As part of the upgrade, the database is dumped to `/tmp`, an upgraded and empty Postgres server is started, and then the dump is restored into the new server. To use a different directory for the dump, pass some extra flags to the command above, like this: `--extra-vars=\"postgres_dump_dir=/directory/to/dump/here\"`" msgstr "" #: ../../../docs/maintenance-postgres.md:99 -msgid "The [Postgres Ansible role](https://github.com/mother-of-all-self-hosting/ansible-role-postgres) **already does some tuning by default**, which matches the [tuning logic](https://github.com/le0pard/pgtune/blob/master/src/features/configuration/configurationSlice.js) done by websites like https://pgtune.leopard.in.ua/. You can manually influence some of the tuning variables. These parameters (variables) are injected via the `postgres_postgres_process_extra_arguments_auto` variable." +msgid "To save disk space in `/tmp`, the dump file is gzipped on the fly at the expense of CPU usage. If you have plenty of space in `/tmp` and would rather avoid gzipping, you can explicitly pass a dump filename which doesn't end in `.gz`. Example: `--extra-vars=\"postgres_dump_name=matrix-postgres-dump.sql\"`" msgstr "" #: ../../../docs/maintenance-postgres.md:101 -msgid "Most users should be fine with the automatically-done tuning. However, you may wish to:" +msgid "**All databases, roles, etc. on the Postgres server are migrated**. However, other components that depend on specific Postgres versions (like the [Postgres Backup](configuring-playbook-postgres-backup.md) service) may need to be updated after the upgrade by using `just install-all`" msgstr "" #: ../../../docs/maintenance-postgres.md:103 -msgid "**adjust the automatically-determined tuning parameters manually**: change the values for the tuning variables defined in the Postgres role's [default configuration file](https://github.com/mother-of-all-self-hosting/ansible-role-postgres/blob/main/defaults/main.yml) (see `postgres_max_connections`, `postgres_data_storage` etc). These variables are ultimately passed to Postgres via a `postgres_postgres_process_extra_arguments_auto` variable" +msgid "Tuning PostgreSQL" msgstr "" #: ../../../docs/maintenance-postgres.md:105 -msgid "**turn automatically-performed tuning off**: override it like this: `postgres_postgres_process_extra_arguments_auto: []`" +msgid "PostgreSQL can be [tuned](https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server) to make it run faster. This is done by passing extra arguments to the Postgres process." msgstr "" #: ../../../docs/maintenance-postgres.md:107 -msgid "**add additional tuning parameters**: define your additional Postgres configuration parameters in `postgres_postgres_process_extra_arguments_custom`. See `postgres_postgres_process_extra_arguments_auto` defined in the Postgres role's [default configuration file](https://github.com/mother-of-all-self-hosting/ansible-role-postgres/blob/main/defaults/main.yml) for inspiration" +msgid "The [Postgres Ansible role](https://github.com/mother-of-all-self-hosting/ansible-role-postgres) **already does some tuning by default**, which matches the [tuning logic](https://github.com/le0pard/pgtune/blob/master/src/features/configuration/configurationSlice.js) done by websites like https://pgtune.leopard.in.ua/. You can manually influence some of the tuning variables. These parameters (variables) are injected via the `postgres_postgres_process_extra_arguments_default` variable." +msgstr "" + +#: ../../../docs/maintenance-postgres.md:109 +msgid "Most users should be fine with the automatically-done tuning. However, you may wish to:" +msgstr "" + +#: ../../../docs/maintenance-postgres.md:111 +msgid "**adjust the automatically-determined tuning parameters manually**: change the values for the tuning variables defined in the Postgres role's [default configuration file](https://github.com/mother-of-all-self-hosting/ansible-role-postgres/blob/main/defaults/main.yml) (see `postgres_max_connections`, `postgres_data_storage` etc). These variables are ultimately passed to Postgres via a `postgres_postgres_process_extra_arguments_default` variable" +msgstr "" + +#: ../../../docs/maintenance-postgres.md:113 +msgid "**turn automatically-performed tuning off**: override it like this: `postgres_postgres_process_extra_arguments_default: []`" +msgstr "" + +#: ../../../docs/maintenance-postgres.md:115 +msgid "**add additional tuning parameters**: define your additional Postgres configuration parameters in `postgres_postgres_process_extra_arguments_custom`. See `postgres_postgres_process_extra_arguments_default` defined in the Postgres role's [default configuration file](https://github.com/mother-of-all-self-hosting/ansible-role-postgres/blob/main/defaults/main.yml) for inspiration" msgstr "" diff --git a/i18n/translation-templates/docs/maintenance-synapse.pot b/i18n/translation-templates/docs/maintenance-synapse.pot index 8d3b68999..4da49e5a2 100644 --- a/i18n/translation-templates/docs/maintenance-synapse.pot +++ b/i18n/translation-templates/docs/maintenance-synapse.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,182 +16,186 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/maintenance-synapse.md:1 +#: ../../../docs/maintenance-synapse.md:12 msgid "Synapse maintenance" msgstr "" -#: ../../../docs/maintenance-synapse.md:3 +#: ../../../docs/maintenance-synapse.md:14 msgid "This document shows you how to perform various maintenance tasks related to the Synapse chat server." msgstr "" -#: ../../../docs/maintenance-synapse.md:5 +#: ../../../docs/maintenance-synapse.md:16 msgid "Table of contents:" msgstr "" -#: ../../../docs/maintenance-synapse.md:7 +#: ../../../docs/maintenance-synapse.md:17 msgid "[Purging old data with the Purge History API](#purging-old-data-with-the-purge-history-api), for when you wish to delete in-use (but old) data from the Synapse database" msgstr "" -#: ../../../docs/maintenance-synapse.md:9 +#: ../../../docs/maintenance-synapse.md:18 msgid "[Compressing state with rust-synapse-compress-state](#compressing-state-with-rust-synapse-compress-state)" msgstr "" -#: ../../../docs/maintenance-synapse.md:11 +#: ../../../docs/maintenance-synapse.md:19 msgid "[Browse and manipulate the database](#browse-and-manipulate-the-database), for when you really need to take matters into your own hands" msgstr "" -#: ../../../docs/maintenance-synapse.md:13 +#: ../../../docs/maintenance-synapse.md:20 msgid "[Make Synapse faster](#make-synapse-faster)" msgstr "" -#: ../../../docs/maintenance-synapse.md:15 -msgid "Purging old data with the Purge History API" -msgstr "" - -#: ../../../docs/maintenance-synapse.md:17 -msgid "You can use the **[Purge History API](https://github.com/element-hq/synapse/blob/master/docs/admin_api/purge_history_api.md)** to delete old messages on a per-room basis. **This is destructive** (especially for non-federated rooms), because it means **people will no longer have access to history past a certain point**." -msgstr "" - -#: ../../../docs/maintenance-synapse.md:19 -msgid "To make use of this Synapse Admin API, **you'll need an admin access token** first. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." -msgstr "" - -#: ../../../docs/maintenance-synapse.md:21 -msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." +#: ../../../docs/maintenance-synapse.md:22 +msgid "💡 See this page for details about configuring Synapse: [Configuring Synapse](configuring-playbook-synapse.md)" msgstr "" #: ../../../docs/maintenance-synapse.md:24 -msgid "Synapse's Admin API is not exposed to the internet by default, following [official Synapse reverse-proxying recommendations](https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md#synapse-administration-endpoints). To expose it you will need to add `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true` to your `vars.yml` file." +msgid "Purging old data with the Purge History API" msgstr "" #: ../../../docs/maintenance-synapse.md:26 -msgid "Follow the [Purge History API](https://github.com/element-hq/synapse/blob/master/docs/admin_api/purge_history_api.md) documentation page for the actual purging instructions." +msgid "You can use the **[Purge History API](https://github.com/element-hq/synapse/blob/master/docs/admin_api/purge_history_api.md)** to delete old messages on a per-room basis. **This is destructive** (especially for non-federated rooms), because it means **people will no longer have access to history past a certain point**." msgstr "" #: ../../../docs/maintenance-synapse.md:28 -msgid "After deleting data, you may wish to run a [`FULL` Postgres `VACUUM`](./maintenance-postgres.md#vacuuming-postgresql)." +msgid "To make use of this Synapse Admin API, **you'll need an admin access token** first. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)." msgstr "" #: ../../../docs/maintenance-synapse.md:30 +msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." +msgstr "" + +#: ../../../docs/maintenance-synapse.md:33 +msgid "Synapse's Admin API is not exposed to the internet by default, following [official Synapse reverse-proxying recommendations](https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md#synapse-administration-endpoints). To expose it you will need to add `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true` to your `vars.yml` file." +msgstr "" + +#: ../../../docs/maintenance-synapse.md:35 +msgid "Follow the [Purge History API](https://github.com/element-hq/synapse/blob/master/docs/admin_api/purge_history_api.md) documentation page for the actual purging instructions." +msgstr "" + +#: ../../../docs/maintenance-synapse.md:37 +msgid "After deleting data, you may wish to run a [`FULL` Postgres `VACUUM`](./maintenance-postgres.md#vacuuming-postgresql)." +msgstr "" + +#: ../../../docs/maintenance-synapse.md:39 msgid "Compressing state with rust-synapse-compress-state" msgstr "" -#: ../../../docs/maintenance-synapse.md:32 +#: ../../../docs/maintenance-synapse.md:41 msgid "[rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state) can be used to optimize some `_state` tables used by Synapse. If your server participates in large rooms this is the most effective way to reduce the size of your database." msgstr "" -#: ../../../docs/maintenance-synapse.md:34 +#: ../../../docs/maintenance-synapse.md:43 msgid "**Note**: besides running the `rust-synapse-compress-state` tool manually, you can also enable its `synapse-auto-compressor` tool by [Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md). The automatic tool will run on a schedule every day and you won't have to compress state manually ever again." msgstr "" -#: ../../../docs/maintenance-synapse.md:36 +#: ../../../docs/maintenance-synapse.md:45 msgid "`rust-synapse-compress-state` should be safe to use (even when Synapse is running), but it's always a good idea to [make Postgres backups](./maintenance-postgres.md#backing-up-postgresql) first." msgstr "" -#: ../../../docs/maintenance-synapse.md:38 +#: ../../../docs/maintenance-synapse.md:47 msgid "To ask the playbook to run rust-synapse-compress-state, execute:" msgstr "" -#: ../../../docs/maintenance-synapse.md:44 +#: ../../../docs/maintenance-synapse.md:53 msgid "The shortcut command with `just` program is also available: `just run-tags rust-synapse-compress-state`" msgstr "" -#: ../../../docs/maintenance-synapse.md:46 +#: ../../../docs/maintenance-synapse.md:55 msgid "By default, all rooms with more than `100000` state group rows will be compressed. If you need to adjust this, pass: `--extra-vars='matrix_synapse_rust_synapse_compress_state_min_state_groups_required=SOME_NUMBER_HERE'` to the command above." msgstr "" -#: ../../../docs/maintenance-synapse.md:48 +#: ../../../docs/maintenance-synapse.md:57 msgid "After state compression, you may wish to run a [`FULL` Postgres `VACUUM`](./maintenance-postgres.md#vacuuming-postgresql)." msgstr "" -#: ../../../docs/maintenance-synapse.md:50 +#: ../../../docs/maintenance-synapse.md:59 msgid "Browse and manipulate the database" msgstr "" -#: ../../../docs/maintenance-synapse.md:52 +#: ../../../docs/maintenance-synapse.md:61 msgid "When the [Synapse Admin API](https://github.com/element-hq/synapse/tree/master/docs/admin_api) and the other tools do not provide a more convenient way, having a look at synapse's postgresql database can satisfy a lot of admins' needs." msgstr "" -#: ../../../docs/maintenance-synapse.md:54 +#: ../../../docs/maintenance-synapse.md:63 msgid "Editing the database manually is not recommended or supported by the Synapse developers. If you are going to do so you should [make a database backup](./maintenance-postgres.md#backing-up-postgresql)." msgstr "" -#: ../../../docs/maintenance-synapse.md:56 +#: ../../../docs/maintenance-synapse.md:65 msgid "First, set up an SSH tunnel to your Matrix server (skip if it is your local machine):" msgstr "" -#: ../../../docs/maintenance-synapse.md:63 +#: ../../../docs/maintenance-synapse.md:72 msgid "Then start up an ephemeral [adminer](https://www.adminer.org/) container on the Matrix server, connecting it to the `matrix` network and linking the postgresql container:" msgstr "" -#: ../../../docs/maintenance-synapse.md:69 +#: ../../../docs/maintenance-synapse.md:78 msgid "You should then be able to browse the adminer database administration GUI at http://localhost:1799/ after entering your DB credentials (found in the `host_vars` or on the server in `{{matrix_synapse_config_dir_path}}/homeserver.yaml` under `database.args`)" msgstr "" -#: ../../../docs/maintenance-synapse.md:71 +#: ../../../docs/maintenance-synapse.md:80 msgid "⚠️️ Be **very careful** with this, there is **no undo** for impromptu DB operations." msgstr "" -#: ../../../docs/maintenance-synapse.md:73 +#: ../../../docs/maintenance-synapse.md:82 msgid "Make Synapse faster" msgstr "" -#: ../../../docs/maintenance-synapse.md:75 +#: ../../../docs/maintenance-synapse.md:84 msgid "Synapse's presence feature which tracks which users are online and which are offline can use a lot of processing power. You can disable presence by adding `matrix_synapse_presence_enabled: false` to your `vars.yml` file." msgstr "" -#: ../../../docs/maintenance-synapse.md:77 +#: ../../../docs/maintenance-synapse.md:86 msgid "If you have enough compute resources (CPU & RAM), you can make Synapse better use of them by [enabling load-balancing with workers](configuring-playbook-synapse.md#load-balancing-with-workers)." msgstr "" -#: ../../../docs/maintenance-synapse.md:79 +#: ../../../docs/maintenance-synapse.md:88 msgid "[Tuning your PostgreSQL database](maintenance-postgres.md#tuning-postgresql) could also improve Synapse performance. The playbook tunes the integrated Postgres database automatically, but based on your needs you may wish to adjust tuning variables manually. If you're using an [external Postgres database](configuring-playbook-external-postgres.md), you will also need to tune Postgres manually." msgstr "" -#: ../../../docs/maintenance-synapse.md:81 +#: ../../../docs/maintenance-synapse.md:90 msgid "Tuning caches and cache autotuning" msgstr "" -#: ../../../docs/maintenance-synapse.md:83 +#: ../../../docs/maintenance-synapse.md:92 msgid "Tuning Synapse's cache factor is useful for performance increases but also as part of controlling Synapse's memory use. Use the variable `matrix_synapse_caches_global_factor` to set the cache factor as part of this process." msgstr "" -#: ../../../docs/maintenance-synapse.md:85 +#: ../../../docs/maintenance-synapse.md:94 msgid "**The playbook defaults the global cache factor to a large value** (e.g. `10`). A smaller value (e.g. `0.5`) will decrease the amount used for caches, but will [not necessarily decrease RAM usage as a whole](https://github.com/matrix-org/synapse/issues/3939)." msgstr "" -#: ../../../docs/maintenance-synapse.md:87 +#: ../../../docs/maintenance-synapse.md:96 msgid "Tuning the cache factor is useful only to a limited degree (as its crude to do in isolation) and therefore users who are tuning their cache factor should likely look into tuning autotune variables as well (see below)." msgstr "" -#: ../../../docs/maintenance-synapse.md:89 +#: ../../../docs/maintenance-synapse.md:98 msgid "Cache autotuning is **enabled by default** and controlled via the following variables:" msgstr "" -#: ../../../docs/maintenance-synapse.md:91 +#: ../../../docs/maintenance-synapse.md:100 msgid "`matrix_synapse_cache_autotuning_max_cache_memory_usage` — defaults to 1/8 of total RAM with a cap of 2GB; values are specified in bytes" msgstr "" -#: ../../../docs/maintenance-synapse.md:92 +#: ../../../docs/maintenance-synapse.md:101 msgid "`matrix_synapse_cache_autotuning_target_cache_memory_usage` — defaults to 1/16 of total RAM with a cap of 1GB; values are specified in bytes" msgstr "" -#: ../../../docs/maintenance-synapse.md:93 +#: ../../../docs/maintenance-synapse.md:102 msgid "`matrix_synapse_cache_autotuning_min_cache_ttl` — defaults to `30s`" msgstr "" -#: ../../../docs/maintenance-synapse.md:95 +#: ../../../docs/maintenance-synapse.md:104 msgid "You can **learn more about cache-autotuning and the global cache factor settings** in the [Synapse's documentation on caches and associated values](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caches-and-associated-values)." msgstr "" -#: ../../../docs/maintenance-synapse.md:97 +#: ../../../docs/maintenance-synapse.md:106 msgid "To **disable cache auto-tuning**, unset all values:" msgstr "" -#: ../../../docs/maintenance-synapse.md:105 +#: ../../../docs/maintenance-synapse.md:114 msgid "Users who wish to lower Synapse's RAM footprint should look into lowering the global cache factor and tweaking the autotune variables (or disabling auto-tuning). If your cache factor is too low for a given auto tune setting your caches will not reach autotune thresholds and autotune won't be able to do its job. Therefore, when auto-tuning is enabled (which it is by default), it's recommended to have your cache factor be large." msgstr "" -#: ../../../docs/maintenance-synapse.md:107 +#: ../../../docs/maintenance-synapse.md:116 msgid "See also [How do I optimize this setup for a low-power server?](faq.md#how-do-i-optimize-this-setup-for-a-low-power-server)." msgstr "" diff --git a/i18n/translation-templates/docs/maintenance-upgrading-services.pot b/i18n/translation-templates/docs/maintenance-upgrading-services.pot index c1ba9faf7..b0d88289b 100644 --- a/i18n/translation-templates/docs/maintenance-upgrading-services.pot +++ b/i18n/translation-templates/docs/maintenance-upgrading-services.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,110 +16,110 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/maintenance-upgrading-services.md:1 +#: ../../../docs/maintenance-upgrading-services.md:12 msgid "Upgrading the Matrix services" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:3 +#: ../../../docs/maintenance-upgrading-services.md:14 msgid "This playbook not only installs the various Matrix services for you, but can also upgrade them as new versions are made available." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:5 +#: ../../../docs/maintenance-upgrading-services.md:16 msgid "While this playbook helps you to set up Matrix services and maintain them, it will **not** automatically run the maintenance task for you. You will need to update the playbook and re-run it **manually**." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:7 +#: ../../../docs/maintenance-upgrading-services.md:18 msgid "The upstream projects, which this playbook makes use of, occasionally if not often suffer from security vulnerabilities (for example, see [here](https://github.com/element-hq/element-web/security) for known ones on Element Web)." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:9 +#: ../../../docs/maintenance-upgrading-services.md:20 msgid "Since it is unsafe to keep outdated services running on the server connected to the internet, please consider to update the playbook and re-run it periodically, in order to keep the services up-to-date." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:11 +#: ../../../docs/maintenance-upgrading-services.md:22 msgid "The developers of this playbook strive to maintain the playbook updated, so that you can re-run the playbook to address such vulnerabilities. It is **your responsibility** to keep your server and the services on it up-to-date." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:13 +#: ../../../docs/maintenance-upgrading-services.md:24 msgid "If you want to be notified when new versions of Synapse are released, you should join the Synapse Homeowners room: [#homeowners:matrix.org](https://matrix.to/#/#homeowners:matrix.org)." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:15 +#: ../../../docs/maintenance-upgrading-services.md:26 msgid "Steps to upgrade the Matrix services" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:17 +#: ../../../docs/maintenance-upgrading-services.md:28 msgid "Check the changelog" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:19 +#: ../../../docs/maintenance-upgrading-services.md:30 msgid "Before updating the playbook and the Ansible roles in the playbook, take a look at [the changelog](../CHANGELOG.md) to see if there have been any backward-incompatible changes that you need to take care of." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:21 +#: ../../../docs/maintenance-upgrading-services.md:32 msgid "Update the playbook and the Ansible roles" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:23 +#: ../../../docs/maintenance-upgrading-services.md:34 msgid "If it looks good to you, go to the `matrix-docker-ansible-deploy` directory, update your playbook directory and all upstream Ansible roles (defined in the `requirements.yml` file) by running:" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:25 +#: ../../../docs/maintenance-upgrading-services.md:36 msgid "either: `just update`" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:26 +#: ../../../docs/maintenance-upgrading-services.md:37 msgid "or: a combination of `git pull` and `just roles` (or `make roles` if you have `make` program on your computer instead of `just`)" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:28 +#: ../../../docs/maintenance-upgrading-services.md:39 msgid "If you don't have either `just` tool or `make` program, you can run the `ansible-galaxy` tool directly: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force`" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:30 +#: ../../../docs/maintenance-upgrading-services.md:41 msgid "**Note**: for details about `just` commands, take a look at: [Running `just` commands](just.md)." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:32 +#: ../../../docs/maintenance-upgrading-services.md:43 msgid "Re-run the playbook setup" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:34 +#: ../../../docs/maintenance-upgrading-services.md:45 msgid "After updating the Ansible roles, then re-run the [playbook setup](installing.md#maintaining-your-setup-in-the-future) and restart all services:" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:40 +#: ../../../docs/maintenance-upgrading-services.md:51 msgid "If you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with the `setup-all` tag as below:" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:46 +#: ../../../docs/maintenance-upgrading-services.md:57 msgid "**Notes**:" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:48 +#: ../../../docs/maintenance-upgrading-services.md:59 msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account, if any." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:50 +#: ../../../docs/maintenance-upgrading-services.md:61 msgid "Our estimation is that running `--tags=install-all,start` is approximately from **2 to 5 times faster** than running `setup-all,ensure-matrix-users-created,start`. See [this entry](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) on `CHANGELOG.md` for more information." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:52 +#: ../../../docs/maintenance-upgrading-services.md:63 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`. Note these shortcuts run the `ensure-matrix-users-created` tag too." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:54 +#: ../../../docs/maintenance-upgrading-services.md:65 msgid "See [this page on the playbook tags](playbook-tags.md) for more information about those tags." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:56 +#: ../../../docs/maintenance-upgrading-services.md:67 msgid "PostgreSQL major version upgrade" msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:58 +#: ../../../docs/maintenance-upgrading-services.md:69 msgid "Major version upgrades to the internal PostgreSQL database are not done automatically. Upgrades must be performed manually." msgstr "" -#: ../../../docs/maintenance-upgrading-services.md:60 +#: ../../../docs/maintenance-upgrading-services.md:71 msgid "For details about upgrading it, refer to the [upgrading PostgreSQL guide](maintenance-postgres.md#upgrading-postgresql)." msgstr "" diff --git a/i18n/translation-templates/docs/obtaining-access-tokens.pot b/i18n/translation-templates/docs/obtaining-access-tokens.pot index ae33c546c..eaf101b79 100644 --- a/i18n/translation-templates/docs/obtaining-access-tokens.pot +++ b/i18n/translation-templates/docs/obtaining-access-tokens.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,78 +16,78 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/obtaining-access-tokens.md:1 +#: ../../../docs/obtaining-access-tokens.md:10 msgid "Obtaining an Access Token" msgstr "" -#: ../../../docs/obtaining-access-tokens.md:3 +#: ../../../docs/obtaining-access-tokens.md:12 msgid "When setting up some optional features like bots and bridges you will need to provide an access token for some user. This document provides documentation on how to obtain such an access token." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:5 +#: ../../../docs/obtaining-access-tokens.md:14 msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:8 +#: ../../../docs/obtaining-access-tokens.md:17 msgid "Prerequisites" msgstr "" -#: ../../../docs/obtaining-access-tokens.md:10 +#: ../../../docs/obtaining-access-tokens.md:19 msgid "The user for whom you want to obtain an access token needs to already exist. You can use this playbook to [register a new user](registering-users.md), if you have not already." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:12 +#: ../../../docs/obtaining-access-tokens.md:21 msgid "Below, we describe 2 ways to generate an access token for a user — using [Element Web](#obtain-an-access-token-via-element-web) or [curl](#obtain-an-access-token-via-curl). For both ways you need the user's password." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:14 +#: ../../../docs/obtaining-access-tokens.md:23 msgid "Obtain an access token via Element Web" msgstr "" -#: ../../../docs/obtaining-access-tokens.md:16 +#: ../../../docs/obtaining-access-tokens.md:25 msgid "In a private browsing session (incognito window), open Element Web." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:17 +#: ../../../docs/obtaining-access-tokens.md:26 msgid "Log in with the user's credentials." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:18 +#: ../../../docs/obtaining-access-tokens.md:27 msgid "In the settings page, choose \"Help & About\", scroll down to the bottom and expand the `Access Token` section (see screenshot below)." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:19 +#: ../../../docs/obtaining-access-tokens.md:28 msgid "Copy the access token to your configuration." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:20 +#: ../../../docs/obtaining-access-tokens.md:29 msgid "Close the private browsing session. **Do not log out**. Logging out will invalidate the token, making it not work." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:22 +#: ../../../docs/obtaining-access-tokens.md:31 msgid "![Obtaining an access token with Element Web](assets/obtain_admin_access_token_element_web.png)" msgstr "" -#: ../../../docs/obtaining-access-tokens.md:22 +#: ../../../docs/obtaining-access-tokens.md:31 msgid "Obtaining an access token with Element Web" msgstr "" -#: ../../../docs/obtaining-access-tokens.md:24 +#: ../../../docs/obtaining-access-tokens.md:33 msgid "Obtain an access token via curl" msgstr "" -#: ../../../docs/obtaining-access-tokens.md:26 +#: ../../../docs/obtaining-access-tokens.md:35 msgid "You can use the following command to get an access token for your user directly from the [Matrix Client-Server API](https://www.matrix.org/docs/guides/client-server-api#login):" msgstr "" -#: ../../../docs/obtaining-access-tokens.md:36 +#: ../../../docs/obtaining-access-tokens.md:45 msgid "Change `USERNAME`, `PASSWORD`, and `example.com` accordingly." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:38 +#: ../../../docs/obtaining-access-tokens.md:47 msgid "`YOURDEVICEID` is optional and can be used to more easily identify the session later. When omitted (mind the commas in the JSON payload if you'll be omitting it), a random device ID will be generated." msgstr "" -#: ../../../docs/obtaining-access-tokens.md:40 +#: ../../../docs/obtaining-access-tokens.md:49 msgid "Your response will look like this (prettified):" msgstr "" diff --git a/i18n/translation-templates/docs/playbook-tags.pot b/i18n/translation-templates/docs/playbook-tags.pot index 020dd51b1..1a80b65cc 100644 --- a/i18n/translation-templates/docs/playbook-tags.pot +++ b/i18n/translation-templates/docs/playbook-tags.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,58 +16,66 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/playbook-tags.md:1 +#: ../../../docs/playbook-tags.md:8 msgid "Playbook tags" msgstr "" -#: ../../../docs/playbook-tags.md:3 +#: ../../../docs/playbook-tags.md:10 msgid "The Ansible playbook's tasks are tagged, so that certain parts of the Ansible playbook can be run without running all other tasks." msgstr "" -#: ../../../docs/playbook-tags.md:5 -msgid "The general command syntax is: `ansible-playbook -i inventory/hosts setup.yml --tags=COMMA_SEPARATED_TAGS_GO_HERE`" -msgstr "" - -#: ../../../docs/playbook-tags.md:7 -msgid "Here are some playbook tags that you should be familiar with:" -msgstr "" - -#: ../../../docs/playbook-tags.md:9 -msgid "`setup-all` — runs all setup tasks (installation and uninstallation) for all components, but does not start/restart services" -msgstr "" - -#: ../../../docs/playbook-tags.md:11 -msgid "`install-all` — like `setup-all`, but skips uninstallation tasks. Useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove components, you'd need to run `setup-all` though, or these components will still remain installed" +#: ../../../docs/playbook-tags.md:12 +msgid "The general command syntax is:" msgstr "" #: ../../../docs/playbook-tags.md:13 +msgid "(**recommended**) when using `just`: `just run-tags COMMA_SEPARATED_TAGS_GO_HERE`" +msgstr "" + +#: ../../../docs/playbook-tags.md:14 +msgid "when not using `just`: `ansible-playbook -i inventory/hosts setup.yml --tags=COMMA_SEPARATED_TAGS_GO_HERE`" +msgstr "" + +#: ../../../docs/playbook-tags.md:16 +msgid "Here are some playbook tags that you should be familiar with:" +msgstr "" + +#: ../../../docs/playbook-tags.md:18 +msgid "`setup-all` — runs all setup tasks (installation and uninstallation) for all components, but does not start/restart services" +msgstr "" + +#: ../../../docs/playbook-tags.md:20 +msgid "`install-all` — like `setup-all`, but skips uninstallation tasks. Useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove components, you'd need to run `setup-all` though, or these components will still remain installed" +msgstr "" + +#: ../../../docs/playbook-tags.md:22 msgid "`setup-SERVICE` (e.g. `setup-postmoogle`) — runs the setup tasks only for a given role, but does not start/restart services. You can discover these additional tags in each role (`roles/**/tasks/main.yml`). Running per-component setup tasks is **not recommended**, as components sometimes depend on each other and running just the setup tasks for a given component may not be enough. For example, setting up the [mautrix-telegram bridge](configuring-playbook-bridge-mautrix-telegram.md), in addition to the `setup-mautrix-telegram` tag, requires database changes (the `setup-postgres` tag) as well as reverse-proxy changes (the `setup-nginx-proxy` tag)." msgstr "" -#: ../../../docs/playbook-tags.md:15 +#: ../../../docs/playbook-tags.md:24 msgid "`install-SERVICE` (e.g. `install-postmoogle`) — like `setup-SERVICE`, but skips uninstallation tasks. See `install-all` above for additional information." msgstr "" -#: ../../../docs/playbook-tags.md:17 +#: ../../../docs/playbook-tags.md:26 msgid "`start` — starts all systemd services and makes them start automatically in the future" msgstr "" -#: ../../../docs/playbook-tags.md:19 +#: ../../../docs/playbook-tags.md:28 msgid "`stop` — stops all systemd services" msgstr "" -#: ../../../docs/playbook-tags.md:21 -msgid "`ensure-matrix-users-created` — a special tag which ensures that all special users needed by the playbook (for bots, etc.) are created" +#: ../../../docs/playbook-tags.md:30 +msgid "`ensure-matrix-users-created` or its alias `ensure-users-created` — a special tag which ensures that all special users needed by the playbook (for bots, etc.) are created. See the variable `matrix_user_creator_users_auto` on [`group_vars/matrix_servers`](../group_vars/matrix_servers) for actual values of users which running this tag can create by default." msgstr "" -#: ../../../docs/playbook-tags.md:23 +#: ../../../docs/playbook-tags.md:32 msgid "**Notes**:" msgstr "" -#: ../../../docs/playbook-tags.md:24 +#: ../../../docs/playbook-tags.md:33 msgid "`setup-*` tags and `install-*` tags **do not start services** automatically, because you may wish to do things before starting services, such as importing a database dump, restoring data from another server, etc." msgstr "" -#: ../../../docs/playbook-tags.md:25 +#: ../../../docs/playbook-tags.md:34 msgid "Please be careful not to confuse the playbook tags with the `just` shortcut commands (\"recipes\"). For details about `just` commands, see: [Running `just` commands](just.md)" msgstr "" diff --git a/i18n/translation-templates/docs/prerequisites.pot b/i18n/translation-templates/docs/prerequisites.pot index adb4809b8..b8ffc38dc 100644 --- a/i18n/translation-templates/docs/prerequisites.pot +++ b/i18n/translation-templates/docs/prerequisites.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,146 +16,146 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/prerequisites.md:1 +#: ../../../docs/prerequisites.md:12 msgid "Prerequisites" msgstr "" -#: ../../../docs/prerequisites.md:3 -msgid "Prerequisites > [Configuring your DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)" +#: ../../../docs/prerequisites.md:14 +msgid "Prerequisites > [Configuring DNS settings](configuring-dns.md) > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)" msgstr "" -#: ../../../docs/prerequisites.md:5 +#: ../../../docs/prerequisites.md:16 msgid "To install Matrix services using this Ansible playbook, you need to prepare several requirements both on your local computer (where you will run the playbook to configure the server) and the server (where the playbook will install the Matrix services for you). **These requirements need to be set up manually** before proceeding to the next step." msgstr "" -#: ../../../docs/prerequisites.md:7 +#: ../../../docs/prerequisites.md:18 msgid "We will be using `example.com` as the domain in the following instruction. Please remember to replace it with your own domain before running any commands." msgstr "" -#: ../../../docs/prerequisites.md:9 +#: ../../../docs/prerequisites.md:20 msgid "**Note**: if you do not have an existing Matrix server and want to start quickly with \"opinionated defaults\", we suggest you to follow ⚡ **[Quick start](quick-start.md)** installation guide." msgstr "" -#: ../../../docs/prerequisites.md:11 +#: ../../../docs/prerequisites.md:22 msgid "Your local computer" msgstr "" -#: ../../../docs/prerequisites.md:13 +#: ../../../docs/prerequisites.md:24 msgid "[Ansible](http://ansible.com/) program. It's used to run this playbook and configures your server for you. Take a look at [our guide about Ansible](ansible.md) for more information, as well as [version requirements](ansible.md#supported-ansible-versions) and alternative ways to run Ansible." msgstr "" -#: ../../../docs/prerequisites.md:15 +#: ../../../docs/prerequisites.md:26 msgid "[passlib](https://passlib.readthedocs.io/en/stable/index.html) Python library. See [this official documentation](https://passlib.readthedocs.io/en/stable/install.html#installation-instructions) for an instruction to install it. On most distros, you need to install some `python-passlib` or `py3-passlib` package, etc." msgstr "" -#: ../../../docs/prerequisites.md:17 +#: ../../../docs/prerequisites.md:28 msgid "[`git`](https://git-scm.com/) as the recommended way to download the playbook. `git` may also be required on the server if you will be [self-building](self-building.md) components." msgstr "" -#: ../../../docs/prerequisites.md:19 -msgid "[`just`](https://github.com/casey/just) for running `just roles`, `just update`, etc. (see [`justfile`](../justfile)), although you can also run these commands manually. Take at look at this documentation for more information: [Running `just` commands](just.md)." +#: ../../../docs/prerequisites.md:30 +msgid "[`just`](https://github.com/casey/just) for running `just roles`, `just update`, etc. (see [`justfile`](../justfile)), although you can also run these commands manually. Take a look at this documentation for more information: [Running `just` commands](just.md)." msgstr "" -#: ../../../docs/prerequisites.md:21 +#: ../../../docs/prerequisites.md:32 msgid "Strong password (random strings) generator. The playbook often requires you to create a strong password and use it for settings on `vars.yml`, components, etc. As any tools should be fine, this playbook has adopted [`pwgen`](https://linux.die.net/man/1/pwgen) (running `pwgen -s 64 1`). [Password Tech](https://pwgen-win.sourceforge.io/), formerly known as \"PWGen for Windows\", is available as free and open source password generator for Windows. Generally, using a random generator available on the internet is not recommended." msgstr "" -#: ../../../docs/prerequisites.md:23 +#: ../../../docs/prerequisites.md:34 msgid "Server" msgstr "" -#: ../../../docs/prerequisites.md:25 +#: ../../../docs/prerequisites.md:36 msgid "(Recommended) An **x86** server ([What kind of server specs do I need?](faq.md#what-kind-of-server-specs-do-i-need)) running one of these operating systems that make use of [systemd](https://systemd.io/):" msgstr "" -#: ../../../docs/prerequisites.md:26 +#: ../../../docs/prerequisites.md:37 msgid "**Archlinux**" msgstr "" -#: ../../../docs/prerequisites.md:27 +#: ../../../docs/prerequisites.md:38 msgid "**CentOS**, **Rocky Linux**, **AlmaLinux**, or possibly other RHEL alternatives (although your mileage may vary)" msgstr "" -#: ../../../docs/prerequisites.md:28 +#: ../../../docs/prerequisites.md:39 msgid "**Debian** (10/Buster or newer)" msgstr "" -#: ../../../docs/prerequisites.md:29 +#: ../../../docs/prerequisites.md:40 msgid "**Ubuntu** (18.04 or newer, although [20.04 may be problematic](ansible.md#supported-ansible-versions) if you run the Ansible playbook on it)" msgstr "" -#: ../../../docs/prerequisites.md:31 +#: ../../../docs/prerequisites.md:42 msgid "Generally, newer is better. We only strive to support released stable versions of distributions, not betas or pre-releases. The playbook can take over your whole server or co-exist with other services that you have there." msgstr "" -#: ../../../docs/prerequisites.md:33 +#: ../../../docs/prerequisites.md:44 msgid "This playbook somewhat supports running on non-`amd64` architectures like ARM. See [Alternative Architectures](alternative-architectures.md)." msgstr "" -#: ../../../docs/prerequisites.md:35 +#: ../../../docs/prerequisites.md:46 msgid "If your distro runs within an [LXC container](https://linuxcontainers.org/), you may hit [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/703). It can be worked around, if absolutely necessary, but we suggest that you avoid running from within an LXC container." msgstr "" -#: ../../../docs/prerequisites.md:37 +#: ../../../docs/prerequisites.md:48 msgid "`root` access to your server (or a user capable of elevating to `root` via `sudo`)." msgstr "" -#: ../../../docs/prerequisites.md:39 +#: ../../../docs/prerequisites.md:50 msgid "[Python](https://www.python.org/). Most distributions install Python by default, but some don't (e.g. Ubuntu 18.04) and require manual installation (something like `apt-get install python3`). On some distros, Ansible may incorrectly [detect the Python version](https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html) (2 vs 3) and you may need to explicitly specify the interpreter path in `inventory/hosts` during installation (e.g. `ansible_python_interpreter=/usr/bin/python3`)" msgstr "" -#: ../../../docs/prerequisites.md:41 -msgid "[sudo](https://www.sudo.ws/), even when you've configured Ansible to log in as `root`. Some distributions, like a minimal Debian net install, do not include the `sudo` package by default." -msgstr "" - -#: ../../../docs/prerequisites.md:43 -msgid "An HTTPS-capable web server at the base domain name (`example.com`) which is capable of serving static files. Unless you decide to [Serve the base domain from the Matrix server](configuring-playbook-base-domain-serving.md) or alternatively, to use DNS SRV records for [Server Delegation](howto-server-delegation.md)." -msgstr "" - -#: ../../../docs/prerequisites.md:45 -msgid "Properly configured DNS records for `example.com` (details in [Configuring DNS](configuring-dns.md))." -msgstr "" - -#: ../../../docs/prerequisites.md:47 -msgid "Some TCP/UDP ports open. This playbook (actually [Docker itself](https://docs.docker.com/network/iptables/)) configures the server's internal firewall for you. In most cases, you don't need to do anything special. But **if your server is running behind another firewall**, you'd need to open these ports:" -msgstr "" - -#: ../../../docs/prerequisites.md:49 -msgid "`80/tcp`: HTTP webserver" -msgstr "" - -#: ../../../docs/prerequisites.md:50 -msgid "`443/tcp` and `443/udp`: HTTPS webserver" -msgstr "" - -#: ../../../docs/prerequisites.md:51 -msgid "`3478/tcp`: TURN over TCP (used by coturn)" -msgstr "" - #: ../../../docs/prerequisites.md:52 -msgid "`3478/udp`: TURN over UDP (used by coturn)" -msgstr "" - -#: ../../../docs/prerequisites.md:53 -msgid "`5349/tcp`: TURN over TCP (used by coturn)" +msgid "[sudo](https://www.sudo.ws/), even when you've configured Ansible to log in as `root`, because this Ansible playbook sometimes uses the Ansible [become](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_privilege_escalation.html) module to perform tasks as another user (e.g. `matrix`) and the `become` module's default implementation uses `sudo`. Some distributions, like a minimal Debian net install, do not include the `sudo` package by default." msgstr "" #: ../../../docs/prerequisites.md:54 -msgid "`5349/udp`: TURN over UDP (used by coturn)" -msgstr "" - -#: ../../../docs/prerequisites.md:55 -msgid "`8448/tcp` and `8448/udp`: Matrix Federation API HTTPS webserver. Some components like [Matrix User Verification Service](configuring-playbook-user-verification-service.md#open-matrix-federation-port) require this port to be opened **even with federation disabled**." +msgid "An HTTPS-capable web server at the base domain name (`example.com`) which is capable of serving static files. Unless you decide to [Serve the base domain from the Matrix server](configuring-playbook-base-domain-serving.md) or alternatively, to use DNS SRV records for [Server Delegation](howto-server-delegation.md)." msgstr "" #: ../../../docs/prerequisites.md:56 -msgid "the range `49152-49172/udp`: TURN over UDP" +msgid "Properly configured DNS records for `example.com` (details in [Configuring DNS](configuring-dns.md))." msgstr "" -#: ../../../docs/prerequisites.md:57 -msgid "potentially some other ports, depending on the additional (non-default) services that you enable in the **configuring the playbook** step (later on). Consult each service's documentation page in `docs/` for that." +#: ../../../docs/prerequisites.md:58 +msgid "Some TCP/UDP ports open. This playbook (actually [Docker itself](https://docs.docker.com/network/iptables/)) configures the server's internal firewall for you. In most cases, you don't need to do anything special. But **if your server is running behind another firewall**, you'd need to open these ports:" +msgstr "" + +#: ../../../docs/prerequisites.md:60 +msgid "`80/tcp`: HTTP webserver" msgstr "" #: ../../../docs/prerequisites.md:61 +msgid "`443/tcp` and `443/udp`: HTTPS webserver" +msgstr "" + +#: ../../../docs/prerequisites.md:62 +msgid "`3478/tcp`: STUN/TURN over TCP (used by [coturn](./configuring-playbook-turn.md))" +msgstr "" + +#: ../../../docs/prerequisites.md:63 +msgid "`3478/udp`: STUN/TURN over UDP (used by [coturn](./configuring-playbook-turn.md))" +msgstr "" + +#: ../../../docs/prerequisites.md:64 +msgid "`5349/tcp`: TURN over TCP (used by [coturn](./configuring-playbook-turn.md))" +msgstr "" + +#: ../../../docs/prerequisites.md:65 +msgid "`5349/udp`: TURN over UDP (used by [coturn](./configuring-playbook-turn.md))" +msgstr "" + +#: ../../../docs/prerequisites.md:66 +msgid "`8448/tcp` and `8448/udp`: Matrix Federation API HTTPS webserver. Some components like [Matrix User Verification Service](configuring-playbook-user-verification-service.md#open-matrix-federation-port) require this port to be opened **even with federation disabled**." +msgstr "" + +#: ../../../docs/prerequisites.md:67 +msgid "the range `49152-49172/udp`: TURN over UDP" +msgstr "" + +#: ../../../docs/prerequisites.md:68 +msgid "potentially some other ports, depending on the additional (non-default) services that you enable in the **configuring the playbook** step (later on). Consult each service's documentation page in `docs/` for that." +msgstr "" + +#: ../../../docs/prerequisites.md:72 msgid "[▶️](configuring-dns.md) When ready to proceed, continue with [Configuring DNS](configuring-dns.md)." msgstr "" diff --git a/i18n/translation-templates/docs/quick-start.pot b/i18n/translation-templates/docs/quick-start.pot index 2dde01c63..f0b853b73 100644 --- a/i18n/translation-templates/docs/quick-start.pot +++ b/i18n/translation-templates/docs/quick-start.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,79 +16,79 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/quick-start.md:1 +#: ../../../docs/quick-start.md:7 msgid "Quick start" msgstr "" -#: ../../../docs/quick-start.md:9 +#: ../../../docs/quick-start.md:15 msgid "This page explains how to use this Ansible playbook to install Matrix services on your server with a minimal set of core services." msgstr "" -#: ../../../docs/quick-start.md:11 +#: ../../../docs/quick-start.md:17 msgid "We will be using `example.com` as the \"base domain\" in the following instruction." msgstr "" -#: ../../../docs/quick-start.md:13 +#: ../../../docs/quick-start.md:19 msgid "By following the instruction on this page, you will set up:" msgstr "" -#: ../../../docs/quick-start.md:15 +#: ../../../docs/quick-start.md:21 msgid "**your own Matrix server** on a `matrix.example.com` server, which is configured to present itself as `example.com`" msgstr "" -#: ../../../docs/quick-start.md:16 +#: ../../../docs/quick-start.md:22 msgid "**your user account** like `@alice:example.com` on the server" msgstr "" -#: ../../../docs/quick-start.md:17 +#: ../../../docs/quick-start.md:23 msgid "a **self-hosted Matrix client**, [Element Web](configuring-playbook-client-element-web.md) with the default subdomain at `element.example.com`" msgstr "" -#: ../../../docs/quick-start.md:18 +#: ../../../docs/quick-start.md:24 msgid "Matrix delegation, so that your `matrix.example.com` server (presenting itself as `example.com`) can join the Matrix Federation and communicate with any other server in the Matrix network" msgstr "" -#: ../../../docs/quick-start.md:20 +#: ../../../docs/quick-start.md:26 msgid "Please remember to replace `example.com` with your own domain before running any commands." msgstr "" -#: ../../../docs/quick-start.md:22 +#: ../../../docs/quick-start.md:28 msgid "Prerequisites" msgstr "" -#: ../../../docs/quick-start.md:24 +#: ../../../docs/quick-start.md:30 msgid "This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Prerequisites](prerequisites.md)" msgstr "" -#: ../../../docs/quick-start.md:26 +#: ../../../docs/quick-start.md:32 msgid "At first, **check prerequisites** and prepare for installation by setting up programs [on your own computer](prerequisites.md#your-local-computer) and [your server](prerequisites.md#server). You also need `root` access on your server (a user that could elevate to `root` via `sudo` also works)." msgstr "" -#: ../../../docs/quick-start.md:28 +#: ../../../docs/quick-start.md:34 msgid "When preparing your server, make sure to check [the server specs you need](faq.md#what-kind-of-server-specs-do-i-need). We recommend starting with a server having at least 2GB of memory." msgstr "" -#: ../../../docs/quick-start.md:34 +#: ../../../docs/quick-start.md:40 msgid "If you encounter an error during installation, please make sure that you have installed and configured programs correctly." msgstr "" -#: ../../../docs/quick-start.md:36 +#: ../../../docs/quick-start.md:42 msgid "One of the main reasons of basic errors is using an incompatible version of required software such as Ansible. Take a look at [our guide about Ansible](ansible.md) for more information. In short: installing the latest available version is recommended." msgstr "" -#: ../../../docs/quick-start.md:38 +#: ../../../docs/quick-start.md:44 msgid "Configure your DNS settings" msgstr "" -#: ../../../docs/quick-start.md:40 -msgid "This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Configuring your DNS settings](configuring-dns.md)" +#: ../../../docs/quick-start.md:46 +msgid "This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Configuring DNS settings](configuring-dns.md)" msgstr "" -#: ../../../docs/quick-start.md:42 +#: ../../../docs/quick-start.md:48 msgid "After installing and configuring prerequisites, you will need to **configure DNS records**." msgstr "" -#: ../../../docs/quick-start.md:44 +#: ../../../docs/quick-start.md:50 msgid "To configure Matrix services in the default settings, go to your DNS service provider, and adjust DNS records as below." msgstr "" @@ -129,7 +129,15 @@ msgid "-" msgstr "" #: ../../../docs/quick-start.md:0 -msgid "`matrix-server-IP`" +msgid "`matrix-server-IPv4`" +msgstr "" + +#: ../../../docs/quick-start.md:0 +msgid "AAAA" +msgstr "" + +#: ../../../docs/quick-start.md:0 +msgid "`matrix-server-IPv6`" msgstr "" #: ../../../docs/quick-start.md:0 @@ -144,286 +152,290 @@ msgstr "" msgid "`matrix.example.com`" msgstr "" -#: ../../../docs/quick-start.md:51 -msgid "As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IP address (DNS `A` record or `CNAME` record is fine)." +#: ../../../docs/quick-start.md:58 +msgid "As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IPv4/IPv6 address." msgstr "" -#: ../../../docs/quick-start.md:53 +#: ../../../docs/quick-start.md:60 +msgid "If you don't have IPv6 connectivity yet, you can skip the `AAAA` record. For more details about IPv6, see the [Configuring IPv6](./configuring-ipv6.md) documentation page." +msgstr "" + +#: ../../../docs/quick-start.md:62 msgid "It might take some time for the DNS records to propagate after creation." msgstr "" -#: ../../../docs/quick-start.md:55 +#: ../../../docs/quick-start.md:64 msgid "**💡 Note**: if you are using Cloudflare DNS, make sure to disable the proxy and set all records to \"DNS only\"" msgstr "" -#: ../../../docs/quick-start.md:57 +#: ../../../docs/quick-start.md:66 msgid "Get the playbook" msgstr "" -#: ../../../docs/quick-start.md:59 +#: ../../../docs/quick-start.md:68 msgid "This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Getting the playbook](getting-the-playbook.md)" msgstr "" -#: ../../../docs/quick-start.md:61 +#: ../../../docs/quick-start.md:70 msgid "Next, let's **get the playbook's source code**." msgstr "" -#: ../../../docs/quick-start.md:63 +#: ../../../docs/quick-start.md:72 msgid "We recommend to do so with [git](https://git-scm.com/) as it enables you to keep it up to date with the latest source code. While it is possible to download the playbook as a ZIP archive, it is not recommended." msgstr "" -#: ../../../docs/quick-start.md:65 +#: ../../../docs/quick-start.md:74 msgid "To get the playbook with git, install git on your computer, go to a directory, and run the command:" msgstr "" -#: ../../../docs/quick-start.md:71 +#: ../../../docs/quick-start.md:80 msgid "It will fetch the playbook to a new `matrix-docker-ansible-deploy` directory underneath the directory you are currently in." msgstr "" -#: ../../../docs/quick-start.md:73 +#: ../../../docs/quick-start.md:82 msgid "Configure the playbook" msgstr "" -#: ../../../docs/quick-start.md:75 +#: ../../../docs/quick-start.md:84 msgid "This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Configuring the playbook](configuring-playbook.md)" msgstr "" -#: ../../../docs/quick-start.md:77 +#: ../../../docs/quick-start.md:86 msgid "Now that the playbook was fetched, it is time to **configure** it per your needs." msgstr "" -#: ../../../docs/quick-start.md:79 +#: ../../../docs/quick-start.md:88 msgid "To install Matrix services with this playbook, you would at least need 2 configuration files." msgstr "" -#: ../../../docs/quick-start.md:81 +#: ../../../docs/quick-start.md:90 msgid "For your convenience, we have prepared example files of them ([`vars.yml`](../examples/vars.yml) and [`hosts`](../examples/hosts))." msgstr "" -#: ../../../docs/quick-start.md:83 +#: ../../../docs/quick-start.md:92 msgid "To start quickly based on these example files, go into the `matrix-docker-ansible-deploy` directory and follow the instructions below:" msgstr "" -#: ../../../docs/quick-start.md:85 +#: ../../../docs/quick-start.md:94 msgid "Create a directory to hold your configuration: `mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your \"base domain\"" msgstr "" -#: ../../../docs/quick-start.md:86 +#: ../../../docs/quick-start.md:95 msgid "Copy the sample configuration file: `cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`" msgstr "" -#: ../../../docs/quick-start.md:87 +#: ../../../docs/quick-start.md:96 msgid "Copy the sample inventory hosts file: `cp examples/hosts inventory/hosts`" msgstr "" -#: ../../../docs/quick-start.md:88 +#: ../../../docs/quick-start.md:97 msgid "Edit the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`)" msgstr "" -#: ../../../docs/quick-start.md:89 +#: ../../../docs/quick-start.md:98 msgid "Edit the inventory hosts file (`inventory/hosts`)" msgstr "" -#: ../../../docs/quick-start.md:91 +#: ../../../docs/quick-start.md:100 msgid "Before editing these 2 files, make sure to read explanations on them to understand what needs to be configured." msgstr "" -#: ../../../docs/quick-start.md:93 +#: ../../../docs/quick-start.md:102 msgid "**💡 Notes:**" msgstr "" -#: ../../../docs/quick-start.md:94 +#: ../../../docs/quick-start.md:103 msgid "If you are not in control of anything on the base domain, you would need to set additional configuration on `vars.yml`. For more information, see [How do I install on matrix.example.com without involving the base domain?](faq.md#how-do-i-install-on-matrix-example-com-without-involving-the-base-domain) on our FAQ." msgstr "" -#: ../../../docs/quick-start.md:95 +#: ../../../docs/quick-start.md:104 msgid "Certain configuration decisions (like the base domain configured in `matrix_domain` and homeserver implementation configured in `matrix_homeserver_implementation`) are final. If you make the wrong choice and wish to change it, you'll have to run the Uninstalling step and start over." msgstr "" -#: ../../../docs/quick-start.md:96 +#: ../../../docs/quick-start.md:105 msgid "Instead of configuring a lot of things all at once, we recommend starting with the basic (default) settings in order to get yourself familiar with how the playbook works. After making sure that everything works as expected, you can add (and remove) advanced settings / features and run the playbook as many times as you wish." msgstr "" -#: ../../../docs/quick-start.md:98 +#: ../../../docs/quick-start.md:107 msgid "Install" msgstr "" -#: ../../../docs/quick-start.md:100 +#: ../../../docs/quick-start.md:109 msgid "This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Installing](installing.md)" msgstr "" -#: ../../../docs/quick-start.md:102 +#: ../../../docs/quick-start.md:111 msgid "After editing `vars.yml` and `hosts` files, let's start the **installation** procedure." msgstr "" -#: ../../../docs/quick-start.md:104 +#: ../../../docs/quick-start.md:113 msgid "Update Ansible roles" msgstr "" -#: ../../../docs/quick-start.md:106 +#: ../../../docs/quick-start.md:115 msgid "Before installing, you need to update the Ansible roles that this playbook uses and fetches from outside." msgstr "" -#: ../../../docs/quick-start.md:108 +#: ../../../docs/quick-start.md:117 msgid "To update your playbook directory and all upstream Ansible roles, run:" msgstr "" -#: ../../../docs/quick-start.md:110 +#: ../../../docs/quick-start.md:119 msgid "either: `just update`" msgstr "" -#: ../../../docs/quick-start.md:111 +#: ../../../docs/quick-start.md:120 msgid "or: a combination of `git pull` and `just roles` (or `make roles` if you have `make` program on your computer instead of `just`)" msgstr "" -#: ../../../docs/quick-start.md:113 +#: ../../../docs/quick-start.md:122 msgid "If you don't have either `just` tool or `make` program, you can run the `ansible-galaxy` tool directly: `rm -rf roles/galaxy; ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force`" msgstr "" -#: ../../../docs/quick-start.md:115 +#: ../../../docs/quick-start.md:124 msgid "Run installation command" msgstr "" -#: ../../../docs/quick-start.md:117 +#: ../../../docs/quick-start.md:126 msgid "Then, run the command below to start installation:" msgstr "" -#: ../../../docs/quick-start.md:123 +#: ../../../docs/quick-start.md:132 msgid "If you **don't** use SSH keys for authentication, but rather a regular password, you may need to add `--ask-pass` to the command." msgstr "" -#: ../../../docs/quick-start.md:125 +#: ../../../docs/quick-start.md:134 msgid "If you **do** use SSH keys for authentication, **and** use a non-root user to *become* root (sudo), you may need to add `-K` (`--ask-become-pass`) to the command." msgstr "" -#: ../../../docs/quick-start.md:127 +#: ../../../docs/quick-start.md:136 msgid "Wait until the command completes. If it's all green, everything should be running properly." msgstr "" -#: ../../../docs/quick-start.md:129 +#: ../../../docs/quick-start.md:138 msgid "Create your user account" msgstr "" -#: ../../../docs/quick-start.md:131 +#: ../../../docs/quick-start.md:140 msgid "This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Registering users](registering-users.md)" msgstr "" -#: ../../../docs/quick-start.md:133 +#: ../../../docs/quick-start.md:142 msgid "As you have configured your brand new server and the client, you need to **create your user account** on your Matrix server." msgstr "" -#: ../../../docs/quick-start.md:135 +#: ../../../docs/quick-start.md:144 msgid "To create your user account (as an administrator of the server) via this Ansible playbook, run the command below on your local computer." msgstr "" -#: ../../../docs/quick-start.md:137 +#: ../../../docs/quick-start.md:146 msgid "**💡 Notes**:" msgstr "" -#: ../../../docs/quick-start.md:138 +#: ../../../docs/quick-start.md:147 msgid "Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE`" msgstr "" -#: ../../../docs/quick-start.md:139 +#: ../../../docs/quick-start.md:148 msgid "For `YOUR_USERNAME_HERE`, use a plain username like `alice`, not your full ID (`@alice:example.com`)" msgstr "" -#: ../../../docs/quick-start.md:151 +#: ../../../docs/quick-start.md:160 msgid "Finalize server installation" msgstr "" -#: ../../../docs/quick-start.md:153 +#: ../../../docs/quick-start.md:162 msgid "This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Server Delegation](howto-server-delegation.md)" msgstr "" -#: ../../../docs/quick-start.md:155 +#: ../../../docs/quick-start.md:164 msgid "Now that you've configured Matrix services and your user account, you need to **finalize the installation process** by [setting up Matrix delegation (redirection)](howto-server-delegation.md), so that your Matrix server (`matrix.example.com`) can present itself as the base domain (`example.com`) in the Matrix network." msgstr "" -#: ../../../docs/quick-start.md:157 +#: ../../../docs/quick-start.md:166 msgid "**This is required for federation to work!** Without a proper configuration, your server will effectively not be part of the Matrix network." msgstr "" -#: ../../../docs/quick-start.md:159 +#: ../../../docs/quick-start.md:168 msgid "To configure the delegation, you have these two options. Choose one of them according to your situation." msgstr "" -#: ../../../docs/quick-start.md:161 +#: ../../../docs/quick-start.md:170 msgid "If you can afford to point the base domain at the Matrix server, follow the instruction below which guides you into [serving the base domain](configuring-playbook-base-domain-serving.md) from the integrated web server." msgstr "" -#: ../../../docs/quick-start.md:162 +#: ../../../docs/quick-start.md:171 msgid "Alternatively, if you're using the base domain for other purposes and cannot point it to the Matrix server (and thus cannot \"serve the base domain\" from it), you most likely need to [manually install well-known files on the base domain's server](configuring-well-known.md#manually-installing-well-known-files-on-the-base-domains-server)." msgstr "" -#: ../../../docs/quick-start.md:164 +#: ../../../docs/quick-start.md:173 msgid "To have the base domain served from the integrated web server, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/quick-start.md:170 +#: ../../../docs/quick-start.md:179 msgid "After configuring the playbook, run the command below and wait until it finishes:" msgstr "" -#: ../../../docs/quick-start.md:176 +#: ../../../docs/quick-start.md:185 msgid "💡 Running the `install-matrix-static-files` playbook tag (as done here) is an optimized version of running [the full setup command](#run-installation-command)." msgstr "" -#: ../../../docs/quick-start.md:178 +#: ../../../docs/quick-start.md:187 msgid "After the command finishes, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain." msgstr "" -#: ../../../docs/quick-start.md:180 +#: ../../../docs/quick-start.md:189 msgid "Re-run the full setup command any time" msgstr "" -#: ../../../docs/quick-start.md:182 +#: ../../../docs/quick-start.md:191 msgid "If you think something is wrong with the server configuration, feel free to re-run the setup command any time:" msgstr "" -#: ../../../docs/quick-start.md:188 +#: ../../../docs/quick-start.md:197 msgid "Log in to your user account" msgstr "" -#: ../../../docs/quick-start.md:190 +#: ../../../docs/quick-start.md:199 msgid "Finally, let's make sure that you can log in to the created account with the specified password." msgstr "" -#: ../../../docs/quick-start.md:192 +#: ../../../docs/quick-start.md:201 msgid "You should be able to log in to it with your own [Element Web](configuring-playbook-client-element-web.md) client which you have set up at `element.example.com` by running the playbook. Open the URL (`https://element.example.com`) in a web browser and enter your credentials to log in." msgstr "" -#: ../../../docs/quick-start.md:194 -msgid "**If you successfully logged in to your account, installing and configuring is complete**🎉" +#: ../../../docs/quick-start.md:203 +msgid "**If you successfully logged in to your account, the installation and configuration have completed successfully**🎉" msgstr "" -#: ../../../docs/quick-start.md:196 +#: ../../../docs/quick-start.md:205 msgid "Come say Hi👋 in our support room — [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting." msgstr "" -#: ../../../docs/quick-start.md:198 +#: ../../../docs/quick-start.md:207 msgid "Things to do next" msgstr "" -#: ../../../docs/quick-start.md:200 +#: ../../../docs/quick-start.md:209 msgid "Once you get familiar with the playbook, you might probably want to set up additional services such as a bridge on your server." msgstr "" -#: ../../../docs/quick-start.md:202 +#: ../../../docs/quick-start.md:211 msgid "As this page intends to be a quick start guide which explains how to start the core Matrix services, it does not cover a topic like how to set them up. Take a look at the list of [things to do next](installing.md#things-to-do-next) to learn more." msgstr "" -#: ../../../docs/quick-start.md:204 +#: ../../../docs/quick-start.md:213 msgid "⚠️Keep the playbook and services up-to-date" msgstr "" -#: ../../../docs/quick-start.md:206 +#: ../../../docs/quick-start.md:215 msgid "While this playbook helps you to set up Matrix services and maintain them, it will **not** automatically run the maintenance task for you. You will need to update the playbook and re-run it **manually**." msgstr "" -#: ../../../docs/quick-start.md:208 +#: ../../../docs/quick-start.md:217 msgid "Since it is unsafe to keep outdated services running on the server connected to the internet, please consider to update the playbook and re-run it periodically, in order to keep the services up-to-date." msgstr "" -#: ../../../docs/quick-start.md:210 -msgid "For more information about upgrading or maintaining services with the playbook, take at look at this page: [Upgrading the Matrix services](maintenance-upgrading-services.md)" +#: ../../../docs/quick-start.md:219 +msgid "For more information about upgrading or maintaining services with the playbook, take a look at this page: [Upgrading the Matrix services](maintenance-upgrading-services.md)" msgstr "" diff --git a/i18n/translation-templates/docs/registering-users.pot b/i18n/translation-templates/docs/registering-users.pot index f90cc2c40..ea3c05f57 100644 --- a/i18n/translation-templates/docs/registering-users.pot +++ b/i18n/translation-templates/docs/registering-users.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,227 +16,227 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/registering-users.md:1 +#: ../../../docs/registering-users.md:11 msgid "Registering users" msgstr "" -#: ../../../docs/registering-users.md:3 +#: ../../../docs/registering-users.md:13 msgid "This documentation page tells you how to create user accounts on your Matrix server." msgstr "" -#: ../../../docs/registering-users.md:5 +#: ../../../docs/registering-users.md:15 msgid "Table of contents:" msgstr "" -#: ../../../docs/registering-users.md:7 +#: ../../../docs/registering-users.md:16 msgid "[Registering users](#registering-users)" msgstr "" -#: ../../../docs/registering-users.md:8 +#: ../../../docs/registering-users.md:17 msgid "[Registering users manually](#registering-users-manually)" msgstr "" -#: ../../../docs/registering-users.md:9 +#: ../../../docs/registering-users.md:18 msgid "[Managing users via a Web UI](#managing-users-via-a-web-ui)" msgstr "" -#: ../../../docs/registering-users.md:10 +#: ../../../docs/registering-users.md:19 msgid "[Letting certain users register on your private server](#letting-certain-users-register-on-your-private-server)" msgstr "" -#: ../../../docs/registering-users.md:11 +#: ../../../docs/registering-users.md:20 msgid "[Enabling public user registration](#enabling-public-user-registration)" msgstr "" -#: ../../../docs/registering-users.md:12 +#: ../../../docs/registering-users.md:21 msgid "[Adding/Removing Administrator privileges to an existing user](#addingremoving-administrator-privileges-to-an-existing-user)" msgstr "" -#: ../../../docs/registering-users.md:14 +#: ../../../docs/registering-users.md:23 msgid "Registering users manually" msgstr "" -#: ../../../docs/registering-users.md:16 -#: ../../../docs/registering-users.md:121 +#: ../../../docs/registering-users.md:25 +#: ../../../docs/registering-users.md:130 msgid "**Notes**:" msgstr "" -#: ../../../docs/registering-users.md:17 +#: ../../../docs/registering-users.md:26 msgid "Make sure to adjust `USERNAME_HERE` and `PASSWORD_HERE`" msgstr "" -#: ../../../docs/registering-users.md:18 +#: ../../../docs/registering-users.md:27 msgid "For `USERNAME_HERE`, use a plain username like `alice`, not a full ID (`@alice:example.com`)" msgstr "" -#: ../../../docs/registering-users.md:19 +#: ../../../docs/registering-users.md:28 msgid "Use `admin=yes` or `admin=no` depending on whether you wish to make the user an administrator of the Matrix server" msgstr "" -#: ../../../docs/registering-users.md:21 +#: ../../../docs/registering-users.md:30 msgid "After registering a user (using one of the methods below), **you can log in with that user** via the [Element Web](configuring-playbook-client-element-web.md) service that this playbook has installed for you at a URL like this: `https://element.example.com/`." msgstr "" -#: ../../../docs/registering-users.md:23 +#: ../../../docs/registering-users.md:32 msgid "Registering users via the Ansible playbook" msgstr "" -#: ../../../docs/registering-users.md:25 +#: ../../../docs/registering-users.md:34 msgid "It's best to register users via the Ansible playbook, because it works regardless of homeserver implementation (Synapse, Dendrite, etc) or usage of [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (MAS)." msgstr "" -#: ../../../docs/registering-users.md:27 +#: ../../../docs/registering-users.md:36 msgid "To register a user via this Ansible playbook:" msgstr "" -#: ../../../docs/registering-users.md:35 +#: ../../../docs/registering-users.md:44 msgid "**or** by invoking `ansible-playbook` manually:" msgstr "" -#: ../../../docs/registering-users.md:43 +#: ../../../docs/registering-users.md:52 msgid "Feel free to register as many users (for friends, family, etc.) as you want. Still, perhaps you should grant full administrative access to your user account only (with `admin=yes`), and others should be created with `admin=no`." msgstr "" -#: ../../../docs/registering-users.md:45 +#: ../../../docs/registering-users.md:54 msgid "[!WARNING] If you're registering users against Matrix Authentication Service, do note that it [still insists](https://github.com/element-hq/matrix-authentication-service/issues/1505) on having a verified email address for each user. Upon a user's first login, they will be asked to confirm their email address. This requires that email sending is [configured](./configuring-playbook-email.md). You can also consult the [Working around email deliverability issues](./configuring-playbook-matrix-authentication-service.md#working-around-email-deliverability-issues) section for more information." msgstr "" -#: ../../../docs/registering-users.md:48 +#: ../../../docs/registering-users.md:57 msgid "Registering users manually for Synapse" msgstr "" -#: ../../../docs/registering-users.md:50 +#: ../../../docs/registering-users.md:59 msgid "If you're using the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default), you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#install-matrix-server-and-services)):" msgstr "" -#: ../../../docs/registering-users.md:58 +#: ../../../docs/registering-users.md:67 msgid "Registering users manually for Dendrite" msgstr "" -#: ../../../docs/registering-users.md:60 +#: ../../../docs/registering-users.md:69 msgid "If you're using the [Dendrite](./configuring-playbook-dendrite.md) homeserver implementation, you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#install-matrix-server-and-services)):" msgstr "" -#: ../../../docs/registering-users.md:68 +#: ../../../docs/registering-users.md:77 msgid "Registering users manually for Matrix Authentication Service" msgstr "" -#: ../../../docs/registering-users.md:70 +#: ../../../docs/registering-users.md:79 msgid "If you're using the [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) and your existing homeserver (most likely [Synapse](./configuring-playbook-synapse.md)) is delegating authentication to it, you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#install-matrix-server-and-services)):" msgstr "" -#: ../../../docs/registering-users.md:78 +#: ../../../docs/registering-users.md:87 msgid "This `register-user` script actually invokes the `mas-cli manage register-user` command under the hood. If you'd like more control over the registration process, consider invoking the `mas-cli` command directly:" msgstr "" -#: ../../../docs/registering-users.md:84 +#: ../../../docs/registering-users.md:93 msgid "[!WARNING] Matrix Authentication Service [still insists](https://github.com/element-hq/matrix-authentication-service/issues/1505) on having a verified email address for each user. Upon a user's first login, they will be asked to confirm their email address. This requires that email sending is [configured](./configuring-playbook-email.md). You can also consult the [Working around email deliverability issues](./configuring-playbook-matrix-authentication-service.md#working-around-email-deliverability-issues) section for more information." msgstr "" -#: ../../../docs/registering-users.md:87 +#: ../../../docs/registering-users.md:96 msgid "Managing users via a Web UI" msgstr "" -#: ../../../docs/registering-users.md:89 +#: ../../../docs/registering-users.md:98 msgid "To manage users more easily (via a web user-interace), you can install [Synapse Admin](configuring-playbook-synapse-admin.md)." msgstr "" -#: ../../../docs/registering-users.md:91 +#: ../../../docs/registering-users.md:100 msgid "[!WARNING] If you're using [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md), note that user management via synapse-admin is not fully working yet. See the [Expectations](configuring-playbook-matrix-authentication-service.md#expectations) section for more information." msgstr "" -#: ../../../docs/registering-users.md:94 +#: ../../../docs/registering-users.md:103 msgid "Letting certain users register on your private server" msgstr "" -#: ../../../docs/registering-users.md:96 +#: ../../../docs/registering-users.md:105 msgid "If you'd rather **keep your server private** (public registration closed, as is the default), and **let certain people create accounts by themselves** (instead of creating user accounts manually like this), consider installing and making use of [matrix-registration](configuring-playbook-matrix-registration.md)." msgstr "" -#: ../../../docs/registering-users.md:98 +#: ../../../docs/registering-users.md:107 msgid "Enabling public user registration" msgstr "" -#: ../../../docs/registering-users.md:100 +#: ../../../docs/registering-users.md:109 msgid "To **open up user registration publicly** (usually **not recommended**), add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" -#: ../../../docs/registering-users.md:102 +#: ../../../docs/registering-users.md:111 msgid "For Synapse:" msgstr "" -#: ../../../docs/registering-users.md:108 +#: ../../../docs/registering-users.md:117 msgid "For Dendrite:" msgstr "" -#: ../../../docs/registering-users.md:114 +#: ../../../docs/registering-users.md:123 msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:" msgstr "" -#: ../../../docs/registering-users.md:123 +#: ../../../docs/registering-users.md:132 msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`" msgstr "" -#: ../../../docs/registering-users.md:125 +#: ../../../docs/registering-users.md:134 msgid "`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." msgstr "" -#: ../../../docs/registering-users.md:127 +#: ../../../docs/registering-users.md:136 msgid "If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md)." msgstr "" -#: ../../../docs/registering-users.md:129 +#: ../../../docs/registering-users.md:138 msgid "Adding/Removing Administrator privileges to an existing user" msgstr "" -#: ../../../docs/registering-users.md:131 +#: ../../../docs/registering-users.md:140 msgid "Adding/Removing Administrator privileges to an existing user in Synapse" msgstr "" -#: ../../../docs/registering-users.md:133 +#: ../../../docs/registering-users.md:142 msgid "To change the admin privileges for a user in Synapse's local database, you need to run an SQL query like this against the `synapse` database:" msgstr "" -#: ../../../docs/registering-users.md:139 +#: ../../../docs/registering-users.md:148 msgid "where:" msgstr "" -#: ../../../docs/registering-users.md:141 +#: ../../../docs/registering-users.md:150 msgid "`ADMIN_VALUE` being either `0` (regular user) or `1` (admin)" msgstr "" -#: ../../../docs/registering-users.md:142 +#: ../../../docs/registering-users.md:151 msgid "`USER` and `example.com` pointing to a valid user on your server" msgstr "" -#: ../../../docs/registering-users.md:144 +#: ../../../docs/registering-users.md:153 msgid "If you're using the integrated Postgres server and not an [external Postgres server](configuring-playbook-external-postgres.md), you can launch a Postgres into the `synapse` database by:" msgstr "" -#: ../../../docs/registering-users.md:146 +#: ../../../docs/registering-users.md:155 msgid "running `/matrix/postgres/bin/cli` — to launch [`psql`](https://www.postgresql.org/docs/current/app-psql.html)" msgstr "" -#: ../../../docs/registering-users.md:147 +#: ../../../docs/registering-users.md:156 msgid "running `\\c synapse` — to change to the `synapse` database" msgstr "" -#: ../../../docs/registering-users.md:149 +#: ../../../docs/registering-users.md:158 msgid "You can then proceed to run the query above." msgstr "" -#: ../../../docs/registering-users.md:151 +#: ../../../docs/registering-users.md:160 msgid "**Note**: directly modifying the raw data of Synapse (or any other software) could cause the software to break. You've been warned!" msgstr "" -#: ../../../docs/registering-users.md:153 +#: ../../../docs/registering-users.md:162 msgid "Adding/Removing Administrator privileges to an existing user in Matrix Authentication Service" msgstr "" -#: ../../../docs/registering-users.md:155 +#: ../../../docs/registering-users.md:164 msgid "Promoting/demoting a user in Matrix Authentication Service cannot currently (2024-10-19) be done via the [`mas-cli` Management tool](./configuring-playbook-matrix-authentication-service.md#management)." msgstr "" -#: ../../../docs/registering-users.md:157 +#: ../../../docs/registering-users.md:166 msgid "You can do it via the [MAS Admin API](https://element-hq.github.io/matrix-authentication-service/api/index.html)'s `POST /api/admin/v1/users/{id}/set-admin` endpoint." msgstr "" diff --git a/i18n/translation-templates/docs/self-building.pot b/i18n/translation-templates/docs/self-building.pot index 6430f8b15..fec761bb1 100644 --- a/i18n/translation-templates/docs/self-building.pot +++ b/i18n/translation-templates/docs/self-building.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,158 +16,150 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/self-building.md:1 +#: ../../../docs/self-building.md:15 msgid "Self-building" msgstr "" -#: ../../../docs/self-building.md:3 +#: ../../../docs/self-building.md:17 msgid "**Caution: self-building does not have to be used on its own. See the [Alternative Architectures](alternative-architectures.md) page.**" msgstr "" -#: ../../../docs/self-building.md:5 +#: ../../../docs/self-building.md:19 msgid "The playbook supports self-building of various components, which don't have a container image for your architecture (see the [container images we use](container-images.md)). For `amd64`, self-building is not required." msgstr "" -#: ../../../docs/self-building.md:7 +#: ../../../docs/self-building.md:21 msgid "For other architectures (e.g. `arm32`, `arm64`), ready-made container images are used when available. If there's no ready-made image for a specific component and said component supports self-building, an image will be built on the host. Building images like this takes more time and resources (some build tools need to get installed by the playbook to assist building)." msgstr "" -#: ../../../docs/self-building.md:9 +#: ../../../docs/self-building.md:23 msgid "To make use of self-building, you don't need to do anything. If a component has an image for the specified architecture, the playbook will use it directly. If not, it will build the image on the server itself." msgstr "" -#: ../../../docs/self-building.md:11 +#: ../../../docs/self-building.md:25 msgid "Note that **not all components support self-building yet**." msgstr "" -#: ../../../docs/self-building.md:13 +#: ../../../docs/self-building.md:27 msgid "Possibly outdated list of roles where self-building the Docker image is currently possible:" msgstr "" -#: ../../../docs/self-building.md:14 +#: ../../../docs/self-building.md:28 msgid "`matrix-synapse`" msgstr "" -#: ../../../docs/self-building.md:15 +#: ../../../docs/self-building.md:29 msgid "`matrix-synapse-admin`" msgstr "" -#: ../../../docs/self-building.md:16 +#: ../../../docs/self-building.md:30 msgid "`matrix-client-element`" msgstr "" -#: ../../../docs/self-building.md:17 +#: ../../../docs/self-building.md:31 msgid "`matrix-client-hydrogen`" msgstr "" -#: ../../../docs/self-building.md:18 +#: ../../../docs/self-building.md:32 msgid "`matrix-client-cinny`" msgstr "" -#: ../../../docs/self-building.md:19 +#: ../../../docs/self-building.md:33 msgid "`matrix-registration`" msgstr "" -#: ../../../docs/self-building.md:20 +#: ../../../docs/self-building.md:34 msgid "`matrix-coturn`" msgstr "" -#: ../../../docs/self-building.md:21 +#: ../../../docs/self-building.md:35 msgid "`matrix-corporal`" msgstr "" -#: ../../../docs/self-building.md:22 +#: ../../../docs/self-building.md:36 msgid "`matrix-dimension`" msgstr "" -#: ../../../docs/self-building.md:23 +#: ../../../docs/self-building.md:37 msgid "`matrix-ma1sd`" msgstr "" -#: ../../../docs/self-building.md:24 +#: ../../../docs/self-building.md:38 msgid "`exim-relay`" msgstr "" -#: ../../../docs/self-building.md:25 +#: ../../../docs/self-building.md:39 msgid "`matrix-bridge-hookshot`" msgstr "" -#: ../../../docs/self-building.md:26 +#: ../../../docs/self-building.md:40 msgid "`matrix-bridge-appservice-irc`" msgstr "" -#: ../../../docs/self-building.md:27 +#: ../../../docs/self-building.md:41 msgid "`matrix-bridge-appservice-slack`" msgstr "" -#: ../../../docs/self-building.md:28 +#: ../../../docs/self-building.md:42 msgid "`matrix-bridge-appservice-webhooks`" msgstr "" -#: ../../../docs/self-building.md:29 +#: ../../../docs/self-building.md:43 msgid "`matrix-bridge-beeper-linkedin`" msgstr "" -#: ../../../docs/self-building.md:30 +#: ../../../docs/self-building.md:44 msgid "`matrix-bridge-mautrix-facebook`" msgstr "" -#: ../../../docs/self-building.md:31 -msgid "`matrix-bridge-mautrix-hangouts`" -msgstr "" - -#: ../../../docs/self-building.md:32 +#: ../../../docs/self-building.md:45 msgid "`matrix-bridge-mautrix-googlechat`" msgstr "" -#: ../../../docs/self-building.md:33 +#: ../../../docs/self-building.md:46 msgid "`matrix-bridge-mautrix-telegram`" msgstr "" -#: ../../../docs/self-building.md:34 +#: ../../../docs/self-building.md:47 msgid "`matrix-bridge-mautrix-signal`" msgstr "" -#: ../../../docs/self-building.md:35 +#: ../../../docs/self-building.md:48 msgid "`matrix-bridge-mautrix-gmessages`" msgstr "" -#: ../../../docs/self-building.md:36 +#: ../../../docs/self-building.md:49 msgid "`matrix-bridge-mautrix-whatsapp`" msgstr "" -#: ../../../docs/self-building.md:37 +#: ../../../docs/self-building.md:50 msgid "`matrix-bridge-mx-puppet-steam`" msgstr "" -#: ../../../docs/self-building.md:38 +#: ../../../docs/self-building.md:51 msgid "`matrix-bot-mjolnir`" msgstr "" -#: ../../../docs/self-building.md:39 +#: ../../../docs/self-building.md:52 msgid "`matrix-bot-honoroit`" msgstr "" -#: ../../../docs/self-building.md:40 +#: ../../../docs/self-building.md:53 msgid "`matrix-bot-matrix-reminder-bot`" msgstr "" -#: ../../../docs/self-building.md:41 +#: ../../../docs/self-building.md:54 msgid "`matrix-bot-maubot`" msgstr "" -#: ../../../docs/self-building.md:42 -msgid "`matrix-email2matrix`" -msgstr "" - -#: ../../../docs/self-building.md:43 +#: ../../../docs/self-building.md:55 msgid "`matrix-pantalaimon`" msgstr "" -#: ../../../docs/self-building.md:45 +#: ../../../docs/self-building.md:57 msgid "Adding self-building support to other roles is welcome. Feel free to contribute!" msgstr "" -#: ../../../docs/self-building.md:47 +#: ../../../docs/self-building.md:59 msgid "If you'd like **to force self-building** even if an image is available for your architecture, look into the `matrix_*_self_build` variables provided by individual roles." msgstr "" diff --git a/i18n/translation-templates/docs/uninstalling.pot b/i18n/translation-templates/docs/uninstalling.pot index b5abf1eb1..edd0600e8 100644 --- a/i18n/translation-templates/docs/uninstalling.pot +++ b/i18n/translation-templates/docs/uninstalling.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,62 +16,62 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/uninstalling.md:1 +#: ../../../docs/uninstalling.md:9 msgid "Uninstalling" msgstr "" -#: ../../../docs/uninstalling.md:3 -msgid "⚠️ **Warnings**:" +#: ../../../docs/uninstalling.md:11 +msgid "[!WARNING]" msgstr "" -#: ../../../docs/uninstalling.md:4 +#: ../../../docs/uninstalling.md:12 msgid "If your server federates with others, make sure to **leave any federated rooms before nuking your Matrix server's data**. Otherwise, the next time you set up a Matrix server for this domain (regardless of the installation method you use), you'll encounter trouble federating." msgstr "" -#: ../../../docs/uninstalling.md:5 +#: ../../../docs/uninstalling.md:13 msgid "If you have some trouble with your installation, you can just [re-run the playbook](installing.md) and it will try to set things up again. **Uninstalling and then installing anew rarely solves anything**." msgstr "" -#: ../../../docs/uninstalling.md:9 +#: ../../../docs/uninstalling.md:15 msgid "Uninstalling using a script" msgstr "" -#: ../../../docs/uninstalling.md:11 +#: ../../../docs/uninstalling.md:17 msgid "Installing places a `/matrix/bin/remove-all` script on the server." msgstr "" -#: ../../../docs/uninstalling.md:13 +#: ../../../docs/uninstalling.md:19 msgid "You can run it to to have it uninstall things for you automatically (see below). **Use with caution!**" msgstr "" -#: ../../../docs/uninstalling.md:15 +#: ../../../docs/uninstalling.md:21 msgid "Uninstalling manually" msgstr "" -#: ../../../docs/uninstalling.md:17 +#: ../../../docs/uninstalling.md:23 msgid "If you prefer to uninstall manually, run these commands (most are meant to be executed on the Matrix server itself):" msgstr "" -#: ../../../docs/uninstalling.md:19 +#: ../../../docs/uninstalling.md:25 msgid "ensure all Matrix services are stopped: `ansible-playbook -i inventory/hosts setup.yml --tags=stop` (if you can't get Ansible working to run this command, you can run `systemctl stop 'matrix*'` manually on the server)" msgstr "" -#: ../../../docs/uninstalling.md:21 +#: ../../../docs/uninstalling.md:27 msgid "delete the Matrix-related systemd `.service` and `.timer` files (`rm -f /etc/systemd/system/matrix*.{service,timer}`) and reload systemd (`systemctl daemon-reload`)" msgstr "" -#: ../../../docs/uninstalling.md:23 +#: ../../../docs/uninstalling.md:29 msgid "delete some cached Docker images (`docker system prune -a`) or just delete them all (`docker rmi $(docker images -aq)`)" msgstr "" -#: ../../../docs/uninstalling.md:25 +#: ../../../docs/uninstalling.md:31 msgid "delete the Docker networks: `docker network rm matrix matrix-coturn` (might have been deleted already if you ran the `docker system prune` command)" msgstr "" -#: ../../../docs/uninstalling.md:27 +#: ../../../docs/uninstalling.md:33 msgid "uninstall Docker itself, if necessary" msgstr "" -#: ../../../docs/uninstalling.md:29 +#: ../../../docs/uninstalling.md:35 msgid "delete the `/matrix` directory (`rm -rf /matrix`)" msgstr "" diff --git a/i18n/translation-templates/docs/updating-users-passwords.pot b/i18n/translation-templates/docs/updating-users-passwords.pot index 2de15287e..7105ced4f 100644 --- a/i18n/translation-templates/docs/updating-users-passwords.pot +++ b/i18n/translation-templates/docs/updating-users-passwords.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -16,74 +16,74 @@ msgstr "" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -#: ../../../docs/updating-users-passwords.md:1 +#: ../../../docs/updating-users-passwords.md:13 msgid "Updating users passwords" msgstr "" -#: ../../../docs/updating-users-passwords.md:3 +#: ../../../docs/updating-users-passwords.md:15 msgid "Option 1 (if you are using the integrated Postgres database):" msgstr "" -#: ../../../docs/updating-users-passwords.md:5 +#: ../../../docs/updating-users-passwords.md:17 msgid "**Notes**:" msgstr "" -#: ../../../docs/updating-users-passwords.md:6 +#: ../../../docs/updating-users-passwords.md:18 msgid "Make sure to adjust `USERNAME_HERE` and `PASSWORD_HERE`" msgstr "" -#: ../../../docs/updating-users-passwords.md:7 +#: ../../../docs/updating-users-passwords.md:19 msgid "For `USERNAME_HERE`, use a plain username like `alice`, not a full ID (`@alice:example.com`)" msgstr "" -#: ../../../docs/updating-users-passwords.md:9 +#: ../../../docs/updating-users-passwords.md:21 msgid "You can reset a user's password via the Ansible playbook:" msgstr "" -#: ../../../docs/updating-users-passwords.md:15 +#: ../../../docs/updating-users-passwords.md:27 msgid "**You can then log in with that user** via Element Web that this playbook has created for you at a URL like this: `https://element.example.com/`." msgstr "" -#: ../../../docs/updating-users-passwords.md:17 +#: ../../../docs/updating-users-passwords.md:29 msgid "Option 2 (if you are using an external Postgres server):" msgstr "" -#: ../../../docs/updating-users-passwords.md:19 +#: ../../../docs/updating-users-passwords.md:31 msgid "You can manually generate the password hash by using the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#finalize-the-installation):" msgstr "" -#: ../../../docs/updating-users-passwords.md:25 -msgid "and then connecting to the postgres server and executing:" -msgstr "" - -#: ../../../docs/updating-users-passwords.md:31 -msgid "where `` is the hash returned by the docker command above." -msgstr "" - -#: ../../../docs/updating-users-passwords.md:33 -msgid "Option 3:" -msgstr "" - -#: ../../../docs/updating-users-passwords.md:35 -msgid "Use the Synapse User Admin API as described here: https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.rst#reset-password" -msgstr "" - #: ../../../docs/updating-users-passwords.md:37 -msgid "This requires an [access token](obtaining-access-tokens.md) from a server admin account. *This method will also log the user out of all of their clients while the other options do not.*" -msgstr "" - -#: ../../../docs/updating-users-passwords.md:39 -msgid "If you didn't make your account a server admin when you created it, you can learn how to switch it now by reading about it in [Adding/Removing Administrator privileges to an existing user in Synapse](registering-users.md#addingremoving-administrator-privileges-to-an-existing-user-in-synapse)." -msgstr "" - -#: ../../../docs/updating-users-passwords.md:41 -msgid "Example:" +msgid "and then connecting to the Postgres server and executing:" msgstr "" #: ../../../docs/updating-users-passwords.md:43 -msgid "To set @alice:example.com's password to `correct_horse_battery_staple` you could use this curl command:" +msgid "where `` is the hash returned by the docker command above." +msgstr "" + +#: ../../../docs/updating-users-passwords.md:45 +msgid "Option 3:" +msgstr "" + +#: ../../../docs/updating-users-passwords.md:47 +msgid "Use the Synapse User Admin API as described here: https://github.com/element-hq/synapse/blob/master/docs/admin_api/user_admin_api.rst#reset-password" msgstr "" #: ../../../docs/updating-users-passwords.md:49 +msgid "This requires an [access token](obtaining-access-tokens.md) from a server admin account. *This method will also log the user out of all of their clients while the other options do not.*" +msgstr "" + +#: ../../../docs/updating-users-passwords.md:51 +msgid "If you didn't make your account a server admin when you created it, you can learn how to switch it now by reading about it in [Adding/Removing Administrator privileges to an existing user in Synapse](registering-users.md#addingremoving-administrator-privileges-to-an-existing-user-in-synapse)." +msgstr "" + +#: ../../../docs/updating-users-passwords.md:53 +msgid "Example:" +msgstr "" + +#: ../../../docs/updating-users-passwords.md:55 +msgid "To set @alice:example.com's password to `correct_horse_battery_staple` you could use this curl command:" +msgstr "" + +#: ../../../docs/updating-users-passwords.md:61 msgid "Make sure to replace `ACCESS_TOKEN_HERE` with the access token of the server admin account." msgstr "" diff --git a/i18n/translation-templates/i18n/README.pot b/i18n/translation-templates/i18n/README.pot index f7d1a72eb..6ba2edd5a 100644 --- a/i18n/translation-templates/i18n/README.pot +++ b/i18n/translation-templates/i18n/README.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2025-01-27 09:54+0200\n" +"POT-Creation-Date: 2025-11-06 23:09+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -53,7 +53,7 @@ msgid "[PUBLISHED_LANGUAGES](PUBLISHED_LANGUAGES): a list of languages that we p msgstr "" #: ../../README.md:23 -msgid "[.gitignore](.gitignore): a list of files and directories to ignore in the `i18n` directory. We intentionaly ignore translated results (`translations/` directories) for languages taht are still in progress. We only [publish translations in a new language](#publish-translations-in-a-new-language) when the translation progresses beyond a certain threshold." +msgid "[.gitignore](.gitignore): a list of files and directories to ignore in the `i18n` directory. We intentionally ignore translated results (`translations/` directories) for languages that are still in progress. We only [publish translations in a new language](#publish-translations-in-a-new-language) when the translation progresses beyond a certain threshold." msgstr "" #: ../../README.md:24