Merge pull request #93 from 0x2142/dev

Release v0.3.1

README.md

@@ -24,7 +24,7 @@ Currently Frigate only supports notifications through Home Assistant, which I'm
 - SMTP
 - Telegram
 - Pushover
-- Nfty
+- Ntfy
 - Generic Webhook
 
 **Other**

config/config.go

@@ -6,6 +6,7 @@ import (
 	"html/template"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"time"
 
@@ -30,6 +31,7 @@ type Frigate struct {
 	WebAPI       WebAPI              `fig:"webapi"`
 	MQTT         MQTT                `fig:"mqtt"`
 	Cameras      Cameras             `fig:"cameras"`
+	Version      int
 }
 
 type StartupCheck struct {
@@ -67,12 +69,14 @@ type Alerts struct {
 	Telegram Telegram `fig:"telegram"`
 	Pushover Pushover `fig:"pushover"`
 	Nfty     Nfty     `fig:"nfty"`
+	Ntfy     Ntfy     `fig:"ntfy"`
 	Webhook  Webhook  `fig:"webhook"`
 }
 
 type General struct {
 	Title      string `fig:"title" default:"Frigate Alert"`
-	TimeFormat string `fig:"timeformat" default: ""`
+	TimeFormat string `fig:"timeformat" default:""`
+	NoSnap     string `fig:"nosnap" default:"allow"`
 }
 
 type Zones struct {
@@ -130,12 +134,23 @@ type Pushover struct {
 	Template string `fig:"template" default:""`
 }
 
+// DEPRECATED: Misspelling of Ntfy
 type Nfty struct {
-	Enabled  bool   `fig:"enabled" default:false`
-	Server   string `fig:"server" default:""`
-	Topic    string `fig:"topic" default:""`
-	Insecure bool   `fig:"ignoressl" default:false`
-	Template string `fig:"template" default:""`
+	Enabled  bool                `fig:"enabled" default:false`
+	Server   string              `fig:"server" default:""`
+	Topic    string              `fig:"topic" default:""`
+	Insecure bool                `fig:"ignoressl" default:false`
+	Headers  []map[string]string `fig:"headers"`
+	Template string              `fig:"template" default:""`
+}
+
+type Ntfy struct {
+	Enabled  bool                `fig:"enabled" default:false`
+	Server   string              `fig:"server" default:""`
+	Topic    string              `fig:"topic" default:""`
+	Insecure bool                `fig:"ignoressl" default:false`
+	Headers  []map[string]string `fig:"headers"`
+	Template string              `fig:"template" default:""`
 }
 
 type Webhook struct {
@@ -247,6 +262,8 @@ func validateConfig() {
 	log.Info().Msgf("Successfully connected to %v", ConfigData.Frigate.Server)
 	if stats.Service.Version != "" {
 		log.Debug().Msgf("Frigate server is running version %v", stats.Service.Version)
+		// Save major version number
+		ConfigData.Frigate.Version, _ = strconv.Atoi(strings.Split(stats.Service.Version, ".")[1])
 	}
 
 	// Check Public / External URL if set
@@ -278,6 +295,13 @@ func validateConfig() {
 		}
 	}
 
+	// Check action on no snapshot available
+	if strings.ToLower(ConfigData.Alerts.General.NoSnap) != "allow" && strings.ToLower(ConfigData.Alerts.General.NoSnap) != "drop" {
+		configErrors = append(configErrors, "Option for nosnap must be 'allow' or 'drop'")
+	} else {
+		log.Debug().Msgf("Events without a snapshot: %v", strings.ToLower(ConfigData.Alerts.General.NoSnap))
+	}
+
 	// Check Zone filtering config
 	if strings.ToLower(ConfigData.Alerts.Zones.Unzoned) != "allow" && strings.ToLower(ConfigData.Alerts.Zones.Unzoned) != "drop" {
 		configErrors = append(configErrors, "Option for unzoned events must be 'allow' or 'drop'")
@@ -409,16 +433,28 @@ func validateConfig() {
 			configErrors = append(configErrors, msg)
 		}
 	}
+	// Deprecation warning
+	// TODO: Remove misspelled Ntfy config with v0.4.0 or later
 	if ConfigData.Alerts.Nfty.Enabled {
-		log.Debug().Msg("Nfty alerting enabled.")
-		if ConfigData.Alerts.Nfty.Server == "" {
-			configErrors = append(configErrors, "No Nfty server specified!")
+		log.Warn().Msg("Config for 'nfty' will be deprecated due to misspelling. Please update config to 'ntfy'")
+		// Copy data to new Ntfy struct
+		ConfigData.Alerts.Ntfy.Enabled = ConfigData.Alerts.Nfty.Enabled
+		ConfigData.Alerts.Ntfy.Server = ConfigData.Alerts.Nfty.Server
+		ConfigData.Alerts.Ntfy.Topic = ConfigData.Alerts.Nfty.Topic
+		ConfigData.Alerts.Ntfy.Insecure = ConfigData.Alerts.Nfty.Insecure
+		ConfigData.Alerts.Ntfy.Headers = ConfigData.Alerts.Nfty.Headers
+		ConfigData.Alerts.Ntfy.Template = ConfigData.Alerts.Nfty.Template
+	}
+	if ConfigData.Alerts.Ntfy.Enabled {
+		log.Debug().Msg("Ntfy alerting enabled.")
+		if ConfigData.Alerts.Ntfy.Server == "" {
+			configErrors = append(configErrors, "No Ntfy server specified!")
 		}
-		if ConfigData.Alerts.Nfty.Topic == "" {
-			configErrors = append(configErrors, "No Nfty topic specified!")
+		if ConfigData.Alerts.Ntfy.Topic == "" {
+			configErrors = append(configErrors, "No Ntfy topic specified!")
 		}
 		// Check template syntax
-		if msg := checkTemplate("Nfty", ConfigData.Alerts.Nfty.Template); msg != "" {
+		if msg := checkTemplate("Ntfy", ConfigData.Alerts.Ntfy.Template); msg != "" {
 			configErrors = append(configErrors, msg)
 		}
 	}

docs/changelog.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [v0.3.1](https://github.com/0x2142/frigate-notify/releases/tag/v0.3.1) - Jun 11 2024
+
+ - Fix misspelling for Ntfy
+     - Currently config will accept either `nfty` or `ntfy`, but in a future release `nfty` will be removed
+     - ⚠️ **Note**: If you are using `nfty`, please update your config to the correct spelling: `ntfy`
+ - Fix issue where Ntfy action button would use local Frigate URL even if `public_url` was configured
+ - Fix camera links for Frigate 0.14.0+
+ - Add support for sending HTTP headers with Ntfy notifications
+ - Added [config file](https://frigate-notify.0x2142.com/latest/config/file/#general) option to drop events that don't have a snapshot image
+ - Move "No snapshot available" message into notification templates
+ - Add support for disabling colored console logging via [config options](https://frigate-notify.0x2142.com/latest/config/options/)
+
 ## [v0.3.0](https://github.com/0x2142/frigate-notify/releases/tag/v0.3.0) - Jun 03 2024
 
  - Reworked & reduced logging, added [debug option](https://frigate-notify.0x2142.com/latest/config/options/)
@@ -13,7 +25,7 @@
 
 ## [v0.2.8](https://github.com/0x2142/frigate-notify/releases/tag/v0.2.8) - May 15 2024
 
- - Add support for notifications via [Nfty](https://frigate-notify.0x2142.com/latest/config/file/#nfty)
+ - Add support for notifications via [Ntfy](https://frigate-notify.0x2142.com/latest/config/file/#ntfy)
  - Add ability to send additional HTTP [headers](https://frigate-notify.0x2142.com/latest/config/file/#frigate) to Frigate
  - Add new `public_url` config item for Frigate
      - This will be used in notification links & should be configured if Frigate is accessible via the internet

docs/config/file.md

@@ -125,12 +125,17 @@ frigate:
     - This utilizes Golang's [reference time](https://go.dev/src/time/format.go) for formatting
     - See [this](https://www.geeksforgeeks.org/time-formatting-in-golang) guide for help
     - Example below uses RFC1123 format
+- **nosnap** (Optional - Default: `allow`)
+    - Specify what to do with events that have no snapshot image
+    - By default, these events will be sent & notification message will say "No snapshot available"
+    - Set to `drop` to silently drop these events & not send notifications
 
 ```yaml title="Config File Snippet"
 alerts:  
   general:
     title: Frigate Alert
     timeformat: Mon, 02 Jan 2006 15:04:05 MST
+    nosnap: 
 ```
 
 ### Zones
@@ -277,6 +282,11 @@ alerts:
 
 ### Telegram
 
+!!! note
+    There is an [issue](https://github.com/0x2142/frigate-notify/issues/54#issuecomment-2148564526) with Telegram alerts if you use URL-embedded credentials for your Frigate links, for example: `https://user:[email protected]`
+
+    Telegram appears to incorrectly process these URLs, which will cause the camera & clip links  to become unclickable within Telegram.
+
 In order to use Telegram for alerts, a bot token & chat ID are required.
 
 To obtain a bot token, follow [this](https://core.telegram.org/bots#how-do-i-create-a-bot) doc to message @BotFather.
@@ -366,29 +376,34 @@ alerts:
     template:
 ```
 
-### Nfty
+### Ntfy
 
 - **enabled** (Optional - Default: `false`)
-    - Set to `true` to enable alerting via Nfty
+    - Set to `true` to enable alerting via Ntfy
 - **server** (Required)
-    - Full URL of the desired Nfty server
+    - Full URL of the desired Ntfy server
     - Required if this alerting method is enabled
 - **topic** (Required)
     - Destination topic that will receive alert notifications
     - Required if this alerting method is enabled
 - **ignoressl** (Optional - Default: `false`)
     - Set to `true` to allow self-signed certificates
+- **headers** (Optional)
+    - Send additional HTTP headers to Ntfy server
+    - Header format: `Header: Value`
+    - Example: `Authorization: Basic abcd1234`
 - **template** (Optional)
     - Optionally specify a custom notification template
     - For more information on template syntax, see [Alert Templates](./templates.md#alert-templates)
 
 ```yaml title="Config File Snippet"
 alerts: 
-  nfty:
+  ntfy:
     enabled: true
-    server: https://nfty.your.domain.tld
+    server: https://ntfy.your.domain.tld
     topic: frigate
     ignoressl: true
+    headers:
     template:
 ```
 
@@ -432,7 +447,7 @@ alerts:
     - For more information on template syntax, see [Alert Templates](./templates.md#alert-templates)
     - Note: Webhook templates **must** be valid JSON
 
-``` title="Config File Snippet"
+```yaml title="Config File Snippet"
   webhook:
     enabled: false
     server: 

docs/config/options.md

@@ -2,8 +2,9 @@
 
 The following options are available as command line flags or environment variables:
 
-| Flag     | Environment Variable | Description                             |
-|----------|----------------------|-----------------------------------------|
-| -c       | FN_CONFIGFILE        | Specify alternate config file location  |
-| -debug   | FN_DEBUG             | Set to `true` to enable debug logging   |
-| -jsonlog | FN_JSONLOG           | Set to `true` to enable logging in JSON |
+| Flag     | Environment Variable | Description                                        |
+|----------|----------------------|----------------------------------------------------|
+| -c       | FN_CONFIGFILE        | Specify alternate config file location             |
+| -debug   | FN_DEBUG             | Set to `true` to enable debug logging              |
+| -jsonlog | FN_JSONLOG           | Set to `true` to enable logging in JSON            |
+| -nocolor | FN_NOCOLOR           | Set to `true` to disable color for console logging |

docs/config/sample.md

@@ -33,6 +33,7 @@ alerts:
   general:
     title:
     timeformat:
+    nosnap:
 
   zones:
     unzoned: allow
@@ -87,11 +88,12 @@ alerts:
     ttl:
     template:
 
-  nfty:
+  ntfy:
     enabled: false
     server:
     topic:
     ignoressl:
+    headers:
     template:
 
   webhook:

docs/index.md

@@ -24,7 +24,7 @@ Currently Frigate only supports notifications through Home Assistant, which I'm
 - SMTP
 - Telegram
 - Pushover
-- Nfty
+- Ntfy
 - Generic Webhook
 
 **Other**

docs/install.md

@@ -6,6 +6,8 @@ Both methods below will require a [configuration file](config/file.md) to be pro
 
 A Docker image is built with every release. Those images can be found [here](https://github.com/0x2142/frigate-notify/pkgs/container/frigate-notify).
 
+Each image is assigned a version tag upon release. Using the `latest` tag is recommended & will ensure you pull down the most recent version of the app. If needed, prior releases can be used by specifying the individual release tag, like `v0.3.0`. Additionally, there is an image built regularly from the latest development branch, which is tagged as `dev`. While the `dev` image may contain the latest fixes & features, it is not recommended for most users and may be unstable.
+
 The app can be run as a container with the bundled [docker-compose.yml](https://github.com/0x2142/frigate-notify/blob/main/docker-compose.yml) file:
 
 ```yaml

example-config.yml

@@ -62,6 +62,9 @@ alerts:
     # 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 
 
   zones:
     # Allow notifications for events outside a zone
@@ -151,16 +154,20 @@ alerts:
     # Custom notification template, if desired
     template:
 
-  # Nfty Config
-  nfty:
-    # Set to true to enable alerting via nfty
+  # Ntfy Config
+  ntfy:
+    # Set to true to enable alerting via ntfy
     enabled: false
-    # URL of Nfty server
+    # URL of Ntfy server
     server:
-    # Nfty topic for notifications
+    # 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:
 

main.go

@@ -15,31 +15,36 @@ import (
 	"github.com/0x2142/frigate-notify/util"
 )
 
-var APP_VER = "v0.3.0"
+var APP_VER = "v0.3.1"
 var debug, debugenv bool
 var jsonlog, jsonlogenv bool
+var nocolor, nocolorenv bool
 var configFile string
 
 func main() {
 	// Parse flags
 	flag.StringVar(&configFile, "c", "", "Configuration file location (default \"./config.yml\")")
 	flag.BoolVar(&debug, "debug", false, "Enable debug logging")
 	flag.BoolVar(&jsonlog, "jsonlog", false, "Enable JSON logging")
+	flag.BoolVar(&nocolor, "nocolor", false, "Disable color on console logging")
 	flag.Parse()
 
 	// Set up logging
 	_, jsonlogenv = os.LookupEnv("FN_JSONLOG")
 	if jsonlog || jsonlogenv {
-		zerolog.TimeFieldFormat = "2006/01/02 15:04:05"
+		zerolog.TimeFieldFormat = "2006/01/02 15:04:05 -0700"
 	} else {
-		log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: "2006/01/02 15:04:05"})
+		_, nocolorenv = os.LookupEnv("FN_NOCOLOR")
+		log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: "2006/01/02 15:04:05 -0700", NoColor: nocolorenv || nocolor})
 	}
 	zerolog.SetGlobalLevel(zerolog.InfoLevel)
 
 	// Enable debug logging if set
 	_, debugenv = os.LookupEnv("FN_DEBUG")
 	if debug || debugenv {
 		zerolog.SetGlobalLevel(zerolog.DebugLevel)
+		// Add calling module to debug logs
+		log.Logger = log.With().Caller().Logger()
 		log.Debug().Msg("Debug logging enabled")
 	}
 

models/event.go

@@ -46,9 +46,10 @@ type Event struct {
 
 // Additional custom fields
 type ExtraFields struct {
-	FormattedTime   string
-	TopScorePercent string
-	ZoneList        string
-	LocalURL        string
-	PublicURL       string
+	FormattedTime       string
+	TopScorePercent     string
+	ZoneList            string
+	LocalURL            string
+	PublicURL           string
+	FrigateMajorVersion int
 }