From 34fca0ddb249cf55190b150fc2cf413e03530fdf Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 1 Aug 2024 16:43:32 -0600 Subject: [PATCH 1/4] Update getting started docs --- docs/docs/guides/getting_started.md | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-) diff --git a/docs/docs/guides/getting_started.md b/docs/docs/guides/getting_started.md index 3b58a1d382..fde6400d6e 100644 --- a/docs/docs/guides/getting_started.md +++ b/docs/docs/guides/getting_started.md @@ -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 ``` -### 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, turning it on via the UI will not have any effect. +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. ```yaml 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). -#### 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 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. @@ -339,3 +317,4 @@ Now that you have a working install, you can use the following documentation for 2. [Home Assistant Integration](../integrations/home-assistant.md) - Integrate with Home Assistant 3. [Masks](../configuration/masks.md) 4. [Zones](../configuration/zones.md) +5. [Review](../configuration/review.md) From e7a2c41934a35134965f1c75289582711c63763f Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 1 Aug 2024 16:44:50 -0600 Subject: [PATCH 2/4] Re-arrange items --- docs/docs/guides/getting_started.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/docs/guides/getting_started.md b/docs/docs/guides/getting_started.md index fde6400d6e..af11f789c8 100644 --- a/docs/docs/guides/getting_started.md +++ b/docs/docs/guides/getting_started.md @@ -314,7 +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: 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 -3. [Masks](../configuration/masks.md) -4. [Zones](../configuration/zones.md) -5. [Review](../configuration/review.md) +2. [Zones](../configuration/zones.md) +3. [Review](../configuration/review.md) +4. [Masks](../configuration/masks.md) +5. [Home Assistant Integration](../integrations/home-assistant.md) - Integrate with Home Assistant + From 94b66389d2ebd8661a15b7371d4f8a57425ef428 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 1 Aug 2024 16:46:42 -0600 Subject: [PATCH 3/4] Update car icon --- docs/docs/configuration/cameras.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index ebe45eac4c..52361e9bf4 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -111,6 +111,6 @@ camera_groups: cameras: - driveway_cam - garage_cam - icon: car + icon: LuCar order: 0 ``` From 0afb84bd52564c2e3d21d7f8ec1af0bbfb054c83 Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 1 Aug 2024 16:49:18 -0600 Subject: [PATCH 4/4] Add warning about labelmap --- docs/docs/configuration/advanced.md | 8 ++++++++ docs/docs/configuration/{objects.mdx => objects.md} | 0 2 files changed, 8 insertions(+) rename docs/docs/configuration/{objects.mdx => objects.md} (100%) diff --git a/docs/docs/configuration/advanced.md b/docs/docs/configuration/advanced.md index 37a3b5ceb5..b237d4b662 100644 --- a/docs/docs/configuration/advanced.md +++ b/docs/docs/configuration/advanced.md @@ -80,6 +80,14 @@ model: 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. ```yaml diff --git a/docs/docs/configuration/objects.mdx b/docs/docs/configuration/objects.md similarity index 100% rename from docs/docs/configuration/objects.mdx rename to docs/docs/configuration/objects.md