unpoller_unpoller/pkg/webserver
Cody Lee 4b19b873ab
address issue
2025-04-04 08:33:58 -05:00
..
LICENSE all to pkg 2022-12-02 20:48:01 -05:00
README.md all to pkg 2022-12-02 20:48:01 -05:00
handlers.go add integration test guard; 2023-07-31 14:40:33 -05:00
logger.go add integration test guard; 2023-07-31 14:40:33 -05:00
plugins.go address issue 2025-04-04 08:33:58 -05:00
plugins_types.go update golangci-lint, address lint issue 2024-12-31 14:12:35 -06:00
server.go add integration test guard; 2023-07-31 14:40:33 -05:00
shared.go add integration test guard; 2023-07-31 14:40:33 -05:00

README.md

UniFi Poller: webserver plugin

Built-In Web Server Go Library for UniFi Poller.

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.

See the Web Server Wiki 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.
  • Uptime and Version are displayed across the top.

Controllers

  • The web server interface allows you to see the configuration for each controller.
  • Some meta data about each controller is displayed, such as sites, clients and devices.
  • Example config: up.json.example

Input Plugins

  • You may view input plugin configuration. Currently only UniFi.
  • The example config above shows input plugin data.

Output Plugins

  • You may view output plugin configuration. Currently Prometheus and InfluxDB.
  • The example config above shows output plugin data.