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.
 
 

356 lines
12 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-alertmanager-receiver.md:1
  23. msgid ""
  24. "Setting up Prometheus Alertmanager integration via matrix-alertmanager-"
  25. "receiver (optional)"
  26. msgstr ""
  27. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:3
  28. msgid ""
  29. "The playbook can install and configure the [matrix-alertmanager-"
  30. "receiver](https://github.com/metio/matrix-alertmanager-receiver) service "
  31. "for you. It's a "
  32. "[client](https://prometheus.io/docs/alerting/latest/clients/) for "
  33. "Prometheus' "
  34. "[Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/),"
  35. " allowing you to deliver alerts to Matrix rooms."
  36. msgstr ""
  37. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:5
  38. msgid ""
  39. "See the project's [documentation](https://github.com/metio/matrix-"
  40. "alertmanager-receiver/blob/main/README.md) to learn what it does and why "
  41. "it might be useful to you."
  42. msgstr ""
  43. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:7
  44. msgid ""
  45. "This service is meant to be used with an external "
  46. "[Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) "
  47. "instance. It's **not** meant to be integrated with the [Prometheus & "
  48. "Grafana stack](./configuring-playbook-prometheus-grafana.md) installed by"
  49. " this playbook, because the Alertmanager component is not installed by "
  50. "it."
  51. msgstr ""
  52. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:9
  53. msgid "Prerequisites"
  54. msgstr ""
  55. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:11
  56. msgid "Register the bot account"
  57. msgstr ""
  58. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:13
  59. msgid ""
  60. "This service uses a bot (with a username specified in "
  61. "`matrix_alertmanager_receiver_config_matrix_user_id_localpart`) for "
  62. "delivering messages."
  63. msgstr ""
  64. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:15
  65. msgid ""
  66. "The playbook does not automatically create users for you. You **need to "
  67. "register the bot user manually** before setting up the bot."
  68. msgstr ""
  69. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:17
  70. msgid ""
  71. "Choose a strong password for the bot. You can generate a good password "
  72. "with a command like this: `pwgen -s 64 1`."
  73. msgstr ""
  74. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:19
  75. msgid "You can use the playbook to [register a new user](registering-users.md):"
  76. msgstr ""
  77. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:25
  78. msgid "Get an access token"
  79. msgstr ""
  80. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:27
  81. msgid ""
  82. "The bot requires an access token to be able to connect to your "
  83. "homeserver. Refer to the documentation on [how to obtain an access token"
  84. "](obtaining-access-tokens.md)."
  85. msgstr ""
  86. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:29
  87. msgid "Join to rooms as the bot manually"
  88. msgstr ""
  89. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:31
  90. msgid ""
  91. "ℹ️ **This bot does not accept room invitations automatically**. To "
  92. "deliver messages to rooms, the bot must be joined to all rooms manually."
  93. msgstr ""
  94. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:33
  95. msgid ""
  96. "For each new room you would like the bot to deliver alerts to, invite the"
  97. " bot to the room."
  98. msgstr ""
  99. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:35
  100. msgid ""
  101. "Then, log in as the bot using any Matrix client of your choosing, accept "
  102. "the room invitation from the bot's account, and log out."
  103. msgstr ""
  104. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:37
  105. msgid "Adjusting the playbook configuration"
  106. msgstr ""
  107. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:39
  108. msgid ""
  109. "Add the following configuration to your "
  110. "`inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to "
  111. "replace `ACCESS_TOKEN_HERE` with the one created [above](#get-an-access-"
  112. "token)."
  113. msgstr ""
  114. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:61
  115. msgid ""
  116. "See `roles/custom/matrix-alertmanager-receiver/defaults/main.yml` for "
  117. "additional configuration variables."
  118. msgstr ""
  119. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:63
  120. msgid "Adjusting the matrix-alertmanager-receiver URL"
  121. msgstr ""
  122. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:65
  123. msgid ""
  124. "By default, this playbook installs matrix-alertmanager-receiver on the "
  125. "`matrix.` subdomain, at the `/matrix-alertmanager-receiver` path "
  126. "(https://matrix.example.com/matrix-alertmanager-receiver). This makes it "
  127. "easy to install it, because it **doesn't require additional DNS records "
  128. "to be set up**. If that's okay, you can skip this section."
  129. msgstr ""
  130. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:67
  131. msgid ""
  132. "By tweaking the `matrix_alertmanager_receiver_hostname` and "
  133. "`matrix_alertmanager_receiver_path_prefix` variables, you can easily make"
  134. " the service available at a **different hostname and/or path** than the "
  135. "default one."
  136. msgstr ""
  137. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:69
  138. msgid ""
  139. "Example additional configuration for your "
  140. "`inventory/host_vars/matrix.example.com/vars.yml` file:"
  141. msgstr ""
  142. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:77
  143. msgid "Adjusting DNS records"
  144. msgstr ""
  145. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:79
  146. msgid ""
  147. "If you've changed the default hostname, **you may need to adjust your "
  148. "DNS** records to point the matrix-alertmanager-receiver domain to the "
  149. "Matrix server."
  150. msgstr ""
  151. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:81
  152. msgid "See [Configuring DNS](configuring-dns.md) for details about DNS changes."
  153. msgstr ""
  154. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:83
  155. msgid ""
  156. "If you've decided to use the default hostname, you won't need to do any "
  157. "extra DNS configuration."
  158. msgstr ""
  159. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:85
  160. msgid "Installing"
  161. msgstr ""
  162. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:87
  163. msgid ""
  164. "After configuring the playbook and potentially [adjusting your DNS "
  165. "records](#adjusting-dns-records), run the playbook with [playbook tags"
  166. "](playbook-tags.md) as below:"
  167. msgstr ""
  168. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:94
  169. msgid "**Notes**:"
  170. msgstr ""
  171. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:96
  172. msgid ""
  173. "The `ensure-matrix-users-created` playbook tag makes the playbook "
  174. "automatically create the bot's user account."
  175. msgstr ""
  176. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:98
  177. msgid ""
  178. "The shortcut commands with the [`just` program](just.md) are also "
  179. "available: `just install-all` or `just setup-all`"
  180. msgstr ""
  181. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:100
  182. msgid ""
  183. "`just install-all` is useful for maintaining your setup quickly ([2x-5x "
  184. "faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-"
  185. "runtime) than `just setup-all`) when its components remain unchanged. If "
  186. "you adjust your `vars.yml` to remove other components, you'd need to run "
  187. "`just setup-all`, or these components will still remain installed."
  188. msgstr ""
  189. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:102
  190. msgid "Usage"
  191. msgstr ""
  192. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:104
  193. msgid "Configure your Prometheus Alertmanager with configuration like this:"
  194. msgstr ""
  195. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:123
  196. msgid ""
  197. "where `URL_HERE` looks like `https://matrix.example.com/matrix-"
  198. "alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name` or "
  199. "`https://matrix.example.com/matrix-alertmanager-receiver-"
  200. "RANDOM_VALUE_HERE/alert/!qporfwt:example.com`."
  201. msgstr ""
  202. #~ msgid ""
  203. #~ "See the project's "
  204. #~ "[documentation](https://github.com/metio/matrix-alertmanager-"
  205. #~ "receiver) to learn more about what "
  206. #~ "this component does and why it "
  207. #~ "might be useful to you."
  208. #~ msgstr ""
  209. #~ msgid ""
  210. #~ "At the moment, **setting up this "
  211. #~ "service's bot requires some manual "
  212. #~ "actions** as described below in [Account"
  213. #~ " and room preparation](#account-and-"
  214. #~ "room-preparation)."
  215. #~ msgstr ""
  216. #~ msgid ""
  217. #~ "To enable matrix-alertmanager-receiver, "
  218. #~ "add the following configuration to your"
  219. #~ " `inventory/host_vars/matrix.example.com/vars.yml` file:"
  220. #~ msgstr ""
  221. #~ msgid "Account and room preparation"
  222. #~ msgstr ""
  223. #~ msgid ""
  224. #~ "The playbook can automatically create "
  225. #~ "users, but it cannot automatically "
  226. #~ "obtain access tokens, nor perform any"
  227. #~ " of the other manual actions below."
  228. #~ msgstr ""
  229. #~ msgid ""
  230. #~ "`matrix-alertmanager-receiver` uses a "
  231. #~ "bot (with a username specified in "
  232. #~ "`matrix_alertmanager_receiver_config_matrix_user_id_localpart` -"
  233. #~ " see above) for delivering messages. "
  234. #~ "You need to **manually register this "
  235. #~ "bot acccount and obtain an access "
  236. #~ "token for it**."
  237. #~ msgstr ""
  238. #~ msgid ""
  239. #~ "[Register a new user](registering-users.md):"
  240. #~ " `ansible-playbook -i inventory/hosts "
  241. #~ "setup.yml --extra-vars='username=bot.alertmanager.receiver"
  242. #~ " password=PASSWORD_FOR_THE_BOT admin=no' --tags"
  243. #~ "=register-user`"
  244. #~ msgstr ""
  245. #~ msgid ""
  246. #~ "[Obtain an access token](obtaining-access-"
  247. #~ "tokens.md) for the bot's user account"
  248. #~ msgstr ""
  249. #~ msgid "Invite the bot to a room where you'd like to alerts to be delivered"
  250. #~ msgstr ""
  251. #~ msgid ""
  252. #~ "Log in as the bot using any "
  253. #~ "Matrix client of your choosing, accept"
  254. #~ " the room invitation from the bot's"
  255. #~ " account and log out"
  256. #~ msgstr ""
  257. #~ msgid ""
  258. #~ "(Optionally) Adjust "
  259. #~ "`matrix_alertmanager_receiver_config_matrix_room_mapping` to "
  260. #~ "create a mapping between the new "
  261. #~ "room and its ID"
  262. #~ msgstr ""
  263. #~ msgid ""
  264. #~ "Steps 1 and 2 above only need "
  265. #~ "to be done once, while preparing "
  266. #~ "your [configuration](#adjusting-the-playbook-"
  267. #~ "configuration)."
  268. #~ msgstr ""
  269. #~ msgid ""
  270. #~ "Steps 3 and 4 need to be "
  271. #~ "done for each new room you'd like"
  272. #~ " the bot to deliver alerts to. "
  273. #~ "Step 5 is optional and provides "
  274. #~ "cleaner `/alert/` URLs."
  275. #~ msgstr ""
  276. #~ msgid ""
  277. #~ "Now that you've [prepared the bot "
  278. #~ "account and room](#account-and-room-"
  279. #~ "preparation), [configured the playbook"
  280. #~ "](#adjusting-the-playbook-configuration), and "
  281. #~ "potentially [adjusted your DNS records"
  282. #~ "](#adjusting-dns-records), you can run "
  283. #~ "the playbook with [playbook tags](playbook-"
  284. #~ "tags.md) as below:"
  285. #~ msgstr ""
  286. #~ msgid ""
  287. #~ ".. where `URL_HERE` looks like "
  288. #~ "`https://matrix.example.com/matrix-alertmanager-"
  289. #~ "receiver-RANDOM_VALUE_HERE/alert/some-room-name` "
  290. #~ "or `https://matrix.example.com/matrix-alertmanager-"
  291. #~ "receiver-RANDOM_VALUE_HERE/alert/!qporfwt:example.com`."
  292. #~ msgstr ""
  293. #~ msgid ""
  294. #~ "This bot does **not** accept room "
  295. #~ "invitations automatically (like many other "
  296. #~ "bots do). To deliver messages to "
  297. #~ "rooms, **the bot must be joined to"
  298. #~ " all rooms manually** - see Step "
  299. #~ "4 of the [Account and room "
  300. #~ "preparation](#account-and-room-preparation) "
  301. #~ "section."
  302. #~ msgstr ""