UnPoller Docker镜像文档

!UnPoller Logo

![]([] ![grafana]([] ![pulls]([] ![stars]([***]

![unifi]([***]

镜像概述和主要用途

UnPoller是一个轻量级Golang应用程序，用于收集UniFi控制器数据并将其报告到InfluxDB实例，或导出供Prometheus收集。该应用程序支持在Windows、macOS、FreeBSD、Linux或Docker上运行，提供了12个Grafana仪表板（6个用于InfluxDB，6个用于Prometheus），并附带截图。

核心功能和特性

• 数据收集：从UniFi控制器每30秒轮询一次测量数据
• 多输出支持：
  • InfluxDB模式：将数据导出到Influx数据库
  • Prometheus模式：打开Web端口接受Prometheus轮询
• 事件日志收集：支持Loki集成，收集UniFi事件、警报、异常和IDS数据
• 多平台支持：可在Windows、macOS、FreeBSD、Linux或Docker上运行
• 丰富的可视化：提供12个Grafana仪表板，支持数据可视化和监控
• 广泛兼容性：支持UniFi 5.12.x、5.13.x控制器及UAP、USG、USW、UDM等设备

使用场景和适用范围

UnPoller适用于任何运行UniFi控制器的网络环境，特别适合需要：

• 监控网络设备性能和状态
• 分析网络流量和用户行为
• 创建自定义网络监控仪表板
• 长期存储网络性能数据用于趋势分析
• 集成到现有监控系统（如Prometheus + Grafana或InfluxDB + Grafana）

详细使用方法和配置说明

安装方式

完整安装说明请参见官方文档。如有问题，可通过以下途径获取帮助：

• GitHub Issues
• GoLift ***服务器上的#unpoller频道
• UI社区论坛帖子

Docker部署方案

基本Docker Run命令

docker run -d \
  --name=unpoller \
  -v /path/to/config:/config \
  -p 9130:9130 \
  --restart unless-stopped \
  golift/unifi-poller

Docker Compose配置

version: '3'
services:
  unpoller:
    image: golift/unifi-poller
    container_name: unpoller
    restart: unless-stopped
    ports:
      - "9130:9130"
    volumes:
      - ./config:/config
    environment:
      - TZ=Asia/Shanghai
      - UP_UNIFI_DEFAULT_URL=[***]
      - UP_UNIFI_DEFAULT_USER=admin
      - UP_UNIFI_DEFAULT_PASS=password
      - UP_INFLUXDB_DISABLE=false
      - UP_INFLUXDB_URL=[***]
      - UP_INFLUXDB_DB=unifi
      - UP_INFLUXDB_USER=influxuser
      - UP_INFLUXDB_PASS=influxpass
      - UP_PROMETHEUS_DISABLE=false
      - UP_PROMETHEUS_LISTEN=:9130

配置参数

UnPoller主要通过配置文件或环境变量进行配置。以下是常用环境变量：

UniFi控制器配置

• UP_UNIFI_DEFAULT_URL: UniFi控制器URL
• UP_UNIFI_DEFAULT_USER: 控制器用户名
• UP_UNIFI_DEFAULT_PASS: 控制器密码
• UP_UNIFI_DEFAULT_SAVE_SITES: 保存的站点列表，逗号分隔
• UP_UNIFI_DEFAULT_SSL_SKIP_VERIFY: 是否跳过SSL验证(true/false)

InfluxDB配置

• UP_INFLUXDB_DISABLE: 是否禁用InfluxDB输出(true/false)
• UP_INFLUXDB_URL: InfluxDB URL
• UP_INFLUXDB_DB: 数据库名称
• UP_INFLUXDB_USER: InfluxDB用户名
• UP_INFLUXDB_PASS: InfluxDB密码
• UP_INFLUXDB_RETENTION: 数据保留策略

Prometheus配置

• UP_PROMETHEUS_DISABLE: 是否禁用Prometheus输出(true/false)
• UP_PROMETHEUS_LISTEN: 监听地址和端口(如:9130)

Loki配置

• UP_LOKI_DISABLE: 是否禁用Loki输出(true/false)
• UP_LOKI_URL: Loki服务URL
• UP_LOKI_TENANT_ID: Loki租户ID(如有)

操作与管理

UnPoller可以通过多种方式进行管理：

• 配置管理工具：Puppet、Chef、SaltStack
• 包管理器：Homebrew(macOS)
• 简单脚本：Bash脚本
• 容器编排：Docker Compose、Kubernetes

可视化效果

UnPoller提供12个仪表板，InfluxDB和Prometheus各6个。在官方文档网站上可以找到部分仪表板的截图。

集成服务

以下服务为该项目提供免费支持，用于存储、构建、编译、分发和文档支持：

• PackageCloud
• GitHub
• Docker Cloud
• Homebrew
• Go Lift
• Grafana

版权信息

• 版权所有 © 2018-2020 David Newhall II
• 许可证信息参见LICENSE

我们回来了！-2023