From 0d4f9f2e76e6a7f44c3817f6183506f37e427241 Mon Sep 17 00:00:00 2001 From: Redsandro <1702193+Redsandro@users.noreply.github.com> Date: Tue, 22 Aug 2023 16:06:36 +0200 Subject: [PATCH] Update installation.md --- docs/docs/frigate/installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index 30b6f290b..c7f01f857 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -25,8 +25,8 @@ Frigate uses the following locations for read/write operations in the container. - `/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/exports`: Storage for clips and timelapses that have been exported via the WebUI or API. -- `/tmp/cache`: Cache location for recording segments. Initial recordings are written here before being checked and converted to mp4 and moved to the recordings folder. -- `/dev/shm`: It is not recommended to modify this directory or map it with docker. This is the location for raw decoded frames in shared memory and it's size is impacted by the `shm-size` calculations below. +- `/tmp/cache`: Cache location for recording segments. Initial recordings are written here before being checked and converted to mp4 and moved to the recordings folder. Segments requested for download are also concatenated and processed here. It is highly recommended to use a [`tmpfs`](https://en.wikipedia.org/wiki/Tmpfs) memory drive that can fit recorded segments for all your cameras plus the maximum size of video files you intend to download. +- `/dev/shm`: Internal cache for raw decoded frames in shared memory. It is not recommended to modify this directory or map it with docker. The minimum size is impacted by the `shm-size` calculations below. #### Common docker compose storage configurations @@ -51,7 +51,7 @@ services: Frigate utilizes shared memory to store frames during processing. The default `shm-size` provided by Docker is **64MB**. -The default shm size of **64MB** is fine for setups with **2 cameras** detecting at **720p**. If Frigate is exiting with "Bus error" messages, it is likely because you have too many high resolution cameras and you need to specify a higher shm size. +The default shm size of **64MB** is fine for setups with **2 cameras** detecting at **720p**. If Frigate is exiting with "Bus error" messages, it is likely because you have too many high resolution cameras and you need to specify a higher shm size, using [`--shm-size`](https://docs.docker.com/engine/reference/run/#runtime-constraints-on-resources) (or [`service.shm_size`](https://docs.docker.com/compose/compose-file/compose-file-v2/#shm_size) in docker-compose). The Frigate container also stores logs in shm, which can take up to **30MB**, so make sure to take this into account in your math as well.