Release info + notification edits.

smtp-changes, deprecate ssmtp, suggest msmtp

README.md

@@ -16,7 +16,14 @@
 
 ___
 ## :bell: Changelog
+* Create notify_gotify.sh by @cerealconyogurt in https://github.com/mag37/dockcheck/pull/87
+* zero configuration DSM notification emails by @yoyoma2 in https://github.com/mag37/dockcheck/pull/88
+* smtp-changes, deprecate ssmtp, suggest msmtp by @mag37 in https://github.com/mag37/dockcheck/pull/90
 
+- **v0.4.7**: Notification Template changes to gotify(new!), DSM(improved), SMTP(deprecation alternative).
+- **v0.4.6**: Compatibility changes to timeout, due to busybox.
+- **v0.4.5**: Bugfixes, compatibility changes to timeout and arrays.
+- **v0.4.3**: Added timeout option to skip container if registry check takes too long (10s default).
 - **v0.4.1**: Syntax and logic cleanups, bugfixes on multi compose and env-files.
 - **v0.4.0**: Reworked selfupdate (auto git/curl/wget), general syntax cleanup, added -v for version.
 - **v0.3.8**: Fixed `--env-file` logic to work with multiple env-files.
@@ -47,6 +54,7 @@ Options:"
 -p     Auto-Prune dangling images after update.
 -r     Allow updating images for docker run, wont update the container.
 -s     Include stopped containers in the check. (Logic: docker ps -a).
+-t     Set a timeout (in seconds) per container for registry checkups, 10 is default.
 -v     Prints current version.
 ```
 
@@ -74,6 +82,7 @@ ___
 
 ## :nut_and_bolt: Dependencies
 - Running docker (duh) and compose, either standalone or plugin.   
+- Bash shell or compatible shell of at least v4.3
 - [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))   
   - User will be prompted to download `regctl` if not in `PATH` or `PWD`.   
   - regctl requires `amd64/arm64` - see [workaround](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
@@ -96,14 +105,15 @@ Add preferred `notify.sh`-template to the same directory - this will not be touc
 Trigger with the `-i` flag.   
 Run it scheduled with `-ni` to only get notified when there's updates available!  
 
-Use a `notify_X.sh` template file, copy it to `notify.sh`, modify it to your needs!   
+Use a `notify_X.sh` template file, copy it to `notify.sh`, modify it to your needs! (notify.sh is added to .gitignore)     
-Current templates:
+**Current templates:**
 - Synology [DSM](https://www.synology.com/en-global/dsm)
-- Email with [sSMTP](https://wiki.debian.org/sSMTP)  
+- Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP))
 - Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications)
   - both native [caronc/apprise](https://github.com/caronc/apprise) and the standalone [linuxserver/docker-apprise-api](https://github.com/linuxserver/docker-apprise-api)
   - Read the [QuickStart](extras/apprise_quickstart.md)
 - [ntfy.sh](https://ntfy.sh/) - HTTP-based pub-sub notifications.
+- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
 - [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
 - [Telegram](https://telegram.org/) - Telegram chat API.
 - [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication.

dockcheck.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-VERSION="v0.4.1"
+VERSION="v0.4.7"
-### ChangeNotes: Syntax and logic cleanups, bugfixes for multi compose and env-files.
+### ChangeNotes: Notification template changes for: gotify(new), DSM(improved), SMTP(deprecation alternative).
 Github="https://github.com/mag37/dockcheck"
 RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
 
@@ -32,6 +32,7 @@ Help() {
   echo "-p     Auto-Prune dangling images after update."
   echo "-r     Allow updating images for docker run, wont update the container."
   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."
 }
 
@@ -43,8 +44,9 @@ c_blue="\033[0;34m"
 c_teal="\033[0;36m"
 c_reset="\033[0m"
 
+Timeout=10
 Stopped=""
-while getopts "aynpfrhlisvme:d:" options; do
+while getopts "aynpfrhlisvme:d:t:" options; do
   case "${options}" in
     a|y) AutoUp="yes" ;;
     n)   AutoUp="no" ;;
@@ -56,6 +58,7 @@ while getopts "aynpfrhlisvme:d:" options; do
     e)   Exclude=${OPTARG} ;;
     m)   declare c_{red,green,yellow,blue,teal,reset}="" ;;
     s)   Stopped="-a" ;;
+    t)   Timeout="${OPTARG}" ;; 
     v)   printf "%s\n" "$VERSION" ; exit 0 ;;
     d)   DaysOld=${OPTARG}
          if ! [[ $DaysOld =~ ^[0-9]+$ ]] ; then { printf "Days -d argument given (%s) is not a number.\n" "${DaysOld}" ; exit 2 ; } ; fi ;;
@@ -83,7 +86,7 @@ self_update_curl() {
 
 self_update() {
   cd "$ScriptWorkDir" || { printf "Path error, skipping update.\n" ; return ; }
-  if [[ $(builtin type -P git) ]] && [[ "$(git ls-remote --get-url)" =~ .*"mag37/dockcheck".* ]] ; then
+  if [[ $(builtin type -P git) ]] && [[ "$(git ls-remote --get-url 2>/dev/null)" =~ .*"mag37/dockcheck".* ]] ; then
     printf "\n%s\n" "Pulling the latest version."
     git pull --force || { printf "Git error, manually pull/clone.\n" ; return ; }
     printf "\n%s\n" "--- starting over with the updated version ---"
@@ -214,6 +217,17 @@ fi
 DocCount=$(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}' | wc -l)
 RegCheckQue=0
 
+### Testing and setting timeout binary
+t_out=$(type -P "timeout") 
+if [[ $t_out ]]; then
+  t_out=$(realpath $t_out 2>/dev/null || readlink -f $t_out)
+  if [[ $t_out =~ "busybox" ]]; then
+    t_out="timeout ${Timeout}"
+  else t_out="timeout --foreground ${Timeout}"
+  fi
+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))
@@ -222,8 +236,8 @@ for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}')
   for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done 
   RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
   LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
-  ### Checking for errors while setting the variable:
+  # Checking for errors while setting the variable:
-  if RegHash=$($regbin image digest --list "$RepoUrl" 2>&1) ; then
+  if RegHash=$(${t_out} $regbin image digest --list "$RepoUrl" 2>&1) ; then
     if [[ "$LocalHash" = *"$RegHash"* ]] ; then 
       NoUpdates+=("$i") 
     else 
@@ -240,9 +254,11 @@ for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}')
 done
 
 ### Sort arrays alphabetically
-readarray -td '' NoUpdates < <(printf '%s\0' "${NoUpdates[@]}" | sort -z -n)
+IFS=$'\n'
-readarray -td '' GotUpdates < <(printf '%s\0' "${GotUpdates[@]}" | sort -z -n)
+NoUpdates=($(sort <<<"${NoUpdates[*]}"))
-readarray -td '' GotErrors < <(printf '%s\0' "${GotErrors[@]}" | sort -z -n)
+GotUpdates=($(sort <<<"${GotUpdates[*]}"))
+unset IFS
+
 
 ### Define how many updates are available
 UpdCount="${#GotUpdates[@]}"

notify_DSM.sh

@@ -1,26 +1,46 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+# INFO: ssmtp is depcerated - consider to use msmtp instead.
 #
-# Copy/rename this file to notify.sh to enable email notifications on Synology DSM
+# Copy/rename this file to notify.sh to enable the notification snipppet.
-# DSM Notification Email has to be configured manually.
+# mSMTP/sSMTP has to be installed and configured manually.
+# The existing DSM Notification Email configuration will be used automatically.
 # Modify to your liking - changing SendMailTo and Subject and content.
 
+MSMTP=$(which msmtp)
+SSMTP=$(which ssmtp)
+
+if [ -n $MSMPT ] ; then  
+	MAIL=$MSMTP
+elif [ -n $SSMTP ] && [ -z $MAIL ] ; then
+	MAIL=$SSMTP
+else
+	echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1
+fi
+
 send_notification() {
 Updates=("$@")
 UpdToString=$( printf "%s\n" "${Updates[@]}" )
 FromHost=$(hostname)
+CfgFile="/usr/syno/etc/synosmtp.conf"
 
 # User variables:
-# change this to your usual destination for synology DSM notification emails
+# Automatically sends to your usual destination for synology DSM notification emails.
-SendMailTo="me@mydomain.com"
+# You can also manually override by assigning something else to SendMailTo below.
-SubjectTag="diskstation"
+SendMailTo=$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
+#SendMailTo="me@mydomain.com"
+
+SubjectTag=$(grep 'eventsubjectprefix' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
+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"
 
-ssmtp $SendMailTo << __EOF
+$MAIL $SendMailTo << __EOF
-From: "$FromHost" <$SendMailTo>
+From: "$SenderName" <$SenderMail>
 date:$(date -R)
 To: <$SendMailTo>
-Subject: [$SubjectTag] Updates available on $FromHost
+Subject: $SubjectTag Updates available on $FromHost
 Content-Type: text/plain; charset=UTF-8; format=flowed
 Content-Transfer-Encoding: 7bit
 
@@ -28,7 +48,6 @@ The following containers on $FromHost have updates available:
 
 $UpdToString
 
- From $FromHost
+ From $SenderName
-
 __EOF
 }

notify_gotify.sh

@@ -0,0 +1,29 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# 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() {
+    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."
+    MessageBody="Containers on ${FromHost} with updates available: ${UpdToString}"
+    
+    # Modify to fit your setup:
+    GotifyToken="Your Gotify token here"
+    GotifyUrl="https://api.gotify/message?token=${GotifyToken}"   
+    
+    curl \
+        -F "title=${MessageTitle}" \
+        -F "message=${MessageBody}" \
+        -F "priority=5" \
+        -X POST "${GotifyUrl}" &> /dev/null
+
+}

notify_matrix.sh

@@ -23,6 +23,6 @@ send_notification() {
 
     # 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 PUT "$MatrixServer/_matrix/client/r0/rooms/$Room_id/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
+    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"
     
 }

notify_smtp.sh

@@ -1,9 +1,21 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+# INFO: ssmtp is depcerated - consider to use msmtp instead.
 #
 # Copy/rename this file to notify.sh to enable the notification snipppet.
-# sSMTP has to be installed and configured manually.
+# mSMTP/sSMTP has to be installed and configured manually.
 # Modify to fit your setup - changing SendMailFrom, SendMailTo, SubjectTag
 
+MSMTP=$(which msmtp)
+SSMTP=$(which ssmtp)
+
+if [ -n $MSMPT ] ; then  
+	MAIL=$MSMTP
+elif [ -n $SSMTP ] && [ -z $MAIL ] ; then
+	MAIL=$SSMTP
+else
+	echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1
+fi
+
 send_notification() {
 Updates=("$@")
 UpdToString=$( printf "%s\n" "${Updates[@]}" )
@@ -16,7 +28,7 @@ SubjectTag="dockcheck"
 
 printf "\nSending email notification.\n"
 
-ssmtp $SendMailTo << __EOF
+$MAIL $SendMailTo << __EOF
 From: "$FromHost" <$SendMailFrom>
 date:$(date -R)
 To: <$SendMailTo>