mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-22 20:45:48 +00:00
162 lines
8.0 KiB
Plaintext
162 lines
8.0 KiB
Plaintext
# SOME DESCRIPTIVE TITLE.
|
||
# Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community members
|
||
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||
#
|
||
#, fuzzy
|
||
msgid ""
|
||
msgstr ""
|
||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||
"Report-Msgid-Bugs-To: \n"
|
||
"POT-Creation-Date: 2024-12-20 09:53+0200\n"
|
||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||
"MIME-Version: 1.0\n"
|
||
"Content-Type: text/plain; charset=UTF-8\n"
|
||
"Content-Transfer-Encoding: 8bit\n"
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:1
|
||
msgid "Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver (optional)"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:3
|
||
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."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:5
|
||
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."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:7
|
||
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."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:9
|
||
msgid "Prerequisites"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:11
|
||
msgid "Register the bot account"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:13
|
||
msgid "This service uses a bot (with a username specified in `matrix_alertmanager_receiver_config_matrix_user_id_localpart`) for delivering messages."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:15
|
||
msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:17
|
||
msgid "Choose a strong password for the bot. You can generate a good password with a command like this: `pwgen -s 64 1`."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:19
|
||
msgid "You can use the playbook to [register a new user](registering-users.md):"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:25
|
||
msgid "Get an access token"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:27
|
||
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)."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:29
|
||
msgid "Join to rooms as the bot manually"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:31
|
||
msgid "ℹ️ **This bot does not accept room invitations automatically**. To deliver messages to rooms, the bot must be joined to all rooms manually."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:33
|
||
msgid "For each new room you would like the bot to deliver alerts to, invite the bot to the room."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:35
|
||
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."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:37
|
||
msgid "Adjusting the playbook configuration"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:39
|
||
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](#get-an-access-token)."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:61
|
||
msgid "See `roles/custom/matrix-alertmanager-receiver/defaults/main.yml` for additional configuration variables."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:63
|
||
msgid "Adjusting the matrix-alertmanager-receiver URL"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:65
|
||
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."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:67
|
||
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."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:69
|
||
msgid "Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:77
|
||
msgid "Adjusting DNS records"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:79
|
||
msgid "If you've changed the default hostname, **you may need to adjust your DNS** records to point the matrix-alertmanager-receiver domain to the Matrix server."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:81
|
||
msgid "See [Configuring DNS](configuring-dns.md) for details about DNS changes."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:83
|
||
msgid "If you've decided to use the default hostname, you won't need to do any extra DNS configuration."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:85
|
||
msgid "Installing"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:87
|
||
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:"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:94
|
||
msgid "**Notes**:"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:96
|
||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:98
|
||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:100
|
||
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."
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:102
|
||
msgid "Usage"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:104
|
||
msgid "Configure your Prometheus Alertmanager with configuration like this:"
|
||
msgstr ""
|
||
|
||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:123
|
||
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`."
|
||
msgstr ""
|