readme update

This commit is contained in:
davidnewhall2 2020-07-06 02:38:52 -07:00
parent a4da890bb0
commit 0a191071b3
1 changed files with 13 additions and 3 deletions

View File

@ -1,11 +1,21 @@
# webserver # UniFi Poller: `webserver` plugin
Built-In Web Server Go Library for UniFi Poller. **INCOMPLETE** Built-In Web Server Go Library for UniFi Poller.
Enabling the web server is optional. It provides a window into the running data. Enabling the web server is optional. It provides a window into the running data.
The web server may be secured with a simple password. SSL is also optional. The web server may be secured with a simple password. SSL is also optional.
## Interface See the [Web Server Wiki](https://github.com/unifi-poller/unifi-poller/wiki/Web-Server)
for more information about how it works.
Other plugins must import this library to make use of it. While this library is
labeled as a plugin, it's pretty much required since everything imports it.
That said, it is still disabled by default, and won't store any data unless it's
enabled.
_This needs a better godoc and examples._
## Overview
- Recent logs from poller are visible. - Recent logs from poller are visible.
- Uptime and Version are displayed across the top. - Uptime and Version are displayed across the top.