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 Комити
11 Гране
342 MiB
 
 
Дрво: 90d3cf78b3
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from '90d3cf78b3'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bot-mj...

268 lines
13 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-bot-mjolnir.md:1

  20. msgid "Setting up Mjolnir (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-bot-mjolnir.md:3

  24. msgid "The playbook can install and configure the [Mjolnir](https://github.com/matrix-org/mjolnir) moderation bot for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-bot-mjolnir.md:5

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

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-bot-mjolnir.md:7

  32. msgid "Prerequisites"

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-bot-mjolnir.md:9

  36. msgid "Register the bot account"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-bot-mjolnir.md:11

  40. msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-bot-mjolnir.md:13

  44. msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-bot-mjolnir.md:15

  48. msgid "You can use the playbook to [register a new user](registering-users.md):"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-bot-mjolnir.md:21

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

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-bot-mjolnir.md:23

  56. msgid "Obtain an access token"

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-bot-mjolnir.md:25

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

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-bot-mjolnir.md:27

  64. #: ../../../docs/configuring-playbook-bot-mjolnir.md:52

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

  66. msgstr ""

  67. 

  68. #: ../../../docs/configuring-playbook-bot-mjolnir.md:30

  69. msgid "Make sure the account is free from rate limiting"

  70. msgstr ""

  71. 

  72. #: ../../../docs/configuring-playbook-bot-mjolnir.md:32

  73. 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.**"

  74. msgstr ""

  75. 

  76. #: ../../../docs/configuring-playbook-bot-mjolnir.md:34

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

  78. msgstr ""

  79. 

  80. #: ../../../docs/configuring-playbook-bot-mjolnir.md:36

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

  82. msgstr ""

  83. 

  84. #: ../../../docs/configuring-playbook-bot-mjolnir.md:38

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

  86. msgstr ""

  87. 

  88. #: ../../../docs/configuring-playbook-bot-mjolnir.md:40

  89. msgid "Add the configuration"

  90. msgstr ""

  91. 

  92. #: ../../../docs/configuring-playbook-bot-mjolnir.md:42

  93. msgid "To expose the APIs publicly, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"

  94. msgstr ""

  95. 

  96. #: ../../../docs/configuring-playbook-bot-mjolnir.md:48

  97. msgid "Obtain an access token for admin account"

  98. msgstr ""

  99. 

  100. #: ../../../docs/configuring-playbook-bot-mjolnir.md:50

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

  102. msgstr ""

  103. 

  104. #: ../../../docs/configuring-playbook-bot-mjolnir.md:55

  105. msgid "Run the `curl` command"

  106. msgstr ""

  107. 

  108. #: ../../../docs/configuring-playbook-bot-mjolnir.md:57

  109. msgid "To disable rate limiting, run the following command on systems that ship curl. Before running it, make sure to replace:"

  110. msgstr ""

  111. 

  112. #: ../../../docs/configuring-playbook-bot-mjolnir.md:59

  113. msgid "`ADMIN_ACCESS_TOKEN_HERE` with the access token of the admin account"

  114. msgstr ""

  115. 

  116. #: ../../../docs/configuring-playbook-bot-mjolnir.md:60

  117. msgid "`example.com` with your base domain"

  118. msgstr ""

  119. 

  120. #: ../../../docs/configuring-playbook-bot-mjolnir.md:61

  121. msgid "`@bot.mjolnir:example.com` with the MXID of your Mjolnir bot user"

  122. msgstr ""

  123. 

  124. #: ../../../docs/configuring-playbook-bot-mjolnir.md:67

  125. #: ../../../docs/configuring-playbook-bot-mjolnir.md:184

  126. msgid "**Notes**:"

  127. msgstr ""

  128. 

  129. #: ../../../docs/configuring-playbook-bot-mjolnir.md:68

  130. msgid "This does not work on outdated Windows 10 as curl is not available there."

  131. msgstr ""

  132. 

  133. #: ../../../docs/configuring-playbook-bot-mjolnir.md:69

  134. msgid "Even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally."

  135. msgstr ""

  136. 

  137. #: ../../../docs/configuring-playbook-bot-mjolnir.md:71

  138. msgid "Create a management room"

  139. msgstr ""

  140. 

  141. #: ../../../docs/configuring-playbook-bot-mjolnir.md:73

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

  143. msgstr ""

  144. 

  145. #: ../../../docs/configuring-playbook-bot-mjolnir.md:75

  146. msgid "[!WARNING] Anyone in this room can control the bot so it is important that you only invite trusted users to this room."

  147. msgstr ""

  148. 

  149. #: ../../../docs/configuring-playbook-bot-mjolnir.md:78

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

  151. msgstr ""

  152. 

  153. #: ../../../docs/configuring-playbook-bot-mjolnir.md:80

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

  155. msgstr ""

  156. 

  157. #: ../../../docs/configuring-playbook-bot-mjolnir.md:82

  158. msgid "Finally invite the `@bot.mjolnir:example.com` account you created earlier into the room."

  159. msgstr ""

  160. 

  161. #: ../../../docs/configuring-playbook-bot-mjolnir.md:84

  162. msgid "Adjusting the playbook configuration"

  163. msgstr ""

  164. 

  165. #: ../../../docs/configuring-playbook-bot-mjolnir.md:86

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

  167. msgstr ""

  168. 

  169. #: ../../../docs/configuring-playbook-bot-mjolnir.md:95

  170. msgid "End-to-End Encryption support"

  171. msgstr ""

  172. 

  173. #: ../../../docs/configuring-playbook-bot-mjolnir.md:97

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

  175. msgstr ""

  176. 

  177. #: ../../../docs/configuring-playbook-bot-mjolnir.md:99

  178. msgid "To support E2EE, Mjolnir needs to [use Pantalaimon](configuring-playbook-pantalaimon.md)."

  179. msgstr ""

  180. 

  181. #: ../../../docs/configuring-playbook-bot-mjolnir.md:101

  182. msgid "Configuration with E2EE support"

  183. msgstr ""

  184. 

  185. #: ../../../docs/configuring-playbook-bot-mjolnir.md:103

  186. msgid "When using Pantalaimon, Mjolnir will log in to its bot account itself through Pantalaimon, so configure its username and password."

  187. msgstr ""

  188. 

  189. #: ../../../docs/configuring-playbook-bot-mjolnir.md:105

  190. msgid "Add the following configuration to your `vars.yml` file (adapt to your needs):"

  191. msgstr ""

  192. 

  193. #: ../../../docs/configuring-playbook-bot-mjolnir.md:119

  194. 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`:"

  195. msgstr ""

  196. 

  197. #: ../../../docs/configuring-playbook-bot-mjolnir.md:131

  198. msgid "Configuration without E2EE support"

  199. msgstr ""

  200. 

  201. #: ../../../docs/configuring-playbook-bot-mjolnir.md:133

  202. msgid "When NOT using Pantalaimon, Mjolnir does not log in by itself and you must give it an access token for its bot account."

  203. msgstr ""

  204. 

  205. #: ../../../docs/configuring-playbook-bot-mjolnir.md:135

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

  207. msgstr ""

  208. 

  209. #: ../../../docs/configuring-playbook-bot-mjolnir.md:141

  210. msgid "Adding Mjolnir synapse antispam module (optional)"

  211. msgstr ""

  212. 

  213. #: ../../../docs/configuring-playbook-bot-mjolnir.md:143

  214. msgid "To enable Mjolnir synapse antispam module, add the following configuration to your `vars.yml` file (adapt to your needs):"

  215. msgstr ""

  216. 

  217. #: ../../../docs/configuring-playbook-bot-mjolnir.md:153

  218. msgid "Extending the configuration"

  219. msgstr ""

  220. 

  221. #: ../../../docs/configuring-playbook-bot-mjolnir.md:155

  222. msgid "There are some additional things you may wish to configure about the bot."

  223. msgstr ""

  224. 

  225. #: ../../../docs/configuring-playbook-bot-mjolnir.md:157

  226. msgid "Take a look at:"

  227. msgstr ""

  228. 

  229. #: ../../../docs/configuring-playbook-bot-mjolnir.md:159

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

  231. msgstr ""

  232. 

  233. #: ../../../docs/configuring-playbook-bot-mjolnir.md:161

  234. msgid "For example, to change Mjolnir's `recordIgnoredInvites` option to `true`, add the following configuration to your `vars.yml` file:"

  235. msgstr ""

  236. 

  237. #: ../../../docs/configuring-playbook-bot-mjolnir.md:175

  238. msgid "Installing"

  239. msgstr ""

  240. 

  241. #: ../../../docs/configuring-playbook-bot-mjolnir.md:177

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

  243. msgstr ""

  244. 

  245. #: ../../../docs/configuring-playbook-bot-mjolnir.md:186

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

  247. msgstr ""

  248. 

  249. #: ../../../docs/configuring-playbook-bot-mjolnir.md:188

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

  251. msgstr ""

  252. 

  253. #: ../../../docs/configuring-playbook-bot-mjolnir.md:190

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

  255. msgstr ""

  256. 

  257. #: ../../../docs/configuring-playbook-bot-mjolnir.md:192

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

  259. msgstr ""

  260. 

  261. #: ../../../docs/configuring-playbook-bot-mjolnir.md:194

  262. msgid "Usage"

  263. msgstr ""

  264. 

  265. #: ../../../docs/configuring-playbook-bot-mjolnir.md:196

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

  267. msgstr ""