From 34fca0ddb249cf55190b150fc2cf413e03530fdf Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 1 Aug 2024 16:43:32 -0600 Subject: [PATCH] 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 3b58a1d38..fde6400d6 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)