11###############################################
22# Notifiarr Client Example Configuration File #
3- # Created by Notifiarr v0.4.4 @ 232801T0734 #
3+ # Created by Notifiarr v0.9.3rc1@ 262402T0654 #
44###############################################
55
66## This API key must be copied from your notifiarr.com account.
77api_key = "api-key-from-notifiarr.com"
88
9- ## Setting a UI password enables the human accessible web GUI . Must be at least 9 characters.
9+ ## Setting a UI password properly secures the Web UI . Must be at least 9 characters.
1010## The default username is admin; change it by setting ui_password to "username:password"
1111## Set to "webauth" to disable the login form and use only proxy authentication. See upstreams, below.
1212## Your auth proxy must pass the x-webauth-user header if you set this to "webauth".
1313## You may also set a custom auth header by setting to "webauth:<header>" e.g. "webauth:remote-user"
14- ## Disable auth by setting this to "noauth". Not recommended. Requires "upstreams" being set.
15- ui_password = ""
14+ ## Disable auth by setting this to "noauth". Not recommended and requires "upstreams" being set.
15+ ## If you leave this unset the password will be set to the API key defined at the top of this file.
16+ ## Changing the password in the Web UI encrypts it, and that is recommended.
17+ ui_password = ''''''
1618
1719## The ip:port to listen on for incoming HTTP requests. 0.0.0.0 means all/any IP and is recommended!
1820## You may use "127.0.0.1:5454" to listen only on localhost; good if using a local proxy.
1921## This is used to receive Plex webhooks and Media Request commands.
2022##
21- bind_addr = " 0.0.0.0:5454"
23+ bind_addr = ''' 0.0.0.0:5454'''
2224
2325## This application can update itself on Windows systems.
2426## Set this to "daily" to check GitHub every day for updates.
@@ -35,16 +37,20 @@ quiet = false
3537
3638## Debug prints more data and json payloads. This increases application memory usage.
3739debug = false
38-
40+ ##
3941## Trace logs function entry/exit with request IDs. Use for debugging request flow.
4042trace = false
41-
42- max_body = 0 # maximum body size for debug logs. 0 = no limit.
43+ ##
44+ max_body = 102400 # maximum body size for debug logs. 0 = no limit.
4345
4446## All API paths start with /api. This does not affect incoming /plex webhooks.
4547## Change it to /somethingelse/api by setting urlbase to "/somethingelse"
4648##
47- urlbase = "/"
49+ urlbase = '''/'''
50+
51+ ## Disable compression of payloads sent to the website.
52+ ##
53+ no_compress = false
4854
4955## Allowed upstream networks. Networks here are allowed to send two special headers:
5056## (1) x-forwarded-for (2) x-webauth-user
@@ -68,15 +74,19 @@ urlbase = "/"
6874#http_log = '~/.notifiarr/notifiarr.http.log'
6975##
7076## Set this to the number of megabytes to rotate files.
71- log_file_mb = 100
77+ log_file_mb = 5
7278##
7379## How many files to keep? 0 = all.
74- log_files = 0
80+ log_files = 10
7581##
7682## Unix file mode for new log files. Umask also affects this.
7783## Missing, blank or 0 uses default of 0600. Permissive is 0644. Ignored by Windows.
7884file_mode = "0600"
7985
86+ ## Disallow the website from triggering (log file) uploads. Sometimes an admin needs to see client
87+ ## logs while diagnosing problems. You can disable this ability by setting no_uploads to true.
88+ no_uploads = false
89+
8090## Web server and website timeout.
8191##
8292timeout = "1m"
@@ -96,6 +106,11 @@ serial = false
96106## Setting this to 0 will take the default of 4. Use 1 to disable retrying.
97107retries = 4
98108
109+ ## The version of the config file. The app uses this to verify the config
110+ ## version the front-end updates is not older than the back-end version.
111+ version = 1
112+
113+
99114##################
100115# Starr Settings #
101116##################
@@ -160,6 +175,13 @@ retries = 4
160175#pass = ""
161176
162177
178+ #[[transmission]]
179+ #name = "" # Set a name to enable checks of your service.
180+ #url = "http://transmission:9091/transmission/rpc"
181+ #user = ""
182+ #pass = ""
183+
184+
163185#[[nzbget]]
164186#name = "" # Set a name to enable checks of your service.
165187#url = "http://nzbget:6789/"
@@ -219,9 +241,9 @@ retries = 4
219241# SMI Path is found automatically if left blank. Set it to path to nvidia-smi (nvidia-smi.exe on Windows).
220242
221243[snapshot.nvidia]
222- disabled = false
223- smi_path = ''''''
224- bus_ids = []
244+ disabled = false
245+ smi_path = ''''''
246+ bus_ids = []
225247
226248##################
227249# Service Checks #
@@ -235,7 +257,6 @@ bus_ids = []
235257
236258[services]
237259 disabled = false # Setting this to true disables all service checking routines.
238- interval = "10m" # How often to send service states to Notifiarr.com. Minimum = 5m.
239260 log_file = '' # Service Check logs go to the app log by default. Change that by setting a services.log file here.
240261
241262## Uncomment the following section to create a service check on a URL or IP:port.
@@ -276,7 +297,7 @@ bus_ids = []
276297# pipe = false
277298# must_exist = false
278299# log_match = true
279-
300+ # disabled = false
280301
281302
282303###################
@@ -298,3 +319,50 @@ bus_ids = []
298319# log = true
299320# notify = true
300321# timeout = "10s"
322+
323+
324+ ############################
325+ # Endpoint URL Passthrough #
326+ ############################
327+
328+ ## The Endpoint URL Passthrough feature allows you to configure the client to poll
329+ ## any URL and send the response to the Notifiarr website for notification processing.
330+ ## @name - Defaults to URL. Name is used in logs and to identify this endpoint remotely.
331+ ## @url - Required URL to poll. Query is optional here, can be added in query param.
332+ ## @method - defaults to GET. Can use POST, PUT, etc.
333+ ## @timeout - How long to wait for the http request to complete. Default is no timeout.
334+ ## @template - Helps the website identify which template to parse this data into.
335+ ## Setting this to "false" will skip sending the response to the website.
336+ ## @body - For POST and PUT this is the body payload that is sent.
337+ ## @follow - Follow redirects? Default is false, do not follow 301/302s.
338+ ## @frequency - 0: no schedule, 1: minutely, 2: hourly, 3: daily, 4: weekly, 5: monthly
339+ ## @interval - How often to schedule when frequency is 3, 4 or 5.
340+ ## @days_of_week - List of days. Used when frequency is 4. Allowed values 0-6, 0 = Sunday.
341+ ## @days_of_month - List of days. Used when frequency is 5. Allowed values 1-31 and -31 to -1.
342+ ## @months - List of months. Currently not used. Allowed values: 1-12, 1 = January.
343+ ## @at_times - List of tuples [hours,minutes,seconds] to schedule when frequency is 3, 4 or 5.
344+ ## Only seconds are used when frequency is 1, only minutes when frequency is 2.
345+ ## @header - Map of header names to values sent with the http request to the URL.
346+ ## @query - Map of query names to values appended to the url in the request.
347+ ##
348+ ## Full Example Follows (remove the leading # hashes to use it):
349+ ##
350+ #[[endpoint]]
351+ # name = "My Example"
352+ # url = "http://example.com"
353+ # valid_ssl = true
354+ # method = "GET"
355+ # timeout = "0s"
356+ # template = "pihole"
357+ # body = ''
358+ # follow = false
359+ # frequency = 1
360+ # interval = 1
361+ # days_of_week = [0]
362+ # days_of_month = [1]
363+ # months = [1]
364+ # at_times = [[0,0,0]]
365+ # [endpoint.header]
366+ # x-api-key = ["abc123"]
367+ # [endpoint.query]
368+ # apiKey = ["abc123"]
0 commit comments