Please enter the address of your UniFi Protect controller (e.g. unvr.local or 10.0.0.1) and the login credentials for a local user to get started with homebridge-unifi-protect.
Things to keep in mind regarding UniFi Protect:
A local user account is required to use this plugin. Ubiquiti.com/UI.com accounts are not supported. You can create an account by accessing the Admins & Users tab in the UniFi console webUI.
If you have a large number of cameras, make sure you are running this plugin on a machine that has sufficient CPU resources for the best performance. The recommended configuration is to use any Apple Silicon-based macOS environment.
You may run into networking issues when using Docker-based environments. These are Homebridge-specific issues, not HBUP-specific ones. You can access the Troubleshooting documentation for more information.
To optimize performance and responsiveness, please make this plugin a child bridge once you've completed configuration.
Introduction
I hope you enjoy this plugin as much as I enjoy developing it. All my projects are labors of love. If you'd like to show your appreciation - star this project on GitHub and do some good in your community, either financially or with your time: a food bank, an animal shelter (two of my passions), or whatever resonates with you that can give something back to the world around you. If you're looking for a couple of my faves: World Central Kitchen and Best Friends.
Best Practices: best practices for getting the most of your HomeKit setup and UniFi Protect.
Troubleshooting: running into login problems or streaming issues? Give this a read before looking anywhere else.
Changelog: changes and release history of this plugin, starting with v3.0.
Additional Topics
Feature Options: granular options to allow you to set the camera quality individually, show or hide specific cameras, controllers, and more.
Autoconfiguration: how HBUP sources and selects your video (the timeshift buffer, stream selection, transcoding, and transmuxing), autoconfigures your controller, and why.
Audio Options: options to further tailor how audio is handled from Protect, such as background noise reduction.
Doorbells: how UniFi Protect doorbell support works in this plugin, and how to use all the available features including doorbell messages.
HomeKit Secure Video: how HomeKit Secure Video support works in this plugin with UniFi Protect.
Liveview Scenes: use the UniFi Protect liveviews feature (available in the UniFi Protect controller webUI) to create motion-detection scenes.
Viewports: control what a UniFi Protect Viewport displays on screen, right from HomeKit.
Your browser doesn't support features this interface requires. Please use a current version of Safari or Chrome.
The interface files couldn't be retrieved from the Homebridge server. Reload the page to try again. If this keeps happening, log out of the Homebridge interface and log back in.
An unexpected error occurred while starting the interface.
Technical details
This is taking longer than expected. If nothing appears shortly, reload the page.
