diff --git a/examples/up.conf.example b/examples/up.conf.example index 26c200ed..ecbe22c0 100644 --- a/examples/up.conf.example +++ b/examples/up.conf.example @@ -1,6 +1,6 @@ -# unifi-poller primary configuration file. # -# commented lines are defaults, uncomment to change. # -###################################################### +# unifi-poller primary configuration file. TOML FORMAT # +# commented lines are defaults, uncomment to change. # +######################################################## # If the controller has more than one site, specify which sites to poll here. # If only one site, "default" is likely the correct name. diff --git a/examples/up.json.example b/examples/up.json.example new file mode 100644 index 00000000..bc3f408b --- /dev/null +++ b/examples/up.json.example @@ -0,0 +1,15 @@ +{ + "sites": ["default"], + "interval": "30s", + "debug": false, + "quiet": false, + "max_errors": 0, + "influx_url": "http://127.0.0.1:8086", + "influx_user": "unifi", + "influx_pass": "unifi", + "influx_db": "unifi", + "unifi_user": "influxdb", + "unifi_pass": "4BB9345C-2341-48D7-99F5-E01B583FF77F", + "unifi_url": "https://127.0.0.1:8443", + "verify_ssl": false +} diff --git a/examples/up.xml.example b/examples/up.xml.example new file mode 100644 index 00000000..9054d75d --- /dev/null +++ b/examples/up.xml.example @@ -0,0 +1,16 @@ + +false +unifi +unifi +http://127.0.0.1:8086 +unifi +30s +0 +false + + default + +4BB9345C-2341-48D7-99F5-E01B583FF77F +https://127.0.0.1:8443 +influxdb +false diff --git a/examples/up.yaml.example b/examples/up.yaml.example new file mode 100644 index 00000000..502745b0 --- /dev/null +++ b/examples/up.yaml.example @@ -0,0 +1,42 @@ +# unifi-poller primary configuration file. YAML FORMAT # +# provided values are defaults # +######################################################## +--- +# If the controller has more than one site, specify which sites to poll here. +# If only one site, "default" is likely the correct name. +# Change default to all to poll all sites, no matter their names. +sites: + - default + +# The Unifi Controller only updates traffic stats about every 30 seconds. +# Setting this to something lower may lead to "zeros" in your data. You've been warned. +interval: "30s" + +# Turns on line numbers, microsecond logging, and a per-device log. +debug: false + +# Turns off per-device log and per-interval log. Logs only errors. +# Recommend using debug with this setting for better error logging. +quiet: false + +# If the poller experiences an error from the Unifi Controller or from InfluxDB +# it will exit. If you do not want it to exit, change max_errors to -1. You can +# adjust the config to tolerate more errors by setting this to a higher value. +# Recommend setting this between 0 and 5. See man page for more explanation. +max_errors: 0 + +# InfluxDB does not require auth by default, so the user/password are probably unimportant. +influx_url: "http://127.0.0.1:8086" +influx_user: "unifi" +influx_pass: "unifi" +# Be sure to create this database. +influx_db: "unifi" + +# Make a read-only user in the Unifi Admin Settings. +unifi_user: "influxdb" +unifi_pass: "" +unifi_url: "https://127.0.0.1:8443" + +# If your Unifi controller has a valid SSL certificate, you can enable +# this option to validate it. Otherwise, any SSL certificate is valid. +verify_ssl: false