UI Toolkit
A comprehensive suite of tools for UniFi network management and monitoring.
Note: This project is not affiliated with, endorsed by, or sponsored by Ubiquiti Inc. UniFi is a trademark of Ubiquiti Inc.
Features
Dashboard
Real-time system status including:
- Gateway Info - Model, firmware, uptime
- Resource Usage - CPU and RAM utilization
- Network Health - WAN, LAN, WLAN, VPN status with diagnostic reasons
- Connected Clients - Wired and wireless counts
- WAN Status - IP, ISP, latency, uptime (supports 3+ WANs dynamically)
- Debug Info - One-click copy of system info for issue reporting
Wi-Fi Stalker
Track specific client devices through your UniFi infrastructure.
- Device tracking by MAC address (wireless and wired)
- Roaming detection between access points
- Connection history with timestamps and CSV export
- Signal strength, radio band (2.4/5/6 GHz), and SSID tracking
- Device analytics: dwell time, favorite AP, presence pattern heatmap
- Block/unblock devices directly from the UI
- Webhook alerts (Slack, Discord, n8n) for connect, disconnect, roam, block, and unblock events
Threat Watch
Monitor IDS/IPS security events from your UniFi gateway.
- Real-time event monitoring (requires UniFi OS)
- Threat categorization and analysis
- Top attackers and targets
- Ignore rules: filter noise by IP address and severity level
- Sortable event columns and advanced filtering
- Webhook alerts (Slack, Discord, n8n)
House Arrest
Lock a device or a whole network down using UniFi's zone-based firewall. Reversible in one click, and honest about exactly what is and is not being blocked.
- Networks - Editable audit matrix of your VLANs: firewall zone, network isolation, internet access, mDNS, and DHCP DNS at a glance, with per-SSID Wi-Fi client isolation
- DNS Lockdown - Force chosen networks onto approved DNS resolvers and block everything else answering DNS (optionally DNS-over-TLS too)
- Devices - Per-device lockdown presets by MAC: Full lockdown, Internet only, or LAN only, with multi-device selection
- Blocked traffic view - See what each lockdown actually stopped, attributed to its own rules by ID
- Every change is previewed before applying, every rule carries a marker so release can only ever delete its own rules, and a lockdown that stops enforcing (MAC changed, rule disabled in UniFi) is flagged instead of shown green
- Requires the zone-based firewall (UniFi Network 9.0+ on a UniFi OS console)
See docs/HOUSE-ARREST.md for the full guide, including measured limitations.
Network Pulse
Real-time network monitoring dashboard.
- Gateway status (model, firmware, uptime, WAN)
- Device counts (total clients, wired, wireless, APs, switches)
- Chart.js visualizations (clients by band, clients by SSID, top bandwidth)
- Clickable AP cards with detailed client views
- WebSocket-powered live updates
Quick Start
Requirements
- Docker (recommended) or Python 3.9+
- Ubuntu 22.04/24.04 (or other Linux)
- UniFi OS controller (UDM, UCG, Cloud Key Gen2+). Standalone/self-hosted controllers are not supported as of v1.11.0
Local Deployment (LAN Only)
No authentication, access via http://localhost:8000
Prerequisites: Install Docker first - see docs/INSTALLATION.md
# Clone and setup
git clone https://github.com/Crosstalk-Solutions/unifi-toolkit.git
cd unifi-toolkit
./setup.sh # Select 1 for Local
# Start
docker compose up -d
Access at http://localhost:8000
Production Deployment (Internet-Facing)
Authentication enabled, HTTPS with Let's Encrypt via Caddy
Prerequisites: Install Docker first - see docs/INSTALLATION.md
# Clone and setup
git clone https://github.com/Crosstalk-Solutions/unifi-toolkit.git
cd unifi-toolkit
./setup.sh # Select 2 for Production
# Enter: domain name, admin username, password
# Open firewall ports
sudo ufw allow 80/tcp && sudo ufw allow 443/tcp
# Start with HTTPS
docker compose --profile production up -d
Access at https://your-domain.com
Documentation
Common Commands
| Action | Command |
|---|
| Start (local) | docker compose up -d |
| Start (production) | docker compose --profile production up -d |
| Stop | docker compose down |
| View logs | docker compose logs -f |
| Restart | docker compose restart |
| Reset password | ./reset_password.sh |
| Update | ./upgrade.sh |
Images are published to both GHCR (ghcr.io/crosstalk-solutions/unifi-toolkit) and Docker Hub (crosstalksolutions/unifi-toolkit), and they are identical. :latest is the release channel and only moves on tagged releases. :edge is the beta channel, rebuilt on every merge. See Running the beta channel.
Configuration
Setup Wizard (Recommended)
Run the interactive setup wizard:
./setup.sh
The wizard will:
- Generate encryption key
- Configure deployment mode (local/production)
- Set up authentication (production only)
- Create your
.env file
Manual Configuration
Copy and edit the example configuration:
cp .env.example .env
以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗
