Frigate

https://docs.frigate.video/
Admin
A complete and local NVR designed for Home Assistant with AI object detection using OpenCV and...
Tokens:314,684
Snippets:2,531
Trust Score:9.4
Update:1 day ago
Show doc for...
Tokens:
Raw
### Setup buildx for multiarch official builds

Source: https://docs.frigate.video/development/contributing/

Commands to set up buildx for multiarch builds. The first line removes an existing builder if present. The remaining commands install binfmt, create a new builder, bootstrap it, and run make push.

```text
docker buildx stop builder && docker buildx rm builder # <---- if existing
docker run --privileged --rm tonistiigi/binfmt --install all
docker buildx create --name builder --driver docker-container --driver-opt network=host --use
docker buildx inspect builder --bootstrap
make push
```

--------------------------------

### Start local documentation development server with npm run start

Source: https://docs.frigate.video/development/contributing/

Starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.

```console
npm run start
```

--------------------------------

### Run Hailo installation script

Source: https://docs.frigate.video/frigate/installation/

Runs the installation script which installs build dependencies, builds and installs the Hailo driver, installs firmware, and sets up udev rules.

```bash
./user_installation.sh
```

--------------------------------

### Install documentation dependencies with npm install

Source: https://docs.frigate.video/development/contributing/

Run from the docs directory to install dependencies for the documentation site. Requires Node.js 20.

```console
cd docs && npm install
```

--------------------------------

### Frigate Full Configuration YAML Example

Source: https://docs.frigate.video/configuration/advanced/reference/

Complete YAML configuration for a Frigate camera setup. Includes required camera name, ffmpeg input streams with roles, optional zones with coordinates and filters. Note that environment variables must begin with 'FRIGATE_' and be referenced in {}.

```yaml
# Required
cameras:
  # Required: name of the camera
  back:
    # Optional: Enable/Disable the camera (default: shown below).
    # When False, ffmpeg is not started and the camera is hidden from the UI
    # (except Camera Management). Re-enabling requires a Frigate restart.
    enabled: True
    # Optional: camera type used for some Frigate features (default: shown below)
    # Options are "generic" and "lpr"
    type: "generic"
    # Required: ffmpeg settings for the camera
    ffmpeg:
      # Required: A list of input streams for the camera. See documentation for more information.
      inputs:
        # Required: the path to the stream
        # NOTE: path may include environment variables or docker secrets, which must begin with 'FRIGATE_' and be referenced in {}
        - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
          # Required: list of roles for this stream. valid values are: audio,detect,record
          # NOTICE: In addition to assigning the audio, detect, and record roles
          # they must also be enabled in the camera config.
          roles:
            - audio
            - detect
            - record
          # Optional: stream specific global args (default: inherit)
          # global_args:
          # Optional: stream specific hwaccel args (default: inherit)
          # hwaccel_args:
          # Optional: stream specific input args (default: inherit)
          # input_args:
      # Optional: camera specific global args (default: inherit)
      # global_args:
      # Optional: camera specific hwaccel args (default: inherit)
      # hwaccel_args:
      # Optional: camera specific input args (default: inherit)
      # input_args:
      # Optional: camera specific output args (default: inherit)
      # output_args:

    # Optional: camera specific hwaccel args for timelapse export (default: inherit)
    # record:
    #   export:
    #     hwaccel_args:

    # Optional: timeout for highest scoring image before allowing it
    # to be replaced by a newer image. (default: shown below)
    best_image_timeout: 60

    # Optional: URL to visit the camera web UI directly from the system page. Might not be available on every camera.
    webui_url: ""

    # Optional: zones for this camera
    zones:
      # Required: name of the zone
      # NOTE: This must be different than any camera names, but can match with another zone on another
      #       camera.
      front_steps:
        # Optional: A friendly name or descriptive text for the zones
        friendly_name: ""
        # Optional: Whether this zone is active (default: shown below)
        # Disabled zones are completely ignored at runtime - no object tracking or debug drawing
        enabled: True
        # Required: List of x,y coordinates to define the polygon of the zone.
        # NOTE: Presence in a zone is evaluated only based on the bottom center of the objects bounding box.
        coordinates: 0.033,0.306,0.324,0.138,0.439,0.185,0.042,0.428
        # Optional: The real-world distances of a 4-sided zone used for zones with speed estimation enabled (default: none)
        # List distances in order of the zone points coordinates and use the unit system defined in the ui config
        distances: 10,15,12,11
        # Optional: Number of consecutive frames required for object to be considered present in the zone (default: shown below).
        inertia: 3
        # Optional: Number of seconds that an object must loiter to be considered in the zone (default: shown below)
        loitering_time: 0
        # Optional: Minimum speed required for an object to be considered present in the zone (default: none)
        # In real-world units if distances are set. Used for speed-based zone triggers.
        speed_threshold: 2.5
        # Optional: List of objects that can trigger this zone (default: all tracked objects)
        objects:
          - person
        # Optional: Zone level object filters.
        # NOTE: The global and camera filters are applied upstream.
        filters:
          person:
            min_area: 5000
            max_area: 100000
            threshold: 0.7
```

--------------------------------

### Install web dependencies

Source: https://docs.frigate.video/development/contributing/

Install the web interface dependencies using npm. Run from the project root.

```console
cd web && npm install
```

--------------------------------

### Download Hailo installation script

Source: https://docs.frigate.video/frigate/installation/

Downloads the official Hailo installation script from the Frigate repository.

```bash
wget https://raw.githubusercontent.com/blakeblackshear/frigate/dev/docker/hailo8l/user_installation.sh
```

--------------------------------

### Example output of modinfo -n hailo_pci

Source: https://docs.frigate.video/frigate/installation/

Example output showing the path to the built-in Hailo kernel module.

```text
/lib/modules/6.6.31+rpt-rpi-2712/kernel/drivers/media/pci/hailo/hailo_pci.ko.xz
```

--------------------------------

### Start Frigate container with Docker Compose

Source: https://docs.frigate.video/frigate/updating/

Starts the Frigate container after updating the image.

```bash
docker compose up -d
```

--------------------------------

### Camera input path example

Source: https://docs.frigate.video/configuration/hardware_acceleration_video/

Example of a camera-level ffmpeg input path. This is not the same as the FFmpeg path option used for upgrading FFmpeg.

```yaml
cameras:
  name:
    ffmpeg:
      inputs:
        - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
```

--------------------------------

### Starter docker-compose.yml for Frigate

Source: https://docs.frigate.video/guides/getting_started/

A starter docker-compose.yml for amd64 devices. Customize it for your setup as detailed in the Installation docs. Start Frigate with 'docker compose up -d' from the folder containing this file. On startup, an admin user and password are created and outputted in the logs; view them with 'docker logs frigate'. Frigate is accessible at https://server_ip:8971.

```yaml
services:
  frigate:
    container_name: frigate
    restart: unless-stopped
    stop_grace_period: 30s
    image: ghcr.io/blakeblackshear/frigate:stable
    volumes:
      - ./config:/config
      - ./storage:/media/frigate
      - type: tmpfs # 1GB In-memory filesystem for recording segment storage
        target: /tmp/cache
        tmpfs:
          size: 1000000000
    ports:
      - "8971:8971"
      - "8554:8554" # RTSP feeds
```

--------------------------------

### GET /preview/:camera_name/start/:start_ts/end/:end_ts

Source: https://docs.frigate.video/integrations/api/preview-ts-preview-camera-name-start-start-ts-end-end-ts-get/

Gets all preview clips for a specified camera and time range. Returns a list of preview video clips that overlap with the requested time period, ordered by start time. Use camera_name='all' to get previews from all cameras. Returns an error if no previews are found.

```APIDOC
## GET /preview/:camera_name/start/:start_ts/end/:end_ts

### Description
Gets all preview clips for a specified camera and time range. Returns a list of preview video clips that overlap with the requested time period, ordered by start time. Use camera_name='all' to get previews from all cameras. Returns an error if no previews are found.

### Method
GET

### Endpoint
/preview/:camera_name/start/:start_ts/end/:end_ts

### Parameters
#### Path Parameters
- **camera_name** (string) - Required - The name of the camera. Use 'all' to get previews from all cameras.
- **start_ts** (number) - Required - The start timestamp of the time range.
- **end_ts** (number) - Required - The end timestamp of the time range.

### Access
Any authenticated user.

### Responses
#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error
```

--------------------------------

### Example test camera config (config/config.yml)

Source: https://docs.frigate.video/development/contributing/

Place this YAML at config/config.yml in the repo root. It defines an MQTT host and a test camera that reads an mp4 file in an infinite loop using ffmpeg input args. Modify the path and other settings for your needs.

```yaml
mqtt:
  host: mqtt

cameras:
  test:
    ffmpeg:
      inputs:
        - path: /media/frigate/car-stopping.mp4
          input_args: -re -stream_loop -1 -fflags +genpts
          roles:
            - detect
```

--------------------------------

### Adjust object filters for higher scores in YAML

Source: https://docs.frigate.video/plus/first_model/

Example YAML configuration for object filters with increased min_score and threshold values. These values are starting points and should evolve as the model improves.

```yaml
objects:
  filters:
    dog:
      min_score: .7
      threshold: .9
    cat:
      min_score: .65
      threshold: .8
    face:
      min_score: .7
    package:
      min_score: .65
      threshold: .9
    license_plate:
      min_score: .6
    amazon:
      min_score: .75
    ups:
      min_score: .75
    fedex:
      min_score: .75
    person:
      min_score: .65
      threshold: .85
    car:
      min_score: .65
      threshold: .85
```

--------------------------------

### Make installation script executable

Source: https://docs.frigate.video/frigate/installation/

Makes the downloaded script executable.

```bash
sudo chmod +x user_installation.sh
```

--------------------------------

### Frigate YAML configuration for Home Assistant integrated Intel Mini PC with OpenVINO

Source: https://docs.frigate.video/configuration/config/

Complete YAML configuration for a single camera setup with 720p 5fps detect stream, VAAPI hardware acceleration, OpenVINO detector, 7-day motion retention, 30-day alert/detection retention, snapshots for 30 days, and a motion mask for the camera timestamp. Configure MQTT to the same broker as Home Assistant and set the OpenVINO model path accordingly.

```yaml
mqtt:
  host: 192.168.X.X # <---- same mqtt broker that home assistant uses
  user: mqtt-user
  password: xxxxxxxxxx

ffmpeg:
  hwaccel_args: preset-vaapi

detectors:
  ov:
    type: openvino
    device: AUTO

model:
  width: 300
  height: 300
  input_tensor: nhwc
  input_pixel_format: bgr
  path: /openvino-model/ssdlite_mobilenet_v2.xml
  labelmap_path: /openvino-model/coco_91cl_bkgr.txt

record:
  enabled: True
  motion:
    days: 7
  alerts:
    retain:
      days: 30
      mode: motion
  detections:
    retain:
      days: 30
      mode: motion

snapshots:
  enabled: True
  retain:
    default: 30

cameras:
  name_of_your_camera:
    detect:
      width: 1280
      height: 720
      fps: 5
    ffmpeg:
      inputs:
        - path: rtsp://10.0.10.10:554/rtsp
          roles:
            - detect
    motion:
      mask:
        timestamp:
          friendly_name: "Camera timestamp"
          enabled: true
          coordinates: "0.000,0.427,0.002,0.000,0.999,0.000,0.999,0.781,0.885,0.456,0.700,0.424,0.701,0.311,0.507,0.294,0.453,0.347,0.451,0.400"
```

--------------------------------

### Setup passwordless sudo

Source: https://docs.frigate.video/guides/getting_started/

Creates a sudoers file to allow passwordless sudo for the user 'blake'. Replace 'blake' with your username.

```bash
echo 'blake    ALL=(ALL) NOPASSWD:ALL' | sudo tee /etc/sudoers.d/user
```

--------------------------------

### Install and configure unattended-upgrades

Source: https://docs.frigate.video/guides/getting_started/

Installs unattended-upgrades, enables automatic updates, and reconfigures non-interactively.

```bash
sudo apt install -y unattended-upgrades
echo unattended-upgrades unattended-upgrades/enable_auto_updates boolean true | sudo debconf-set-selections
sudo dpkg-reconfigure -f noninteractive unattended-upgrades
```

--------------------------------

### Run web development server

Source: https://docs.frigate.video/development/contributing/

Start the Vite development server for the web interface. Run from the project root.

```console
cd web && npm run dev
```

--------------------------------

### Example dummy camera config in config.yml

Source: https://docs.frigate.video/troubleshooting/dummy-camera/

Add this temporary camera configuration to config/config.yml to replay a clip. The input_args '-re -stream_loop -1' play the file in real time and loop indefinitely, while '-fflags +genpts' generates presentation timestamps when missing. Disable record and snapshots unless debugging those features.

```yaml
cameras:
  test:
    ffmpeg:
      inputs:
        - path: /media/frigate/car-stopping.mp4
          input_args: -re -stream_loop -1 -fflags +genpts
          roles:
            - detect
    detect:
      enabled: true
    record:
      enabled: false
    snapshots:
      enabled: false
```

--------------------------------

### GET /review/activity/motion

Source: https://docs.frigate.video/integrations/api/motion-activity-review-activity-motion-get/

Get motion and audio activity. This endpoint is accessible to any authenticated user.

```APIDOC
## GET /review/activity/motion

### Description
Get motion and audio activity.

### Method
GET

### Endpoint
/review/activity/motion

### Access
Any authenticated user.

### Responses

#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error
```

--------------------------------

### Install Frigate on QNAP NAS with Docker commands

Source: https://docs.frigate.video/frigate/installation/

Run these shell commands to install Frigate on a QNAP NAS. It downloads the stable Frigate image, creates directories for config and media files, copies the config file, and runs the Docker container with specified shm-size, timezone, CPU, and memory limits. Adjust the shm-size, timezone, and volume paths as needed.

```shell
# Download Frigate image
docker pull ghcr.io/blakeblackshear/frigate:stable
# Create directory to host Frigate config file on QNAP file system.
# E.g., you can choose to create it under /share/Container.
mkdir -p /share/Container/frigate/config
# Copy the config file prepared in step 2 into the newly created config directory.
cp path/to/your/config/file /share/Container/frigate/config
# Create directory to host Frigate media files on QNAP file system.
# (if you have a surveillance disk, create media directory on the surveillance disk.
# Example command assumes share_vol2 is the surveillance drive
mkdir -p /share/share_vol2/frigate/media
# Create Frigate docker container.  Replace shm-size value with the value from preparation step 3.
# Also replace the time zone value for 'TZ' in the sample command.
# Example command will create a docker container that uses at most 2 CPUs and 4G RAM.
# You may need to add "--env=LIBVA_DRIVER_NAME=i965 \" to the following docker run command if you
# have certain CPU (e.g., J4125). See https://docs.frigate.video/configuration/hardware_acceleration_video.
docker run \
  --name=frigate \
  --shm-size=256m \
  --restart=unless-stopped \
  --env=TZ=America/New_York \
  --volume=/share/Container/frigate/config:/config:rw \
  --volume=/share/share_vol2/frigate/media:/media/frigate:rw \
  --network=bridge \
  --privileged \
  --workdir=/opt/frigate \
  -p 8971:8971 \
  -p 8554:8554 \
  -p 8555:8555 \
  -p 8555:8555/udp \
  --label='com.qnap.qcs.network.mode=nat' \
  --label='com.qnap.qcs.gpu=False' \
  --memory="4g" \
  --cpus="2" \
  --detach=true \
  -t \
  ghcr.io/blakeblackshear/frigate:stable
```

--------------------------------

### GET /jobs/export

Source: https://docs.frigate.video/integrations/api/get-active-export-jobs-jobs-export-get/

Gets queued and running export jobs. Access is restricted to authenticated users.

```APIDOC
## GET /jobs/export

### Description
Gets queued and running export jobs.

### Method
GET

### Endpoint
/jobs/export

### Access
Any authenticated user.

### Responses
#### Success Response (200)
Successful Response
```

--------------------------------

### Build static documentation with npm run build

Source: https://docs.frigate.video/development/contributing/

Generates static content into the build directory, which can be served by any static hosting service.

```console
npm run build
```

--------------------------------

### GET /ffprobe/snapshot

Source: https://docs.frigate.video/integrations/api/ffprobe-snapshot-ffprobe-snapshot-get/

Get a snapshot from a stream URL using ffmpeg. Requires Admin role.

```APIDOC
## GET /ffprobe/snapshot

### Description
Get a snapshot from a stream URL using ffmpeg.

### Method
GET

### Endpoint
/ffprobe/snapshot

### Access
Admin role required.

### Responses

#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error
```

--------------------------------

### Install sudo on Debian

Source: https://docs.frigate.video/guides/getting_started/

Run as root to install sudo. Required before adding a user to the sudo group.

```bash
apt update && apt install -y sudo
```

--------------------------------

### Configure FFmpeg hwaccel_args preset in YAML

Source: https://docs.frigate.video/configuration/ffmpeg_presets/

Sets the global hardware acceleration preset to preset-vaapi and overrides it for the front_door camera with preset-nvidia. Use in the Frigate config file.

```yaml
ffmpeg:
  hwaccel_args: preset-vaapi

cameras:
  front_door:
    ffmpeg:
      hwaccel_args: preset-nvidia

```

--------------------------------

### GET /jobs/export/:export_id

Source: https://docs.frigate.video/integrations/api/get-export-job-status-jobs-export-export-id-get/

Gets the status of a specific export job. Requires authentication and access to the referenced camera.

```APIDOC
## GET /jobs/export/:export_id

### Description
Gets queued, running, or completed status for a specific export job.

### Method
GET

### Endpoint
/jobs/export/:export_id

### Parameters
#### Path Parameters
- **export_id** (string) - Required - The ID of the export job.

### Responses
#### Success Response (200)
Successful Response

#### Error Response (422)
Validation Error

```

--------------------------------

### YAML example for adding additional cameras

Source: https://docs.frigate.video/configuration/cameras/

Shows the structure for adding multiple cameras under the camera configuration section. The ellipses (...) indicate where existing configuration and camera definitions go.

```yaml
mqtt: ...
cameras:
  back: ...
  front: ...
  side: ...
```

--------------------------------

### GET /cases request

Source: https://docs.frigate.video/integrations/api/get-export-cases-cases-get/

Sends a GET request to the /cases endpoint to retrieve all export cases. Requires authentication.

```http
GET /cases
```

--------------------------------

### Create Hailo PCI configuration file

Source: https://docs.frigate.video/frigate/installation/

Creates a modprobe configuration file to force the correct descriptor page size, fixing the PCIe descriptor page size error.

```bash
echo 'options hailo_pci force_desc_page_size=4096' | sudo tee /etc/modprobe.d/hailo_pci.conf
```

--------------------------------

### POST /debug_replay/start

Source: https://docs.frigate.video/integrations/api/start-debug-replay-debug-replay-start-post/

Starts a debug replay session from camera recordings. Requires admin role. Returns immediately while clip generation runs as a background job; subscribe to the 'debug_replay' job_state WS topic to track progress.

```APIDOC
## POST /debug_replay/start

### Description
Starts a debug replay session from camera recordings. Requires admin role. Returns immediately while clip generation runs as a background job; subscribe to the 'debug_replay' job_state WS topic to track progress.

### Method
POST

### Endpoint
/debug_replay/start

### Access
Admin role required.

### Responses
#### Success Response (202)
Successful Response

#### Error Responses
- **400** - Invalid camera or time range
- **404** - No recordings in the requested time range
- **409** - A replay session is already active
- **422** - Validation Error
```

--------------------------------

### Install Frigate integration via HACS

Source: https://docs.frigate.video/integrations/home-assistant/

Steps to install the integration using HACS. Navigate to HACS, search for 'Frigate', and select it.

```text
Home Assistant > HACS > Click in the Search bar and type "Frigate" > Frigate
```

--------------------------------

### DebugReplayStartBody

Source: https://docs.frigate.video/integrations/api/schemas/debugreplaystartbody/

Request body for starting a debug replay session. Contains the source camera name and the start and end timestamps for the replay.

```APIDOC
## DebugReplayStartBody

### Description
Request body for starting a debug replay session.

### Fields
- **camera** (string) - Required - Source camera name
- **start_time** (number) - Required - Start timestamp
- **end_time** (number) - Required - End timestamp

### Request Example
```json
{
  "camera": "string",
  "start_time": 0,
  "end_time": 0
}
```
```

--------------------------------

### Copy binary file to host and generate flamegraph locally

Source: https://docs.frigate.video/troubleshooting/memory/

Copy the .bin file from the container to the host and run memray locally to generate the HTML report. Requires memray installed on the host.

```bash
docker cp <container_name_or_id>:/config/memray_reports/<module_name>.bin /tmp/
memray flamegraph /tmp/<module_name>.bin
```
Tokens:
Raw