From edc1884c4e4fd8a7ab6127cd937a0212af62fc64 Mon Sep 17 00:00:00 2001 From: Blake Blackshear Date: Fri, 11 Feb 2022 06:15:15 -0600 Subject: [PATCH] add warning to storage docs --- docs/docs/configuration/index.md | 5 +++++ docs/docs/installation.md | 6 ++++++ 2 files changed, 11 insertions(+) diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index 9461ec6bd..49b468143 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -217,6 +217,11 @@ motion: # NOTE: Can be overridden at the camera level record: # Optional: Enable recording (default: shown below) + # 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 + # will fit within the available disk space of your drive or Frigate + # will crash. enabled: False # Optional: Number of days to retain recordings regardless of events (default: shown below) # NOTE: This should be set to 0 and retention should be defined in events section below diff --git a/docs/docs/installation.md b/docs/docs/installation.md index c86cad0b7..48b4a6a50 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -21,6 +21,12 @@ Windows is not officially supported, but some users have had success getting it Frigate uses the following locations for read/write operations in the container. Docker volume mappings can be used to map these to any location on your host machine. +:::caution + +Note that 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 will fit within the available disk space of your drive or Frigate will crash. + +::: + - `/media/frigate/clips`: Used for snapshot storage. In the future, it will likely be renamed from `clips` to `snapshots`. The file structure here cannot be modified and isn't intended to be browsed or managed manually. - `/media/frigate/recordings`: Internal system storage for recording segments. The file structure here cannot be modified and isn't intended to be browsed or managed manually. - `/media/frigate/frigate.db`: Default location for the sqlite database. You will also see several files alongside this file while frigate is running. If moving the database location (often needed when using a network drive at `/media/frigate`), it is recommended to mount a volume with docker at `/db` and change the storage location of the database to `/db/frigate.db` in the config file.