overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki 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.
10090 Commits
12 Branches
1.2 GiB
 
 
Tree: ec00a76b14
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'ec00a76b14'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-mautri...

179 lines
8.5 KiB
Raw Blame History 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2024, 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: 2024-12-20 07:23+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-mautrix-bridges.md:1

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

  21. msgstr ""

  22. 

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

  24. msgid "The playbook can install and configure various [mautrix](https://github.com/mautrix) bridges (twitter, facebook, instagram, signal, hangouts, 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-mautrix-bridges.md:5

  28. msgid "You can see each bridge's features at in the `ROADMAP.md` file in its corresponding [mautrix](https://github.com/mautrix) repository."

  29. msgstr ""

  30. 

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

  32. msgid "Adjusting the playbook configuration"

  33. msgstr ""

  34. 

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

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

  37. msgstr ""

  38. 

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

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

  41. msgstr ""

  42. 

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

  44. msgid "To **configure a user as an administrator for all bridges**, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  45. msgstr ""

  46. 

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

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

  49. msgstr ""

  50. 

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

  52. msgid "encryption"

  53. msgstr ""

  54. 

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

  56. msgid "Encryption support is off by default. If you would like to enable encryption, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  57. msgstr ""

  58. 

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

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

  61. msgstr ""

  62. 

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

  64. #: ../../../docs/configuring-playbook-mautrix-bridges.md:61

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

  66. msgstr ""

  67. 

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

  69. msgid "relay mode"

  70. msgstr ""

  71. 

  72. #: ../../../docs/configuring-playbook-mautrix-bridges.md:53

  73. msgid "Relay mode is off by default. If you would like to enable relay mode, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  74. msgstr ""

  75. 

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

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

  78. msgstr ""

  79. 

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

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

  82. msgstr ""

  83. 

  84. #: ../../../docs/configuring-playbook-mautrix-bridges.md:82

  85. msgid "Setting the bot's username"

  86. msgstr ""

  87. 

  88. #: ../../../docs/configuring-playbook-mautrix-bridges.md:88

  89. msgid "Can be used to set the username for the bridge."

  90. msgstr ""

  91. 

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

  93. msgid "Discovering additional configuration options"

  94. msgstr ""

  95. 

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

  97. msgid "You may wish to look at `roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` and `roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` to find other things you would like to configure."

  98. msgstr ""

  99. 

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

  101. msgid "Installing"

  102. msgstr ""

  103. 

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

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

  106. msgstr ""

  107. 

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

  109. msgid "**Notes**:"

  110. msgstr ""

  111. 

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

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

  114. msgstr ""

  115. 

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

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

  118. msgstr ""

  119. 

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

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

  122. msgstr ""

  123. 

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

  125. msgid "Set up Double Puppeting"

  126. msgstr ""

  127. 

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

  129. msgid "To set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook."

  130. msgstr ""

  131. 

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

  133. msgid "The bridge automatically performs Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) is configured and enabled on the server for this playbook by adding"

  134. msgstr ""

  135. 

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

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

  138. msgstr ""

  139. 

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

  141. msgid "Controlling the logging level"

  142. msgstr ""

  143. 

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

  145. msgid "to `vars.yml` to control the logging level, where you may replace WARN with one of the following to control the verbosity of the logs generated: TRACE, DEBUG, INFO, WARN, ERROR, or FATAL."

  146. msgstr ""

  147. 

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

  149. msgid "If you have issues with a service, and are requesting support, the higher levels of logging will generally be more helpful."

  150. msgstr ""

  151. 

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

  153. msgid "Usage"

  154. msgstr ""

  155. 

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

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

  158. msgstr ""

  159. 

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

  161. msgid "Send `login` to the bridge bot to get started. You can learn more here about authentication from the bridge's official documentation on Authentication: https://docs.mau.fi/bridges/python/SERVICENAME/authentication.html"

  162. msgstr ""

  163. 

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

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

  166. msgstr ""

  167. 

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

  169. msgid "Troubleshooting"

  170. msgstr ""

  171. 

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

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

  174. msgstr ""

  175. 

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

  177. msgid "Reporting bridge bugs should happen upstream, in the corresponding mautrix repository, not to us."

  178. msgstr ""