overmind
/
matrix-docker-ansible-deploy
огледало од https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Креирај огранак 0
Код Дискусије 0 Издања 0 Вики Activity
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.
10427 Комити
18 Гране
1.2 GiB
 
 
Дрво: 90d3cf78b3
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from '90d3cf78b3'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bridge...

300 lines
16 KiB
Датотека Blame Историја 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2025, 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: 2025-01-27 09:54+0200\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:1

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

  21. msgstr ""

  22. 

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

  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:5

  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:7

  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:9

  36. msgid "Adjusting the playbook configuration"

  37. msgstr ""

  38. 

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

  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:18

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

  45. msgstr ""

  46. 

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

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

  49. msgstr ""

  50. 

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

  52. msgid "Configure bridge permissions (optional)"

  53. msgstr ""

  54. 

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

  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:26

  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:32

  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:34

  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:43

  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:45

  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:47

  80. msgid "Enable encryption (optional)"

  81. msgstr ""

  82. 

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

  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:51

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

  89. msgstr ""

  90. 

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

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

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

  94. msgstr ""

  95. 

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

  97. msgid "Enable relay mode (optional)"

  98. msgstr ""

  99. 

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

  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:69

  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:71

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

  110. msgstr ""

  111. 

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

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

  114. msgstr ""

  115. 

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

  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:102

  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:104

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

  126. msgstr ""

  127. 

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

  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:112

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

  134. msgstr ""

  135. 

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

  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:120

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

  142. msgstr ""

  143. 

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

  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:128

  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:130

  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:132

  157. msgid "Extending the configuration"

  158. msgstr ""

  159. 

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

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

  162. msgstr ""

  163. 

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

  165. msgid "Take a look at:"

  166. msgstr ""

  167. 

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

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

  170. msgstr ""

  171. 

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

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

  174. msgstr ""

  175. 

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

  177. msgid "Installing"

  178. msgstr ""

  179. 

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

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

  182. msgstr ""

  183. 

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

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

  186. msgid "**Notes**:"

  187. msgstr ""

  188. 

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

  190. msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."

  191. msgstr ""

  192. 

  193. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:154

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

  195. msgstr ""

  196. 

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

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

  199. msgstr ""

  200. 

  201. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:158

  202. msgid "Usage"

  203. msgstr ""

  204. 

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

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

  207. msgstr ""

  208. 

  209. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:162

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

  211. msgstr ""

  212. 

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

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

  215. msgstr ""

  216. 

  217. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:166

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

  219. msgstr ""

  220. 

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

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

  223. msgstr ""

  224. 

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

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

  227. msgstr ""

  228. 

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

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

  231. msgstr ""

  232. 

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

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

  235. msgstr ""

  236. 

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

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

  239. msgstr ""

  240. 

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

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

  243. msgstr ""

  244. 

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

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

  247. msgstr ""

  248. 

  249. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:186

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

  251. msgstr ""

  252. 

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

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

  255. msgstr ""

  256. 

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

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

  259. msgstr ""

  260. 

  261. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:195

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

  263. msgstr ""

  264. 

  265. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:197

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

  267. msgstr ""

  268. 

  269. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:199

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

  271. msgstr ""

  272. 

  273. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:201

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

  275. msgstr ""

  276. 

  277. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:203

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

  279. msgstr ""

  280. 

  281. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:205

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

  283. msgstr ""

  284. 

  285. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:207

  286. msgid "Troubleshooting"

  287. msgstr ""

  288. 

  289. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:209

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

  291. msgstr ""

  292. 

  293. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:211

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

  295. msgstr ""

  296. 

  297. #: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:213

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

  299. msgstr ""