overmind
/
matrix-docker-ansible-deploy
의 미러 https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
포크 0
코드 이슈 0 릴리즈 0 위키 활동
Matrix Docker Ansible eploy
25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11292 커밋
12 브랜치
405 MiB
 
 
브렌치: master
브랜치 태그
${ item.name }
${ searchTerm } 브랜치 생성
from 'master'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bot-dr...

503 lines
27 KiB
Raw 고유링크 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-05-07 14:00+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-bot-draupnir.md:11

  20. msgid "Setting up Draupnir (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-bot-draupnir.md:13

  24. msgid "The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation bot for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-bot-draupnir.md:15

  28. msgid "See the project's [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) to learn what it does and why it might be useful to you."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-bot-draupnir.md:17

  32. msgid "This documentation page is about installing Draupnir in bot mode. As an alternative, you can run a multi-instance Draupnir deployment by installing [Draupnir in appservice mode](./configuring-playbook-appservice-draupnir-for-all.md) (called Draupnir-for-all) instead."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-bot-draupnir.md:19

  36. msgid "If your migrating from [Mjolnir](configuring-playbook-bot-mjolnir.md), skip to [this section](#migrating-from-mjolnir-only-required-if-migrating)."

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-bot-draupnir.md:21

  40. msgid "Prerequisites"

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-bot-draupnir.md:23

  44. msgid "Prerequisites for Zero Touch Deployment (recommended)"

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-bot-draupnir.md:25

  48. msgid "As of Draupnir 3.1.0, Zero Touch Deployment of Draupnir bot mode requires you to supply the following:"

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-bot-draupnir.md:27

  52. msgid "MXID of the first person who gets invited to the management room that the bot creates for you."

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-bot-draupnir.md:28

  56. msgid "A permanent access token for authentication. Instructions for obtaining one can be found at [obtain an access token via curl](obtaining-access-tokens.md#obtain-an-access-token-via-curl)."

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-bot-draupnir.md:29

  60. msgid "A user account for Draupnir."

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-bot-draupnir.md:31

  64. msgid "Zero Touch Deployment is the officially preferred installation method for new deployments of Draupnir as of 3.1.0."

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-bot-draupnir.md:33

  68. msgid "Create a management room (optional)"

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-bot-draupnir.md:35

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

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-bot-draupnir.md:37

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

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-bot-draupnir.md:40

  80. msgid "It is possible to make the management room encrypted (E2EE). If doing so, then you need to enable the native E2EE support (see [below](#native-e2ee-support))."

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-bot-draupnir.md:42

  84. msgid "E2EE support for the management room is mutually exclusive with Zero Touch Deployment of Draupnir."

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-bot-draupnir.md:44

  88. msgid "Once you have created the room you need to copy the room ID so you can specify it on your `inventory/host_vars/matrix.example.com/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`."

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-bot-draupnir.md:46

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

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-bot-draupnir.md:48

  96. msgid "Decide whether you want to support having an encrypted management room or not. Draupnir can still protect encrypted rooms without encryption support enabled."

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-bot-draupnir.md:50

  100. msgid "Refer to Draupnir's [documentation](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#protecting-encrypted-rooms) for more details about why you might want to care about encryption support for protected rooms."

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-bot-draupnir.md:52

  104. msgid "Disable Pantalaimon for Draupnir (since v2.0.0; optional)"

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-bot-draupnir.md:54

  108. msgid "It is known that running Draupnir along with Pantalaimon breaks all workflows that involve answering prompts with reactions."

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-bot-draupnir.md:56

  112. msgid "If you are updating Draupnir from v1.x.x and have enabled Pantalaimon for it, you can disable Pantalaimon in favor of the native E2EE support. To disable Pantalaimon, remove the configuration `matrix_bot_draupnir_pantalaimon_use: true` from your `vars.yml` file."

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-bot-draupnir.md:58

  116. msgid "**Note**: because the management room is still encrypted, disabling it without enabling the native E2EE support will break the management room."

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-bot-draupnir.md:60

  120. msgid "Native E2EE support"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-bot-draupnir.md:62

  124. msgid "To enable the native E2EE support, you need to obtain an access token for Draupnir and set it on your `vars.yml` file."

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-bot-draupnir.md:64

  128. msgid "Note that native E2EE requires a clean access token that has not touched E2EE so curl is recommended as a method to obtain it. **The access token obtained via Element Web does not work with it**. Refer to the documentation on [how to obtain an access token via curl](obtaining-access-tokens.md#obtain-an-access-token-via-curl)."

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-bot-draupnir.md:66

  132. msgid "To enable the native E2EE support, add the following configuration to your `vars.yml` file. Make sure to replace `CLEAN_ACCESS_TOKEN_HERE` with the access token you obtained just now."

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-bot-draupnir.md:77

  136. msgid "Adjusting the playbook configuration"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-bot-draupnir.md:79

  140. msgid "Configuration for Zero Touch Deployment (recommended)"

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-bot-draupnir.md:81

  144. msgid "To enable the bot using Zero Touch Deployment, add the following configuration to your `vars.yml` file. Make sure to replace `INITIAL_MANAGER_MXID_HERE` with the MXID of the user who should be invited to the management room first, and `CLEAN_ACCESS_TOKEN_HERE` with the access token you obtained."

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-bot-draupnir.md:95

  148. msgid "Configuration without Zero Touch Deployment"

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-bot-draupnir.md:97

  152. msgid "If you'd prefer to have the bot manage its own login at the cost of having to create the management room manually, you can use native login with the configuration block below. Make sure to replace `MANAGEMENT_ROOM_ID_HERE` with the ID of the management room you have created earlier."

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-bot-draupnir.md:116

  156. msgid "Running both bot mode and appservice mode"

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-bot-draupnir.md:118

  160. msgid "When running both bot mode and [appservice mode (Draupnir for all)](./configuring-playbook-appservice-draupnir-for-all.md), the playbook will force-restart the bot if running a non-release tag like `latest` or `main` or a development build. This is due to the conditional restart logic not being able to reliably tell when an update happened."

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-bot-draupnir.md:122

  164. msgid "Conditional restarts work correctly for all tags when running only one of these two operating modes."

  165. msgstr ""

  166. 

  167. #: ../../../docs/configuring-playbook-bot-draupnir.md:124

  168. msgid "Create and invite the bot to the management room (only when using native login without Zero Touch Deployment)"

  169. msgstr ""

  170. 

  171. #: ../../../docs/configuring-playbook-bot-draupnir.md:126

  172. msgid "Before proceeding to the next step, run the playbook with the following command to create the bot user."

  173. msgstr ""

  174. 

  175. #: ../../../docs/configuring-playbook-bot-draupnir.md:132

  176. msgid "**Note**: the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."

  177. msgstr ""

  178. 

  179. #: ../../../docs/configuring-playbook-bot-draupnir.md:134

  180. msgid "Then, invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier."

  181. msgstr ""

  182. 

  183. #: ../../../docs/configuring-playbook-bot-draupnir.md:136

  184. msgid "Creating a user account for the bot (when using Zero Touch Deployment)"

  185. msgstr ""

  186. 

  187. #: ../../../docs/configuring-playbook-bot-draupnir.md:138

  188. msgid "Since Zero Touch Deployment is not validated with native login, you will need to create the user account manually."

  189. msgstr ""

  190. 

  191. #: ../../../docs/configuring-playbook-bot-draupnir.md:140

  192. msgid "Refer to [registering users](registering-users.md) for documentation on how to configure the user account."

  193. msgstr ""

  194. 

  195. #: ../../../docs/configuring-playbook-bot-draupnir.md:142

  196. msgid "Make sure the account is free from rate limiting (optional, recommended)"

  197. msgstr ""

  198. 

  199. #: ../../../docs/configuring-playbook-bot-draupnir.md:144

  200. msgid "If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a highly recommended step. If you do not configure it, Draupnir performance will be degraded.**"

  201. msgstr ""

  202. 

  203. #: ../../../docs/configuring-playbook-bot-draupnir.md:146

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

  205. msgstr ""

  206. 

  207. #: ../../../docs/configuring-playbook-bot-draupnir.md:148

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

  209. msgstr ""

  210. 

  211. #: ../../../docs/configuring-playbook-bot-draupnir.md:150

  212. msgid "The APIs can also be accessed via [Ketesa](https://github.com/etkecc/ketesa), a web UI tool you can use to administrate users, rooms, media, etc. on your Matrix server. The playbook can install and configure Ketesa for you. For details about it, see [this page](configuring-playbook-ketesa.md)."

  213. msgstr ""

  214. 

  215. #: ../../../docs/configuring-playbook-bot-draupnir.md:152

  216. msgid "Add the configuration"

  217. msgstr ""

  218. 

  219. #: ../../../docs/configuring-playbook-bot-draupnir.md:154

  220. msgid "This is automatically done if Ketesa is enabled. Otherwise, to expose the APIs publicly, add the following configuration to your `vars.yml` file:"

  221. msgstr ""

  222. 

  223. #: ../../../docs/configuring-playbook-bot-draupnir.md:160

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

  225. msgstr ""

  226. 

  227. #: ../../../docs/configuring-playbook-bot-draupnir.md:162

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

  229. msgstr ""

  230. 

  231. #: ../../../docs/configuring-playbook-bot-draupnir.md:164

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

  233. msgstr ""

  234. 

  235. #: ../../../docs/configuring-playbook-bot-draupnir.md:167

  236. msgid "Run the `curl` command"

  237. msgstr ""

  238. 

  239. #: ../../../docs/configuring-playbook-bot-draupnir.md:169

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

  241. msgstr ""

  242. 

  243. #: ../../../docs/configuring-playbook-bot-draupnir.md:171

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

  245. msgstr ""

  246. 

  247. #: ../../../docs/configuring-playbook-bot-draupnir.md:172

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

  249. msgstr ""

  250. 

  251. #: ../../../docs/configuring-playbook-bot-draupnir.md:173

  252. msgid "`@bot.draupnir:example.com` with the MXID of your Draupnir bot user"

  253. msgstr ""

  254. 

  255. #: ../../../docs/configuring-playbook-bot-draupnir.md:179

  256. #: ../../../docs/configuring-playbook-bot-draupnir.md:254

  257. msgid "**Notes**:"

  258. msgstr ""

  259. 

  260. #: ../../../docs/configuring-playbook-bot-draupnir.md:181

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

  262. msgstr ""

  263. 

  264. #: ../../../docs/configuring-playbook-bot-draupnir.md:182

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

  266. msgstr ""

  267. 

  268. #: ../../../docs/configuring-playbook-bot-draupnir.md:184

  269. msgid "Abuse Reports"

  270. msgstr ""

  271. 

  272. #: ../../../docs/configuring-playbook-bot-draupnir.md:186

  273. msgid "Draupnir can receive reports in the management room."

  274. msgstr ""

  275. 

  276. #: ../../../docs/configuring-playbook-bot-draupnir.md:188

  277. msgid "The bot can intercept the report API endpoint of the client-server API, which requires integration with the reverse proxy in front of the homeserver. If you are using Traefik, this playbook can set this up for you:"

  278. msgstr ""

  279. 

  280. #: ../../../docs/configuring-playbook-bot-draupnir.md:194

  281. msgid "Enabling synapse-http-antispam support"

  282. msgstr ""

  283. 

  284. #: ../../../docs/configuring-playbook-bot-draupnir.md:196

  285. msgid "Certain protections in Draupnir require the [synapse-http-antispam](https://github.com/maunium/synapse-http-antispam) module and a Synapse homeserver plus homeserver admin status to function. This module can be enabled in the playbook via setting `matrix_bot_draupnir_config_web_synapseHTTPAntispam_enabled` to `true` and making sure that Draupnir admin API access is enabled."

  286. msgstr ""

  287. 

  288. #: ../../../docs/configuring-playbook-bot-draupnir.md:206

  289. msgid "These protections need to be manually activated. Consulting the [enabling protections](#enabling-built-in-protections) guide and/or upstream documentation can be helpful."

  290. msgstr ""

  291. 

  292. #: ../../../docs/configuring-playbook-bot-draupnir.md:208

  293. msgid "The other method polls a Synapse Admin API endpoint, hence it is available only if using Synapse and if the Draupnir user is an admin. To enable it, set `pollReports: true` in your `vars.yml` file as below:"

  294. msgstr ""

  295. 

  296. #: ../../../docs/configuring-playbook-bot-draupnir.md:215

  297. msgid "Extending the configuration"

  298. msgstr ""

  299. 

  300. #: ../../../docs/configuring-playbook-bot-draupnir.md:217

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

  302. msgstr ""

  303. 

  304. #: ../../../docs/configuring-playbook-bot-draupnir.md:219

  305. msgid "Take a look at:"

  306. msgstr ""

  307. 

  308. #: ../../../docs/configuring-playbook-bot-draupnir.md:221

  309. msgid "`roles/custom/matrix-bot-draupnir/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_draupnir_configuration_extension_yaml` variable"

  310. msgstr ""

  311. 

  312. #: ../../../docs/configuring-playbook-bot-draupnir.md:223

  313. msgid "For example, to change Draupnir's `acceptInvitesFromSpace` option to `!qporfwt:example.com`, add the following configuration to your `vars.yml` file:"

  314. msgstr ""

  315. 

  316. #: ../../../docs/configuring-playbook-bot-draupnir.md:237

  317. msgid "Migrating from Mjolnir (Only required if migrating)"

  318. msgstr ""

  319. 

  320. #: ../../../docs/configuring-playbook-bot-draupnir.md:239

  321. msgid "Replace your `matrix_bot_mjolnir` config with `matrix_bot_draupnir` config. Also disable Mjolnir if you're doing migration."

  322. msgstr ""

  323. 

  324. #: ../../../docs/configuring-playbook-bot-draupnir.md:241

  325. msgid "Note that Draupnir supports E2EE natively, so you can enable it instead of Pantalaimon. It is recommended to consult the instruction [here](#native-e2ee-support)."

  326. msgstr ""

  327. 

  328. #: ../../../docs/configuring-playbook-bot-draupnir.md:243

  329. msgid "That is all you need to do due to that Draupnir can complete migration on its own."

  330. msgstr ""

  331. 

  332. #: ../../../docs/configuring-playbook-bot-draupnir.md:245

  333. msgid "Installing"

  334. msgstr ""

  335. 

  336. #: ../../../docs/configuring-playbook-bot-draupnir.md:247

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

  338. msgstr ""

  339. 

  340. #: ../../../docs/configuring-playbook-bot-draupnir.md:256

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

  342. msgstr ""

  343. 

  344. #: ../../../docs/configuring-playbook-bot-draupnir.md:258

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

  346. msgstr ""

  347. 

  348. #: ../../../docs/configuring-playbook-bot-draupnir.md:260

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

  350. msgstr ""

  351. 

  352. #: ../../../docs/configuring-playbook-bot-draupnir.md:262

  353. msgid "If you change the bot password (`matrix_bot_draupnir_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [Ketesa](configuring-playbook-ketesa.md) to change it, and then update `matrix_bot_draupnir_password` to let the bot know its new password."

  354. msgstr ""

  355. 

  356. #: ../../../docs/configuring-playbook-bot-draupnir.md:264

  357. msgid "Usage"

  358. msgstr ""

  359. 

  360. #: ../../../docs/configuring-playbook-bot-draupnir.md:266

  361. msgid "You can refer to the upstream [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) for additional ways to use and configure Draupnir and for a more detailed usage guide."

  362. msgstr ""

  363. 

  364. #: ../../../docs/configuring-playbook-bot-draupnir.md:268

  365. msgid "Below is a **non-exhaustive quick-start guide** for the impatient."

  366. msgstr ""

  367. 

  368. #: ../../../docs/configuring-playbook-bot-draupnir.md:270

  369. msgid "Making Draupnir join and protect a room"

  370. msgstr ""

  371. 

  372. #: ../../../docs/configuring-playbook-bot-draupnir.md:272

  373. msgid "Draupnir can be told to self-join public rooms, but it's better to follow this flow which works well for all kinds of rooms:"

  374. msgstr ""

  375. 

  376. #: ../../../docs/configuring-playbook-bot-draupnir.md:274

  377. msgid "Invite the bot to the room manually ([inviting Draupnir to rooms](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#inviting-draupnir-to-rooms)). Before joining, the bot *may* ask for confirmation in the Management Room"

  378. msgstr ""

  379. 

  380. #: ../../../docs/configuring-playbook-bot-draupnir.md:276

  381. msgid "[Give the bot permissions to do its job](#giving-draupnir-permissions-to-do-its-job)"

  382. msgstr ""

  383. 

  384. #: ../../../docs/configuring-playbook-bot-draupnir.md:278

  385. msgid "Tell it to protect the room (using the [rooms command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#using-the-draupnir-rooms-command)) by sending the following command to the Management Room: `!draupnir rooms add !qporfwt:example.com`"

  386. msgstr ""

  387. 

  388. #: ../../../docs/configuring-playbook-bot-draupnir.md:280

  389. msgid "To have Draupnir provide useful room protection, you need do to a bit more work (at least the first time around). You may wish to [Subscribe to a public policy list](#subscribing-to-a-public-policy-list), [Create your own own policy and rules](#creating-your-own-policy-lists-and-rules) and [Enabling built-in protections](#enabling-built-in-protections)."

  390. msgstr ""

  391. 

  392. #: ../../../docs/configuring-playbook-bot-draupnir.md:282

  393. msgid "Giving Draupnir permissions to do its job"

  394. msgstr ""

  395. 

  396. #: ../../../docs/configuring-playbook-bot-draupnir.md:284

  397. msgid "For Draupnir to do its job, you need to [give it permissions](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#giving-draupnir-permissions) in rooms it's protecting. This involves **giving it an Administrator power level**."

  398. msgstr ""

  399. 

  400. #: ../../../docs/configuring-playbook-bot-draupnir.md:286

  401. msgid "**We recommend setting this power level as soon as the bot joins your room** (and before you create new rules), so that it can apply rules as soon as they are available. If the bot is under-privileged, it may fail to apply protections and may not retry for a while (or until your restart it)."

  402. msgstr ""

  403. 

  404. #: ../../../docs/configuring-playbook-bot-draupnir.md:288

  405. msgid "Subscribing to a public policy list"

  406. msgstr ""

  407. 

  408. #: ../../../docs/configuring-playbook-bot-draupnir.md:290

  409. msgid "We recommend **subscribing to a public [policy list](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists)** using the [watch command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-watch-command-to-subscribe-to-policy-rooms)."

  410. msgstr ""

  411. 

  412. #: ../../../docs/configuring-playbook-bot-draupnir.md:292

  413. msgid "Policy lists are maintained in Matrix rooms. Popular ones maintained in the public are:"

  414. msgstr ""

  415. 

  416. #: ../../../docs/configuring-playbook-bot-draupnir.md:294

  417. msgid "`#community-moderation-effort-bl:neko.dev`"

  418. msgstr ""

  419. 

  420. #: ../../../docs/configuring-playbook-bot-draupnir.md:295

  421. msgid "`#huginn-muninn-active-threats:feline.support`"

  422. msgstr ""

  423. 

  424. #: ../../../docs/configuring-playbook-bot-draupnir.md:297

  425. msgid "You can tell Draupnir to subscribe to each of these by sending the following command to the Management Room: `!draupnir watch POLICY_LIST_ADDRESS_HERE` (e.g. `!draupnir watch #community-moderation-effort-bl:neko.dev`)"

  426. msgstr ""

  427. 

  428. #: ../../../docs/configuring-playbook-bot-draupnir.md:299

  429. msgid "Creating your own policy lists and rules"

  430. msgstr ""

  431. 

  432. #: ../../../docs/configuring-playbook-bot-draupnir.md:301

  433. msgid "We also recommend **creating your own policy lists** with the [list create](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-list-create-command-to-create-a-policy-room) command."

  434. msgstr ""

  435. 

  436. #: ../../../docs/configuring-playbook-bot-draupnir.md:303

  437. msgid "You can do so by sending the following command to the Management Room: `!draupnir list create my-bans my-bans-bl`. This will create a policy list having a name (shortcode) of `my-bans` and stored in a public `#my-bans-bl:example.com` room on your server. As soon as you run this command, the bot will invite you to the policy list room."

  438. msgstr ""

  439. 

  440. #: ../../../docs/configuring-playbook-bot-draupnir.md:305

  441. msgid "A policy list does nothing by itself, so the next step is **adding some rules to your policy list**. Policies target a so-called `entity` (one of: `user`, `room` or `server`). These entities are mentioned on the [policy lists](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists) documentation page and in the Matrix Spec [here](https://spec.matrix.org/v1.11/client-server-api/#mban-recommendation)."

  442. msgstr ""

  443. 

  444. #: ../../../docs/configuring-playbook-bot-draupnir.md:307

  445. msgid "The simplest and most useful entity to target is `user`. Below are a few examples using the [ban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-ban-command) and targeting users."

  446. msgstr ""

  447. 

  448. #: ../../../docs/configuring-playbook-bot-draupnir.md:309

  449. msgid "To create rules, you run commands in the Management Room (**not** in the policy list room)."

  450. msgstr ""

  451. 

  452. #: ../../../docs/configuring-playbook-bot-draupnir.md:311

  453. msgid "(ban a single user on a given homeserver): `!draupnir ban @charles:example.com my-bans Rude to others`"

  454. msgstr ""

  455. 

  456. #: ../../../docs/configuring-playbook-bot-draupnir.md:312

  457. msgid "(ban all users on a given homeserver by using a [wildcard](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server, all users are fake`"

  458. msgstr ""

  459. 

  460. #: ../../../docs/configuring-playbook-bot-draupnir.md:314

  461. msgid "As a result of running these commands, you may observe:"

  462. msgstr ""

  463. 

  464. #: ../../../docs/configuring-playbook-bot-draupnir.md:316

  465. msgid "Draupnir creating `m.policy.rule.user` state events in the `#my-bans-bl:example.com` room on your server"

  466. msgstr ""

  467. 

  468. #: ../../../docs/configuring-playbook-bot-draupnir.md:317

  469. msgid "applying these rules against all rooms that Draupnir is an Administrator in"

  470. msgstr ""

  471. 

  472. #: ../../../docs/configuring-playbook-bot-draupnir.md:319

  473. msgid "You can undo bans with the [unban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-unban-command)."

  474. msgstr ""

  475. 

  476. #: ../../../docs/configuring-playbook-bot-draupnir.md:321

  477. msgid "Enabling built-in protections"

  478. msgstr ""

  479. 

  480. #: ../../../docs/configuring-playbook-bot-draupnir.md:323

  481. msgid "You can also **turn on various built-in [protections](https://the-draupnir-project.github.io/draupnir-documentation/protections)** like `JoinWaveShortCircuitProtection` (\"If X amount of users join in Y time, set the room to invite-only\")."

  482. msgstr ""

  483. 

  484. #: ../../../docs/configuring-playbook-bot-draupnir.md:325

  485. msgid "To **see which protections are available and which are enabled**, send a `!draupnir protections` command to the Management Room."

  486. msgstr ""

  487. 

  488. #: ../../../docs/configuring-playbook-bot-draupnir.md:327

  489. msgid "To [**see the configuration options for a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/configuring-protections#displaying-the-protection-settings), send a `!draupnir protections show PROTECTION_NAME` (e.g. `!draupnir protections show JoinWaveShortCircuitProtection`)."

  490. msgstr ""

  491. 

  492. #: ../../../docs/configuring-playbook-bot-draupnir.md:329

  493. msgid "To [**set a specific option for a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/configuring-protections#changing-protection-settings), send a command like this: `!draupnir protections config set PROTECTION_NAME OPTION VALUE` (e.g. `!draupnir protections config set JoinWaveShortCircuitProtection timescaleMinutes 30`)."

  494. msgstr ""

  495. 

  496. #: ../../../docs/configuring-playbook-bot-draupnir.md:331

  497. msgid "To [**enable a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/block-invitations-on-server-protection#enabling-the-protection), send a command like this: `!draupnir protections enable PROTECTION_NAME` (e.g. `!draupnir protections enable JoinWaveShortCircuitProtection`)."

  498. msgstr ""

  499. 

  500. #: ../../../docs/configuring-playbook-bot-draupnir.md:333

  501. msgid "To **disable a given protection**, send a command like this: `!draupnir protections disable PROTECTION_NAME` (e.g. `!draupnir protections disable JoinWaveShortCircuitProtection`)."

  502. msgstr ""