overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10858 Commits
13 Branches
36 MiB
 
 
Tree: 2d3d1f83d2
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '2d3d1f83d2'
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-alertm...

190 lines
9.6 KiB
Raw Blame History 

  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-02-13 10:32+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-alertmanager-receiver.md:9

  20. msgid "Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:11

  24. msgid "The playbook can install and configure the [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver) service for you. It's a [client](https://prometheus.io/docs/alerting/latest/clients/) for Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), allowing you to deliver alerts to Matrix rooms."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:13

  28. msgid "See the project's [documentation](https://github.com/metio/matrix-alertmanager-receiver/blob/main/README.md) to learn what it does and why it might be useful to you."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:15

  32. msgid "This service is meant to be used with an external [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) instance. It's **not** meant to be integrated with the [Prometheus & Grafana stack](./configuring-playbook-prometheus-grafana.md) installed by this playbook, because the Alertmanager component is not installed by it."

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:17

  36. msgid "Prerequisites"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:19

  40. msgid "Register the bot account"

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:21

  44. msgid "This service uses a bot (with a username specified in `matrix_alertmanager_receiver_config_matrix_user_id_localpart`) for delivering messages."

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:23

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

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:25

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

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:27

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

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:33

  60. msgid "Obtain an access token"

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:35

  64. msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:37

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

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:40

  72. msgid "Join to rooms as the bot manually"

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:42

  76. msgid "ℹ️ **This bot does not accept room invitations automatically**. To deliver messages to rooms, the bot must be joined to all rooms manually."

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:44

  80. msgid "For each new room you would like the bot to deliver alerts to, invite the bot to the room."

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:46

  84. msgid "Then, log in as the bot using any Matrix client of your choosing, accept the room invitation from the bot's account, and log out."

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:48

  88. msgid "Adjusting DNS records (optional)"

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:50

  92. msgid "By default, this playbook installs matrix-alertmanager-receiver on the `matrix.` subdomain, at the `/matrix-alertmanager-receiver` path (https://matrix.example.com/matrix-alertmanager-receiver). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section."

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:52

  96. msgid "If you wish to adjust it, see the section [below](#adjusting-the-matrix-alertmanager-receiver-url-optional) for details about DNS configuration."

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:54

  100. msgid "Adjusting the playbook configuration"

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:56

  104. msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#obtain-an-access-token)."

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:77

  108. msgid "Adjusting the matrix-alertmanager-receiver URL (optional)"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:79

  112. msgid "By tweaking the `matrix_alertmanager_receiver_hostname` and `matrix_alertmanager_receiver_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:81

  116. msgid "Example additional configuration for your `vars.yml` file:"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:89

  120. msgid "If you've changed the default hostname, you may need to create a CNAME record for the matrix-alertmanager-receiver domain (`alertmanager.example.com`), which targets `matrix.example.com`."

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:91

  124. msgid "When setting, replace `example.com` with your own."

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:93

  128. msgid "Extending the configuration"

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:95

  132. msgid "There are some additional things you may wish to configure about the component."

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:97

  136. msgid "Take a look at:"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:99

  140. msgid "`roles/custom/matrix-alertmanager-receiver/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:100

  144. msgid "`roles/custom/matrix-alertmanager-receiver/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_alertmanager_receiver_configuration_extension_yaml` variable"

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:102

  148. msgid "Installing"

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:104

  152. msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:111

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

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:113

  160. 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. Note these shortcuts run the `ensure-matrix-users-created` tag too."

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:115

  164. msgid "Usage"

  165. msgstr ""

  166. 

  167. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:117

  168. msgid "Configure your Prometheus Alertmanager with configuration like this:"

  169. msgstr ""

  170. 

  171. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:136

  172. msgid "where `URL_HERE` looks like `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name` or `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!qporfwt:example.com`."

  173. msgstr ""

  174. 

  175. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:138

  176. msgid "Troubleshooting"

  177. msgstr ""

  178. 

  179. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:140

  180. 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 logging in to the server with SSH and running `journalctl -fu matrix-alertmanager-receiver`."

  181. msgstr ""

  182. 

  183. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:142

  184. msgid "Increase logging verbosity"

  185. msgstr ""

  186. 

  187. #: ../../../docs/configuring-playbook-alertmanager-receiver.md:144

  188. msgid "The default logging level for this component is `info`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"

  189. msgstr ""