README
¶
Frigate-Notify
About
Frigate-Notify is a simple app designed to send notifications from Frigate NVR to your favorite platforms. Intended to be used with standalone Frigate installations - Home Assistant not required, MQTT is optional but recommended.
Features
Event Polling
- MQTT
- Direct via Frigate API
Notification Methods
- Discord
- Gotify
- Matrix
- Mattermost
- Ntfy
- Pushover
- Signal
- SMTP
- Telegram
- Webhook
- And many others via the Apprise API
Other
- Aliveness monitor via HTTP GET (for use with tools like HealthChecks or Uptime Kuma)
Installation
See Install / Setup.
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 docs.
Screenshots
For example screenshots of app notifications, see here
Changelog
Additional details on each release are in the Changelog
Support
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
providers/env
Custom environment variable provider Needed in order to support multiple notification provider profiles config via env vars Thanks to https://github.com/knadh/koanf/issues/74#issuecomment-1778885434
|
Custom environment variable provider Needed in order to support multiple notification provider profiles config via env vars Thanks to https://github.com/knadh/koanf/issues/74#issuecomment-1778885434 |
|
providers/secrets
Custom docker secrets provider
|
Custom docker secrets provider |
Click to show internal directories.
Click to hide internal directories.