Mirrors/blakeblackshear.frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2024-11-21 19:07:46 +01:00
Code Issues Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Blake Blackshear 2021-12-11 14:25:35 -06:00
parent ec3c15e4a7
commit 985bd6d9bd
2 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/docs/configuration/index.md
View File

@ -229,15 +229,23 @@ record:
# will fit within the available disk space of your drive or Frigate # will fit within the available disk space of your drive or Frigate
# will crash. # will crash.
enabled: False enabled: False
# Optional: Number of days to retain recordings regardless of events (default: shown below) # Optional: Retention settings for recording
# NOTE: This should be set to 0 and retention should be defined in events section below retain:
# if you only want to retain recordings of events. # Optional: Number of days to retain recordings regardless of events (default: shown below)
retain_days: 0 # NOTE: This should be set to 0 and retention should be defined in events section below
# if you only want to retain recordings of events.
days: 0
# Optional: Mode for retention. Available options are: all, motion, and active_objects
# all - save all recording segments regardless of activity
# motion - save all recordings segments with any detected motion
# active_objects - save all recording segments with active/moving objects
# NOTE: this mode only applies when the days setting above is greater than 0
mode: all
# Optional: Event recording settings # Optional: Event recording settings
events: events:
# Optional: Maximum length of time to retain video during long events. (default: shown below) # Optional: Maximum length of time to retain video during long events. (default: shown below)
# NOTE: If an object is being tracked for longer than this amount of time, the retained recordings # NOTE: If an object is being tracked for longer than this amount of time, the retained recordings
# will be the last x seconds of the event unless retain_days under record is > 0. # will be the last x seconds of the event unless retain->days under record is > 0.
max_seconds: 300 max_seconds: 300
# Optional: Number of seconds before the event to include (default: shown below) # Optional: Number of seconds before the event to include (default: shown below)
pre_capture: 5 pre_capture: 5
@ -252,6 +260,16 @@ record:
retain: retain:
# Required: Default retention days (default: shown below) # Required: Default retention days (default: shown below)
default: 10 default: 10
# Optional: Mode for retention. (default: shown below)
# all - save all recording segments for events regardless of activity
# motion - save all recordings segments for events with any detected motion
# active_objects - save all recording segments for event with active/moving objects
#
# NOTE: If the retain mode for the camera is more restrictive than the mode configured
# here, the segments will already be gone by the time this mode is applied.
# For example, if the camera retain mode is "motion", the segments without motion are
# never stored, so setting the mode to "all" here won't bring them back.
mode: active_objects
# Optional: Per object retention days # Optional: Per object retention days
objects: objects:
person: 15 person: 15

5
docs/docs/configuration/record.md
View File

@ -14,12 +14,11 @@ If you only used clips in previous versions with recordings disabled, you can us
```yaml ```yaml
record: record:
enabled: True enabled: True
retain_days: 0
events: events:
retain: retain:
default: 10 default: 10
``` ```
This configuration will retain recording segments that overlap with events for 10 days. Because multiple events can reference the same recording segments, this avoids storing duplicate footage for overlapping events and reduces overall storage needs. This configuration will retain recording segments that overlap with events and have active tracked objects for 10 days. Because multiple events can reference the same recording segments, this avoids storing duplicate footage for overlapping events and reduces overall storage needs.
When `retain_days` is set to `0`, segments will be deleted from the cache if no events are in progress When `retain_days` is set to `0`, segments will be deleted from the cache if no events are in progress.