mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Update UniFi Protect setup docs for permissions (#23156)
Co-authored-by: J. Nick Koston <nick@koston.org>
This commit is contained in:
parent
0e331be25c
commit
141a893fde
@ -87,32 +87,47 @@ You can replace `2.0.0-beta.5` with whatever version of UniFi Protect you want t
|
|||||||
|
|
||||||
### Local User
|
### Local User
|
||||||
|
|
||||||
You will need a local user created in your UniFi OS Console to log in with. Ubiquiti Cloud Users will **not** work.
|
You will need a local user created in your UniFi OS Console to log in with. Ubiquiti SSO Cloud Users will **not** work.
|
||||||
|
It is recommended you use the Administrator or a user with full read/write access to get the most out of the integration,
|
||||||
|
but it is not required. The entities that are created will automatically adjust based on the permissions of the user you
|
||||||
|
use has.
|
||||||
|
|
||||||
1. Login to your *Local Portal* on your UniFi OS device, and click on *Users*
|
1. Login to your _Local Portal_ on your UniFi OS device, and click on _Users_. **Note**: This **must** be done from
|
||||||
1. In the upper right corner, click on *Add User*
|
the UniFi OS by accessing it directly by IP address (i.e. _Local Portal_), not via `unifi.ui.com` or within the
|
||||||
1. Click *Add Admin*, and fill out the form. Specific Fields to pay attention to:
|
UniFi Protect app.
|
||||||
* Role: Must be *Limited Admin*
|
2. In the upper right corner, click on _Add User_.
|
||||||
* Account Type: *Local Access Only*
|
3. Fill out the fields for your user. Be sure the role you assign to the user grants them access to at least one or
|
||||||
* CONTROLLER PERMISSIONS - Under UniFi Protect, select Administrators. **NOTE**: Other roles may work, but only the default Administrators role is fully tested.
|
more UniFi Protect devices.
|
||||||
1. Click *Add* in the bottom Right.
|
4. Click _Add_ in the bottom Right.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Camera Streams
|
### Camera Streams
|
||||||
|
|
||||||
The Integration uses the RTSP(S) Streams as the Live Feed source, so this needs to be enabled on each camera to ensure you can stream your camera in Home Assistant. This may already be enabled by default, but it is recommended to just check that this is done. To check and enable the feature:
|
The Integration uses the RTSP(S) Streams as the Live Feed source, so this needs to be enabled on each camera to ensure
|
||||||
|
you can stream your camera in Home Assistant. This may already be enabled by default, but it is recommended to just
|
||||||
|
check that this is done. To check and enable the feature:
|
||||||
|
|
||||||
1. Open UniFi Protect and click on *Devices*
|
1. Open UniFi Protect and click on _Devices_.
|
||||||
1. Select *Manage* in the Menu bar at the top
|
1. Select the camera you want to ensure can stream in UniFi Protect.
|
||||||
1. Click on the + sign next to RTSP
|
1. Click the _Settings_ tab in the top right.
|
||||||
|
1. Expand the _Advanced_ section at the bottom.
|
||||||
1. Enable a minimum 1 stream out of the 3 available. The Stream with the Highest resolution is the default enabled one.
|
1. Enable a minimum 1 stream out of the 3 available. The Stream with the Highest resolution is the default enabled one.
|
||||||
|
|
||||||
{% include integrations/config_flow.md %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
All known UniFi Protect devices should be supported. Each UniFi Protect device will get a variety of entities added for each of the different entity platforms.
|
All known UniFi Protect devices should be supported. Each UniFi Protect device will get a variety of entities added for
|
||||||
|
each of the different entity platforms.
|
||||||
|
|
||||||
|
<div class='note'>
|
||||||
|
|
||||||
|
**Permissions**: The below sections on the features available to your Home Assistant instance assume you have full
|
||||||
|
write access to each device. If the user you are using has limited access to some devices, you will get fewer entities
|
||||||
|
and in many cases, get a read-only sensor instead of an editable switch/select/number entity.
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
### UniFi Protect Cameras
|
### UniFi Protect Cameras
|
||||||
|
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 47 KiB |
BIN
source/images/integrations/unifiprotect/user.png
Normal file
BIN
source/images/integrations/unifiprotect/user.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 25 KiB |
Loading…
x
Reference in New Issue
Block a user