frigate-notify

Frigate-Notify uses Golang text templates to allow customization of alert messages. You can define a template within any notification provider's configuration.

Variables are inserted using the {{ .VariableName }} syntax. If the template key is missing or blank, the default template (HTML, Plaintext, Markdown, or JSON depending on the provider) is used.

Important Syntax Rules:

• Single-line templates: If your template starts with a variable, you must wrap the entire string in quotes to avoid configuration loading errors. Use template: "{{ .Camera }} alert!" instead of template: {{ .Camera }} alert!.
• Multi-line templates: Use the YAML pipe operator (|) for cleaner multi-line messages.

To debug template rendering issues, enable debug logging to see the final rendered output in the logs.

alerts:
  discord:
    enabled: true
    webhook: # Webhook URL
    template: "Looks like {{ .Camera }} spotted a {{ .Label }}!!"

Frigate-Notify is configured via a YAML file. The configuration is divided into several main sections: app (application settings), frigate (connection settings for the Frigate server and MQTT), alerts (notification logic and provider settings), and monitor (health monitoring).

Use the following template to structure your configuration file. Note that many fields are optional and depend on which notification methods and Frigate features you intend to use.

app:
  mode:
  api:
    enabled:
    port:

frigate:
  server: 
  ignoressl: true
  public_url: 
  headers: 
  startup_check:
    attempts: 
    interval: 

  webapi:
    enabled: 
    interval: 
    
  mqtt: 
    enabled: 
    server: 
    port:
    clientid:
    username: 
    password: 
    topic_prefix: 
  
  cameras:
    exclude:
      - test_cam_01

alerts:  
  general:
    title:
    timeformat:
    nosnap: 
    snap_bbox: 
    snap_timestamp: 
    snap_crop: 
    snap_hires: 
    max_snap_retry: 
    notify_once: 
    notify_detections: 
    recheck_delay: 
    audio_only: 

  quiet:
    start:
    end:

  zones:
    unzoned: allow
    allow:
     - test_zone_01
    block:
     - test_zone_02

  labels:
    min_score: 
    allow:
     - person
     - dog
    block:
     - bird

  sublabels:
    allow:
     - ABCD
    block:
     - EFGH

  license_plate:
    enabled: false
    allow:
    block:

  # Notification Providers (examples)
  apprise_api:
    enabled: false
    server:
    token:
    urls:
    tags:
    ignoressl: 
    template: 

  discord:
    enabled: false
    webhook:
    disable_embed: 
    template: 
  
  gotify:
    enabled: false
    server:
    token:
    priority: 
    ignoressl: 
    template: 

  matrix:
    enabled: false
    server:
    username:
    password:
    roomid:
    ignoressl: 
    template: 

  mattermost:
    enabled: false
    webhook:
    channel:
    username:
    priority: 
    ignoressl: 
    headers: 
    template: 

  ntfy:
    enabled: false
    server:
    topic:
    ignoressl: 
    headers: 
    template: 

  pushover:
    enabled: false
    token:
    userkey:
    devices:
    sound: 
    priority: 
    retry: 
    expire: 
    ttl: 
    template: 

  signal:
    enabled: false
    server:
    account:
    recipients:
    ignoressl: 
    template: 

  smtp:
    enabled: false
    server:
    port:
    tls: 
    authtype: 
    user:
    password:
    recipient:
    msguuid: 
    thread: 
    template: 

  telegram:
    enabled: false
    chatid:
    send_clip: 
    message_thread_id: 
    token:
    template: 

  webhook:
    enabled: false
    server: 
    ignoressl: 
    method: 
    params: 
    headers: 
    template: 

monitor:
  enabled: false
  url: 
  interval: 
  ignoressl: