Feature/frigate#505
Open
DewaldOosthuizen wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces a new Frigate app template for Pi-Hosted, including a Docker Compose stack, a detailed documentation file, and updates to contributor workflows. The changes make it easier for users to deploy Frigate with sensible defaults and for contributors to validate their changes locally before submitting pull requests.
Why This Is Needed
Frigate is an open source network video recorder (NVR) with real-time local object detection for IP cameras. It is commonly deployed alongside Home Assistant and supports multiple camera streams, motion review, recordings, and live restreaming. There is also no existing way for new contributors to check for any linting errors across the app unless a specific IDE or editor has a built-in mechanism. To enforce a standard, we should have a common way to check any linting errors, which is why the Makefile was added.
What Changed
docs/Contributors.mdto document the new local validation workflow and encourage contributors to use it before opening a pull request.Added
template/apps/frigate.json.stack/frigate.ymlwith required volumes, environment variables, and resource limits for Frigate deployment.docs/frigate.md, covering prerequisites, configuration, hardware notes, and troubleshooting steps.lint-json,lint-yaml,ci) for validating JSON and YAML files locally, helping contributors catch errors before PR submission.Screenshots
Checklist