Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minimal config in installation guide #11339

Merged
merged 4 commits into from
May 20, 2024
Merged

Minimal config in installation guide #11339

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53630be
Minimal config in installation guide (#11339)
lachlanmacphee May 11, 2024
5159b49
Add spacing between Markdown title and text
lachlanmacphee May 11, 2024
a6b4811
Remove subsection in favour of exclusively adding a warning
lachlanmacphee May 11, 2024
fcfe2e2
Adjust wording for the warning
lachlanmacphee May 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/docs/frigate/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down