# 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 , YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2024-12-20 07:23+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \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) to learn more about what this component does and why it might be useful to you." msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:7 msgid "At the moment, **setting up this service's bot requires some manual actions** as described below in [Account and room preparation](#account-and-room-preparation)." msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:9 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:11 msgid "Adjusting the playbook configuration" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:13 msgid "To enable matrix-alertmanager-receiver, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:36 msgid "See `roles/custom/matrix-alertmanager-receiver/defaults/main.yml` for additional configuration variables." msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:38 msgid "Adjusting the matrix-alertmanager-receiver URL" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:40 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:42 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:44 msgid "Example additional configuration for your `inventory/host_vars/matrix.example.com/vars.yml` file:" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:52 msgid "Adjusting DNS records" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:54 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:56 msgid "See [Configuring DNS](configuring-dns.md) for details about DNS changes." msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:58 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:60 msgid "Account and room preparation" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:62 msgid "The playbook can automatically create users, but it cannot automatically obtain access tokens, nor perform any of the other manual actions below." msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:64 msgid "`matrix-alertmanager-receiver` uses a bot (with a username specified in `matrix_alertmanager_receiver_config_matrix_user_id_localpart` - see above) for delivering messages. You need to **manually register this bot acccount and obtain an access token for it**." msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:66 msgid "[Register a new user](registering-users.md): `ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.alertmanager.receiver password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user`" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:67 msgid "[Obtain an access token](obtaining-access-tokens.md) for the bot's user account" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:68 msgid "Invite the bot to a room where you'd like to alerts to be delivered" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:69 msgid "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:70 msgid "(Optionally) Adjust `matrix_alertmanager_receiver_config_matrix_room_mapping` to create a mapping between the new room and its ID" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:72 msgid "Steps 1 and 2 above only need to be done once, while preparing your [configuration](#adjusting-the-playbook-configuration)." msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:74 msgid "Steps 3 and 4 need to be done for each new room you'd like the bot to deliver alerts to. Step 5 is optional and provides cleaner `/alert/` URLs." msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:76 msgid "Installing" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:78 msgid "Now that you've [prepared the bot account and room](#account-and-room-preparation), [configured the playbook](#adjusting-the-playbook-configuration), and potentially [adjusted your DNS records](#adjusting-dns-records), you can run the playbook with [playbook tags](playbook-tags.md) as below:" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:85 msgid "**Notes**:" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:87 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:89 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:91 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:93 msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:95 msgid "Configure your Prometheus Alertmanager with configuration like this:" msgstr "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:114 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 "" #: ../../../docs/configuring-playbook-alertmanager-receiver.md:116 msgid "This bot does **not** accept room invitations automatically (like many other bots do). To deliver messages to rooms, **the bot must be joined to all rooms manually** - see Step 4 of the [Account and room preparation](#account-and-room-preparation) section." msgstr ""