From 87d3ee09b0d0a1feefeeffaab15c058dc54c6be7 Mon Sep 17 00:00:00 2001 From: Lachlan MacPhee Date: Mon, 20 May 2024 23:55:25 +1000 Subject: [PATCH] Minimal config in installation guide (#11339) * Minimal config in installation guide (#11339) + Adds a subsection to the installation guide that mentions the requirement for a minimal config to start Frigate successfully. + Adds a warning not to proceed any further into the guide without this valid config * Add spacing between Markdown title and text Co-authored-by: Nicolas Mowen * Remove subsection in favour of exclusively adding a warning * Adjust wording for the warning Co-authored-by: Nicolas Mowen --------- Co-authored-by: Nicolas Mowen --- docs/docs/frigate/installation.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docs/frigate/installation.md b/docs/docs/frigate/installation.md index 59c196d0d..9399f775e 100644 --- a/docs/docs/frigate/installation.md +++ b/docs/docs/frigate/installation.md @@ -28,6 +28,12 @@ Frigate uses the following locations for read/write operations in the container. - `/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 generated via the `clip.mp4` endpoints are also concatenated and processed here. It is recommended to use a [`tmpfs`](https://docs.docker.com/storage/tmpfs/) mount for this. - `/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. +:::warning + +For Frigate to start, it requires a valid configuration file inside the `/config/` directory mentioned above. There is a step by step guide to creating a minimal configuration in the [getting started guide](https://docs.frigate.video/guides/getting_started#configuring-frigate). + +::: + #### Common docker compose storage configurations Writing to a local disk or external USB drive: