overmind
/
matrix-docker-ansible-deploy
зеркало из https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Форкнуть 0
Код Задачи 0 Релизы 0 Вики Активность
Matrix Docker Ansible eploy
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
11803 коммитов
14 Ветки
1.0 GiB
 
 
ветка: master
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из 'master'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-bot-me...

582 строки
31 KiB
Исходник Постоянная ссылка Вина История 

  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-08-13 05:03+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-meowlnir.md:7

  20. msgid "Setting up Meowlnir (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-bot-meowlnir.md:9

  24. msgid "The playbook can install and configure the [Meowlnir](https://github.com/maunium/meowlnir) moderation bot for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-bot-meowlnir.md:11

  28. msgid "See the project's [documentation](https://docs.mau.fi/meowlnir/) to learn what it does and why it might be useful to you."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-bot-meowlnir.md:13

  32. msgid "Meowlnir is an alternative to [Draupnir](configuring-playbook-bot-draupnir.md) and [Mjolnir](configuring-playbook-bot-mjolnir.md). It speaks the same [policy list](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists) protocol, so it can subscribe to the same community ban lists, but it differs from them in a few ways that may matter to you:"

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-bot-meowlnir.md:15

  36. msgid "It runs as an **appservice** and hosts **multiple bots**, each with its own management room. They live in Meowlnir's database, not its configuration file, but you still [declare them in your `vars.yml` file](#declaring-bots)."

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-bot-meowlnir.md:16

  40. msgid "It can **override a policy coming from a list you do not control**, via unban policies combined with the ordering of your watched lists. See [Overriding a policy from someone else's list](#overriding-a-policy-from-someone-elses-list)."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-bot-meowlnir.md:17

  44. msgid "It is written in Go and is optimized for Synapse, using its database and admin APIs directly."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-bot-meowlnir.md:19

  48. msgid "Meowlnir and Draupnir can run side by side, but not usefully in the *same* room: whichever bot you are migrating away from still watches the same community lists, so it re-applies the very bans your unban policies remove. Migrate room by room. See [Trialling Meowlnir alongside another bot](#trialling-meowlnir-alongside-another-bot)."

  49. msgstr ""

  50. 

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

  52. msgid "Prerequisites"

  53. msgstr ""

  54. 

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

  56. msgid "Postgres"

  57. msgstr ""

  58. 

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

  60. msgid "Meowlnir stores its state in a Postgres database. The playbook creates one for you automatically when using the integrated Postgres server."

  61. msgstr ""

  62. 

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

  64. msgid "Adjusting DNS records"

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-bot-meowlnir.md:29

  68. msgid "**No DNS changes are necessary.** Meowlnir is reached by the homeserver over the container network, and the paths it optionally serves publicly (abuse reports and the policy server) are routed on your existing `matrix.example.com` domain."

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-bot-meowlnir.md:31

  72. msgid "Adjusting the playbook configuration"

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-bot-meowlnir.md:33

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

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-bot-meowlnir.md:39

  80. msgid "Declaring bots"

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-bot-meowlnir.md:41

  84. msgid "That gets the service running, but Meowlnir does nothing until it has at least one bot. Declare the ones you want and the playbook creates them for you:"

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  88. msgid "Field"

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  92. msgid "Required"

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  96. msgid "Notes"

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  100. msgid "`username`"

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  104. msgid "yes"

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  108. msgid "The localpart of the bot's Matrix user. Awkward to change later, so choose it carefully."

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  112. msgid "`displayname`"

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  116. msgid "The name shown in rooms. Safe to change at any time."

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  120. msgid "`avatar_url`"

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  124. msgid "An `mxc://` URI, or `\"\"` for no avatar."

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  128. msgid "`management_room_auto_create`"

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  132. msgid "Whether the playbook creates the bot's management room. Mutually exclusive with a non-empty `management_rooms`."

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  136. msgid "`management_rooms`"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  140. msgid "Rooms you have created yourself, `[]` when auto-creating. See [Supplying your own management room](#supplying-your-own-management-room)."

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  144. msgid "`initial_managers`"

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  148. msgid "no"

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-bot-meowlnir.md:0

  152. msgid "Who to invite to an auto-created room. Defaults to the instance-wide list below."

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-bot-meowlnir.md:67

  156. msgid "Usernames have to start with `meowlnir_` (the value of `matrix_bot_meowlnir_user_prefix`), so that bots fall inside the user namespace the homeserver lets Meowlnir operate."

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-bot-meowlnir.md:69

  160. msgid "Changing `displayname` or `avatar_url` and re-running updates the bot in place. The comparison is against Meowlnir's own record, so profile edits made directly from a Matrix client are not reverted."

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-bot-meowlnir.md:71

  164. msgid "Initial managers"

  165. msgstr ""

  166. 

  167. #: ../../../docs/configuring-playbook-bot-meowlnir.md:73

  168. msgid "With `management_room_auto_create: true`, the playbook creates each bot's management room and invites its initial managers to it. You only need to accept the room invitation."

  169. msgstr ""

  170. 

  171. #: ../../../docs/configuring-playbook-bot-meowlnir.md:75

  172. msgid "`matrix_admin` is a single playbook variable which affects all bridges and bots, so setting it is usually a better move than setting anything specific to this role — **if it is already configured in your `vars.yml` file, there is nothing to do here**. If neither `matrix_admin` nor `matrix_bot_meowlnir_initial_managers` are set, the playbook would tell you about it."

  173. msgstr ""

  174. 

  175. #: ../../../docs/configuring-playbook-bot-meowlnir.md:77

  176. msgid "A per-bot `initial_managers` replaces the instance-wide list. Declaring it empty means nobody, which fails the run for a bot relying on `management_room_auto_create`."

  177. msgstr ""

  178. 

  179. #: ../../../docs/configuring-playbook-bot-meowlnir.md:79

  180. msgid "The list is consulted only while the room is being created. Adding a name to it later invites nobody, because the room already exists — invite and promote further moderators from inside the room instead, as described in [Who can command a bot](#who-can-command-a-bot)."

  181. msgstr ""

  182. 

  183. #: ../../../docs/configuring-playbook-bot-meowlnir.md:81

  184. msgid "Rooms the playbook creates"

  185. msgstr ""

  186. 

  187. #: ../../../docs/configuring-playbook-bot-meowlnir.md:83

  188. msgid "The bot creates the room with the `trusted_private_chat` preset, which gives every invitee the standing to command it. This is an additional room creator on room versions supporting [MSC4289](https://github.com/matrix-org/matrix-spec-proposals/pull/4289) (like v12) and power level 100 on older room versions. Creator status cannot be revoked subsequently."

  189. msgstr ""

  190. 

  191. #: ../../../docs/configuring-playbook-bot-meowlnir.md:85

  192. msgid "The room's encryption follows `matrix_bot_meowlnir_config_encryption_enable`, and its name and topic come from `matrix_bot_meowlnir_management_room_name` and `matrix_bot_meowlnir_management_room_topic`."

  193. msgstr ""

  194. 

  195. #: ../../../docs/configuring-playbook-bot-meowlnir.md:87

  196. msgid "Supplying your own management room"

  197. msgstr ""

  198. 

  199. #: ../../../docs/configuring-playbook-bot-meowlnir.md:89

  200. msgid "If you would rather own the room outright, create it yourself and declare it instead. The bot is then merely an administrator in a room you created:"

  201. msgstr ""

  202. 

  203. #: ../../../docs/configuring-playbook-bot-meowlnir.md:102

  204. msgid "An empty, invite-only room is fine. The order matters, because **each step depends on the one before it**:"

  205. msgstr ""

  206. 

  207. #: ../../../docs/configuring-playbook-bot-meowlnir.md:104

  208. msgid "Declare the room and run the playbook. Do not invite the bot beforehand."

  209. msgstr ""

  210. 

  211. #: ../../../docs/configuring-playbook-bot-meowlnir.md:105

  212. msgid "The playbook creates the bot and tells Meowlnir about the room. Meowlnir would try to join right away, but will fail for invite-only rooms (a harmless error in the log)."

  213. msgstr ""

  214. 

  215. #: ../../../docs/configuring-playbook-bot-meowlnir.md:106

  216. msgid "Invite the bot. It accepts the invitation, because the room is already marked as a management room for it."

  217. msgstr ""

  218. 

  219. #: ../../../docs/configuring-playbook-bot-meowlnir.md:107

  220. msgid "Give it power level 50 or more (ideally 100), so that it can store its protected rooms and watched lists there."

  221. msgstr ""

  222. 

  223. #: ../../../docs/configuring-playbook-bot-meowlnir.md:109

  224. msgid "Meowlnir supports several management rooms per bot, and `encrypted` is set per room. Marking a room encrypted only means something when [End-to-End Encryption support](#end-to-end-encryption-support) is switched on, which it is not by default."

  225. msgstr ""

  226. 

  227. #: ../../../docs/configuring-playbook-bot-meowlnir.md:111

  228. msgid "Who can command a bot"

  229. msgstr ""

  230. 

  231. #: ../../../docs/configuring-playbook-bot-meowlnir.md:113

  232. msgid "**Management room membership alone is not enough**, which is different from what [Draupnir](configuring-playbook-bot-draupnir.md) does, where everyone in the management room can issue commands."

  233. msgstr ""

  234. 

  235. #: ../../../docs/configuring-playbook-bot-meowlnir.md:115

  236. msgid "Meowlnir decides who may drive a bot from power levels in its management room: anyone who can send the `fi.mau.meowlnir.watched_lists` state event (power level 50 by default), plus the room's creators."

  237. msgstr ""

  238. 

  239. #: ../../../docs/configuring-playbook-bot-meowlnir.md:117

  240. msgid "Bots which are no longer declared"

  241. msgstr ""

  242. 

  243. #: ../../../docs/configuring-playbook-bot-meowlnir.md:119

  244. msgid "The bot list (`matrix_bot_meowlnir_bots_custom`) is authoritative. Removing entries from there will make the playbook unregister them with the Meowlnir instance."

  245. msgstr ""

  246. 

  247. #: ../../../docs/configuring-playbook-bot-meowlnir.md:121

  248. msgid "Removal only adjusts Meowlnir's own records. A removed bot's Matrix user remains activated and stays in the rooms it had joined. A removed management room leaves the room and the bot's membership in it intact - it's just that Meowlnir stops taking commands there."

  249. msgstr ""

  250. 

  251. #: ../../../docs/configuring-playbook-bot-meowlnir.md:123

  252. msgid "Removal happens under the same `ensure-matrix-users-created` tag that creates bots. It's one Ansible tag for \"synchronizing the bots state\" (creation, changes, and removal)."

  253. msgstr ""

  254. 

  255. #: ../../../docs/configuring-playbook-bot-meowlnir.md:125

  256. msgid "To turn removal off entirely, set `matrix_bot_meowlnir_bots_pruning_enabled: false`. As a safety measure, the playbook refuses to prune when *no* bots are declared at all; override that with `matrix_bot_meowlnir_bots_pruning_on_empty_roster_enabled: true`."

  257. msgstr ""

  258. 

  259. #: ../../../docs/configuring-playbook-bot-meowlnir.md:127

  260. msgid "Trialling Meowlnir alongside another bot"

  261. msgstr ""

  262. 

  263. #: ../../../docs/configuring-playbook-bot-meowlnir.md:129

  264. msgid "Meowlnir has a dry-run mode in which it does everything except take moderation actions:"

  265. msgstr ""

  266. 

  267. #: ../../../docs/configuring-playbook-bot-meowlnir.md:136

  268. msgid "Dry run does not cover the [synapse-http-antispam](#enabling-synapse-http-antispam-support) integration. It suppresses actions Meowlnir takes itself (bans, server ACLs, rejecting pending invites), but the verdicts it hands back to Synapse still block invites and joins. Leave that integration off while trialling."

  269. msgstr ""

  270. 

  271. #: ../../../docs/configuring-playbook-bot-meowlnir.md:138

  272. msgid "Do not expect dry run to preview what Meowlnir would do in rooms another policy-list bot already moderates. Meowlnir only acts on users who are *in* a room, and the other bot has already removed everyone its lists match, so the preview comes out empty. Dry run also skips the power level check described under [Protecting a room](#protecting-a-room), so it will not surface a permissions problem either."

  273. msgstr ""

  274. 

  275. #: ../../../docs/configuring-playbook-bot-meowlnir.md:140

  276. msgid "Abuse reports"

  277. msgstr ""

  278. 

  279. #: ../../../docs/configuring-playbook-bot-meowlnir.md:142

  280. msgid "Meowlnir can intercept the report endpoints of the client-server API, so that abuse reports are delivered to a management room. This requires integration with the reverse proxy in front of the homeserver, which the playbook sets up for you when using Traefik:"

  281. msgstr ""

  282. 

  283. #: ../../../docs/configuring-playbook-bot-meowlnir.md:151

  284. msgid "Only the `v3` report endpoints are routed to Meowlnir. Requests to the legacy `r0` endpoints continue to reach the homeserver, because Meowlnir does not serve them."

  285. msgstr ""

  286. 

  287. #: ../../../docs/configuring-playbook-bot-meowlnir.md:153

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

  289. msgstr ""

  290. 

  291. #: ../../../docs/configuring-playbook-bot-meowlnir.md:155

  292. msgid "Meowlnir can block invites and joins before they happen. This requires the [synapse-http-antispam](https://github.com/maunium/synapse-http-antispam) module, which the playbook can enable for you:"

  293. msgstr ""

  294. 

  295. #: ../../../docs/configuring-playbook-bot-meowlnir.md:165

  296. msgid "The playbook wires the module up to a single consumer, so this cannot be enabled at the same time as `matrix_bot_draupnir_config_web_synapseHTTPAntispam_enabled`. The playbook fails the run if both are enabled."

  297. msgstr ""

  298. 

  299. #: ../../../docs/configuring-playbook-bot-meowlnir.md:167

  300. msgid "With the module in place, you can also block invitations to specific users outright, which is useful for accounts that attract spam:"

  301. msgstr ""

  302. 

  303. #: ../../../docs/configuring-playbook-bot-meowlnir.md:174

  304. msgid "Such an invitation can still be let through case by case with the `!allow-invite` command."

  305. msgstr ""

  306. 

  307. #: ../../../docs/configuring-playbook-bot-meowlnir.md:176

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

  309. msgstr ""

  310. 

  311. #: ../../../docs/configuring-playbook-bot-meowlnir.md:178

  312. msgid "To let Meowlnir's bots participate in encrypted rooms:"

  313. msgstr ""

  314. 

  315. #: ../../../docs/configuring-playbook-bot-meowlnir.md:184

  316. msgid "When using Synapse, the playbook turns on the experimental features this depends on (`msc2409_to_device_messages_enabled` and `msc3202_transaction_extensions`) for you."

  317. msgstr ""

  318. 

  319. #: ../../../docs/configuring-playbook-bot-meowlnir.md:186

  320. msgid "Policy server (MSC4284)"

  321. msgstr ""

  322. 

  323. #: ../../../docs/configuring-playbook-bot-meowlnir.md:188

  324. msgid "Meowlnir can act as a [policy server](https://github.com/matrix-org/matrix-spec-proposals/pull/4284), letting rooms ask it to vet events before they are accepted:"

  325. msgstr ""

  326. 

  327. #: ../../../docs/configuring-playbook-bot-meowlnir.md:194

  328. msgid "This exposes `/_matrix/policy` on your Matrix federation endpoint, so that other servers participating in a room can reach it."

  329. msgstr ""

  330. 

  331. #: ../../../docs/configuring-playbook-bot-meowlnir.md:196

  332. msgid "That only stands the policy server up, though — no room is put behind it until you say so from the management room:"

  333. msgstr ""

  334. 

  335. #: ../../../docs/configuring-playbook-bot-meowlnir.md:202

  336. msgid "Given no room, `enable` applies to every protected room. Rooms which are not protected are skipped, with `Skipped ... as it is not a protected room`, so [protect a room](#protecting-a-room) before enabling it here. `!policyserver` on its own reports whether the policy server is available and prints its public key, and `!policyserver disable` reverses the change."

  337. msgstr ""

  338. 

  339. #: ../../../docs/configuring-playbook-bot-meowlnir.md:204

  340. msgid "The playbook derives a stable signing key for you from `matrix_homeserver_generic_secret_key`. If you would rather use an independently generated one, produce it with the command below and set it as `matrix_bot_meowlnir_config_policy_server_signing_key`:"

  341. msgstr ""

  342. 

  343. #: ../../../docs/configuring-playbook-bot-meowlnir.md:210

  344. msgid "Synapse admin API access (optional)"

  345. msgstr ""

  346. 

  347. #: ../../../docs/configuring-playbook-bot-meowlnir.md:212

  348. msgid "A few of Meowlnir's features go through Synapse's admin API, not the client-server API — suspending or deactivating users, and deleting rooms during a takedown. Those calls require the caller to be a Synapse **server admin**, which bots are not by default, so they come back as `M_FORBIDDEN` (\"You are not a server admin\"). Nothing else is affected: bans, server ACLs, protecting rooms and watching policy lists all go through the client-server API, where a sufficient power level is the only requirement."

  349. msgstr ""

  350. 

  351. #: ../../../docs/configuring-playbook-bot-meowlnir.md:214

  352. msgid "To grant that access, point each bot at a token belonging to a server admin:"

  353. msgstr ""

  354. 

  355. #: ../../../docs/configuring-playbook-bot-meowlnir.md:221

  356. msgid "The key is the bot the token is used for; the token itself belongs to an administrator account, not to the bot."

  357. msgstr ""

  358. 

  359. #: ../../../docs/configuring-playbook-bot-meowlnir.md:223

  360. msgid "If you have more than one management room, note that room bans are only processed in the one named by `matrix_bot_meowlnir_config_meowlnir_room_ban_room`, and ignored elsewhere."

  361. msgstr ""

  362. 

  363. #: ../../../docs/configuring-playbook-bot-meowlnir.md:225

  364. msgid "Where the token comes from depends on how your homeserver authenticates. Ordinarily you [obtain an access token](obtaining-access-tokens.md) for an account which is a Synapse server admin. When [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) is enabled, Synapse no longer decides who is an admin, so the token has to be issued by MAS with admin privileges:"

  365. msgstr ""

  366. 

  367. #: ../../../docs/configuring-playbook-bot-meowlnir.md:231

  368. msgid "Note that bot users are created by the appservice and are not known to Matrix Authentication Service, so the token cannot be issued for the bot itself — use an administrator account."

  369. msgstr ""

  370. 

  371. #: ../../../docs/configuring-playbook-bot-meowlnir.md:233

  372. msgid "Access to the Synapse database (optional)"

  373. msgstr ""

  374. 

  375. #: ../../../docs/configuring-playbook-bot-meowlnir.md:235

  376. msgid "Some room takedown features rely on Meowlnir reading room IDs directly from the Synapse database. Upstream expects a user with read-only permissions, which the playbook does not create. Enabling the integration below hands Meowlnir the same credentials Synapse itself uses, which also grant write access:"

  377. msgstr ""

  378. 

  379. #: ../../../docs/configuring-playbook-bot-meowlnir.md:241

  380. msgid "If you would rather not do that, create a read-only Postgres user yourself and point Meowlnir at it with `matrix_bot_meowlnir_synapse_database_uri`."

  381. msgstr ""

  382. 

  383. #: ../../../docs/configuring-playbook-bot-meowlnir.md:243

  384. msgid "Adopting an existing Meowlnir installation"

  385. msgstr ""

  386. 

  387. #: ../../../docs/configuring-playbook-bot-meowlnir.md:245

  388. msgid "If you already run Meowlnir outside the playbook and want to bring it under this role, two things need attention before the first run."

  389. msgstr ""

  390. 

  391. #: ../../../docs/configuring-playbook-bot-meowlnir.md:247

  392. msgid "Your bots exist in Meowlnir's database but not in your `vars.yml` file, and [pruning](#bots-which-are-no-longer-declared) is on by default, so the first run would remove them. Declare them in `matrix_bot_meowlnir_bots_custom` — with `management_room_auto_create: false` and their existing rooms under `management_rooms` — or set `matrix_bot_meowlnir_bots_pruning_enabled: false`."

  393. msgstr ""

  394. 

  395. #: ../../../docs/configuring-playbook-bot-meowlnir.md:249

  396. msgid "If the installation uses encryption, also copy the `pickle_key` from its old configuration file into `matrix_bot_meowlnir_config_encryption_pickle_key`. The crypto store cannot be read with a different key than it was written with, so leaving the playbook's default in place costs your bots their existing encryption sessions."

  397. msgstr ""

  398. 

  399. #: ../../../docs/configuring-playbook-bot-meowlnir.md:251

  400. msgid "Extending the configuration"

  401. msgstr ""

  402. 

  403. #: ../../../docs/configuring-playbook-bot-meowlnir.md:253

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

  405. msgstr ""

  406. 

  407. #: ../../../docs/configuring-playbook-bot-meowlnir.md:255

  408. msgid "Take a look at:"

  409. msgstr ""

  410. 

  411. #: ../../../docs/configuring-playbook-bot-meowlnir.md:257

  412. msgid "`roles/custom/matrix-bot-meowlnir/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_meowlnir_configuration_extension_yaml` variable"

  413. msgstr ""

  414. 

  415. #: ../../../docs/configuring-playbook-bot-meowlnir.md:260

  416. msgid "Do not set any of Meowlnir's secrets to the literal value `generate`. Meowlnir re-runs its configuration upgrader on every start, so a `generate` placeholder would produce a brand new secret on every restart. The playbook derives stable values for you, and fails the run if it finds a `generate` placeholder."

  417. msgstr ""

  418. 

  419. #: ../../../docs/configuring-playbook-bot-meowlnir.md:262

  420. msgid "Installing"

  421. msgstr ""

  422. 

  423. #: ../../../docs/configuring-playbook-bot-meowlnir.md:264

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

  425. msgstr ""

  426. 

  427. #: ../../../docs/configuring-playbook-bot-meowlnir.md:270

  428. msgid "With `management_room_auto_create`, you then have an invitation waiting for you — accept it and start sending commands. If you supplied the management room yourself, carry on from step 3 of [Supplying your own management room](#supplying-your-own-management-room): invite the bot, then give it power level 50 or more."

  429. msgstr ""

  430. 

  431. #: ../../../docs/configuring-playbook-bot-meowlnir.md:272

  432. msgid "**Notes**:"

  433. msgstr ""

  434. 

  435. #: ../../../docs/configuring-playbook-bot-meowlnir.md:274

  436. msgid "The `ensure-matrix-users-created` tag is what creates the bots declared in `matrix_bot_meowlnir_bots_custom`, registers their management rooms, and removes the ones you no longer declare. It deliberately does not run as part of `setup-all`, so that installing onto a server whose database you are about to restore from a backup does not write anything."

  437. msgstr ""

  438. 

  439. #: ../../../docs/configuring-playbook-bot-meowlnir.md:276

  440. msgid "Re-running is safe and idempotent, so adding a bot later is a matter of extending the list and running the same command again."

  441. msgstr ""

  442. 

  443. #: ../../../docs/configuring-playbook-bot-meowlnir.md:278

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

  445. msgstr ""

  446. 

  447. #: ../../../docs/configuring-playbook-bot-meowlnir.md:280

  448. msgid "Usage"

  449. msgstr ""

  450. 

  451. #: ../../../docs/configuring-playbook-bot-meowlnir.md:282

  452. msgid "You can refer to the upstream [documentation](https://docs.mau.fi/meowlnir/) for a more detailed usage guide."

  453. msgstr ""

  454. 

  455. #: ../../../docs/configuring-playbook-bot-meowlnir.md:284

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

  457. msgstr ""

  458. 

  459. #: ../../../docs/configuring-playbook-bot-meowlnir.md:286

  460. msgid "Inspecting and driving Meowlnir directly"

  461. msgstr ""

  462. 

  463. #: ../../../docs/configuring-playbook-bot-meowlnir.md:288

  464. msgid "The playbook drives Meowlnir's management API for you based on `matrix_bot_meowlnir_bots_custom`, which is the recommended way. For anything it does not cover, helper scripts are installed under `/matrix/meowlnir/bin`, which find the management secret and reach the API inside the container:"

  465. msgstr ""

  466. 

  467. #: ../../../docs/configuring-playbook-bot-meowlnir.md:301

  468. msgid "`meowlnir-create-management-room` prints the new room's ID, which you then register with `meowlnir-api PUT /_meowlnir/v1/management_room/<room ID>`."

  469. msgstr ""

  470. 

  471. #: ../../../docs/configuring-playbook-bot-meowlnir.md:303

  472. msgid "See the upstream [bot creation documentation](https://docs.mau.fi/meowlnir/bot-create.html) for the full set of endpoints. Bear in mind that bots you create this way are not declared in your `vars.yml` file, so the next playbook run will remove them again (see [Bots which are no longer declared](#bots-which-are-no-longer-declared))."

  473. msgstr ""

  474. 

  475. #: ../../../docs/configuring-playbook-bot-meowlnir.md:305

  476. msgid "If you have enabled encryption, each bot also needs verifying once. That step is left manual because it returns a recovery key you need to store somewhere safe:"

  477. msgstr ""

  478. 

  479. #: ../../../docs/configuring-playbook-bot-meowlnir.md:311

  480. msgid "Protecting a room"

  481. msgstr ""

  482. 

  483. #: ../../../docs/configuring-playbook-bot-meowlnir.md:313

  484. msgid "Invite the bot to a room, give it a power level high enough to act (see below), and then tell it to protect the room by sending this command to its management room:"

  485. msgstr ""

  486. 

  487. #: ../../../docs/configuring-playbook-bot-meowlnir.md:319

  488. msgid "Meowlnir refuses to protect a room unless its power level reaches that room's own `ban` and `redact` levels (50 in a default room). That is only enough for user bans, though: writing `m.room.server_acl` usually requires 100, and without it the server rules in your watched lists have no effect — which is most of what a list like [CME](https://matrix.to/#/%23community-moderation-effort-bl:neko.dev) carries. **Give the bot power level 100** unless you only care about user bans."

  489. msgstr ""

  490. 

  491. #: ../../../docs/configuring-playbook-bot-meowlnir.md:321

  492. msgid "Set the power level *before* protecting the room. Meowlnir re-sends server ACLs when it starts and when a watched list changes, but not when its own power level goes up subsequently, so raising it afterwards leaves the room without ACLs until you restart the bot (`systemctl restart matrix-bot-meowlnir` or via the playbook's Ansible `start` tag)."

  493. msgstr ""

  494. 

  495. #: ../../../docs/configuring-playbook-bot-meowlnir.md:323

  496. msgid "Subscribing to a policy list"

  497. msgstr ""

  498. 

  499. #: ../../../docs/configuring-playbook-bot-meowlnir.md:325

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

  501. msgstr ""

  502. 

  503. #: ../../../docs/configuring-playbook-bot-meowlnir.md:327

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

  505. msgstr ""

  506. 

  507. #: ../../../docs/configuring-playbook-bot-meowlnir.md:328

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

  509. msgstr ""

  510. 

  511. #: ../../../docs/configuring-playbook-bot-meowlnir.md:330

  512. msgid "Subscribe to one by sending the following command to the management room:"

  513. msgstr ""

  514. 

  515. #: ../../../docs/configuring-playbook-bot-meowlnir.md:336

  516. msgid "The last argument is a shortcode, which you use to refer to the list in later commands."

  517. msgstr ""

  518. 

  519. #: ../../../docs/configuring-playbook-bot-meowlnir.md:338

  520. msgid "Overriding a policy from someone else's list"

  521. msgstr ""

  522. 

  523. #: ../../../docs/configuring-playbook-bot-meowlnir.md:340

  524. msgid "This is the main capability Meowlnir has that Draupnir does not."

  525. msgstr ""

  526. 

  527. #: ../../../docs/configuring-playbook-bot-meowlnir.md:342

  528. msgid "When several watched lists carry a policy for the same user, **the first match wins**, and \"first\" means the order in which the lists are watched. So to be able to override a community list's ban, your own list has to come before it."

  529. msgstr ""

  530. 

  531. #: ../../../docs/configuring-playbook-bot-meowlnir.md:344

  532. msgid "`!lists subscribe` appends, which makes subscription order the precedence order. Subscribe to your own list first, and to community lists afterwards:"

  533. msgstr ""

  534. 

  535. #: ../../../docs/configuring-playbook-bot-meowlnir.md:352

  536. msgid "If you have already subscribed in the wrong order, fixing it means editing the `fi.mau.meowlnir.watched_lists` state event in the management room by hand. Newer Meowlnir releases (than `v0.2606.0`) add `!lists subscribe … --insert-before <shortcode>`, which will make reordering a single command."

  537. msgstr ""

  538. 

  539. #: ../../../docs/configuring-playbook-bot-meowlnir.md:354

  540. msgid "You can then publish an unban policy into your own list, which takes precedence over the community list's ban:"

  541. msgstr ""

  542. 

  543. #: ../../../docs/configuring-playbook-bot-meowlnir.md:361

  544. msgid "Unlike `!ban`, the `!add-unban` command does not treat its reason as a trailing argument, so a reason containing spaces is discarded. Use a single word (or hyphenate) until that is fixed upstream."

  545. msgstr ""

  546. 

  547. #: ../../../docs/configuring-playbook-bot-meowlnir.md:364

  548. msgid "An unban policy stops a ban from being **re-applied**; it does not undo one that is already in place unless Meowlnir applied it itself and still has it on record. A ban placed by a human moderator, or by the Draupnir or Mjolnir you are migrating away from, stays. Unban such a user once by hand — from then on the policy keeps them unbanned, while you remain subscribed to the list that banned them."

  549. msgstr ""

  550. 

  551. #: ../../../docs/configuring-playbook-bot-meowlnir.md:366

  552. msgid "Use `!match @alice:example.com` to see which policies currently apply to a user and which list each came from."

  553. msgstr ""

  554. 

  555. #: ../../../docs/configuring-playbook-bot-meowlnir.md:369

  556. msgid "Unban policies use a Meowlnir-specific recommendation (`fi.mau.meowlnir.unban`) which is not part of the Matrix specification. If you publish your policy list for other people to subscribe to, subscribers running Draupnir or Mjolnir will ignore your unban policies."

  557. msgstr ""

  558. 

  559. #: ../../../docs/configuring-playbook-bot-meowlnir.md:371

  560. msgid "There is also a blunter, server-wide escape hatch for policies that are too wide to tolerate at all — `matrix_bot_meowlnir_config_meowlnir_hacky_rule_filter_custom`, which makes Meowlnir ignore any policy matching the listed entities."

  561. msgstr ""

  562. 

  563. #: ../../../docs/configuring-playbook-bot-meowlnir.md:373

  564. msgid "Troubleshooting"

  565. msgstr ""

  566. 

  567. #: ../../../docs/configuring-playbook-bot-meowlnir.md:375

  568. msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by running a command like `journalctl -fu matrix-bot-meowlnir`."

  569. msgstr ""

  570. 

  571. #: ../../../docs/configuring-playbook-bot-meowlnir.md:377

  572. msgid "If bots appear to do nothing, check that they have an Administrator power level in the rooms they are meant to protect, and that the room has been added with `!rooms protect`."

  573. msgstr ""

  574. 

  575. #: ../../../docs/configuring-playbook-bot-meowlnir.md:379

  576. msgid "If commands in a management room get no reply at all, check the bot's power level *there* too — it needs at least 50 to record its own configuration."

  577. msgstr ""

  578. 

  579. #: ../../../docs/configuring-playbook-bot-meowlnir.md:381

  580. msgid "A bare `!lists` returns nothing in a management room which has never had a policy list. That is an upstream bug and it clears as soon as you subscribe to one; `!lists subscribe` works from the start."

  581. msgstr ""