overmind
/
matrix-docker-ansible-deploy
镜像来自 https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
複製 0
程式碼 問題 0 版本發佈 0 Wiki 活動
Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11808 提交
14 分支
11 GiB
 
 
分支: master
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 'master'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bridge...

327 line
18 KiB
原始文件 永久連結 Blame 歷史記錄 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members

  3. # This file is distributed under the same license as the matrix-docker-ansible-deploy package.

  4. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.

  5. #

  6. #, fuzzy

  7. msgid ""

  8. msgstr ""

  9. "Project-Id-Version: matrix-docker-ansible-deploy \n"

  10. "Report-Msgid-Bugs-To: \n"

  11. "POT-Creation-Date: 2026-07-16 13:47+0000\n"

  12. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

  13. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

  14. "Language-Team: LANGUAGE <LL@li.org>\n"

  15. "MIME-Version: 1.0\n"

  16. "Content-Type: text/plain; charset=UTF-8\n"

  17. "Content-Transfer-Encoding: 8bit\n"

  18. 

  19. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:10

  20. msgid "Setting up a Generic Mautrix Bridge (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:12

  24. 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."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:14

  28. 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."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:16

  32. msgid "You can see each bridge's features on the `ROADMAP.md` file in its corresponding mautrix repository."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:18

  36. msgid "Adjusting the playbook configuration"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:20

  40. msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:27

  44. 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_bridge_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."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:29

  48. 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_bridge_mautrix_telegram_api_id` and `matrix_bridge_mautrix_telegram_api_hash` variables to be defined. Refer to each bridge's individual documentation page for details about enabling bridges."

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:31

  52. msgid "Configure bridge permissions (optional)"

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:33

  56. 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."

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:35

  60. 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:"

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:41

  64. 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."

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:43

  68. msgid "**Alternatively** (more verbose, but allows multiple admins to be configured), you can do the same on a per-bridge basis with:"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:52

  72. msgid "This will add the admin permission to the specific user, while keeping the default permissions."

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:54

  76. 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."

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:56

  80. msgid "Enable encryption (optional)"

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:58

  84. 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:"

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:60

  88. msgid "**for all bridges with encryption support**:"

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:67

  92. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:86

  93. msgid "**Alternatively**, for a specific bridge:"

  94. msgstr ""

  95. 

  96. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:74

  97. msgid "Enable relay mode (optional)"

  98. msgstr ""

  99. 

  100. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:76

  101. 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."

  102. msgstr ""

  103. 

  104. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:78

  105. msgid "If you would like to enable it, add the following configuration to your `vars.yml` file:"

  106. msgstr ""

  107. 

  108. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:80

  109. msgid "**for all bridges with relay mode support**:"

  110. msgstr ""

  111. 

  112. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:95

  113. msgid "You can only have one `matrix_bridge_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:"

  114. msgstr ""

  115. 

  116. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:109

  117. 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`."

  118. msgstr ""

  119. 

  120. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:111

  121. msgid "Use `!prefix set-pl 100` to be able for the bot to modify room settings and invite others."

  122. msgstr ""

  123. 

  124. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:113

  125. msgid "Allow anyone on the homeserver to become a relay user (optional)"

  126. msgstr ""

  127. 

  128. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:115

  129. 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:"

  130. msgstr ""

  131. 

  132. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:121

  133. msgid "Set the bot's username (optional)"

  134. msgstr ""

  135. 

  136. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:123

  137. msgid "To set the bot's username, add the following configuration to your `vars.yml` file:"

  138. msgstr ""

  139. 

  140. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:129

  141. msgid "Configure the logging level (optional)"

  142. msgstr ""

  143. 

  144. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:131

  145. msgid "To specify the logging level, add the following configuration to your `vars.yml` file:"

  146. msgstr ""

  147. 

  148. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:137

  149. msgid "Replace `warn` with one of the following to control the verbosity of the logs generated: `trace`, `debug`, `info`, `warn`, `error` or `fatal`."

  150. msgstr ""

  151. 

  152. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:139

  153. 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."

  154. msgstr ""

  155. 

  156. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:141

  157. msgid "Expose the bridge's API (for Mautrix Manager and similar tools)"

  158. msgstr ""

  159. 

  160. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:143

  161. msgid "Each mautrix bridge runs an HTTP API which tools like [Mautrix Manager](https://github.com/mautrix/manager) can use to help you log into the bridge. This is especially handy for bridges where logging in manually is cumbersome (like [mautrix-gmessages](configuring-playbook-bridge-mautrix-gmessages.md))."

  162. msgstr ""

  163. 

  164. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:145

  165. msgid "By default, the playbook exposes this API publicly at `https://matrix.example.com/bridges/SERVICENAME` (for example, `https://matrix.example.com/bridges/gmessages`). Such tools authenticate to the bridge with your own Matrix access token, so you never need to share any bridge secret with them."

  166. msgstr ""

  167. 

  168. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:147

  169. msgid "To make discovery easier, the playbook also serves a `/.well-known/matrix/mautrix` file which advertises all your exposed bridges. Mautrix Manager reads this file and offers your bridges automatically, so you don't need to enter their URLs by hand."

  170. msgstr ""

  171. 

  172. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:149

  173. msgid "This is all enabled by default. To **disable exposing the API for all bridges**, add the following configuration to your `vars.yml` file:"

  174. msgstr ""

  175. 

  176. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:155

  177. msgid "**Alternatively**, to disable it for a specific bridge:"

  178. msgstr ""

  179. 

  180. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:161

  181. msgid "If you run additional bridges on the same server which are not managed by this playbook and would like compatible tools to discover them as well, you can advertise their base URLs in the `/.well-known/matrix/mautrix` file:"

  182. msgstr ""

  183. 

  184. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:168

  185. msgid "Only list bridges hosted on (and connected to) this server here, as compatible tools will send your Matrix access token to them. For bridges on other servers, take a look at the `fi.mau.external_bridge_servers` property described in the [Mautrix Manager](https://github.com/mautrix/manager) documentation, which you can add via `matrix_static_files_file_matrix_mautrix_configuration_extension_json`."

  186. msgstr ""

  187. 

  188. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:170

  189. msgid "Extending the configuration"

  190. msgstr ""

  191. 

  192. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:172

  193. msgid "There are some additional things you may wish to configure about the bridge."

  194. msgstr ""

  195. 

  196. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:174

  197. msgid "Take a look at:"

  198. msgstr ""

  199. 

  200. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:176

  201. msgid "`roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"

  202. msgstr ""

  203. 

  204. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:177

  205. 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_bridge_mautrix_SERVICENAME_configuration_extension_yaml` variable"

  206. msgstr ""

  207. 

  208. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:179

  209. msgid "Installing"

  210. msgstr ""

  211. 

  212. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:181

  213. msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"

  214. msgstr ""

  215. 

  216. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:188

  217. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"

  218. msgstr ""

  219. 

  220. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:190

  221. 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."

  222. msgstr ""

  223. 

  224. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:192

  225. msgid "Usage"

  226. msgstr ""

  227. 

  228. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:194

  229. 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)."

  230. msgstr ""

  231. 

  232. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:196

  233. msgid "For details about the next steps, refer to each bridge's individual documentation page."

  234. msgstr ""

  235. 

  236. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:198

  237. msgid "Send `help` to the bot to see the available commands."

  238. msgstr ""

  239. 

  240. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:200

  241. msgid "If you run into trouble, check the [Troubleshooting](#troubleshooting) section below."

  242. msgstr ""

  243. 

  244. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:202

  245. msgid "Set up Double Puppeting (optional)"

  246. msgstr ""

  247. 

  248. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:204

  249. 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)."

  250. msgstr ""

  251. 

  252. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:206

  253. msgid "To set it up, you have 2 ways of going about it."

  254. msgstr ""

  255. 

  256. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:208

  257. msgid "Method 1: automatically, by enabling Appservice Double Puppet (recommended)"

  258. msgstr ""

  259. 

  260. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:210

  261. 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."

  262. msgstr ""

  263. 

  264. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:212

  265. msgid "Appservice Double Puppet is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver."

  266. msgstr ""

  267. 

  268. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:214

  269. msgid "To enable the Appservice Double Puppet service, add the following configuration to your `vars.yml` file:"

  270. msgstr ""

  271. 

  272. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:220

  273. msgid "When enabled, double puppeting will automatically be enabled for all bridges that support double puppeting via the appservice method."

  274. msgstr ""

  275. 

  276. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:222

  277. 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."

  278. msgstr ""

  279. 

  280. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:224

  281. msgid "**Notes**:"

  282. msgstr ""

  283. 

  284. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:226

  285. 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)."

  286. msgstr ""

  287. 

  288. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:229

  289. msgid "Some bridges like [the deprecated Facebook mautrix bridge](configuring-playbook-bridge-mautrix-facebook.md) 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."

  290. msgstr ""

  291. 

  292. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:231

  293. msgid "Method 2: manually, by asking each user to provide a working access token"

  294. msgstr ""

  295. 

  296. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:233

  297. msgid "When using this method, **each user** that wishes to enable Double Puppeting needs to follow the following steps:"

  298. msgstr ""

  299. 

  300. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:235

  301. msgid "retrieve a Matrix access token for yourself. Refer to the documentation on [how to obtain one](obtaining-access-tokens.md)."

  302. msgstr ""

  303. 

  304. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:237

  305. msgid "send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE`"

  306. msgstr ""

  307. 

  308. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:239

  309. 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"

  310. msgstr ""

  311. 

  312. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:241

  313. msgid "Troubleshooting"

  314. msgstr ""

  315. 

  316. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:243

  317. 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."

  318. msgstr ""

  319. 

  320. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:245

  321. 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."

  322. msgstr ""

  323. 

  324. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:247

  325. msgid "If you found bugs in mautrix bridges, they should be reported to the upstream project, in the corresponding mautrix repository, not to us."

  326. msgstr ""