Files
unpoller_unpoller/examples/up.yaml.example
T
Cody LeeandClaude Opus 5 01ac7ca2b7 refactor(unas): replace disable flag with enable, defaulting to off
`disable = false` is a double negative, and a bool named disable cannot
express opt-in anyway: it zero-values to false, so the flag was inert and
opt-in rested entirely on the device list being empty.

`enable` defaults to false and is now the real gate -- Initialize, Metrics
and DebugInput all return early unless it is set. The two existing guards
remain: an empty device list is still a no-op, and no default URL is ever
synthesized.

Configuring devices while enable is false is always a mistake, so that
combination logs one error instead of silently collecting nothing.

Adds binding tests for the flag across toml, json, yaml and UP_UNAS_ENABLE
(the env name derives from the xml tag, not the json one), plus a test that
all three shipped examples default to off. Both were verified by mutation:
breaking a struct tag or flipping an example fails the suite.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-19 09:34:02 -05:00

107 lines
2.8 KiB
Plaintext

##############################################
# UniFi Poller primary configuration file. #
# YAML FORMAT. Provided values are defaults. #
# See up.conf.example! v2 #
##############################################
---
poller:
debug: false
quiet: false
plugins: []
# log_unknown_types: false # Set to true to log unknown device types as DEBUG messages.
# By default, newer UniFi device types that aren't recognized
# are silently ignored to reduce log volume. Enable this when
# debugging or reporting new device types to developers.
prometheus:
disable: false
http_listen: "0.0.0.0:9130"
ssl_cert_path: ""
ssl_key_path: ""
report_errors: false
interval: "60s"
influxdb:
disable: false
interval: "30s"
url: "http://127.0.0.1:8086"
user: "unifipoller"
pass: "unifipoller"
db: "unifi"
verify_ssl: false
tags:
customer: abc_corp
env: prod
webserver:
enable: false
port: 37288
html_path: "/usr/local/lib/unpoller/web"
ssl_cert_path: ""
ssl_key_path: ""
max_events: 200
accounts:
captain: "$2a$04$mxw6i0LKH6u46oaLK2cq5eCTAAFkfNiRpzNbz.EyvJZZWNa2FzIlS"
datadog:
enable: false
address: localhost:8125
namespace: ""
tags:
- customer:abcdef
unifi:
dynamic: false
defaults:
url: "https://127.0.0.1:8443"
user: "unifipoller"
pass: "unifipoller"
sites:
- all
timeout: 60s
save_ids: false
save_events: false
save_alarms: false
save_anomalies: false
save_dpi: false
save_sites: true
hash_pii: false
verify_ssl: false
# Added an example for overriding the default site name.
# default_site_name_override: "My Custom Default Site"
controllers:
# Repeat the following stanza to poll multiple controllers.
- url: "https://127.0.0.1:8443"
user: "unifipoller"
pass: "unifipoller"
sites:
- all
save_ids: false
save_events: false
save_alarms: false
save_anomalies: false
save_dpi: false
save_sites: true
hash_pii: false
verify_ssl: false
# A UNAS Pro is a standalone UniFi OS console with no Network application, so it is polled
# by its own input plugin with its own credentials and host -- not as a UniFi controller.
# This section is optional: with no devices configured the plugin stays silent and inert.
#unas:
# enable: true
# defaults:
# user: "unpoller"
# pass: ""
# verify_ssl: false
# timeout: "60s"
# devices:
# # Repeat the following stanza to poll multiple UNAS consoles.
# - url: "https://192.168.1.10"
# user: "unpoller"
# pass: "unpoller"
# verify_ssl: false
# timeout: "60s"