Skip to content

Commit

Permalink
Update docs to include warnings about needing record enabled in the c…
Browse files Browse the repository at this point in the history
…onfig (blakeblackshear#3045)

* Update record docs to include note for automations.

* Update config to warn about recording needing to be enabled.

* Update wording from PR comments
  • Loading branch information
NickM-27 committed Apr 2, 2022
1 parent 83481af commit 2e5d082
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,8 @@ motion:
# NOTE: Can be overridden at the camera level
record:
# Optional: Enable recording (default: shown below)
# WARNING: If recording is disabled in the config, turning it on via
# the UI or MQTT later will have no effect.
# WARNING: Frigate does not currently support limiting recordings based
# on available disk space automatically. If using recordings,
# you must specify retention settings for a number of days that
Expand Down
6 changes: 6 additions & 0 deletions docs/docs/configuration/record.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ This configuration will retain recording segments that overlap with events and h

When `retain -> days` is set to `0`, segments will be deleted from the cache if no events are in progress.

## Can I have "24/7" recordings, but only at certain times?

Using Frigate UI, HomeAssistant, or MQTT, cameras can be automated to only record in certain situations or at certain times.

**WARNING**: Recordings still must be enabled in the config. If a camera has recordings disabled in the config, enabling via the methods listed above will have no effect.

## What do the different retain modes mean?

Frigate saves from the stream with the `record` role in 10 second segments. These options determine which recording segments are kept for 24/7 recording (but can also affect events).
Expand Down

0 comments on commit 2e5d082

Please sign in to comment.