diff --git a/doc/API/API-Docs.md b/doc/API/API-Docs.md index c6f3976d9..57dae7d06 100644 --- a/doc/API/API-Docs.md +++ b/doc/API/API-Docs.md @@ -586,8 +586,9 @@ Output: "device_id": "1", "rule": "%devices.os != \"Juniper\"", "severity": "warning", - "extra": "{\"mute\":true,\"count\":\"15\",\"delay\":null}", - "disabled": "0" + "extra": "{\"mute\":true,\"count\":\"15\",\"delay\":null,\"invert\":false}", + "disabled": "0", + "name": "A test rule" } ] } @@ -648,8 +649,9 @@ Output: "device_id": "-1", "rule": "%devices.os != \"Juniper\"", "severity": "critical", - "extra": "{\"mute\":false,\"count\":\"15\",\"delay\":\"300\"}", - "disabled": "0" + "extra": "{\"mute\":false,\"count\":\"15\",\"delay\":\"300\",\"invert\":false}", + "disabled": "0", + "name": "A test rule" }, } ``` @@ -671,6 +673,8 @@ Input (JSON): - count: This is how many polling runs before an alert will trigger and the frequency. - delay: Delay is when to start alerting and how frequently. The value is stored in seconds but you can specify minutes, hours or days by doing 5 m, 5 h, 5 d for each one. - mute: If mute is enabled then an alert will never be sent but will show up in the Web UI (true or false). + - invert: This would invert the rules check. + - name: This is the name of the rule and is mandatory. Example: @@ -705,6 +709,8 @@ Input (JSON): - count: This is how many polling runs before an alert will trigger and the frequency. - delay: Delay is when to start alerting and how frequently. The value is stored in seconds but you can specify minutes, hours or days by doing 5 m, 5 h, 5 d for each one. - mute: If mute is enabled then an alert will never be sent but will show up in the Web UI (true or false). + - invert: This would invert the rules check. + - name: This is the name of the rule and is mandatory. Example: ```curl diff --git a/doc/Extensions/Interface-Description-Parsing.md b/doc/Extensions/Interface-Description-Parsing.md index 4033ffb19..44338d38b 100644 --- a/doc/Extensions/Interface-Description-Parsing.md +++ b/doc/Extensions/Interface-Description-Parsing.md @@ -10,19 +10,19 @@ Table of Content: # About: Librenms can interpret, display and group certain additional information on ports. -For this a small `bash` script is supplied in `librenms/scripts` called `ifAlias`. +For this a small `bash` script is supplied in `scripts/` called `ifAlias`. Setup: This requires a little bit of setup on the monitored Server (Not the server running librenms!): -* Add `ifAlias` from `/path/to/librenms/scripts/` or download it from [here](#source) to the Server and make +* Add `ifAlias` from `/opt/librenms/scripts/` or download it from [here](#source) to the Server and make it executeable `chmod +x /path/to/ifAlias` * Add to `snmpd.conf` something like: ``pass .1.3.6.1.2.1.31.1.1.1.18 /path/to/ifAlias`` * Restart your `net-snmpd` -There are no changes to be made or additions to insteall for the polling librenms. +There are no changes to be made or additions to install for the polling librenms. Now you can set up your [keywords](#keywords) in your `/etc/network/interfaces` ``//Add more distributions than just Debian based`` @@ -52,4 +52,4 @@ See [examples](#examples) for formats. # Sourcecode: -* https://github.com/librenms/librenms/blob/master/scripts/ifAlias \ No newline at end of file +* https://github.com/librenms/librenms/blob/master/scripts/ifAlias diff --git a/doc/General/Credits.md b/doc/General/Credits.md index 125eb3d25..a6e1991a1 100644 --- a/doc/General/Credits.md +++ b/doc/General/Credits.md @@ -17,12 +17,18 @@ LibreNMS ships with the following software components: Other components (needs details filled in): - JpGraph (html/includes/jpgraph): QPL 1.0 license + - MIBS (mibs): unknown/various + - html/graph-realtime.php: BSD (original?) + - html/includes/collectd/: GPLv2 only + - overLIB (html/js/overlib_mini.js): modified Artistic 1.0? + - scripts/*/mysql: GPLv2 only + - check_mk (scripts/observium_agent*): GPLv2 + - qTip (html/css/jquery.qtip.min.css and html/js/qtip/jquery.qtip.min.js): GPLv2 - diff --git a/doc/General/Roadmap.md b/doc/General/Roadmap.md index acd9a1eb8..c98772ac2 100644 --- a/doc/General/Roadmap.md +++ b/doc/General/Roadmap.md @@ -6,21 +6,21 @@ but should still be useful to users. - Functionality/performance improvements: - - Investigate solutions for poller performance improvement. (Tyler) - - Investigate solutions for multiple communities per device. (tooms) - - Eliminate interface churn for transient interfaces (e.g. ppp/tun) on - net-snmp. + - Investigate solutions for poller performance improvement. (Tyler) + - Investigate solutions for multiple communities per device. (tooms) + - Eliminate interface churn for transient interfaces (e.g. ppp/tun) on + net-snmp. -- Integrate Nagios-based alerting. Allow user to choose their preferred - Nagios distribution/fork. +- ~~Integrate Nagios-based alerting. Allow user to choose their preferred + Nagios distribution/fork.~~ Alerting is now present. - Consider adding some non-monitoring administrative functions: - - enabling/disabling ports - - changing access port VLANs - - editing port labels + - enabling/disabling ports + - changing access port VLANs + - editing port labels - Integrate as many usability improvements as time permits: - - Integrate nice menus like current Observium? - - Front page: more automation; GUI configuration? + - ~~Integrate nice menus like current Observium?~~ UI Design improved + - Front page: more automation; GUI configuration? -- Improve / Change alerting system \ No newline at end of file +- ~~Improve / Change alerting system~~ Alerting is now present. diff --git a/doc/General/Welcome-to-Observium-users.md b/doc/General/Welcome-to-Observium-users.md index 31d54d362..2795f3edc 100644 --- a/doc/General/Welcome-to-Observium-users.md +++ b/doc/General/Welcome-to-Observium-users.md @@ -25,7 +25,7 @@ How LibreNMS will be different from Observium: - Development decisions will be community-driven. We want to make software that fulfills its users' needs. See the [ROADMAP][4] for more thoughts on our current plans. -- Development will probably proceed at a slower pace, at least initially. +- ~~Development will probably proceed at a slower pace, at least initially.~~ - There are no plans for a paid version, and we don't anticipate this ever changing. - There are no current plans for paid support, but this may be added later @@ -36,7 +36,7 @@ How LibreNMS will be different from Observium: Reasons why you might want to use Observium instead of LibreNMS: - You have a financial investment in Observium and aren't concerned about community contributions. -- You need functionality that has been added to Observium since r3250. +- ~~You need functionality that has been added to Observium since r3250.~~ The beauty of LibreNMS is that you can contribute missing features. - You don't like the [GNU General Public License, version 3][5] or the [philosophy of Free Software/copyleft][6] in general. @@ -45,6 +45,7 @@ Reasons why you might want to use LibreNMS instead of Observium: investment of time and effort will not be wasted][7]. - You want to add and experiment with features that are not a priority for the Observium developers. See [CONTRIBUTING][8] for more details. +- You want to make use of the additional features LibreNMS can offer. [1]: http://postman.memetic.org/pipermail/observium/2013-October/003915.html "Observium edition split announcement"