71 lines
1.7 KiB
ReStructuredText
71 lines
1.7 KiB
ReStructuredText
cdist-type__matrix_alertmanager_receiver(7)
|
|
=====================
|
|
|
|
NAME
|
|
----
|
|
cdist-type__matrix_alertmanager_receiver - Deploy a simple Prometheus Alertmanager-to-Matrix service
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
This (singleton) type deploys `matrix-alertmanager-receiver <https://git.sr.ht/~fnux/matrix-alertmanager-receiver>`_, a simple daemon allowing Prometheus alerts to be sent to a `Matrix <https://matrix/>`_ room.
|
|
|
|
REQUIRED PARAMETERS
|
|
-------------------
|
|
homeserver
|
|
Address of the matrix homeserver to use.
|
|
|
|
room-id
|
|
ID of the (Matrix) room receiving alerts. Note that it must be the room ID:
|
|
an alias won't work!
|
|
|
|
user-id
|
|
MXID of the (Matrix) user sending alerts.
|
|
|
|
user-token
|
|
Token of the (Matrix) user sending alerts. Can be found under
|
|
Settings/Advanced in the Element web client.
|
|
|
|
OPTIONAL PARAMETERS
|
|
-------------------
|
|
host
|
|
Host to bind, defaults to `localhost`.
|
|
|
|
port
|
|
Port to listen on, defaults to `9088`.
|
|
|
|
BOOLEAN PARAMETERS
|
|
------------------
|
|
None.
|
|
|
|
EXAMPLES
|
|
--------
|
|
|
|
.. code-block:: sh
|
|
|
|
__matrix_alertmanager_receiver \
|
|
--homeserver 'https://matrix.domain.tld/' \
|
|
--room-id '!patatra:domain.tld' \
|
|
--user-id '@alerts:domain.tls' \
|
|
--user-token 'secretsecretsecret' \
|
|
--host 'localhost' \
|
|
--port 9088
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
- `Upstream <https://git.sr.ht/~fnux/matrix-alertmanager-receiver>`_
|
|
- `__prometheus_alertmanager(7)`
|
|
|
|
AUTHORS
|
|
-------
|
|
Timothée Floure <t.floure@e-durable.ch>
|
|
|
|
|
|
COPYING
|
|
-------
|
|
Copyright \(C) 2020 Timothée Floure. You can redistribute it
|
|
and/or modify it under the terms of the GNU General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|