mirror of
https://github.com/blakeblackshear/frigate.git
synced 2024-11-21 19:07:46 +01:00
Update docs (#12714)
This commit is contained in:
parent
c0b23ca938
commit
b28cc45510
@ -80,6 +80,14 @@ model:
|
|||||||
input_pixel_format: "bgr"
|
input_pixel_format: "bgr"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### `labelmap`
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
|
||||||
|
If the labelmap is customized then the labels used for alerts will need to be adjusted as well. See [alert labels](../configuration/review.md#restricting-alerts-to-specific-labels) for more info.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
The labelmap can be customized to your needs. A common reason to do this is to combine multiple object types that are easily confused when you don't need to be as granular such as car/truck. By default, truck is renamed to car because they are often confused. You cannot add new object types, but you can change the names of existing objects in the model.
|
The labelmap can be customized to your needs. A common reason to do this is to combine multiple object types that are easily confused when you don't need to be as granular such as car/truck. By default, truck is renamed to car because they are often confused. You cannot add new object types, but you can change the names of existing objects in the model.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -111,6 +111,6 @@ camera_groups:
|
|||||||
cameras:
|
cameras:
|
||||||
- driveway_cam
|
- driveway_cam
|
||||||
- garage_cam
|
- garage_cam
|
||||||
icon: car
|
icon: LuCar
|
||||||
order: 0
|
order: 0
|
||||||
```
|
```
|
||||||
|
@ -274,13 +274,11 @@ cameras:
|
|||||||
- 0,461,3,0,1919,0,1919,843,1699,492,1344,458,1346,336,973,317,869,375,866,432
|
- 0,461,3,0,1919,0,1919,843,1699,492,1344,458,1346,336,973,317,869,375,866,432
|
||||||
```
|
```
|
||||||
|
|
||||||
### Step 6: Enable recording and/or snapshots
|
### Step 6: Enable recordings
|
||||||
|
|
||||||
In order to see Events in the Frigate UI, either snapshots or record will need to be enabled.
|
In order to review activity in the Frigate UI, recordings need to be enabled.
|
||||||
|
|
||||||
#### Record
|
To enable recording video, add the `record` role to a stream and enable it in the config. If record is disabled in the config, it won't be possible to enable it in the UI.
|
||||||
|
|
||||||
To enable recording video, add the `record` role to a stream and enable it in the config. If record is disabled in the config, turning it on via the UI will not have any effect.
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
mqtt: ...
|
mqtt: ...
|
||||||
@ -307,26 +305,6 @@ If you don't have separate streams for detect and record, you would just add the
|
|||||||
|
|
||||||
By default, Frigate will retain video of all events for 10 days. The full set of options for recording can be found [here](../configuration/reference.md).
|
By default, Frigate will retain video of all events for 10 days. The full set of options for recording can be found [here](../configuration/reference.md).
|
||||||
|
|
||||||
#### Snapshots
|
|
||||||
|
|
||||||
To enable snapshots of your events, just enable it in the config. Snapshots are taken from the detect stream because it is the only stream decoded.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
mqtt: ...
|
|
||||||
|
|
||||||
detectors: ...
|
|
||||||
|
|
||||||
cameras:
|
|
||||||
name_of_your_camera: ...
|
|
||||||
detect: ...
|
|
||||||
record: ...
|
|
||||||
snapshots: # <----- Enable snapshots
|
|
||||||
enabled: True
|
|
||||||
motion: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
By default, Frigate will retain snapshots of all events for 10 days. The full set of options for snapshots can be found [here](../configuration/reference.md).
|
|
||||||
|
|
||||||
### Step 7: Complete config
|
### Step 7: Complete config
|
||||||
|
|
||||||
At this point you have a complete config with basic functionality. You can see the [full config reference](../configuration/reference.md) for a complete list of configuration options.
|
At this point you have a complete config with basic functionality. You can see the [full config reference](../configuration/reference.md) for a complete list of configuration options.
|
||||||
@ -336,6 +314,8 @@ At this point you have a complete config with basic functionality. You can see t
|
|||||||
Now that you have a working install, you can use the following documentation for additional features:
|
Now that you have a working install, you can use the following documentation for additional features:
|
||||||
|
|
||||||
1. [Configuring go2rtc](configuring_go2rtc.md) - Additional live view options and RTSP relay
|
1. [Configuring go2rtc](configuring_go2rtc.md) - Additional live view options and RTSP relay
|
||||||
2. [Home Assistant Integration](../integrations/home-assistant.md) - Integrate with Home Assistant
|
2. [Zones](../configuration/zones.md)
|
||||||
3. [Masks](../configuration/masks.md)
|
3. [Review](../configuration/review.md)
|
||||||
4. [Zones](../configuration/zones.md)
|
4. [Masks](../configuration/masks.md)
|
||||||
|
5. [Home Assistant Integration](../integrations/home-assistant.md) - Integrate with Home Assistant
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user