Merge pull request #137 from mag37/notify_versioning

notify-template versioning

README.md

@@ -16,14 +16,20 @@
 
 <h4 align="center">For Podman - see the fork <a href="https://github.com/sudo-kraken/podcheck">sudo-kraken/podcheck</a>!</h4>
 
+<h4 align="center">:whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls - <a href="#whale-docker-hub-pull-limit-chart_with_downwards_trend-not-an-issue-for-checks-but-for-actual-pulls">read more</a></h4>
+
 ___
 ## :bell: Changelog
 
+- **v0.5.8.0**: Added version checks to all templates and a notification if a new template is released.
+- **v0.5.7.0**: Rewritten templates - now with a function to notify when there's a new Dockcheck release.
+    - Manually migrate your current `notify.sh` settings to a new template for new functionality.
+- **v0.5.6.1**: Async xargs hotfix - due to errors `failed to request manifest head ... context canceled`
+    - Defaulted subprocess to 1 with `MaxAsync=1`, increase to find a stable value in your environment.
+    - Added `-x N` option to pass `MaxAsync` value at runtime.
+    - To disable xargs `-P` flag (max processes) all together, set `MaxAsync` to 0.
+- **v0.5.6.0**: Heavily improved performance due to async checking for updates.
 - **v0.5.5.0**: osx and bsd compatibility changes + rewrite of dependency installer
-- **v0.5.4.0**: Added support for a Prometheus+node_exporter metric collection through a file collector.
-- **v0.5.3.0**: Local image check changed (use imageId instead of name) and Gotify-template fixed (whale icon removed).
-- **v0.5.2.1**: Rewrite of dependency downloads, jq can be installed with package manager or static binary.
-- **v0.5.1**: DEPENDENCY WARNING: now requires **jq**. + Upstreaming changes from [sudo-kraken/podcheck](https://github.com/sudo-kraken/podcheck)
 ___
 
 
@@ -77,6 +83,7 @@ ___
 ## :nut_and_bolt: Dependencies
 - Running docker (duh) and compose, either standalone or plugin. (see [Podman fork](https://github.com/sudo-kraken/podcheck)  
 - Bash shell or compatible shell of at least v4.3
+  - POSIX `xargs`, usually default but can be installed with the `findutils` package - to enable async.
 - [jq](https://github.com/jqlang/jq)
   - User will be prompted to install with package manager or download static binary.
 - [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))  
@@ -84,7 +91,7 @@ ___
   - regctl requires `amd64/arm64` - see [workaround](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
 
 ## :tent: Install Instructions
-Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.   
+Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.  
 For OSX/macOS preferably use `/usr/local/bin`.
 ```sh
 # basic example with curl:
@@ -104,6 +111,7 @@ Add preferred `notify.sh`-template to the same directory - this will not be touc
 ## :loudspeaker: Notifications
 Trigger with the `-i` flag.  
 Run it scheduled with `-ni` to only get notified when there's updates available!  
+Will also send a notification when `dockcheck.sh` itself has an update.
 
 Use a `notify_X.sh` template file from the **notify_templates** directory, copy it to `notify.sh` alongside the script, modify it to your needs! (notify.sh is added to .gitignore)  
 **Current templates:**
@@ -136,6 +144,11 @@ nginx  ->  https://github.com/docker-library/official-images/blob/master/library
 ```
 The `urls.list` file is just an example and I'd gladly see that people contribute back when they add their preferred URLs to their lists.
 
+## :fast_forward: Asyncronous update checks with **xargs**; `-x N` option. (default=1)
+Pass `-x N` where N is number of subprocesses allowed, experiment in your environment to find a suitable max!  
+Change the default value by editing the `MaxAsync=N` variable in `dockcheck.sh`. To disable the subprocess function set `MaxAsync=0`.
+
+
 ## :chart_with_upwards_trend: Prometheus and node_exporter
 Dockcheck can be used together with [Prometheus](https://github.com/prometheus/prometheus) and [node_exporter](https://github.com/prometheus/node_exporter) to export metrics via the file collector, scheduled with cron or likely.
 This is done with the `-c` option, like this:
@@ -177,7 +190,15 @@ chmod 755 regctl
 ```
 Test it with `./regctl --help` and then either add the file to the same path as *dockcheck.sh* or in your path (eg. `~/.local/bin/regctl`).
 
-## :guardsman: Function to auth with docker hub before running
+## :whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls
+Due to recent changes in [Docker Hub usage and limits](https://docs.docker.com/docker-hub/usage/)
+>Unauthenticated users: 10 pulls/hour  
+>Authenticated users with a free account: 100 pulls/hour
+
+This is not an issue for registry checks. But if you have a large stack and pull more than 10 updates at once consider updating more often or to create a free account.
+You could use/modify the login-wrapper function in the example below to automate the login prior to running `dockcheck.sh`.
+
+### :guardsman: Function to auth with docker hub before running
 **Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
 ```sh
 function dchk {

dockcheck.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-VERSION="v0.5.5.0"
-### ChangeNotes: osx and bsd compatibility changes + rewrite of dependency installer
+VERSION="v0.5.8.0"
+### ChangeNotes: Added version checks to all templates and a notification if a new template is released.
 Github="https://github.com/mag37/dockcheck"
 RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
 
@@ -13,6 +13,10 @@ ScriptWorkDir="$(dirname "$ScriptPath")"
 LatestRelease="$(curl -s -r 0-50 $RawUrl | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
 LatestChanges="$(curl -s -r 0-200 $RawUrl | sed -n "/ChangeNotes/s/# ChangeNotes: //p")"
 
+# User customizable defaults
+MaxAsync=1
+Timeout=10
+
 # Help Function
 Help() {
   echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]"
@@ -34,6 +38,7 @@ Help() {
   echo "-s     Include stopped containers in the check. (Logic: docker ps -a)."
   echo "-t     Set a timeout (in seconds) per container for registry checkups, 10 is default."
   echo "-v     Prints current version."
+  echo "-x N   Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested."
   echo
   echo "Project source: $Github"
 }
@@ -46,9 +51,8 @@ c_blue="\033[0;34m"
 c_teal="\033[0;36m"
 c_reset="\033[0m"
 
-Timeout=10
 Stopped=""
-while getopts "aynpfrhlisvmc:e:d:t:" options; do
+while getopts "aynpfrhlisvmc:e:d:t:x:" options; do
   case "${options}" in
     a|y) AutoUp="yes" ;;
     c)   CollectorTextFileDirectory="${OPTARG}"
@@ -64,6 +68,7 @@ while getopts "aynpfrhlisvmc:e:d:t:" options; do
     s)   Stopped="-a" ;;
     t)   Timeout="${OPTARG}" ;;
     v)   printf "%s\n" "$VERSION" ; exit 0 ;;
+    x)   MaxAsync=${OPTARG} ;;
     d)   DaysOld=${OPTARG}
          if ! [[ $DaysOld =~ ^[0-9]+$ ]] ; then { printf "Days -d argument given (%s) is not a number.\n" "${DaysOld}" ; exit 2 ; } ; fi ;;
     h|*) Help ; exit 2 ;;
@@ -169,6 +174,8 @@ if [[ "$VERSION" != "$LatestRelease" ]] ; then
   if [[ -z "$AutoUp" ]] ; then
     read -r -p "Would you like to update? y/[n]: " SelfUpdate
     [[ "$SelfUpdate" =~ [yY] ]] && self_update
+  else
+    [[ -n "$Notify" ]] && { [[ $(type -t dockcheck_notification) == function ]] && dockcheck_notification "$VERSION" "$LatestRelease" "$LatestChanges" || printf "Could not source notification function.\n" ; }
   fi
 fi
 
@@ -282,31 +289,70 @@ if [[ $t_out ]]; then
 else t_out=""
 fi
 
-# Check the image-hash of every running container VS the registry
-for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}') ; do
-  ((RegCheckQue+=1))
-  progress_bar "$RegCheckQue" "$ContCount"
-  # Looping every item over the list of excluded names and skipping
-  for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done
+check_image() {
+  i="$1"
+  local Excludes=($Excludes_string)
+  for e in "${Excludes[@]}" ; do
+    if [[ "$i" == "$e" ]]; then
+      echo Skip $i
+      return
+    fi
+  done
+
+  local NoUpdates GotUpdates GotErrors
   ImageId=$(docker inspect "$i" --format='{{.Image}}')
   RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
   LocalHash=$(docker image inspect "$ImageId" --format '{{.RepoDigests}}')
+
   # Checking for errors while setting the variable
   if RegHash=$(${t_out} $regbin -v error image digest --list "$RepoUrl" 2>&1) ; then
     if [[ "$LocalHash" = *"$RegHash"* ]] ; then
-      NoUpdates+=("$i")
+      echo NoUpdates "$i"
     else
       if [[ -n "$DaysOld" ]] && ! datecheck ; then
-        NoUpdates+=("+$i ${ImageAge}d")
+        echo NoUpdates "+$i ${ImageAge}d"
       else
-        GotUpdates+=("$i")
+        echo GotUpdates "$i"
       fi
     fi
   else
     # Here the RegHash is the result of an error code
-    GotErrors+=("$i - ${RegHash}")
+    echo GotErrors "$i - ${RegHash}"
   fi
-done
+}
+
+# Make required functions and variables available to subprocesses
+export -f check_image datecheck
+export Excludes_string="${Excludes[@]}" # Can only export scalar variables
+export t_out regbin RepoUrl DaysOld
+
+# Check for POSIX xargs with -P option, fallback without async
+if (echo "test" | xargs -P 2 >/dev/null 2>&1) && [[ "$MaxAsync" != 0 ]]; then
+  XargsAsync="-P $MaxAsync"
+else
+  XargsAsync=""
+  [[ "$MaxAsync" != 0 ]] && printf "%bMissing POSIX xargs, consider installing 'findutils' for asynchronous lookups.%b\n" "$c_red" "$c_reset"
+fi
+
+# Asynchronously check the image-hash of every running container VS the registry
+while read -r line; do
+  ((RegCheckQue+=1))
+  progress_bar "$RegCheckQue" "$ContCount"
+
+  Got=${line%% *}  # Extracts the first word (NoUpdates, GotUpdates, GotErrors)
+  item=${line#* }
+
+  case "$Got" in
+    NoUpdates) NoUpdates+=("$item") ;;
+    GotUpdates) GotUpdates+=("$item") ;;
+    GotErrors) GotErrors+=("$item") ;;
+    Skip) ;;
+    *) echo "Error! Unexpected output from subprocess: ${line}" ;;
+  esac
+done < <( \
+  docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}' | \
+  xargs ${XargsAsync} -I {} bash -c 'check_image "{}"' \
+)
 
 # Sort arrays alphabetically
 IFS=$'\n'

notify_templates/notify_DSM.sh

@@ -1,5 +1,6 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-# INFO: ssmtp is depcerated - consider to use msmtp instead.
+NOTIFY_DSM_VERSION="v0.1"
+# INFO: ssmtp is deprecated - consider to use msmtp instead.
 #
 # Copy/rename this file to notify.sh to enable the notification snipppet.
 # mSMTP/sSMTP has to be installed and configured manually.
@@ -17,10 +18,9 @@ else
 	echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1
 fi
 
-send_notification() {
-[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-UpdToString=$( printf '%s\\n' "${Updates[@]}" )
 FromHost=$(hostname)
+
+trigger_notification() {
 CfgFile="/usr/syno/etc/synosmtp.conf"
 
 # User variables:
@@ -34,15 +34,11 @@ SenderName=$(grep 'smtp_from_name' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
 SenderMail=$(grep 'smtp_from_mail' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
 SenderMail=${SenderMail:-$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')}
 
-printf "\nSending email notification.\n"
-
-printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"
-
 $MailPkg $SendMailTo << __EOF
 From: "$SenderName" <$SenderMail>
 date:$(date -R)
 To: <$SendMailTo>
-Subject: $SubjectTag Updates available on $FromHost
+Subject: $SubjectTag $MessageTitle $FromHost
 Content-Type: text/plain; charset=UTF-8; format=flowed
 Content-Transfer-Encoding: 7bit
 
@@ -52,3 +48,35 @@ __EOF
 # This ensures DSM's container manager will also see the update
 /var/packages/ContainerManager/target/tool/image_upgradable_checker
 }
+
+send_notification() {
+		[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+		UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+		printf "\nSending email notification.\n"
+
+		MessageTitle="Updates available on"
+		# Setting the MessageBody variable here.
+		printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"
+
+		trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+		printf "\nSending email dockcheck notification.\n"
+
+		MessageTitle="New version of dockcheck available on"
+		# Setting the MessageBody variable here.
+		printf -v MessageBody "Installed version: $1\nLatest version: $2\n\nChangenotes: $3\n"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_DSM.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_DSM_VERSION/s/NOTIFY_DSM_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_DSM_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_DSM.sh update avialable:\n $NOTIFY_DSM_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+		trigger_notification
+}

notify_templates/notify_apprise.sh

@@ -1,30 +1,55 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_APPRISE_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # Required receiving services must already be set up.
 # Modify to fit your setup - if API, set AppriseURL to your Apprise ip/domain.
 
-send_notification() {
-[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-UpdToString=$( printf '%s\\n' "${Updates[@]}" )
 FromHost=$(hostname)
 
-printf "\nSending Apprise notification\n"
+trigger_notification() {
 
-MessageTitle="$FromHost - updates available."
-# Setting the MessageBody variable here.
-printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
-
-# Modify to fit your setup:
-apprise -vv -t "$MessageTitle" -b "$MessageBody" \
-   mailto://myemail:mypass@gmail.com \
-   mastodons://{token}@{host} \
-   pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b \
-   tgram://{bot_token}/{chat_id}/
-
-### If you use the Apprise-API - Comment out the apprise command above.
-### Uncomment the AppriseURL and the curl-line below:
-# AppriseURL="http://apprise.mydomain.tld:1234/notify/apprise"
-# curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
+   ### Modify to fit your setup:
+   apprise -vv -t "$MessageTitle" -b "$MessageBody" \
+      mailto://myemail:mypass@gmail.com \
+      mastodons://{token}@{host} \
+      pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b \
+      tgram://{bot_token}/{chat_id}/
 
+   ### If you use the Apprise-API - Comment out the apprise command above.
+   ### Uncomment the AppriseURL and the curl-line below:
+   # AppriseURL="http://apprise.mydomain.tld:1234/notify/apprise"
+   # curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
+}
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    printf "\nSending Apprise notification\n"
+
+    MessageTitle="$FromHost - updates available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nSending Apprise dockcheck notification\n"
+
+    MessageTitle="$FromHost - New version of dockcheck available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_apprise.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_APPRISE_VERSION/s/NOTIFY_APPRISE_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_APPRISE_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_apprise.sh update avialable:\n $NOTIFY_APPRISE_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
 }

notify_templates/notify_discord.sh

@@ -1,28 +1,43 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_DISCORD_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # Required receiving services must already be set up.
 # Modify to fit your setup - set DiscordWebhookUrl
 
-send_notification() {
-    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
-
-    echo "$UpdToString"
-    FromHost=$(hostname)
-
-    # platform specific notification code would go here
-    printf "\nSending Discord notification\n"
-
-    # Setting the MessageBody variable here.
-    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+FromHost=$(hostname)
 
+trigger_notification() {
     # Modify to fit your setup:
     DiscordWebhookUrl="PasteYourFullDiscordWebhookURL"
 
     MsgBody="{\"username\":\"$FromHost\",\"content\":\"$MessageBody\"}"
-
     curl -sS -o /dev/null --fail -X POST -H "Content-Type: application/json" -d "$MsgBody" "$DiscordWebhookUrl"
-
 }
 
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    printf "\nSending Discord notification\n"
+    # Setting the MessageBody variable here.
+    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nSending Discord dockcheck notification\n"
+    MessageBody="$FromHost - New version of dockcheck available: \n Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_discord.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_DISCORD_VERSION/s/NOTIFY_DISCORD_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_DISCORD_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_discord.sh update avialable:\n $NOTIFY_DISCORD_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
+}

notify_templates/notify_generic.sh

@@ -1,16 +1,44 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_GENERIC_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # generic sample, the "Hello World" of notification addons
 
-send_notification() {
-  [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-  UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+FromHost=$(hostname)
 
-  FromHost=$(hostname)
-
-  # platform specific notification code would go here
-  printf "\n%bGeneric notification addon:%b" "$c_green" "$c_reset"
-  printf "\nThe following docker containers on %s need to be updated:\n" "$FromHost"
-  printf "$UpdToString"
+trigger_notification()  {
+    # Modify to fit your setup:
+    printf "\n$MessageTitle\n"
+    printf "\n$MessageBody\n"
+}
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    # platform specific notification code would go here
+    printf "\n%bGeneric notification addon:%b" "$c_green" "$c_reset"
+    MessageTitle="$FromHost - updates available."
+    printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nGeneric dockcheck notification\n"
+
+    MessageTitle="$FromHost - New version of dockcheck available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_generic.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_GENERIC_VERSION/s/NOTIFY_GENERIC_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_GENERIC_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_generic.sh update avialable:\n $NOTIFY_GENERIC_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
 }

notify_templates/notify_gotify.sh

@@ -1,21 +1,13 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_GOTIFY_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # Required receiving services must already be set up.
 # Modify to fit your setup - set GotifyUrl and GotifyToken.
 
-send_notification() {
-    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
-    FromHost=$(hostname)
-
-    # platform specific notification code would go here
-    printf "\nSending Gotify notification\n"
-
-    # Setting the MessageTitle and MessageBody variable here.
-    MessageTitle="${FromHost} - updates available."
-    printf -v MessageBody "Containers on $FromHost with updates available:\n$UpdToString"
+FromHost=$(hostname)
 
+trigger_notification() {
     # Modify to fit your setup:
     GotifyToken="Your Gotify token here"
     GotifyUrl="https://api.gotify/message?token=${GotifyToken}"
@@ -25,5 +17,37 @@ send_notification() {
         -F "message=${MessageBody}" \
         -F "priority=5" \
         -X POST "${GotifyUrl}" 1> /dev/null
-
+}
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    # platform specific notification code would go here
+    printf "\nSending Gotify notification\n"
+
+    # Setting the MessageTitle and MessageBody variable here.
+    MessageTitle="${FromHost} - updates available."
+    printf -v MessageBody "Containers on $FromHost with updates available:\n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nSending Gotify dockcheck notification\n"
+
+    MessageTitle="$FromHost - New version of dockcheck available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_gotify.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_GOTIFY_VERSION/s/NOTIFY_GOTIFY_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_GOTIFY_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_gotify.sh update avialable:\n $NOTIFY_GOTIFY_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
 }

notify_templates/notify_matrix.sh

@@ -1,20 +1,13 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_MATRIX_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # Required receiving services must already be set up.
 # Modify to fit your setup - set MatrixServer, Room_id and AccessToken
 
-send_notification() {
-    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
-    FromHost=$(hostname)
-
-    # platform specific notification code would go here
-    printf "\nSending Matrix notification\n"
-
-    # Setting the MessageBody variable here.
-    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+FromHost=$(hostname)
 
+trigger_notification() {
     # Modify to fit your setup:
     AccessToken="Your Matrix token here"
     Room_id="Enter Room_id here"
@@ -22,7 +15,37 @@ send_notification() {
     MsgBody="{\"msgtype\":\"m.text\",\"body\":\"$MessageBody\"}"
 
     # URL Example:  https://matrix.org/_matrix/client/r0/rooms/!xxxxxx:example.com/send/m.room.message?access_token=xxxxxxxx
-
     curl -sS -o /dev/null --fail -X POST "$MatrixServer/_matrix/client/r0/rooms/$Room_id/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
-
+}
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    # platform specific notification code would go here
+    printf "\nSending Matrix notification\n"
+
+    # Setting the MessageBody variable here.
+    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nSending Matrix dockcheck notification\n"
+
+    MessageTitle="$FromHost - New version of dockcheck available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_matrix.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_MATRIX_VERSION/s/NOTIFY_MATRIX_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_MATRIX_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_matrix.sh update avialable:\n $NOTIFY_MATRIX_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
 }

notify_templates/notify_ntfy-sh.sh

@@ -1,26 +1,50 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_NTFYSH_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # Setup app and subscription at https://ntfy.sh
 # Use your unique Topic Name in the URL below.
 
-send_notification() {
-[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-UpdToString=$( printf '%s\\n' "${Updates[@]}" )
 FromHost=$(hostname)
 
-printf "\nSending ntfy.sh notification\n"
-
-MessageTitle="$FromHost - updates available."
-# Setting the MessageBody variable here.
-printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
-
-# Modify to fit your setup:
-NtfyUrl="ntfy.sh/YourUniqueTopicName"
-
-curl -sS -o /dev/null --show-error --fail \
-  -H "Title: $MessageTitle" \
-  -d "$MessageBody" \
-  $NtfyUrl
+trigger_notification() {
+    # Modify to fit your setup:
+    NtfyUrl="ntfy.sh/YourUniqueTopicName"
 
+    curl -sS -o /dev/null --show-error --fail \
+      -H "Title: $MessageTitle" \
+      -d "$MessageBody" \
+      $NtfyUrl
+}
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    printf "\nSending ntfy.sh notification\n"
+
+    MessageTitle="$FromHost - updates available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nSending ntfy.sh dockcheck notification\n"
+
+    MessageTitle="$FromHost - New version of dockcheck available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_ntfy-sh.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_NTFYSH_VERSION/s/NOTIFY_NTFYSH_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_NTFYSH_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_ntfy-sh.sh update avialable:\n $NOTIFY_NTFYSH_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
 }

notify_templates/notify_pushbullet.sh

@@ -1,27 +1,51 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_PUSHBULLET_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # Required receiving services must already be set up.
 # Requires jq installed and in PATH.
 # Modify to fit your setup - set Url and Token.
 
-send_notification() {
-[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-UpdToString=$( printf '%s\\n' "${Updates[@]}" )
 FromHost=$(hostname)
 
-# platform specific notification code would go here
-printf "\nSending pushbullet notification\n"
-
-MessageTitle="$FromHost - updates available."
-# Setting the MessageBody variable here.
-printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
-
-# Modify to fit your setup:
-PushUrl="https://api.pushbullet.com/v2/pushes"
-PushToken="Your Pushbullet token here"
-
-# Requires jq to process json data
-jq -n --arg title "$MessageTitle" --arg body "$MessageBody" '{body: $body, title: $title, type: "note"}' | curl -sS -o /dev/null --show-error --fail -X POST -H "Access-Token: $PushToken" -H "Content-type: application/json" $PushUrl -d @-
+trigger_notification() {
+    # Modify to fit your setup:
+    PushUrl="https://api.pushbullet.com/v2/pushes"
+    PushToken="Your Pushbullet token here"
 
+    # Requires jq to process json data
+    jq -n --arg title "$MessageTitle" --arg body "$MessageBody" '{body: $body, title: $title, type: "note"}' | curl -sS -o /dev/null --show-error --fail -X POST -H "Access-Token: $PushToken" -H "Content-type: application/json" $PushUrl -d @-
+}
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    # platform specific notification code would go here
+    printf "\nSending pushbullet notification\n"
+
+    MessageTitle="$FromHost - updates available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nSending pushbullet dockcheck notification\n"
+
+    MessageTitle="$FromHost - New version of dockcheck available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_pushbullet.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_PUSHBULLET_VERSION/s/NOTIFY_PUSHBULLET_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_PUSHBULLET_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_pushbullet.sh update avialable:\n $NOTIFY_PUSHBULLET_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
 }

notify_templates/notify_pushover.sh

@@ -1,22 +1,14 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_PUSHOVER_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # Required receiving services must already be set up.
 # Requires jq installed and in PATH.
 # Modify to fit your setup - set Url and Token.
 
-send_notification() {
-    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
-    FromHost=$(hostname)
-
-    # platform specific notification code would go here
-    printf "\nSending pushover notification\n"
-
-    MessageTitle="$FromHost - updates available."
-    # Setting the MessageBody variable here.
-    printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+FromHost=$(hostname)
 
+trigger_notification() {
     # Modify to fit your setup:
     PushoverUrl="https://api.pushover.net/1/messages.json"
     PushoverUserKey="Your Pushover User Key Here"
@@ -30,3 +22,36 @@ send_notification() {
         -F "message=$MessageBody" \
         $PushoverUrl
 }
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    # platform specific notification code would go here
+    printf "\nSending pushover notification\n"
+
+    MessageTitle="$FromHost - updates available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nSending pushover dockcheck notification\n"
+
+    MessageTitle="$FromHost - New version of dockcheck available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_pushover.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_PUSHOVER_VERSION/s/NOTIFY_PUSHOVER_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_PUSHOVER_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_pushover.sh update avialable:\n $NOTIFY_PUSHOVER_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
+}

notify_templates/notify_smtp.sh

@@ -1,4 +1,5 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_SMTP_VERSION="v0.1"
 # INFO: ssmtp is depcerated - consider to use msmtp instead.
 #
 # Copy/rename this file to notify.sh to enable the notification snipppet.
@@ -16,25 +17,19 @@ else
 	echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1
 fi
 
-send_notification() {
-[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-UpdToString=$( printf '%s\\n' "${Updates[@]}" )
 FromHost=$(hostname)
 
+trigger_notification() {
 # User variables:
 SendMailFrom="me@mydomain.tld"
 SendMailTo="me@mydomain.tld"
 SubjectTag="dockcheck"
 
-printf "\nSending email notification.\n"
-
-printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"
-
 $MailPkg $SendMailTo << __EOF
 From: "$FromHost" <$SendMailFrom>
 date:$(date -R)
 To: <$SendMailTo>
-Subject: [$SubjectTag] Updates available on $FromHost
+Subject: [$SubjectTag] $MessageTitle $FromHost
 Content-Type: text/plain; charset=UTF-8; format=flowed
 Content-Transfer-Encoding: 7bit
 
@@ -42,3 +37,35 @@ $MessageBody
 
 __EOF
 }
+
+send_notification() {
+		[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+		UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+		printf "\nSending email notification.\n"
+
+		MessageTitle="Updates available on"
+		# Setting the MessageBody variable here.
+		printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"
+
+		trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+		printf "\nSending email dockcheck notification.\n"
+
+		MessageTitle="New version of dockcheck available on"
+		# Setting the MessageBody variable here.
+		printf -v MessageBody "Installed version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_smtp.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_SMTP_VERSION/s/NOTIFY_SMTP_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_SMTP_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_smtp.sh update avialable:\n $NOTIFY_SMTP_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+		trigger_notification
+}

notify_templates/notify_telegram.sh

@@ -1,20 +1,13 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_TELEGRAM_VERSION="v0.1"
 #
 # Copy/rename this file to notify.sh to enable the notification snippet.
 # Required receiving services must already be set up.
 # Modify to fit your setup - set TelegramChatId and TelegramToken.
 
-send_notification() {
-    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
-    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
-    FromHost=$(hostname)
-
-    # platform specific notification code would go here
-    printf "\nSending Telegram notification\n"
-
-    # Setting the MessageBody variable here.
-    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+FromHost=$(hostname)
 
+trigger_notification() {
     # Modify to fit your setup:
     TelegramToken="Your Telegram token here"
     TelegramChatId="Your Telegram ChatId here"
@@ -23,5 +16,36 @@ send_notification() {
     TelegramData="{\"chat_id\":\"$TelegramChatId\",\"text\":\"$MessageBody\",\"message_thread_id\":\"$TelegramTopicID\",\"disable_notification\": false}"
 
     curl -sS -o /dev/null --fail -X POST "$TelegramUrl/sendMessage" -H 'Content-Type: application/json' -d "$TelegramData"
-
+}
+
+send_notification() {
+    [ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
+    UpdToString=$( printf '%s\\n' "${Updates[@]}" )
+
+    # platform specific notification code would go here
+    printf "\nSending Telegram notification\n"
+
+    # Setting the MessageBody variable here.
+    MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
+
+    trigger_notification
+}
+
+### Rename (eg. disabled_dockcheck_notification), remove or comment out the following function
+### to not send notifications when dockcheck itself has updates.
+dockcheck_notification() {
+    printf "\nSending Telegram dockcheck notification\n"
+
+    MessageTitle="$FromHost - New version of dockcheck available."
+    # Setting the MessageBody variable here.
+    printf -v MessageBody "$FromHost - New version of dockcheck available.\n\nInstalled version: $1 \nLatest version: $2 \n\nChangenotes: $3"
+
+    RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_telegram.sh"
+    LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_TELEGRAM_VERSION/s/NOTIFY_TELEGRAM_VERSION=//p" | tr -d '"')"
+    if [[ "$NOTIFY_TELEGRAM_VERSION" != "$LatestNotifyRelease" ]] ; then
+        printf -v NotifyUpdate "\n\nnotify_telegram.sh update avialable:\n $NOTIFY_TELEGRAM_VERSION -> $LatestNotifyRelease\n"
+        MessageBody="${MessageBody}${NotifyUpdate}"
+    fi
+
+    trigger_notification
 }