# Icinga Tray
This script creates a system tray icon that displays current Icinga information
and sends notifications on changes. It uses the icingaweb-API.
It runs on Linux and Windows, possibly on Mac, but that's untested.
# Installation
Install using `pip`:
```
pip install icinga-tray
```
# Configuration
At this point the configuration is done with a config file in JSON format,
no GUI available.
The file should be located here:
- Linux: `$XDG_CONFIG_HOME/icinga_tray/config.json` (default is `~/.config/icinga-tray/config.json`)
- Windows: `%USERPROFILE%\AppData\Local\icinga-tray\icinga-tray\config.json`
It should look like this:
```json
{
"base_url": "https://my.icinga.server/icingaweb2/",
"ssl_verify": "yes",
"user": "login",
"notifications": "yes",
"use_keyring": "yes",
"interval": 10000,
"host_groups": ["host_group1", "host_group2"]
}
```
- `base_url`: the URL to the icinga-Webinterface
- `ssl_verify`: whether to check for a valid ssl certificate
- `user`: the login to authenticate
- `notifications`: whether to send desktop notifications or not
- `use_keyring`: if set to yes, the credentials will be stored in the system keyring, if set to no the password needs to be entered on every launch
- `interval`: refresh interval in ms
- `host_groups`: host groups to monitor (no "all" setting or similar available at this point)
# Run
- Linux: simply run `icinga_tray` from anywhere. Make sure that the install directory is in your `PATH`
- Windows: run `icinga_tray` from a terminal or create a shortcut as target simply put `icinga_tray`, you can add it to your autostart
Raw data
{
"_id": null,
"home_page": "",
"name": "icinga-tray",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "icinga,tray,icon,monitoring,icingaweb,icinga2",
"author": "Johannes Battenberg",
"author_email": "joe@chaoticneutral.eu",
"download_url": "",
"platform": null,
"description": "# Icinga Tray\n\nThis script creates a system tray icon that displays current Icinga information\nand sends notifications on changes. It uses the icingaweb-API.\n\nIt runs on Linux and Windows, possibly on Mac, but that's untested.\n\n# Installation\nInstall using `pip`:\n```\npip install icinga-tray\n```\n\n# Configuration\nAt this point the configuration is done with a config file in JSON format,\nno GUI available.\n\nThe file should be located here:\n- Linux: `$XDG_CONFIG_HOME/icinga_tray/config.json` (default is `~/.config/icinga-tray/config.json`)\n- Windows: `%USERPROFILE%\\AppData\\Local\\icinga-tray\\icinga-tray\\config.json`\n\nIt should look like this:\n```json\n{\n \"base_url\": \"https://my.icinga.server/icingaweb2/\",\n \"ssl_verify\": \"yes\",\n \"user\": \"login\",\n \"notifications\": \"yes\",\n \"use_keyring\": \"yes\",\n \"interval\": 10000,\n \"host_groups\": [\"host_group1\", \"host_group2\"]\n}\n```\n- `base_url`: the URL to the icinga-Webinterface\n- `ssl_verify`: whether to check for a valid ssl certificate\n- `user`: the login to authenticate\n- `notifications`: whether to send desktop notifications or not\n- `use_keyring`: if set to yes, the credentials will be stored in the system keyring, if set to no the password needs to be entered on every launch\n- `interval`: refresh interval in ms\n- `host_groups`: host groups to monitor (no \"all\" setting or similar available at this point)\n\n# Run\n- Linux: simply run `icinga_tray` from anywhere. Make sure that the install directory is in your `PATH`\n- Windows: run `icinga_tray` from a terminal or create a shortcut as target simply put `icinga_tray`, you can add it to your autostart\n",
"bugtrack_url": null,
"license": "",
"summary": "A small script to display a tray icon with icinga information",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [
"icinga",
"tray",
"icon",
"monitoring",
"icingaweb",
"icinga2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b631b8f442a311c66817516b0d54833324f3715f804d0201812c277d14ad1188",
"md5": "79bcdc1d1b056ac3b5d09bba2d3b7c7a",
"sha256": "9ea62cd17f5b7acf9179ba7c64e17c5e024cc7de649f1c6e6f7a77544166a298"
},
"downloads": -1,
"filename": "icinga_tray-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79bcdc1d1b056ac3b5d09bba2d3b7c7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 69137,
"upload_time": "2023-10-20T10:38:23",
"upload_time_iso_8601": "2023-10-20T10:38:23.368764Z",
"url": "https://files.pythonhosted.org/packages/b6/31/b8f442a311c66817516b0d54833324f3715f804d0201812c277d14ad1188/icinga_tray-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-20 10:38:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "icinga-tray"
}
JSON