Add some doc

This commit is contained in:
root 2019-12-27 13:48:51 +01:00
parent dc4a1d4537
commit b2b84fd353

View file

@ -1,3 +1,17 @@
# matrix-zabbix-alerting
# A simple script to notify Zabbix alert on Matrix
## Requirement
You need a Matrix Server, Chat ID and user token for this script
## Installation
- Clone this repo where you want and move `matrix-zabbix-alerting.sh` into the alertingscript's folder of Zabbix (default is `/usr/lib/zabbix/alertscripts/`).
- Copy config.sample.ini where you want (Example `/etc/matrix-zabbix.ini`) and edit it.
- Go to your Zabbix server, Administration tab, Media type and clic on "Create media type".
- Choose a name, set type to script and in "Script name" set `matrix-zabbix-alerting.sh`
- On script parameters add 3 parameters : `{ALERT.SENDTO}`, `{ALERT.SUBJECT}` and `{ALERT.MESSAGE}`
- Clic on create.
## Enjoy
A simple script to notify Zabbix alert on Matrix