All apps · 0 apps

frigate

Overview

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. You cas use a integrated or dedicated GPU (Intel/AMD/Nvidia) to perform the image decoding of the input streams of your cameras. Optionally (but highly recommended), you can use multiple devices to perform the object detetion, such as a Google Coral Accelerator, Nvidia GPU, OpenVINO (Intel GPU)... See the documentation for more details about your specific hardware and needs (https://docs.frigate.video/). This is a general templeate that aims to give a fast deoplyment for every user so check all the options carefully and remove all the configurations that you are not going to use.

Readme

View on GitHub

logo

Frigate NVR™ - Realtime Object Detection for IP Cameras

[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 is highly recommended. AI accelerators will outperform even the best CPUs with very little overhead. See Frigate's supported object detectors.

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.

License

This project is licensed under the MIT License.

Code: The source code, configuration files, and documentation in this repository are available under the MIT License. You are free to use, modify, and distribute the code as long as you include the original copyright notice.
Trademarks: The "Frigate" name, the "Frigate NVR" brand, and the Frigate logo are trademarks of Frigate, Inc. and are not covered by the MIT License.

Please see our Trademark Policy for details on acceptable use of our brand assets.

Screenshots

Live dashboard

Streamlined review workflow

Multi-camera scrubbing

Built-in mask and zone editor

Translations

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

Install Frigate on Unraid in a few clicks.

Find Frigate in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Frigate Review the template variables and paths Click Install

Explore Unraid OS

Requirements

- A valid config.yml file must exist in the config directory to startup the container.
- If you are using a PCI Coral instead of a USB one, you must install first the needed drivers going to the CA app and searching for Coral-Driver (thanks to @ich777)
- If you want to use a NVidia card to image decoding and/or detection, you must first install the drivers from CA app (thanks to @ich777), add "--runtime=nvidia" as extra parameter under advanced view and set the "Nvidia Visible Devices" variable with your "GPU UUID" as the value.
- If you want to use the NVidia TensorRT ONNX Detector, you have to select the correspondig NVIDIA branch.
- If you want to use a AMD GPU to image decoding you must change driver to "radeonsi".

Related apps

Explore more like this

Explore all

Home Automation Security

Links

Projectfrigate.video Supportforums.unraid.net Registrygithub.com Templategitlab.com

Details

Repository

ghcr.io/blakeblackshear/frigate:stable

Registry

https://github.com/blakeblackshear/frigate/pkgs/container/frigate

Last Updated2023-01-07

First Seen2022-09-23

Runtime arguments

Web UI: https://[IP]:[PORT:8971]
Network: bridge
Shell: sh
Privileged: false
Extra Params: --shm-size=256m --mount type=tmpfs,target=/tmp/cache,tmpfs-size=1000000000 --restart unless-stopped

Template configuration

Config PathPathrw

Target: /config
Default: /mnt/user/appdata/frigate
Value: /mnt/user/appdata/frigate

Media pathPathrw

Target: /media/frigate
Value: /mnt/user/Media/frigate

Authenticated UI and API access without TLS. Reverse proxies should use this portPorttcp

Target: 8971
Value: 8971

RTSP restreaming portPorttcp

By default, these streams are unauthenticated. Authentication can be configured in go2rtc section of config

Target: 8554
Value: 8554

Frigate RTSP PasswordVariable

Target: FRIGATE_RTSP_PASSWORD
Value: enterpassword

Frigate+ API keyVariable

Optional: Enter the frigate+ API key or remove this if you are not using it

Target: PLUS_API_KEY

Coral TPU/NCS2 MappingDevice

Use /dev/bus/usb for USB devices and /dev/apex_0 for PCIe devices (you must install the drivers first for PCIe devices). Remove this if you are not using it

Target: /dev/bus/usb
Value: /dev/bus/usb

Intel/AMD GPU mappingDevice

Intel/AMD GPU mapping for image decode (and detection with Intel OpenVINO). Remove this if you are not using it

Value: /dev/dri/renderD128

Driver for Intel/AMD GPUsVariable

(Intel = iHD or i965 and AMD = radeonsi). Remove this if you are not using it

Target: LIBVA_DRIVER_NAME
Value: iHD

Nvidia Visible DevicesVariable

This info can be found in the NVidia driver plugin.. Only for Nvidia GPU decoding and/or detection. Remove this if you are not using it

Target: NVIDIA_VISIBLE_DEVICES
Value: YOURGPUUUID

Nvidia Driver CapabilitiesVariable

Only for Nvidia GPU decoding and/or detection. Remove this if you are not using it

Target: NVIDIA_DRIVER_CAPABILITIES
Value: compute,utility,video

WebRTC connection TCP portPorttcp

For low latency live views

Target: 8555
Value: 8555

WebRTC connection UDP portPortudp