Sign inSign up

scottibyte/unifi-statistics

By scottibyte

•Updated 8 days ago

The Unifi Statistics Utility is a top down summary dashboard for your Ubiquiti Unifi Gateway.

Image
Networking
Monitoring & observability
0

5.6K

scottibyte/unifi-statistics repository overview

⁠UniFi Statistics

A modern real-time UniFi network awareness dashboard developed by ScottiBYTE.

UniFi Statistics consolidates gateway health, WAN status, client activity, infrastructure health, application versions, available updates, release channels, and historical performance into one lightweight dashboard.


⁠Dashboard Overview

UniFi Statistics v2.4.0 Dashboard


⁠Features

  • Consolidated gateway, WAN, client, and infrastructure health
  • Live WAN throughput, CPU, memory, uptime, and Internet status
  • Recently detected, offline, returned, and unnamed client tracking
  • Combined Recent Network Activity view
  • UniFi device firmware and poor Wi-Fi client warnings
  • Access-point client, channel, and utilization statistics
  • Top network talkers with traffic-counter fallback for controllers that omit live client rates
  • Named network ranges with normalized CIDR notation
  • Configurable automatic dashboard refresh interval, including Off
  • Client classification
  • Collapsible historical charts and network configuration details
  • Installed UniFi application version and available-update display
  • UniFi release-channel identification
  • Platform-aware links to applicable UniFi Community release notes
  • Support for integrated UniFi consoles and self-hosted UniFi OS with externally managed UXG gateways
  • Manual refresh with forced application-version recheck
  • Persistent local history, cache, and baseline data
  • Read-only UniFi API interaction
  • Docker deployment support

⁠Latest Release: v2.4.0

Docker image:

docker pull scottibyte/unifi-statistics:v2.4.0

Or use the latest tag:

docker pull scottibyte/unifi-statistics:latest
⁠Network visibility
  • Top Talkers can derive traffic rates from changes in client byte counters when a controller does not provide live-rate fields.
  • Network ranges are read from the connected UniFi site rather than a hardcoded fallback subnet.
  • Each configured network is displayed with its name and CIDR range.
  • IPv4 interface addresses are normalized to their network CIDR ranges.
  • Individual IPv6 addresses such as ::2 are excluded from the network-range listing.
⁠Dashboard controls and layout
  • Added a Refresh every selector for 15 seconds, 30 seconds, 1 minute, 2 minutes, 5 minutes, or Off.
  • The chosen refresh interval persists in the browser; manual Refresh remains available.
  • Rebalanced the Details row so Network Summary has more room and the network list uses two columns.
  • Grouped DHCP, ISP, WAN, and gateway facts beneath the configured networks.
⁠Compatibility
  • Existing configuration, persistent client data, baselines, and history remain compatible.
  • No new environment variables are required.
⁠Full Release Notes

Full v2.4.0 release notes⁠


⁠Quick Start

⁠Create .env
UNIFI_URL=https://192.168.1.1
UNIFI_USERNAME=your_username
UNIFI_PASSWORD='your_password_here'
UNIFI_SITE=default
PORT=3050

Passwords containing $ symbols should be wrapped in single quotes.

⁠Create docker-compose.yml
services:
  unifi-statistics:
    image: scottibyte/unifi-statistics:v2.4.0
    container_name: unifi-statistics
    restart: unless-stopped

    ports:
      - "80:3050"

    env_file:
      - .env

    volumes:
      - ./data:/app/data
⁠Deploy
docker compose up -d

Access the dashboard at:

http://SERVER-IP/

⁠Update an Existing Deployment

If the Compose file uses latest:

docker compose pull
docker compose up -d

If it uses a versioned tag, change the image tag to v2.4.0, then run the same commands.


⁠Data Storage

Persistent application data is stored in:

./data

This directory may contain release-link cache and override files along with dashboard history and baseline data. No additional config.json file is required.


⁠Docker Tags

TagDescription
latestCurrent production build
v2.4.0Traffic-counter fallback, named network ranges, and configurable refresh
v2.3.0Platform-aware release links, self-hosted UniFi OS and UXG support, and consolidated dashboard redesign
v2.2.0Update availability and release-channel awareness
v2.1.2Login reliability and hardware-family release-link improvements
v2.1.1Release-note resolver and dashboard refresh stability
v1.0Initial stable release

⁠Previous Releases

⁠v2.3.0
  • Discovered hardware-family-specific UniFi OS release links and validated cached URLs.
  • Added self-hosted UniFi OS and externally managed UXG version support.
  • Consolidated gateway, client, infrastructure, and recent activity into a refreshed dashboard.
  • Moved historical charts and configuration details into an expandable section.

Full v2.3.0 release notes⁠

⁠v2.2.0
  • Added available-update detection and release-channel identification.
  • Added installed-to-available version indicators to application pills.
  • Added forced application-version refresh and summary API data.
  • Improved version normalization and hardware-family release resolution.
  • Added persistent release URL overrides to the Docker image.

Full v2.2.0 release notes⁠

⁠v2.1.2
  • Improved UniFi login, session caching, rate-limit backoff, and expired-session recovery.
  • Added hardware-family-aware release discovery with persistent local caching.
  • Prevented stale release UUID reuse after version or hardware-family changes.

Full v2.1.2 release notes⁠

⁠v2.1.1
  • Removed unsafe hardcoded UniFi OS release UUID behavior.
  • Added exact release-note resolution and Chromium fallback discovery.
  • Reduced dashboard movement and overlapping refresh operations.

Full v2.1.1 release notes⁠



⁠Community Support

Need help with UniFi Statistics, Docker deployment, Incus profile management, container creation, or other ScottiBYTE utilities?

Join the ScottiBYTE Rocket.Chat community⁠

New users can start in #general. Use GitHub Issues for bugs and feature requests, and Rocket.Chat for quick questions and community discussion.

Tag summary

Content type

Image

Digest

sha256:ce398834c…

Size

377.1 MB

Last updated

8 days ago

docker pull scottibyte/unifi-statistics