NVR with realtime local object detection for IP cameras
Go to file
Josh Hawkins ed1e3a7c9a
Enhance user roles to limit camera access (#20024)
* update config for roles and add validator

* ensure admin and viewer are never overridden

* add class method to user to retrieve all allowed cameras

* enforce config roles in auth api endpoints

* add camera access api dependency functions

* protect review endpoints

* protect preview endpoints

* rename param name for better fastapi injection matching

* remove unneeded

* protect export endpoints

* protect event endpoints

* protect media endpoints

* update auth hook for allowed cameras

* update default app view

* ensure anonymous user always returns all cameras

* limit cameras in explore

* cameras is already a list

* limit cameras in review/history

* limit cameras in live view

* limit cameras in camera groups

* only show face library and classification in sidebar for admin

* remove check in delete reviews

since admin role is required, no need to check camera access. fixes failing test

* pass request with camera access for tests

* more async

* camera access tests

* fix proxy auth tests

* allowed cameras for review tests

* combine event tests and refactor for camera access

* fix post validation for roles

* don't limit roles in create user dialog

* fix triggers endpoints

no need to run require camera access dep since the required role is admin

* fix type

* create and edit role dialogs

* delete role dialog

* fix role change dialog

* update settings view for roles

* i18n changes

* minor spacing tweaks

* docs

* use badges and camera name label component

* clarify docs

* display all cameras badge for admin and viewer

* i18n fix

* use validator to prevent reserved and empty roles from being assigned

* split users and roles into separate tabs in settings

* tweak docs

* clarify docs

* change icon

* don't memoize roles

always recalculate on component render
2025-09-12 05:19:29 -06:00
.cspell Fixes (#18304) 2025-05-19 14:43:22 -06:00
.devcontainer Initial implementation of D-FINE model via ONNX (#16772) 2025-02-24 08:56:01 -07:00
.github update bug report discussion template (#19670) 2025-08-20 15:10:24 -05:00
.vscode Fix vscode launch configuration (#13795) 2024-09-17 10:42:10 -05:00
config Improve the devcontainer experience (#3492) 2022-11-20 07:34:12 -06:00
docker Merge remote-tracking branch 'origin/master' into dev 2025-09-04 06:33:22 -05:00
docs Enhance user roles to limit camera access (#20024) 2025-09-12 05:19:29 -06:00
frigate Enhance user roles to limit camera access (#20024) 2025-09-12 05:19:29 -06:00
migrations Semantic Search Triggers (#18969) 2025-08-16 10:20:33 -05:00
notebooks Update YOLO_NAS_Pretrained_Export.ipynb (#19669) 2025-08-20 14:59:43 -05:00
web Enhance user roles to limit camera access (#20024) 2025-09-12 05:19:29 -06:00
.dockerignore Improve the devcontainer experience (#3492) 2022-11-20 07:34:12 -06:00
.gitignore Removed usage of PyYAML for config parsing. (#13883) 2024-09-22 10:56:57 -05:00
.pylintrc
audio-labelmap.txt Audio events (#6848) 2023-07-01 08:18:33 -05:00
benchmark_motion.py use a different method for blur and contrast to reduce CPU (#6940) 2023-06-30 07:27:31 -05:00
benchmark.py Fix go2rtc init (#18708) 2025-08-16 10:20:33 -05:00
CODEOWNERS Initial support for Hailo-8L (#12431) 2024-08-29 20:19:50 -06:00
cspell.json Work through most of the cspell warnings in python (#13794) 2024-09-17 10:41:46 -05:00
docker-compose.yml Devcontainer: update Mosquitto from 1.6 to 2.0 (#17415) 2025-03-27 10:33:49 -06:00
labelmap.txt Cleanup Detector labelmap (#4932) 2023-01-06 07:03:16 -06:00
LICENSE
Makefile Enable mypy for DB and fix types (#19434) 2025-08-16 10:20:33 -05:00
netlify.toml Docs improvements (#8641) 2023-11-18 08:04:43 -06:00
package-lock.json Implement support for notifications (#12523) 2024-08-29 20:19:50 -06:00
process_clip.py Improve async object detector support (#17712) 2025-04-15 08:55:38 -05:00
pyproject.toml Fix various typing issues (#18187) 2025-05-13 08:27:20 -06:00
README_CN.md Add Chinese community sponsors (#18945) 2025-07-04 14:32:48 -05:00
README.md Small Tweaks (#17652) 2025-04-11 08:21:01 -06:00

logo

Frigate - NVR With Realtime Object Detection for IP Cameras

Translation status
English

A complete and local NVR designed for Home Assistant with AI object detection. Uses OpenCV and Tensorflow to perform realtime object detection locally for IP cameras.

Use of a GPU or AI accelerator such as a Google Coral or Hailo is highly recommended. AI accelerators will outperform even the best CPUs with very little overhead.

  • Tight integration with Home Assistant via a custom component
  • Designed to minimize resource use and maximize performance by only looking for objects when and where it is necessary
  • Leverages multiprocessing heavily with an emphasis on realtime over processing every frame
  • Uses a very low overhead motion detection to determine where to run object detection
  • Object detection with TensorFlow runs in separate processes for maximum FPS
  • Communicates over MQTT for easy integration into other systems
  • Records video with retention settings based on detected objects
  • 24/7 recording
  • Re-streaming via RTSP to reduce the number of connections to your camera
  • WebRTC & MSE support for low-latency live view

Documentation

View the documentation at https://docs.frigate.video

Donations

If you would like to make a donation to support development, please use Github Sponsors.

Screenshots

Live dashboard

Live dashboard

Streamlined review workflow

Streamlined review workflow

Multi-camera scrubbing

Multi-camera scrubbing

Built-in mask and zone editor

Multi-camera scrubbing

Translations

We use Weblate to support language translations. Contributions are always welcome.

Translation status