aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 20 insertions, 12 deletions
diff --git a/README.md b/README.md
index 6c38edf..f39e6f6 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
-This is a [Munin](http://munin-monitoring.org/) plugin to monitor your [Ubiquity Unifi](https://www.ubnt.com/products/#unifi) wireless network status.
+This is a [Munin](http://munin-monitoring.org/) plugin to monitor your [Ubiquiti Unifi](https://www.ubnt.com/products/#unifi) wireless network status.
It uses SNMP v2 to get network data.
+**The original version of this repo is aviable here: [http://git.bmrg.hu/unifi-munin.git](http://git.bmrg.hu/unifi-munin.git/)**
+
+.
+
## Usage
unifi_munin - Munin plugin to monitor UBNT unifi wireless APs
@@ -13,13 +17,17 @@ Network usage
-## Installation on Debian
+## Installing on Debian
1) Copy the **ubnt_unifi.php** into the **/usr/share/munin/plugins/** folder.
2) Set the rights:
- `chmod 755 /usr/share/munin/plugins/ubnt_unifi.php`
+
+ chmod 755 /usr/share/munin/plugins/ubnt_unifi.php
+
3) Create a symlink to this file:
- `ln -s /usr/share/munin/plugins/ubnt_unifi.php /etc/munin/plugins/ubnt_unifi`
+
+ ln -s /usr/share/munin/plugins/ubnt_unifi.php /etc/munin/plugins/ubnt_unifi
+
4) Edit the **/etc/munin/plugin-conf.d/munin-node** file, and add the following configuration lines.
5) Test the plugin with the `munin-run ubnt_unifi` command.
@@ -27,13 +35,13 @@ Network usage
The following environment variables are used:
-` [ubnt_unifi] `
-` timeout` - Munin-update timeout for this plugin.
-` env.controller` - The unifi controller hostname/ip.
-` env.devices` - A "space" separated list of the hostnames or IP addresses of wireless APs.
-` env.timeout` - The maximum timeout in milliseconds of SNMP requests. (Be careful of munin max update time!).
-` env.retry` - Number of retry after failed/time out SNMP requets.
-` env.devnetw` - The network of the APs. (It is expreimental yet.)
+ [ubnt_unifi]
+ timeout - Munin-update timeout for this plugin.
+ env.controller - The unifi controller hostname/ip.
+ env.devices - A "space" separated list of the hostnames or IP addresses of wireless APs.
+ env.timeout - The maximum timeout in milliseconds of SNMP requests. (Be careful of munin max update time!).
+ env.retry - Number of retry after failed/time out SNMP requets.
+ env.devnetw - The network of the APs. (It is expreimental yet.)
Configuration example for Munin:
@@ -52,7 +60,7 @@ Configuration example for Munin:
### AUTHOR
-Copyright (C) 2018 Gergő M.
+Copyright (C) 2018 Gergő J. Miklós.