Update README.md

This commit is contained in:
moudsen 2021-03-01 20:27:13 +01:00 committed by GitHub
parent 2808544170
commit cb8d2cb546
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -7,23 +7,17 @@ Zabbix Media module and scripts for sending e-mail alerts with graphs.
Although still under development (consider the current releases "beta"), I need feedback and interaction with other users of Zabbix that are looking for the functionality I've developed hence I'm releasing my code to the world.
**List of item to-do**
1. Resolve macro information => _DROPPED_: Found out during development and testing this may expose sensitive information over the e-mail hence decided to drop this; clicking the EVENT DETAILS link takes any receiver to the corresponding Zabbix page.
2. Passing dynamic parameters via the Webhook for template/output usage => WORK IN PROGRESS, release 1.20
3. Finding "beta testers" to assist me in further enhancing the use cases => awaiting the first users/feedback!
4. Adding parameters to configure SwitftMailer configuration. Currently mailGraph assumes you have a localhost capable of processing the mail. => WORK IN PROGRESS, release 1.20
1. Passing dynamic parameters via the Webhook for template/output usage => WORK IN PROGRESS, release 1.20
2. Finding "beta testers" to assist me in further enhancing the use cases => awaiting the first users/feedback!
# Zabbix enhancements
https://support.zabbix.com/browse/ZBXNEXT-6534
Main ticket asking how to get this Media type onboarded in the Media type section of the manual and the associated Zabbix GitHub directory.
https://support.zabbix.com/browse/ZBXNEXT-6535
One of the major items that needs to be tackled is to resolve Macros that are in names, descriptions, etc. As this does work for the Trigger and TriggerPrototype I've examined the Zabbix source code and from here I would say it's quite "easy" to add the "expandXXX" flags to other types as well (found many existing functions to perform this).
I'm adding this to my testlab setup for Item and ItemPrototype and will share the outcome. If it is succesfull I will also arrange for other types (like Host) eventually giving back the additional code lines to Zabbix for incorporation into a release.
# Installation pre-requisites
The suggested installation path of this script is on the same host where Zabbix lives but outside the actual Zabbix directory, although it is possible to run the script entirely somewhere else (the code is webhook based, picking up information from Zabbix is via the front-end login and API).
I've tested my code with Zabbix 5.0.5 (LTS). Not sure if it can/will run in any versions under 5.
I've tested my code with Zabbix 5.0.5 (LTS) on Linux with local Postfix. Not sure if it can/will run in any Zabbix versions under 5 or on other environments.
# I'm assuming
- You are familiar with "composer"
@ -147,6 +141,8 @@ Values available:
{{ GRAPH_CID }} - IMG embed string (<img src="{{ GRAPH_CID }}" />)
{{ GRAPH_MATCH }} - Whether the located graph directly relates to the main trigger item or not ('Exact','Other')
{{ LOG_HTML }} - script log in HTML format
{{ LOG_PLAIN }} - script log in PLAIN text format