forked from 0x2142/frigate-notify
-
Notifications
You must be signed in to change notification settings - Fork 0
/
example-config.yml
221 lines (201 loc) · 6.14 KB
/
example-config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
## SAMPLE CONFIG FILE
# For more info, see docs at https://frigate-notify.0x2142.com/config/file/
## Event Collection Methods
# Note: Only enable one - webapi OR mqtt
frigate:
# Frigate host URL (ex. https://frigate.yourdomain.tld)
# This is required for both collection methods
server:
# Set to true if using SSL & a self-signed certificate
ignoressl: false
# Public / internet-facing Frigate URL, if different from above server address
public_url:
# List of HTTP headers to send to Frigate, in format Header: Value
headers:
# Example:
# - Authorization: Basic abcd1234
# On startup, frigate-notify will check reachability of Frigate server
startup_check:
# Max number of attempts (Default: 5)
attempts: 3
# Interval between attempts, in seconds (Default: 30)
interval: 30
webapi:
# Set to true to enable event collection via the web API
enabled:
# Interval between checking for new events, in seconds (Default: 30)
interval:
mqtt:
# Set to true to enable event collection via MQTT
enabled:
# MQTT host IP
server:
# MQTT host port. (Default: 1883)
port:
# MQTT Client ID (Default: frigate-notify)
clientid:
# MQTT Authentication. Leave both blank for anonymous
username:
password:
# Optionally set custom topic prefix (Default: frigate)
topic_prefix:
cameras:
# List of cameras to exclude from being monitored
# Camera names must match frigate configuration
exclude:
- test_cam_01
## Alerting methods
# Any combination of alert destinations can be configured
alerts:
# General config applies to all alert methods below
general:
# Title for any alert messages (Default: Frigate Alert)
title:
# Optionally modify default time format in notifications
# Use Golang's reference time format, or see docs for more info
timeformat:
# Allow notification of events without a snapshot
# Set to `drop` to disallow this
nosnap: allow
# Note: Following snap_ items only apply when event is in progress
# Set to `true` to include bounding box on detected object in snapshot
snap_bbox:
# Set to `true` to include timestamp on snapshot
snap_timestamp:
# Set to `true` to crop snapshot
snap_crop:
# If configured, ignore events between times below
quiet:
# Start / end times in 24 hour format (ex. 4:00 or 22:30)
start:
end:
zones:
# Allow notifications for events outside a zone
# Set to `drop` to disallow this
unzoned: allow
# List of valid zones to generate alerts
# If blank, all events with a zone will generate notifications
allow:
- test_zone_01
# List of zones to never generate notifications
block:
- test_zone_02
labels:
# Filter events under minimum required label score (default: 0)
min_score:
# Filter notifications to only specific labels allowed here
allow:
# List of labels to never generate notifications
block:
sublabels:
# Filter notifications to only specific sublabels allowed here
allow:
# List of sublabels to never generate notifications
block:
discord:
# Set to true to enable alerting via Discord messages
enabled: false
# Insert full webhook URL below
webhook:
# Custom notification template, if desired
template:
gotify:
# Set to true to enable alerting via a Gotify push notification server
enabled: false
# Server URL (ex. https://push.yourdomain.tld)
server:
# Application token generated by Gotify
token:
# Set to true if using SSL & a self-signed certificate
ignoressl:
# Custom notification template, if desired
template:
smtp:
# Set to true to enable alerting via SMTP
enabled: false
# SMTP server host (ex. smtp.gmail.com)
server:
# SMTP port
port:
# Whether or not the SMTP server requires TLS (Default: true)
tls:
# Sending address / username
user:
# SMTP password for above user
password:
# Email alerts sent to any addresses listed below, separated by comma
recipient:
# Custom notification template, if desired
template:
# Telegram Config
telegram:
# Set to true to enable alerting via Telegram
enabled: false
# Chat ID of alert recipient
chatid:
# Bot API token
token:
# Custom notification template, if desired
template:
# Pushover Config
pushover:
# Set to true to enable alerting via Pushover
enabled: false
# Pushover API token for this application
token:
# User or Group key for recipients
userkey:
# Optional list of target devices by name, separated by comma
devices:
# Optional message priority, default is 0
priority:
# If priority is 2, retry & expiration must be set
# Values in seconds. Retry must be 30 or higher
retry:
expire:
# Optional message lifetime
ttl:
# Custom notification template, if desired
template:
# Ntfy Config
ntfy:
# Set to true to enable alerting via ntfy
enabled: false
# URL of Ntfy server
server:
# Ntfy topic for notifications
topic:
# Set to true if using SSL & a self-signed certificate
ignoressl:
# List of HTTP headers to send to Ntfy, in format Header: Value
headers:
# Example:
# - Authorization: Basic abcd1234
# Custom notification template, if desired
template:
# Webhook Config
webhook:
# Set to true to enable alerting via webhook
enabled: false
# URL of webhook receiver
server:
# Set to true if using SSL & a self-signed certificate
ignoressl:
# List of HTTP headers to send to webhook receiver, in format Header: Value
headers:
# Example:
# - Authorization: Basic abcd1234
# Custom notification template, if desired
# Note that template must be valid JSON
template:
## App Monitoring
# Sends HTTP GET to provided URL for aliveness checks
monitor:
# Set to true to enable app monitoring
enabled: false
# URL for monitoring server
url:
# Interval between monitoring check-in events, in seconds
interval:
# Set to true if using SSL & a self-signed certificate
ignoressl: