public_git
/
unpoller_unpoller
mirror of https://github.com/unpoller/unpoller.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add description.

This commit is contained in:
David Newhall II 2019-06-14 21:51:36 -07:00
parent 320fc64533
commit df9fb0a6d6
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -3,6 +3,24 @@
Collect your Unifi Controller Data and send it to an InfluxDB instance.
Grafana dashboards included. Updated 2019.
## Description
Ubiquiti makes networking devices like switches, gateways (routers) and wireless
access points. They have a line of equipment named UniFi that uses a controller
to keep stats and make it easy to configure the network devices. This controller
can be installed on Windows, macOS and Linux. Ubiquiti also provides a dedicated
hardware devices called a CloudKey that runs the controller software.
Unifi-Poller is a smaller application that runs on macOS, Linux or Docker. It
polls your controller every 30 seconds for metric data and stores that data in
an Influx Database. A small setup with 2 APs, 1 switch, 1 gateway and 40 clients
produces nearly 3000 fields (metrics).
This application requires your controller to be running all the time. If you run
a Unifi Controller, there's no excuse not to install Influx, Grafana and this app.
You'll have a plethora of data at your fingertips and the ability to craft custom
graphs to slice the data any way you choose. Good luck!
## Installation
[See the Wiki!](https://github.com/davidnewhall/unifi-poller/wiki/Installation)