Rev 38 | Rev 67 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
| Rev 38 | Rev 60 | ||
|---|---|---|---|
| 1 | 1 | ||
| 2 | [](https://www.viathinksoft.com/projects/vnag "VNag") |
2 | [](https://www.viathinksoft.com/projects/vnag "VNag") |
| 3 | 3 | ||
| 4 | **VNag** (**V**iaThinkSoft **Nag**ios) is a framework for PHP which allows developing plugins for Nagios-compatible systems (e.g. Icinga2), following the [development guidelines](https://nagios-plugins.org/doc/guidelines.html "development guidelines"). |
4 | **VNag** (**V**iaThinkSoft **Nag**ios) is a framework for PHP which allows developing plugins for Nagios-compatible systems (e.g. Icinga2), following the [development guidelines](https://nagios-plugins.org/doc/guidelines.html "development guidelines"). |
| 5 | 5 | ||
| 6 | The download package contains documentation, examples and many new plugins, e.g. to check WordPress installations. |
6 | The download package contains documentation, examples and many new plugins, e.g. to check WordPress installations. |
| 7 | 7 | ||
| 8 | Beside developing normal Nagios/Icinga plugins (PHP will be called via CLI), you can develop plugins which are additionally served over HTTP. |
8 | Beside developing normal Nagios/Icinga plugins (PHP will be called via CLI), you can develop plugins which are additionally served over HTTP. |
| 9 | 9 | ||
| 10 | - The plugins can be shown via a HTTP-Demon (e.g. Apache) in user's browsers. Beside the output for Nagios (Summary, Verbose information, Performance data), user-defined HTML output can be added, e.g. to complete your Nagios output with more diagrams, pictures, etc. Only one code base is required! |
10 | - The plugins can be shown via a HTTP-Demon (e.g. Apache) in user's browsers. Beside the output for Nagios (Summary, Verbose information, Performance data), user-defined HTML output can be added, e.g. to complete your Nagios output with more diagrams, pictures, etc. Only one code base is required! |
| 11 | 11 | ||
| 12 | - The web-output contains a hidden machine readable part, which can be read out with the "WebReader" plugin of VNag. The WebReader plugins reads the machine readable part and outputs the data in the output format which can be read by Nagios. This way, you can monitor things like WordPress version at systems where you have no shell access and/or without Nagios installed. |
12 | - The web-output contains a hidden machine readable part, which can be read out with the "WebReader" plugin of VNag. The WebReader plugins reads the machine readable part and outputs the data in the output format which can be read by Nagios. This way, you can monitor things like WordPress version at systems where you have no shell access and/or without Nagios installed. |
| 13 | 13 | ||
| 14 | - It is also possible to create websites which only have a machine readable part (i.e. you include your VNag output in your existing website). This machine readable part can be optionally signed and/or encrypted. |
14 | - It is also possible to create websites which only have a machine readable part (i.e. you include your VNag output in your existing website). This machine readable part can be optionally signed and/or encrypted. |
| 15 | 15 | ||
| 16 | Pre-Installed plugins |
16 | Pre-Installed plugins |
| 17 | --------------------- |
17 | --------------------- |
| 18 | 18 | ||
| 19 | VNag comes with following plugins pre-installed: |
19 | VNag comes with following plugins pre-installed: |
| 20 | 20 | ||
| 21 | - **4images_version**: Checks 4images installations for updates. |
21 | - **4images_version**: Checks 4images installations for updates. |
| - | 22 | - **aastra_430_voicemail**: Checks Aastra 430 phone system for new voicemails. |
|
| 22 | - **disk_running**: Checks if harddisks which do not have SMART capability are online |
23 | - **disk_running**: Checks if harddisks which do not have SMART capability are online |
| 23 | - **file_timestamp**: Warns when files are not modified withhin a specific interval/age. |
24 | - **file_timestamp**: Warns when files are not modified withhin a specific interval/age. |
| 24 | - **gitlab_version**: Checks GitLab install~ations for updates. |
25 | - **gitlab_version**: Checks GitLab install~ations for updates. |
| 25 | - **hp_smartarray**: Checks disk and controller status of HP SmartArray RAID controllers. |
26 | - **hp_smartarray**: Checks disk and controller status of HP SmartArray RAID controllers. |
| 26 | - **ipfm**: Checks the log files of the tool "ipfm" and warns when the measured traffic exceeds a given limit. |
27 | - **ipfm**: Checks the log files of the tool "ipfm" and warns when the measured traffic exceeds a given limit. |
| 27 | - **joomla_version**: checks Joomla installations for updates. |
28 | - **joomla_version**: checks Joomla installations for updates. |
| 28 | - **last**: Checks the output of the tool "last" and warns when logins from suspicious IP adresses are detected. |
29 | - **last**: Checks the output of the tool "last" and warns when logins from suspicious IP adresses are detected. |
| 29 | - **mdstat**: Parses the output of "/proc/mdstat" and warns when drives inside a RAID array have failed. |
30 | - **mdstat**: Parses the output of "/proc/mdstat" and warns when drives inside a RAID array have failed. |
| 30 | - **mediawiki_version**: Checks MediaWiki installations for updates. |
31 | - **mediawiki_version**: Checks MediaWiki installations for updates. |
| - | 32 | - **minecraft_java_version**: Checks the version of a local Minecraft Java server for updates. |
|
| 31 | - **net2ftp_version**: Checks net2ftp installations for updates. |
33 | - **net2ftp_version**: Checks [net2ftp](https://www.net2ftp.com/) installations for updates. |
| 32 | - **nextcloud_version**: Checks Nextcloud installations for updates. |
34 | - **nextcloud_version**: Checks Nextcloud installations for updates. |
| 33 | - **nocc_version**: Checks NOCC webmail installations for updates. |
35 | - **nocc_version**: Checks NOCC webmail installations for updates. |
| 34 | - **openbugbounty**: Checks if your domains are listed at OpenBugBounty.org. |
36 | - **openbugbounty**: Checks if your domains are listed at OpenBugBounty.org. |
| - | 37 | - **open_deleted_files**: Checks if there are deleted files which have open file handles (leaked disk space). |
|
| 35 | - **owncloud_version**: Checks ownCloud installations for updates. |
38 | - **owncloud_version**: Checks ownCloud installations for updates. |
| 36 | - **phpbb_version**: Checks phpBB installations for updates. |
39 | - **phpbb_version**: Checks phpBB installations for updates. |
| 37 | - **phpmyadmin_version**: Checks phpMyAdmin installations for updates. |
40 | - **phpmyadmin_version**: Checks phpMyAdmin installations for updates. |
| 38 | - **ping**: Pings a hostname or IP address. |
41 | - **ping**: Pings a hostname or IP address. |
| 39 | - **pmwiki_version**: Checks PmWiki installations for updates. |
42 | - **pmwiki_version**: Checks PmWiki installations for updates. |
| 40 | - **roundcube_version**: Checks RoundCube installations for updates. |
43 | - **roundcube_version**: Checks RoundCube installations for updates. |
| 41 | - **smart**: Checks the SMART attributes of harddrives and warns when bad attributes are detected. |
44 | - **smart**: Checks the SMART attributes of harddrives and warns when bad attributes are detected. |
| - | 45 | - **viewvc_version**: Checks [ViewVC](https://github.com/viewvc/viewvc/) installations for updates. |
|
| 42 | - **virtual_mem**: Checks the amount of virtual memory (physical memory + swap). |
46 | - **virtual_mem**: Checks the amount of virtual memory (physical memory + swap). |
| 43 | - **webreader**: Reads the output of another VNag plugin transferred over HTTP. |
47 | - **webreader**: Reads the output of another VNag plugin transferred over HTTP. |
| - | 48 | - **websvn_version**: Checks [WebSVN](https://github.com/websvnphp/websvn/) installations for updates. |
|
| 44 | - **wordpress_version**: Checks WordPress installations for updates. |
49 | - **wordpress_version**: Checks WordPress installations for updates. |
| 45 | - **x509_expire**: Warns when X.509 (PEM) certificate files reach a specific age. |
50 | - **x509_expire**: Warns when X.509 (PEM) certificate files reach a specific age. |
| 46 | 51 | ||
| 47 | Use-case diagrams |
52 | Use-case diagrams |
| 48 | ----------------- |
53 | ----------------- |
| 49 | 54 | ||
| 50 | 1. [Simple case](https://raw.githubusercontent.com/danielmarschall/vnag/master/doc/vnag_model_1.png "Simple case"): Nagios/CLI checks an object |
55 | 1. [Simple case](https://raw.githubusercontent.com/danielmarschall/vnag/master/doc/vnag_model_1.png "Simple case"): Nagios/CLI checks an object |
| 51 | 2. [Extended case](https://raw.githubusercontent.com/danielmarschall/vnag/master/doc/vnag_model_2.png "Extended case"): Nagios/CLI checks an object, and a user can additionally view the status in a web-browser |
56 | 2. [Extended case](https://raw.githubusercontent.com/danielmarschall/vnag/master/doc/vnag_model_2.png "Extended case"): Nagios/CLI checks an object, and a user can additionally view the status in a web-browser |
| 52 | 3. [More extended case](https://raw.githubusercontent.com/danielmarschall/vnag/master/doc/vnag_model_3.png "More extended case"): Nagios/CLI checks an object, a user can additionally view the status in a web-browser, and another Nagios/CLI instance can remotely access the output of the primary Nagios/CLI |
57 | 3. [More extended case](https://raw.githubusercontent.com/danielmarschall/vnag/master/doc/vnag_model_3.png "More extended case"): Nagios/CLI checks an object, a user can additionally view the status in a web-browser, and another Nagios/CLI instance can remotely access the output of the primary Nagios/CLI |
| 53 | 58 | ||