elie
/
zabbix-super-vision
mirror of https://github.com/outscale/zabbix-super-vision.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
kevin.francoise 2023-01-19 18:35:08 +00:00
parent 0bb2e6c698
commit b240b786e1
1 changed files with 3 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -25,44 +25,12 @@ pip3 install -r requirements.txt
```
## Usage
```
Usage: super-server.py [-h]
--zabbix_ip ZABBIX_IP
--zabbix_url ZABBIX_URL
--alert_limit ALERT_LIMIT
--zabbix_hostgroup ZABBIX_HOSTGROUP
--zabbix_min_severity ZABBIX_MIN_SEVERITY
--zabbix_login ZABBIX_LOGIN
--zabbix_pass ZABBIX_PASS
--list_zabbix_servers LIST_ZABBIX_SERVERS [LIST_ZABBIX_SERVERS ...]
--zabbix_timeout ZABBIX_TIMEOUT
--port PORT
```
Fill the settings.py file with your informations about Zabbix server IP, severity ...
| Argument | Description | Example |
| ----------- | ----------- | ----------- |
| zabbix_ip | IP/URL of the Zabbix Frontend. | 127.0.0.1:8080 |
| zabbix_url | IP/URL of the Zabbix Frontend. Used to create triggers URL. | https://zabbix.internal
| alert_limit | Number of alerts to retrieve for all hostgroups. | 2000 |
| zabbix_hostgroup | Hostgroup or Pattern | Team-* |
| zabbix_min_severity | Minimum severity to retrieve. | 3 |
| zabbix_login | Login to connect to Zabbix API. | Admin |
| zabbix_pass | Password to connect to Zabbix API. | admin |
| list_zabbix_servers | List of Zabbix server IP to check if they are running or no and display an alert on the dashboard. | 127.0.0.1:10051 |
| zabbix_timeout | Timeout call to the Zabbix API. | 30 |
| port | Listen server port. | 80 |
You can use the TV Mode :tv: to remove the menu from the page by adding /tv/ in your URL.
## Examples
_Example:_ http://127.0.0.1:8080/tv/
```
python3 super-server.py --zabbix_ip=127.0.0.1:8080 --zabbix_url='https://zabbix.internal' --alert_limit=100 --zabbix_hostgroup="Team-*" --zabbix_min_severity=3 --zabbix_login=Admin --zabbix_pass='admin' --list_zabbix_servers=127.0.0.1:10051 --zabbix_timeout=30 --port=8080
```
## Next
- [ ] Pause page reload when push on button "Add message".
- [ ] Refresh hostgroups in background not on script launch.
- [ ] Clean/rework code.
## Contributing
- If you think you've found a bug in the code or you have a question regarding the usage of this software, please reach out to us by opening an issue in this GitHub repository.