UniFi Toolkit
https://github.com/crosstalk-solutions/unifi-toolkit- Category
- Developer Tools
- Rank
- No. 1380Tools index
Previous survey · No. 1385 ·
- Pricing
- Open Source
- Type
- TOOL
- Builder
- crosstalk-solutions
- GitHub
- 512 stars
- Date
About
Python toolkit for UniFi network management: scripts for bulk config, audits, and admin tasks.
What it does
UniFi Toolkit is a self-hosted browser application for observing and controlling UniFi OS networks. It combines live health dashboards, client movement tracking, IDS and IPS event monitoring, device blocking, history export, analytics, and webhook notifications.
Why it's ranked here
The appeal is unusually practical: one deployment covers everyday status checks, roaming investigations, and security-event triage. Live WebSocket updates, encrypted stored credentials, production authentication, automatic HTTPS, migrations, and documented NAS deployment make it more than a loose collection of scripts.
What's good
Wi-Fi Stalker records wired and wireless movement, signal details, dwell time, preferred access points, and presence patterns. Threat Watch adds filtering, ignore rules, attacker and target summaries, plus alerts. The setup supports API keys, protects saved credentials with Fernet encryption, and offers a tested production mode with login rate limiting.
Tradeoffs
Current releases require a UniFi OS controller. Standalone Java-based and cloud-hosted controllers are unsupported. Local mode has no authentication, so it belongs only on a trusted LAN. Internet deployment requires a domain, open web ports, and Caddy. SQLite migrations include automatic repair logic that may continue after warnings, potentially leaving some features impaired.
How to use it well
Use it when you operate UniFi OS locally and want a persistent browser dashboard for troubleshooting clients, watching threats, and receiving webhook alerts. Prefer Docker and API-key authentication, keep local mode inside a trusted network, and connect remote sites through a VPN. It does not replace cloud controller access or support standalone controllers.
Technical notes+
The FastAPI assembly in app/main.py mounts three sub-applications, starts their schedulers during lifespan handling, adds authentication and security-header middleware, and exposes health, debug, and update APIs. run.py resolves secret-file environment variables, validates writable SQLite storage, runs Alembic, repairs selected missing columns, then launches Uvicorn. alembic/env.py converts the asynchronous SQLite URL for synchronous migrations. shared/cache.py provides process-local TTL caching, while shared/crypto.py encrypts controller passwords and API keys with Fernet. requirements.txt lists FastAPI, SQLAlchemy, Alembic, APScheduler, aiohttp, bcrypt, and cryptography among the runtime dependencies.
Observed
- License
- MIT
- Primary language
- Python
- Runtime
- Python 3.9 through 3.12
- Install surface
- Docker Compose, published container images, or direct installation from requirements.txt
- Interfaces
- Browser UI, FastAPI HTTP endpoints, and WebSocket live updates
- Platform support
- Linux deployment documented for Ubuntu, Synology NAS, and Unraid; container images support amd64 and arm64
- Testing structure
- The repository documents a tests directory covering authentication, caching, configuration, and encryption
Read from README.md, pyproject.toml, requirements.txt, docs/UNRAID.md, docs/SYNOLOGY.md, docs/QUICKSTART.md, docs/INSTALLATION.md, run.py, app/main.py, alembic/env.py, app/__init__.py, shared/cache.py, shared/config.py, shared/crypto.py, shared/__init__.py.
What it can do
Configure multiple UniFi devices simultaneously
Device list and configuration parameters → Updated device configurations across network
Audit UniFi network configuration
UniFi network setup → Configuration audit report with findings
Backup UniFi device configurations
UniFi devices and network credentials → Configuration backup files
Monitor UniFi network performance
UniFi controller connection → Network performance metrics and status
Automate routine UniFi administrative tasks
Administrative task scripts and parameters → Executed administrative operations
Generate UniFi network reports
UniFi network data and reporting criteria → Formatted network analysis reports
Tags
Tech Stack
Comments (0)
No comments yet
Editorially curated, with community endorsements as a secondary signal. Corrections welcome.