mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-11-06 18:18:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update translation-templates/

Browse Source 
Signed-off-by: Suguru Hirahara <did🔑z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>
This commit is contained in:
Suguru Hirahara
2025-11-06 23:12:32 +09:00
parent 69a3d1f69d
commit 096b85bd96
143 changed files with 12813 additions and 10672 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6821
i18n/translation-templates/CHANGELOG.pot
View File

File diff suppressed because it is too large Load Diff

246
i18n/translation-templates/README.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

160
i18n/translation-templates/YEAR-IN-REVIEW.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

88
i18n/translation-templates/docs/README.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 <!-- NOTE: the 🚀 emoji is used by \"Getting started\" on README.md -->"
#: ../../../docs/README.md:12
msgid "⬇️ Installation guides <!-- NOTE: the 🚀 emoji is used by \"Getting started\" on README.md -->"
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 <!-- NOTE: this header's title and the section below need optimization -->"
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 ""

22
i18n/translation-templates/docs/alternative-architectures.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

152
i18n/translation-templates/docs/ansible.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

34
i18n/translation-templates/docs/configuring-captcha.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<http://www.google.com/recaptcha/admin>"
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 "<https://dashboard.hcaptcha.com/sites/new>"
msgstr ""
#: ../../../docs/configuring-captcha.md:43
#: ../../../docs/configuring-captcha.md:52
msgid "Setting hCaptcha keys"
msgstr ""

60
i18n/translation-templates/docs/configuring-dns.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>[Prerequisites](prerequisites.md) > Configuring your DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>"
#: ../../../docs/configuring-dns.md:20
msgid "<sup>[Prerequisites](prerequisites.md) > Configuring DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>"
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 ""

361
i18n/translation-templates/docs/configuring-ipv6.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

98
i18n/translation-templates/docs/configuring-playbook-alertmanager-receiver.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

44
i18n/translation-templates/docs/configuring-playbook-appservice-double-puppet.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

90
i18n/translation-templates/docs/configuring-playbook-appservice-draupnir-for-all.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

168
i18n/translation-templates/docs/configuring-playbook-backup-borg.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

72
i18n/translation-templates/docs/configuring-playbook-base-domain-serving.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

240
i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

78
i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

104
i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

319
i18n/translation-templates/docs/configuring-playbook-bot-draupnir.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

136
i18n/translation-templates/docs/configuring-playbook-bot-go-neb.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

86
i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

116
i18n/translation-templates/docs/configuring-playbook-bot-matrix-registration-bot.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

88
i18n/translation-templates/docs/configuring-playbook-bot-matrix-reminder-bot.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

116
i18n/translation-templates/docs/configuring-playbook-bot-maubot.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

148
i18n/translation-templates/docs/configuring-playbook-bot-mjolnir.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

152
i18n/translation-templates/docs/configuring-playbook-bridge-appservice-discord.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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_<guildID>_<channelID>`)."
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_<guildID>_<channelID>`. 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/<guildID>/<channelID>`."
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_<guildID>_<channelID>` 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 ""

70
i18n/translation-templates/docs/configuring-playbook-bridge-appservice-irc.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

74
i18n/translation-templates/docs/configuring-playbook-bridge-appservice-kakaotalk.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

159
i18n/translation-templates/docs/configuring-playbook-bridge-appservice-slack.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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/<the channel ID>/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/<the channel ID>/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) <the channel ID> <some other ID>`"
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 ""

100
i18n/translation-templates/docs/configuring-playbook-bridge-appservice-webhooks.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

86
i18n/translation-templates/docs/configuring-playbook-bridge-beeper-linkedin.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

90
i18n/translation-templates/docs/configuring-playbook-bridge-go-skype-bridge.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

82
i18n/translation-templates/docs/configuring-playbook-bridge-heisenbridge.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

212
i18n/translation-templates/docs/configuring-playbook-bridge-hookshot.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

54
i18n/translation-templates/docs/configuring-playbook-bridge-matrix-bridge-sms.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

121
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bluesky.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

161
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-bridges.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

114
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-discord.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

148
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-facebook.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

78
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-gmessages.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

74
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-googlechat.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

92
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-hangouts.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

64
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-instagram.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

88
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-instagram.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

112
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-meta-messenger.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

78
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-signal.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

122
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-slack.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

93
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-telegram.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

76
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-twitter.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

74
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-whatsapp.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

68
i18n/translation-templates/docs/configuring-playbook-bridge-mautrix-wsproxy.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
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 ""

78
i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-discord.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

44
i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-groupme.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

86
i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-instagram.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 <username> <password>` 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 ""

12
i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-skype.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

82
i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-slack.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

54
i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-steam.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

78
i18n/translation-templates/docs/configuring-playbook-bridge-mx-puppet-twitter.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

78
i18n/translation-templates/docs/configuring-playbook-bridge-postmoogle.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

85
i18n/translation-templates/docs/configuring-playbook-bridge-steam.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

86
i18n/translation-templates/docs/configuring-playbook-bridge-wechat.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

100
i18n/translation-templates/docs/configuring-playbook-cactus-comments.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 `<div>` 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 ""

68
i18n/translation-templates/docs/configuring-playbook-client-cinny.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

146
i18n/translation-templates/docs/configuring-playbook-client-element-web.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

101
i18n/translation-templates/docs/configuring-playbook-client-fluffychat-web.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

74
i18n/translation-templates/docs/configuring-playbook-client-hydrogen.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

136
i18n/translation-templates/docs/configuring-playbook-client-schildichat-web.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

84
i18n/translation-templates/docs/configuring-playbook-conduit.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

88
i18n/translation-templates/docs/configuring-playbook-conduwuit.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

161
i18n/translation-templates/docs/configuring-playbook-continuwuity.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

58
i18n/translation-templates/docs/configuring-playbook-dendrite.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

108
i18n/translation-templates/docs/configuring-playbook-dimension.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

64
i18n/translation-templates/docs/configuring-playbook-dynamic-dns.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

113
i18n/translation-templates/docs/configuring-playbook-element-admin.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

245
i18n/translation-templates/docs/configuring-playbook-element-call.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

110
i18n/translation-templates/docs/configuring-playbook-email.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

252
i18n/translation-templates/docs/configuring-playbook-email2matrix.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

136
i18n/translation-templates/docs/configuring-playbook-etherpad.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

16
i18n/translation-templates/docs/configuring-playbook-external-postgres.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

38
i18n/translation-templates/docs/configuring-playbook-federation.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 <https://federationtester.matrix.org/> without issues.**"
msgstr ""

470
i18n/translation-templates/docs/configuring-playbook-jitsi.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

93
i18n/translation-templates/docs/configuring-playbook-jwt-service.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

46
i18n/translation-templates/docs/configuring-playbook-ldap-auth.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

45
i18n/translation-templates/docs/configuring-playbook-livekit-jwt-service.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

85
i18n/translation-templates/docs/configuring-playbook-livekit-server.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

192
i18n/translation-templates/docs/configuring-playbook-ma1sd.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

372
i18n/translation-templates/docs/configuring-playbook-matrix-authentication-service.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

112
i18n/translation-templates/docs/configuring-playbook-matrix-corporal.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

56
i18n/translation-templates/docs/configuring-playbook-matrix-ldap-registration-proxy.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

184
i18n/translation-templates/docs/configuring-playbook-matrix-media-repo.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

112
i18n/translation-templates/docs/configuring-playbook-matrix-registration.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

105
i18n/translation-templates/docs/configuring-playbook-matrix-rtc.pot Normal file
View File

@@ -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 <EMAIL@ADDRESS>, 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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

6
i18n/translation-templates/docs/configuring-playbook-nginx.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

322
i18n/translation-templates/docs/configuring-playbook-ntfy.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

90
i18n/translation-templates/docs/configuring-playbook-own-webserver.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

36
i18n/translation-templates/docs/configuring-playbook-pantalaimon.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

146
i18n/translation-templates/docs/configuring-playbook-postgres-backup.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

356
i18n/translation-templates/docs/configuring-playbook-prometheus-grafana.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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`<br>`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`<br>`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 ""

78
i18n/translation-templates/docs/configuring-playbook-rageshake.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

42
i18n/translation-templates/docs/configuring-playbook-rest-auth.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

38
i18n/translation-templates/docs/configuring-playbook-riot-web.pot
View File

@@ -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 <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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 ""

Some files were not shown because too many files have changed in this diff Show More