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.
 
 
 

740 line
25 KiB

  1. # SOME DESCRIPTIVE TITLE.
  2. # Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community
  3. # members
  4. # This file is distributed under the same license as the
  5. # matrix-docker-ansible-deploy package.
  6. # FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
  7. #
  8. #, fuzzy
  9. msgid ""
  10. msgstr ""
  11. "Project-Id-Version: matrix-docker-ansible-deploy \n"
  12. "Report-Msgid-Bugs-To: \n"
  13. "POT-Creation-Date: 2024-12-20 09:53+0200\n"
  14. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
  15. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
  16. "Language: jp\n"
  17. "Language-Team: jp <LL@li.org>\n"
  18. "MIME-Version: 1.0\n"
  19. "Content-Type: text/plain; charset=utf-8\n"
  20. "Content-Transfer-Encoding: 8bit\n"
  21. "Generated-By: Babel 2.16.0\n"
  22. #: ../../../docs/configuring-playbook-bot-draupnir.md:1
  23. msgid "Setting up Draupnir (optional)"
  24. msgstr ""
  25. #: ../../../docs/configuring-playbook-bot-draupnir.md:3
  26. msgid ""
  27. "The playbook can install and configure the [Draupnir](https://github.com"
  28. "/the-draupnir-project/Draupnir) moderation bot for you."
  29. msgstr ""
  30. #: ../../../docs/configuring-playbook-bot-draupnir.md:5
  31. msgid ""
  32. "See the project's [documentation](https://github.com/the-draupnir-"
  33. "project/Draupnir/blob/main/README.md) to learn what it does and why it "
  34. "might be useful to you."
  35. msgstr ""
  36. #: ../../../docs/configuring-playbook-bot-draupnir.md:7
  37. msgid ""
  38. "This documentation page is about installing Draupnir in bot mode. As an "
  39. "alternative, you can run a multi-instance Draupnir deployment by "
  40. "installing [Draupnir in appservice mode](./configuring-playbook-"
  41. "appservice-draupnir-for-all.md) (called Draupnir-for-all) instead."
  42. msgstr ""
  43. #: ../../../docs/configuring-playbook-bot-draupnir.md:9
  44. msgid ""
  45. "If your migrating from Mjolnir skip to [this section](#migrating-from-"
  46. "mjolnir-only-required-if-migrating)."
  47. msgstr ""
  48. #: ../../../docs/configuring-playbook-bot-draupnir.md:11
  49. msgid "Prerequisites"
  50. msgstr ""
  51. #: ../../../docs/configuring-playbook-bot-draupnir.md:13
  52. msgid "Register the bot account"
  53. msgstr ""
  54. #: ../../../docs/configuring-playbook-bot-draupnir.md:15
  55. msgid ""
  56. "The playbook does not automatically create users for you. You **need to "
  57. "register the bot user manually** before setting up the bot."
  58. msgstr ""
  59. #: ../../../docs/configuring-playbook-bot-draupnir.md:17
  60. msgid ""
  61. "Choose a strong password for the bot. You can generate a good password "
  62. "with a command like this: `pwgen -s 64 1`."
  63. msgstr ""
  64. #: ../../../docs/configuring-playbook-bot-draupnir.md:19
  65. msgid "You can use the playbook to [register a new user](registering-users.md):"
  66. msgstr ""
  67. #: ../../../docs/configuring-playbook-bot-draupnir.md:25
  68. msgid ""
  69. "If you would like Draupnir to be able to deactivate users, move aliases, "
  70. "shutdown rooms, show abuse reports (see [below](#abuse-reports)), etc "
  71. "then it must be a server admin so you need to change `admin=no` to "
  72. "`admin=yes` in the command above."
  73. msgstr ""
  74. #: ../../../docs/configuring-playbook-bot-draupnir.md:27
  75. msgid "Get an access token"
  76. msgstr ""
  77. #: ../../../docs/configuring-playbook-bot-draupnir.md:29
  78. msgid ""
  79. "The bot requires an access token to be able to connect to your "
  80. "homeserver. Refer to the documentation on [how to obtain an access token"
  81. "](obtaining-access-tokens.md)."
  82. msgstr ""
  83. #: ../../../docs/configuring-playbook-bot-draupnir.md:31
  84. msgid "Make sure the account is free from rate limiting"
  85. msgstr ""
  86. #: ../../../docs/configuring-playbook-bot-draupnir.md:33
  87. msgid ""
  88. "If your homeserver's implementation is Synapse, you will need to prevent "
  89. "it from rate limiting the bot's account. **This is a required step. If "
  90. "you do not configure it, Draupnir will crash.**"
  91. msgstr ""
  92. #: ../../../docs/configuring-playbook-bot-draupnir.md:35
  93. msgid ""
  94. "This can be done using Synapse's [Admin APIs](https://element-"
  95. "hq.github.io/synapse/latest/admin_api/user_admin_api.html#override-"
  96. "ratelimiting-for-users). They can be accessed both externally and "
  97. "internally."
  98. msgstr ""
  99. #: ../../../docs/configuring-playbook-bot-draupnir.md:37
  100. msgid ""
  101. "To expose the APIs publicly, add the following configuration to your "
  102. "`inventory/host_vars/matrix.example.com/vars.yml` file."
  103. msgstr ""
  104. #: ../../../docs/configuring-playbook-bot-draupnir.md:43
  105. msgid ""
  106. "The APIs can also be accessed via [Synapse "
  107. "Admin](https://github.com/etkecc/synapse-admin), a web UI tool you can "
  108. "use to administrate users, rooms, media, etc. on your Matrix server. The "
  109. "playbook can install and configure Synapse Admin for you. For details "
  110. "about it, see [this page](configuring-playbook-synapse-admin.md)."
  111. msgstr ""
  112. #: ../../../docs/configuring-playbook-bot-draupnir.md:45
  113. msgid ""
  114. "**Note**: access to the APIs is restricted with a valid access token, so "
  115. "exposing them publicly should not be a real security concern. Still, "
  116. "doing so is not recommended for additional security. See [official "
  117. "Synapse reverse-proxying recommendations](https://element-"
  118. "hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-"
  119. "endpoints)."
  120. msgstr ""
  121. #: ../../../docs/configuring-playbook-bot-draupnir.md:47
  122. msgid ""
  123. "To discharge rate limiting, run the following command on systems that "
  124. "ship curl (note that it does not work on outdated Windows 10). Even if "
  125. "the APIs are not exposed to the internet, you should still be able to run"
  126. " the command on the homeserver locally. Before running it, make sure to "
  127. "replace `@bot.draupnir:example.com` with the MXID of your Draupnir:"
  128. msgstr ""
  129. #: ../../../docs/configuring-playbook-bot-draupnir.md:53
  130. msgid ""
  131. "You can obtain an access token for a homeserver admin account in the same"
  132. " way as you can do so for Draupnir itself. If you have made Draupnir an "
  133. "admin, you can just use the Draupnir token."
  134. msgstr ""
  135. #: ../../../docs/configuring-playbook-bot-draupnir.md:55
  136. msgid "Create a management room"
  137. msgstr ""
  138. #: ../../../docs/configuring-playbook-bot-draupnir.md:57
  139. msgid ""
  140. "Using your own account, create a new invite only room that you will use "
  141. "to manage the bot. This is the room where you will see the status of the "
  142. "bot and where you will send commands to the bot, such as the command to "
  143. "ban a user from another room. Anyone in this room can control the bot so "
  144. "it is important that you only invite trusted users to this room."
  145. msgstr ""
  146. #: ../../../docs/configuring-playbook-bot-draupnir.md:59
  147. msgid ""
  148. "If you make the management room encrypted (E2EE), then you MUST enable "
  149. "and use Pantalaimon (see [below](#configuration-with-e2ee-support))."
  150. msgstr ""
  151. #: ../../../docs/configuring-playbook-bot-draupnir.md:61
  152. msgid ""
  153. "Once you have created the room you need to copy the room ID so you can "
  154. "tell the bot to use that room. In Element Web you can do this by going to"
  155. " the room's settings, clicking Advanced, and then copying the internal "
  156. "room ID. The room ID will look something like `!qporfwt:example.com`."
  157. msgstr ""
  158. #: ../../../docs/configuring-playbook-bot-draupnir.md:63
  159. msgid ""
  160. "Finally invite the `@bot.draupnir:example.com` account you created "
  161. "earlier into the room."
  162. msgstr ""
  163. #: ../../../docs/configuring-playbook-bot-draupnir.md:65
  164. msgid "Adjusting the playbook configuration"
  165. msgstr ""
  166. #: ../../../docs/configuring-playbook-bot-draupnir.md:67
  167. msgid ""
  168. "Add the following configuration to your "
  169. "`inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to "
  170. "replace `MANAGEMENT_ROOM_ID_HERE`."
  171. msgstr ""
  172. #: ../../../docs/configuring-playbook-bot-draupnir.md:76
  173. msgid "End-to-End Encryption support"
  174. msgstr ""
  175. #: ../../../docs/configuring-playbook-bot-draupnir.md:78
  176. msgid ""
  177. "Decide whether you want Draupnir to be capable of operating in end-to-end"
  178. " encrypted (E2EE) rooms. This includes the management room and the "
  179. "moderated rooms."
  180. msgstr ""
  181. #: ../../../docs/configuring-playbook-bot-draupnir.md:80
  182. msgid ""
  183. "To support E2EE, Draupnir needs to [use Pantalaimon](configuring-"
  184. "playbook-pantalaimon.md)."
  185. msgstr ""
  186. #: ../../../docs/configuring-playbook-bot-draupnir.md:82
  187. msgid "Configuration with E2EE support"
  188. msgstr ""
  189. #: ../../../docs/configuring-playbook-bot-draupnir.md:84
  190. msgid ""
  191. "When using Pantalaimon, Draupnir will log in to its bot account itself "
  192. "through Pantalaimon, so configure its username and password."
  193. msgstr ""
  194. #: ../../../docs/configuring-playbook-bot-draupnir.md:86
  195. msgid ""
  196. "Add the following configuration to your "
  197. "`inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your "
  198. "needs):"
  199. msgstr ""
  200. #: ../../../docs/configuring-playbook-bot-draupnir.md:100
  201. msgid ""
  202. "The playbook's `group_vars` will configure other required settings. If "
  203. "using this role separately without the playbook, you also need to "
  204. "configure the two URLs that Draupnir uses to reach the homeserver, one "
  205. "through Pantalaimon and one \"raw\". This example is taken from the "
  206. "playbook's `group_vars`:"
  207. msgstr ""
  208. #: ../../../docs/configuring-playbook-bot-draupnir.md:112
  209. msgid "Configuration without E2EE support"
  210. msgstr ""
  211. #: ../../../docs/configuring-playbook-bot-draupnir.md:114
  212. msgid ""
  213. "When NOT using Pantalaimon, Draupnir does not log in by itself and you "
  214. "must give it an access token for its bot account."
  215. msgstr ""
  216. #: ../../../docs/configuring-playbook-bot-draupnir.md:116
  217. msgid ""
  218. "Add the following configuration to your "
  219. "`inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to "
  220. "replace `ACCESS_TOKEN_HERE` with the one created [above](#get-an-access-"
  221. "token)."
  222. msgstr ""
  223. #: ../../../docs/configuring-playbook-bot-draupnir.md:122
  224. msgid "Abuse Reports"
  225. msgstr ""
  226. #: ../../../docs/configuring-playbook-bot-draupnir.md:124
  227. msgid "Draupnir supports two methods to receive reports in the management room."
  228. msgstr ""
  229. #: ../../../docs/configuring-playbook-bot-draupnir.md:126
  230. msgid ""
  231. "The first method intercepts the report API endpoint of the client-server "
  232. "API, which requires integration with the reverse proxy in front of the "
  233. "homeserver. If you are using traefik, this playbook can set this up for "
  234. "you:"
  235. msgstr ""
  236. #: ../../../docs/configuring-playbook-bot-draupnir.md:132
  237. msgid ""
  238. "The other method polls an Synapse Admin API endpoint, hence it is "
  239. "available only if using Synapse and if the Draupnir user is an admin (see"
  240. " [above](#register-the-bot-account)). To enable it, set `pollReports: "
  241. "true` on `vars.yml` file as below."
  242. msgstr ""
  243. #: ../../../docs/configuring-playbook-bot-draupnir.md:134
  244. msgid "Extending the configuration"
  245. msgstr ""
  246. #: ../../../docs/configuring-playbook-bot-draupnir.md:136
  247. msgid ""
  248. "You can configure additional options by adding the "
  249. "`matrix_bot_draupnir_configuration_extension_yaml` variable."
  250. msgstr ""
  251. #: ../../../docs/configuring-playbook-bot-draupnir.md:138
  252. msgid ""
  253. "For example, to change Draupnir's `pollReports` option to `true`, add the"
  254. " following configuration to your "
  255. "`inventory/host_vars/matrix.example.com/vars.yml` file:"
  256. msgstr ""
  257. #: ../../../docs/configuring-playbook-bot-draupnir.md:152
  258. msgid "Migrating from Mjolnir (Only required if migrating)"
  259. msgstr ""
  260. #: ../../../docs/configuring-playbook-bot-draupnir.md:154
  261. msgid ""
  262. "Replace your `matrix_bot_mjolnir` config with `matrix_bot_draupnir` "
  263. "config. Also disable Mjolnir if you're doing migration."
  264. msgstr ""
  265. #: ../../../docs/configuring-playbook-bot-draupnir.md:156
  266. msgid ""
  267. "That is all you need to do due to that Draupnir can complete migration on"
  268. " its own."
  269. msgstr ""
  270. #: ../../../docs/configuring-playbook-bot-draupnir.md:158
  271. msgid "Installing"
  272. msgstr ""
  273. #: ../../../docs/configuring-playbook-bot-draupnir.md:160
  274. msgid ""
  275. "After configuring the playbook, run it with [playbook tags](playbook-"
  276. "tags.md) as below:"
  277. msgstr ""
  278. #: ../../../docs/configuring-playbook-bot-draupnir.md:167
  279. msgid "**Notes**:"
  280. msgstr ""
  281. #: ../../../docs/configuring-playbook-bot-draupnir.md:169
  282. msgid ""
  283. "The `ensure-matrix-users-created` playbook tag makes the playbook "
  284. "automatically create the bot's user account."
  285. msgstr ""
  286. #: ../../../docs/configuring-playbook-bot-draupnir.md:171
  287. msgid ""
  288. "The shortcut commands with the [`just` program](just.md) are also "
  289. "available: `just install-all` or `just setup-all`"
  290. msgstr ""
  291. #: ../../../docs/configuring-playbook-bot-draupnir.md:173
  292. msgid ""
  293. "`just install-all` is useful for maintaining your setup quickly ([2x-5x "
  294. "faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-"
  295. "runtime) than `just setup-all`) when its components remain unchanged. If "
  296. "you adjust your `vars.yml` to remove other components, you'd need to run "
  297. "`just setup-all`, or these components will still remain installed."
  298. msgstr ""
  299. #: ../../../docs/configuring-playbook-bot-draupnir.md:175
  300. msgid ""
  301. "If you change the Pantalaimon's password "
  302. "(`matrix_bot_draupnir_pantalaimon_password` in your `vars.yml` file) "
  303. "subsequently, its credentials on the homeserver won't be updated "
  304. "automatically. If you'd like to change the password, use a tool like "
  305. "[synapse-admin](configuring-playbook-synapse-admin.md) to change it, and "
  306. "then update `matrix_bot_draupnir_pantalaimon_password` to let Pantalaimon"
  307. " know its new password."
  308. msgstr ""
  309. #: ../../../docs/configuring-playbook-bot-draupnir.md:177
  310. msgid "Usage"
  311. msgstr ""
  312. #: ../../../docs/configuring-playbook-bot-draupnir.md:179
  313. msgid ""
  314. "You can refer to the upstream [documentation](https://the-draupnir-"
  315. "project.github.io/draupnir-documentation/) for additional ways to use and"
  316. " configure Draupnir and for a more detailed usage guide."
  317. msgstr ""
  318. #: ../../../docs/configuring-playbook-bot-draupnir.md:181
  319. msgid "Below is a **non-exhaustive quick-start guide** for the impatient."
  320. msgstr ""
  321. #: ../../../docs/configuring-playbook-bot-draupnir.md:183
  322. msgid "Making Draupnir join and protect a room"
  323. msgstr ""
  324. #: ../../../docs/configuring-playbook-bot-draupnir.md:185
  325. msgid ""
  326. "Draupnir can be told to self-join public rooms, but it's better to follow"
  327. " this flow which works well for all kinds of rooms:"
  328. msgstr ""
  329. #: ../../../docs/configuring-playbook-bot-draupnir.md:187
  330. msgid ""
  331. "Invite the bot to the room manually ([inviting Draupnir to rooms](https"
  332. "://the-draupnir-project.github.io/draupnir-documentation/moderator"
  333. "/managing-protected-rooms#inviting-draupnir-to-rooms)). Before joining, "
  334. "the bot *may* ask for confirmation in the Management Room"
  335. msgstr ""
  336. #: ../../../docs/configuring-playbook-bot-draupnir.md:189
  337. msgid ""
  338. "[Give the bot permissions to do its job](#giving-draupnir-permissions-to-"
  339. "do-its-job)"
  340. msgstr ""
  341. #: ../../../docs/configuring-playbook-bot-draupnir.md:191
  342. msgid ""
  343. "Tell it to protect the room (using the [rooms command](https://the-"
  344. "draupnir-project.github.io/draupnir-documentation/moderator/managing-"
  345. "protected-rooms#using-the-draupnir-rooms-command)) by sending the "
  346. "following command to the Management Room: `!draupnir rooms add "
  347. "!qporfwt:example.com`"
  348. msgstr ""
  349. #: ../../../docs/configuring-playbook-bot-draupnir.md:193
  350. msgid ""
  351. "To have Draupnir provide useful room protection, you need do to a bit "
  352. "more work (at least the first time around). You may wish to [Subscribe to"
  353. " a public policy list](#subscribing-to-a-public-policy-list), [Create "
  354. "your own own policy and rules](#creating-your-own-policy-lists-and-rules)"
  355. " and [Enabling built-in protections](#enabling-built-in-protections)."
  356. msgstr ""
  357. #: ../../../docs/configuring-playbook-bot-draupnir.md:195
  358. msgid "Giving Draupnir permissions to do its job"
  359. msgstr ""
  360. #: ../../../docs/configuring-playbook-bot-draupnir.md:197
  361. msgid ""
  362. "For Draupnir to do its job, you need to [give it permissions](https"
  363. "://the-draupnir-project.github.io/draupnir-documentation/moderator"
  364. "/managing-protected-rooms#giving-draupnir-permissions) in rooms it's "
  365. "protecting. This involves **giving it an Administrator power level**."
  366. msgstr ""
  367. #: ../../../docs/configuring-playbook-bot-draupnir.md:199
  368. msgid ""
  369. "**We recommend setting this power level as soon as the bot joins your "
  370. "room** (and before you create new rules), so that it can apply rules as "
  371. "soon as they are available. If the bot is under-privileged, it may fail "
  372. "to apply protections and may not retry for a while (or until your restart"
  373. " it)."
  374. msgstr ""
  375. #: ../../../docs/configuring-playbook-bot-draupnir.md:201
  376. msgid "Subscribing to a public policy list"
  377. msgstr ""
  378. #: ../../../docs/configuring-playbook-bot-draupnir.md:203
  379. msgid ""
  380. "We recommend **subscribing to a public [policy list](https://the-"
  381. "draupnir-project.github.io/draupnir-documentation/concepts/policy-"
  382. "lists)** using the [watch command](https://the-draupnir-project.github.io"
  383. "/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-"
  384. "watch-command-to-subscribe-to-policy-rooms)."
  385. msgstr ""
  386. #: ../../../docs/configuring-playbook-bot-draupnir.md:205
  387. msgid ""
  388. "Polcy lists are maintained in Matrix rooms. A popular policy list is "
  389. "maintained in the public `#community-moderation-effort-bl:neko.dev` room."
  390. msgstr ""
  391. #: ../../../docs/configuring-playbook-bot-draupnir.md:207
  392. msgid ""
  393. "You can tell Draupnir to subscribe to it by sending the following command"
  394. " to the Management Room: `!draupnir watch #community-moderation-effort-"
  395. "bl:neko.dev`"
  396. msgstr ""
  397. #: ../../../docs/configuring-playbook-bot-draupnir.md:209
  398. msgid "Creating your own policy lists and rules"
  399. msgstr ""
  400. #: ../../../docs/configuring-playbook-bot-draupnir.md:211
  401. msgid ""
  402. "We also recommend **creating your own policy lists** with the [list "
  403. "create](https://the-draupnir-project.github.io/draupnir-"
  404. "documentation/moderator/managing-policy-lists#using-draupnirs-list-"
  405. "create-command-to-create-a-policy-room) command."
  406. msgstr ""
  407. #: ../../../docs/configuring-playbook-bot-draupnir.md:213
  408. msgid ""
  409. "You can do so by sending the following command to the Management Room: "
  410. "`!draupnir list create my-bans my-bans-bl`. This will create a policy "
  411. "list having a name (shortcode) of `my-bans` and stored in a public `#my-"
  412. "bans-bl:example.com` room on your server. As soon as you run this "
  413. "command, the bot will invite you to the policy list room."
  414. msgstr ""
  415. #: ../../../docs/configuring-playbook-bot-draupnir.md:215
  416. msgid ""
  417. "A policy list does nothing by itself, so the next step is **adding some "
  418. "rules to your policy list**. Policies target a so-called `entity` (one "
  419. "of: `user`, `room` or `server`). These entities are mentioned on the "
  420. "[policy lists](https://the-draupnir-project.github.io/draupnir-"
  421. "documentation/concepts/policy-lists) documentation page and in the Matrix"
  422. " Spec [here](https://spec.matrix.org/v1.11/client-server-api/#mban-"
  423. "recommendation)."
  424. msgstr ""
  425. #: ../../../docs/configuring-playbook-bot-draupnir.md:217
  426. msgid ""
  427. "The simplest and most useful entity to target is `user`. Below are a few "
  428. "examples using the [ban command](https://the-draupnir-project.github.io"
  429. "/draupnir-documentation/moderator/managing-users#the-ban-command) and "
  430. "targeting users."
  431. msgstr ""
  432. #: ../../../docs/configuring-playbook-bot-draupnir.md:219
  433. msgid ""
  434. "To create rules, you run commands in the Management Room (**not** in the "
  435. "policy list room)."
  436. msgstr ""
  437. #: ../../../docs/configuring-playbook-bot-draupnir.md:221
  438. msgid ""
  439. "(ban a single user on a given homeserver): `!draupnir ban "
  440. "@charles:example.com my-bans Rude to others`"
  441. msgstr ""
  442. #: ../../../docs/configuring-playbook-bot-draupnir.md:222
  443. msgid ""
  444. "(ban all users on a given homeserver by using a [wildcard](https://the-"
  445. "draupnir-project.github.io/draupnir-documentation/moderator/managing-"
  446. "users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server - "
  447. "all users are fake`"
  448. msgstr ""
  449. #: ../../../docs/configuring-playbook-bot-draupnir.md:224
  450. msgid "As a result of running these commands, you may observe:"
  451. msgstr ""
  452. #: ../../../docs/configuring-playbook-bot-draupnir.md:226
  453. msgid ""
  454. "Draupnir creating `m.policy.rule.user` state events in the `#my-bans-"
  455. "bl:example.com` room on your server"
  456. msgstr ""
  457. #: ../../../docs/configuring-playbook-bot-draupnir.md:227
  458. msgid ""
  459. "applying these rules against all rooms that Draupnir is an Administrator "
  460. "in"
  461. msgstr ""
  462. #: ../../../docs/configuring-playbook-bot-draupnir.md:229
  463. msgid ""
  464. "You can undo bans with the [unban command](https://the-draupnir-"
  465. "project.github.io/draupnir-documentation/moderator/managing-users#the-"
  466. "unban-command)."
  467. msgstr ""
  468. #: ../../../docs/configuring-playbook-bot-draupnir.md:231
  469. msgid "Enabling built-in protections"
  470. msgstr ""
  471. #: ../../../docs/configuring-playbook-bot-draupnir.md:233
  472. msgid ""
  473. "You can also **turn on various built-in [protections](https://the-"
  474. "draupnir-project.github.io/draupnir-documentation/protections)** like "
  475. "`JoinWaveShortCircuit` (\"If X amount of users join in Y time, set the "
  476. "room to invite-only\")."
  477. msgstr ""
  478. #: ../../../docs/configuring-playbook-bot-draupnir.md:235
  479. msgid ""
  480. "To **see which protections are available and which are enabled**, send a "
  481. "`!draupnir protections` command to the Management Room."
  482. msgstr ""
  483. #: ../../../docs/configuring-playbook-bot-draupnir.md:237
  484. msgid ""
  485. "To **see the configuration options for a given protection**, send a "
  486. "`!draupnir config get PROTECTION_NAME` (e.g. `!draupnir config get "
  487. "JoinWaveShortCircuit`)."
  488. msgstr ""
  489. #: ../../../docs/configuring-playbook-bot-draupnir.md:239
  490. msgid ""
  491. "To **set a specific option for a given protection**, send a command like "
  492. "this: `!draupnir config set PROTECTION_NAME.OPTION VALUE` (e.g. "
  493. "`!draupnir config set JoinWaveShortCircuit.timescaleMinutes 30`)."
  494. msgstr ""
  495. #: ../../../docs/configuring-playbook-bot-draupnir.md:241
  496. msgid ""
  497. "To **enable a given protection**, send a command like this: `!draupnir "
  498. "enable PROTECTION_NAME` (e.g. `!draupnir enable JoinWaveShortCircuit`)."
  499. msgstr ""
  500. #: ../../../docs/configuring-playbook-bot-draupnir.md:243
  501. msgid ""
  502. "To **disable a given protection**, send a command like this: `!draupnir "
  503. "disable PROTECTION_NAME` (e.g. `!draupnir disable JoinWaveShortCircuit`)."
  504. msgstr ""
  505. #~ msgid ""
  506. #~ "See the project's [documentation](https://github.com"
  507. #~ "/the-draupnir-project/Draupnir) to learn "
  508. #~ "what it does and why it might "
  509. #~ "be useful to you."
  510. #~ msgstr ""
  511. #~ msgid "If your migrating from Mjolnir skip to step 5b."
  512. #~ msgstr ""
  513. #~ msgid ""
  514. #~ "The playbook does not automatically "
  515. #~ "create users for you. The bot "
  516. #~ "requires an access token to be "
  517. #~ "able to connect to your homeserver."
  518. #~ msgstr ""
  519. #~ msgid ""
  520. #~ "You **need to register the bot "
  521. #~ "user manually** before setting up the"
  522. #~ " bot."
  523. #~ msgstr ""
  524. #~ msgid ""
  525. #~ "If you would like Draupnir to be"
  526. #~ " able to deactivate users, move "
  527. #~ "aliases, shutdown rooms, show abuse "
  528. #~ "reports ([see below](#abuse-reports)), etc "
  529. #~ "then it must be a server admin "
  530. #~ "so you need to change `admin=no` "
  531. #~ "to `admin=yes` in the command above."
  532. #~ msgstr ""
  533. #~ msgid ""
  534. #~ "Refer to the documentation on [how "
  535. #~ "to obtain an access token](obtaining-"
  536. #~ "access-tokens.md)."
  537. #~ msgstr ""
  538. #~ msgid ""
  539. #~ "You will need to prevent Synapse "
  540. #~ "from rate limiting the bot's account."
  541. #~ " This is not an optional step. "
  542. #~ "If you do not do this step "
  543. #~ "Draupnir will crash. This can be "
  544. #~ "done using Synapse's [admin API](https"
  545. #~ "://matrix-"
  546. #~ "org.github.io/synapse/latest/admin_api/user_admin_api.html"
  547. #~ "#override-ratelimiting-for-users). Please "
  548. #~ "ask for help if you are "
  549. #~ "uncomfortable with these steps or run"
  550. #~ " into issues."
  551. #~ msgstr ""
  552. #~ msgid ""
  553. #~ "If your Synapse Admin API is "
  554. #~ "exposed to the internet for some "
  555. #~ "reason like running the Synapse Admin"
  556. #~ " Role [Link](configuring-playbook-synapse-"
  557. #~ "admin.md) or running "
  558. #~ "`matrix_synapse_container_labels_public_client_synapse_admin_api_enabled:"
  559. #~ " true` in your playbook config. If"
  560. #~ " your API is not externally exposed"
  561. #~ " you should still be able to on"
  562. #~ " the local host for your synapse "
  563. #~ "run these commands."
  564. #~ msgstr ""
  565. #~ msgid ""
  566. #~ "The following command works on semi "
  567. #~ "up to date Windows 10 installs and"
  568. #~ " All Windows 11 installations and "
  569. #~ "other systems that ship curl. `curl "
  570. #~ "--header \"Authorization: Bearer <access_token>\""
  571. #~ " -X POST "
  572. #~ "https://matrix.example.com/_synapse/admin/v1/users/@bot.draupnir:example.com/override_ratelimit`"
  573. #~ " Replace `@bot.draupnir:example.com` with the "
  574. #~ "MXID of your Draupnir and example.com"
  575. #~ " with your homeserver domain. You can"
  576. #~ " easily obtain an access token for"
  577. #~ " a homeserver admin account the same"
  578. #~ " way you can obtain an access "
  579. #~ "token for Draupnir itself. If you "
  580. #~ "made Draupnir Admin you can just "
  581. #~ "use the Draupnir token."
  582. #~ msgstr ""
  583. #~ msgid ""
  584. #~ "If you make the management room "
  585. #~ "encrypted (E2EE), then you MUST enable"
  586. #~ " and use Pantalaimon (see below)."
  587. #~ msgstr ""
  588. #~ msgid ""
  589. #~ "Decide whether you want Draupnir to "
  590. #~ "be capable of operating in end-"
  591. #~ "to-end encrypted (E2EE) rooms. This "
  592. #~ "includes the management room and the "
  593. #~ "moderated rooms. To support E2EE, "
  594. #~ "Draupnir needs to [use Pantalaimon"
  595. #~ "](configuring-playbook-pantalaimon.md)."
  596. #~ msgstr ""
  597. #~ msgid "a. Configuration with E2EE support"
  598. #~ msgstr ""
  599. #~ msgid "b. Configuration without E2EE support"
  600. #~ msgstr ""
  601. #~ msgid ""
  602. #~ "You must replace "
  603. #~ "`ACCESS_TOKEN_FROM_STEP_2_GOES_HERE` and "
  604. #~ "`ROOM_ID_FROM_STEP_4_GOES_HERE` with your own "
  605. #~ "values."
  606. #~ msgstr ""
  607. #~ msgid "c. Migrating from Mjolnir (Only required if migrating.)"
  608. #~ msgstr ""
  609. #~ msgid ""
  610. #~ "You can configure additional options by"
  611. #~ " adding the "
  612. #~ "`matrix_bot_draupnir_configuration_extension_yaml` variable "
  613. #~ "to your `inventory/host_vars/matrix.example.com/vars.yml`"
  614. #~ " file."
  615. #~ msgstr ""
  616. #~ msgid ""
  617. #~ "For example to change Draupnir's "
  618. #~ "`recordIgnoredInvites` option to `true` you"
  619. #~ " would add the following to your "
  620. #~ "`vars.yml` file."
  621. #~ msgstr ""
  622. #~ msgid ""
  623. #~ "The other method polls an synapse "
  624. #~ "admin API endpoint and is hence "
  625. #~ "only available when using synapse and"
  626. #~ " when the Draupnir user is an "
  627. #~ "admin user (see step 1). To enable"
  628. #~ " it, set `pollReports: true` in "
  629. #~ "Draupnir's config:"
  630. #~ msgstr ""