https://github.com/0x2142/frigate-notify

Event notifications for a standalone Frigate NVR instance
https://github.com/0x2142/frigate-notify

alerts frigate frigate-nvr golang notifications

Last synced: about 1 month ago
JSON representation

Event notifications for a standalone Frigate NVR instance

• Host: GitHub
• URL: https://github.com/0x2142/frigate-notify
• Owner: 0x2142
• License: mit
• Created: 2023-03-17T17:41:47.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-13T21:05:45.000Z (3 months ago)
• Last Synced: 2024-07-10T11:01:56.692Z (2 months ago)
• Topics: alerts, frigate, frigate-nvr, golang, notifications
• Language: Go
• Homepage: https://frigate-notify.0x2142.com/
• Size: 1 MB
• Stars: 61
• Watchers: 4
• Forks: 5
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Frigate-notify



[![Static Badge](https://img.shields.io/badge/Project-Documentation-blue)](https://frigate-notify.0x2142.com) [![GitHub Repo stars](https://img.shields.io/github/stars/0x2142/frigate-notify)]() [![GitHub release (with filter)](https://img.shields.io/github/v/release/0x2142/frigate-notify)](https://github.com/0x2142/frigate-notify/releases) [![Static Badge](https://img.shields.io/badge/Docker-latest-blue)](https://github.com/0x2142/frigate-notify/pkgs/container/frigate-notify)



## About

This project is designed to generate event notifications from a standalone [Frigate](https://github.com/blakeblackshear/frigate) NVR instance.

Currently Frigate only supports notifications through Home Assistant, which I'm not using right now. So I set out to build a simple notification app that would work with a standalone Frigate server.

## Features

**Event Polling**

- MQTT

- Direct via Frigate API

**Notification Methods**

- Discord

- Gotify

- SMTP

- Telegram

- Pushover

- Ntfy

- Generic Webhook

**Other**

- Aliveness monitor via HTTP GET (for use with tools like [HealthChecks](https://github.com/healthchecks/healthchecks) or [Uptime Kuma](https://github.com/louislam/uptime-kuma))

## Installation

See [Install / Setup](https://frigate-notify.0x2142.com/latest/install/).

## Configuration

An example config file has been provided (`example-config.yml`). Please copy this & edit to fit your needs.

The sample config contains inline descriptions for each field. For additional details on the available config options & the defaults, see the [Config](https://frigate-notify.0x2142.com/latest/config/) docs.

## Screenshots

**Discord**

![Discord](/screenshots/discord.png)

**Gotify**

![Gotify](/screenshots/gotify.png)

**SMTP**

![SMTP](/screenshots/smtp.png)

**Telegram**

![Telegram](/screenshots/telegram.png)

## Changelog

Additional details on each release are in the [Changelog](https://frigate-notify.0x2142.com/latest/changelog/)

## Support