New updates to readme

add a generic sample notification and a DSM notification addon

README.md

@@ -15,7 +15,12 @@
 <h4 align="center">With features like excluding specific containers, filter by name, auto-prune dangling images and more.</h4</h3>
 
 
-### :pushpin: Recent changes:
+### :bell: Recent changes
+- **v0.3.2**: Added a notify function to wrap a notify-script, currently DSM/Ssmtp + template script.
+- **v0.3.1**: Addded option `-m` , monochrome mode - no printf color codes.
+- **v0.3.0**: Added option `-d N`, age (days) new images have to be before being pulled and updated.
+- **v0.2.6**: regctl check / download logic changed. Now using the scripts directory as primary location.
+- **v0.2.5**: Added a new option `-s` to include stopped containers in the check for updates.
 - **v0.2.4**: Fixed a bug with the Exclude-logic to only exclude exact matches. Added a counter.
 - **v0.2.3**: Added a self updating function (curl/git) and a ugly changenote-message for updates.
 - **v0.2.2**: Fixed breaking errors with multi-compose, odd breakage and working dir error.
@@ -25,7 +30,7 @@
 - **v0.1.9:** Fixed custom env-support. 
 ___
 
-## Dependencies:
+## Dependencies
 Running docker (duh) and compose, either standalone or plugin.   
 [`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`
@@ -37,16 +42,18 @@ ___
 ## `dockcheck.sh`
 ```
 $ ./dockcheck.sh -h
-Syntax:     dockcheck.sh [OPTION] [part of name to filter]
-Example:    dockcheck.sh -a -e nextcloud,heimdall
-
-Options:
--h     Print this Help.
--a|y   Automatic updates, without interaction.
--n     No updates, only checking availability.
--e     Exclude containers, separated by comma.
--p     Auto-Prune dangling images after update.
--r     Allow updating images for docker run, wont update the container.
+ Syntax:     dockcheck.sh [OPTION] [part of name to filter] 
+ Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall
+ 
+ Options:
+ -h     Print this Help.
+ -a|y   Automatic updates, without interaction.
+ -n     No updates, only checking availability.
+ -e X   Exclude containers, separated by comma.
+ -d N   Only update to new images that are N+ days old. Lists too recent with +prefix. 2xSlower.
+ -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).
 ```
 
 Basic example:
@@ -62,22 +69,25 @@ Containers with updates available:
 2) syncthing
 3) whoogle-search
 
-
 Choose what containers to update:
 Enter number(s) separated by comma, [a] for all - [q] to quit:
-
 ```
 Then it proceedes to run `pull` and `up -d` on every container with updates.   
 After the updates are complete, you'll get prompted if you'd like to prune dangling images.
 
-### `-r flag` :warning: disclaimer and warning:
+### Notifications:
+
+A simple email notification function is added, with a generic example and DSM/Ssmtp script by [yoyoma2](https://github.com/yoyoma2). Further addons are welcome, suggestions or PR!   
+
+### :warning: `-r flag` disclaimer and warning
 **Wont auto-update the containers, only their images. (compose is recommended)**   
 `docker run` dont support using new images just by restarting a container.  
 Containers need to be manually stopped, removed and created again to run on the new image.
 
 ### :hammer: Known issues
-- No detailed error feedback (just skip + list what's skipped) .
+- No detailed error feedback (just skip + list what's skipped).
 - Not respecting `--profile` options when re-creating the container.
+- Not working well with containers created by Portainer.
 
 ## `dc_brief.sh`
 Just a brief, slimmed down version of the script to only print what containers got updates, no updates or errors.
@@ -86,9 +96,8 @@ Just a brief, slimmed down version of the script to only print what containers g
 dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
 ___
 
-## Check out a spinoff brother-project:
-### [Palleri/DCW](https://github.com/Palleri/DCW) for a WebUI-front with exporters and notifications.
+### Check out a spinoff project: [Palleri/DCW](https://github.com/Palleri/DCW) for a WebUI-front with exporters and notifications.
 
-## Special Thanks:
+## Special Thanks
 - :bison: [t0rnis](https://github.com/t0rnis)   
 - :leopard: [Palleri](https://github.com/Palleri)

dockcheck.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-VERSION="v0.2.4"
-### ChangeNotes: Fixes to the Exclude-option to only exclude exact matches. +cleaning
+VERSION="v0.3.2"
+### ChangeNotes: Added a notify function - template and email script (DSM etc)
 Github="https://github.com/mag37/dockcheck"
 RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
 
@@ -14,28 +14,47 @@ 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")"
 
+[ -s $ScriptWorkDir/notify.sh ] && source $ScriptWorkDir/notify.sh
+
 ### Help Function:
 Help() {
   echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]" 
-  echo "Example:    dockcheck.sh -a -e nextcloud,heimdall"
+  echo "Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall"
   echo
   echo "Options:"
-  echo "-h     Print this Help."
   echo "-a|y   Automatic updates, without interaction."
+  echo "-d N   Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower."
+  echo "-e X   Exclude containers, separated by comma."
+  echo "-h     Print this Help."
+  echo "-m     Monochrome mode, no printf color codes."
   echo "-n     No updates, only checking availability."
-  echo "-e     Exclude containers, separated by comma."
   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)"
 }
 
-while getopts "aynprhe:" options; do
+### Colors:
+c_red="\033[0;31m"
+c_green="\033[0;32m"
+c_yellow="\033[0;33m"
+c_blue="\033[0;34m"
+c_teal="\033[0;36m"
+c_reset="\033[0m"
+
+
+Stopped=""
+while getopts "aynprhsme:d:" options; do
   case "${options}" in
-    a|y) UpdYes="yes" ;;
-    n) UpdYes="no" ;;
-    r) DrUp="yes" ;;
-    p) PruneQ="yes" ;;
-    e) Exclude=${OPTARG} ;;
-    h|*) Help ; exit 0 ;;
+    a|y) AutoUp="yes" ;;
+    n)   AutoUp="no" ;;
+    r)   DRunUp="yes" ;;
+    p)   AutoPrune="yes" ;;
+    e)   Exclude=${OPTARG} ;;
+    m)   declare c_{red,green,yellow,blue,teal,reset}="" ;;
+    s)   Stopped="-a" ;;
+    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 ;;
   esac
 done
 shift "$((OPTIND-1))"
@@ -47,7 +66,6 @@ self_update_git() {
   git fetch
   [ -n "$(git diff --name-only "$ScriptUpstream" "$ScriptName")" ] && {
     printf "%s\n" "Pulling the latest version."
-   # git checkout "$ScriptUpstream"
     git pull --force
     printf "%s\n" "--- starting over with the updated version ---"
     cd - || { printf "Path error.\n" ; return ; }
@@ -100,8 +118,19 @@ choosecontainers() {
   printf "\n"
 }
 
+datecheck() {
+  ImageDate=$($regbin image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1 )
+  ImageAge=$((($(date +%s) - $(date -d "$ImageDate" +%s))/86400))
+  if [ $ImageAge -gt $DaysOld ] ; then
+    return 0
+  else
+    return 1
+  fi
+}
+
+
 ### Version check & initiate self update
-[[ "$VERSION" != "$LatestRelease" ]] && { printf "New version available! Local: %s - Latest: %s \n Change Notes: %s \n" "$VERSION" "$LatestRelease" "$LatestChanges" ; [[ -z "$UpdYes" ]] && self_update_select ; }
+[[ "$VERSION" != "$LatestRelease" ]] && { printf "New version available! Local: %s - Latest: %s \n Change Notes: %s \n" "$VERSION" "$LatestRelease" "$LatestChanges" ; [[ -z "$AutoUp" ]] && self_update_select ; }
 
 ### Set $1 to a variable for name filtering later.
 SearchName="$1"
@@ -110,7 +139,7 @@ IFS=',' read -r -a Excludes <<< "$Exclude" ; unset IFS
 
 ### Check if required binary exists in PATH or directory:
 if [[ $(builtin type -P "regctl") ]]; then regbin="regctl" ;
-elif [[ -f "./regctl" ]]; then regbin="./regctl" ;
+elif [[ -f "$ScriptWorkDir/regctl" ]]; then regbin="$ScriptWorkDir/regctl" ;
 else
   read -r -p "Required dependency 'regctl' missing, do you want it downloaded? y/[n] " GetDep
   if [[ "$GetDep" =~ [yY] ]] ; then
@@ -121,8 +150,8 @@ else
       *) echo "Architecture not supported, exiting." ; exit 1;;
     esac
     RegUrl="https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture"
-    if [[ $(builtin type -P curl) ]]; then curl -L $RegUrl > ./regctl ; chmod +x ./regctl ; regbin="./regctl" ;
-    elif [[ $(builtin type -P wget) ]]; then wget $RegUrl -O ./regctl ; chmod +x ./regctl ; regbin="./regctl" ;
+    if [[ $(builtin type -P curl) ]]; then curl -L $RegUrl > "$ScriptWorkDir/regctl" ; chmod +x "$ScriptWorkDir/regctl" ; regbin="$ScriptWorkDir/regctl" ;
+    elif [[ $(builtin type -P wget) ]]; then wget $RegUrl -O "$ScriptWorkDir/regctl" ; chmod +x "$ScriptWorkDir/regctl" ; regbin="$ScriptWorkDir/regctl" ;
     else
       printf "%s\n" "curl/wget not available - get regctl manually from the repo link, quitting."
     fi
@@ -156,13 +185,13 @@ done
 
 ### Listing typed exclusions:
 if [[ -n ${Excludes[*]} ]] ; then
-  printf "\n\033[0;34mExcluding these names:\033[0m\n"
+  printf "\n%bExcluding these names:%b\n" $c_blue $c_reset
   printf "%s\n" "${Excludes[@]}"
   printf "\n"
 fi
 
 ### Check the image-hash of every running container VS the registry
-for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
+for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}') ; do
   ### Looping every item over the list of excluded names and skipping:
   for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done 
   printf ". "
@@ -170,7 +199,15 @@ for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
   LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
   ### Checking for errors while setting the variable:
   if RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null) ; then
-    if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi
+    if [[ "$LocalHash" = *"$RegHash"* ]] ; then 
+      NoUpdates+=("$i") 
+    else 
+      if [[ -n "$DaysOld" ]] && ! datecheck ; then
+        NoUpdates+=("+$i ${ImageAge}d") 
+      else 
+        GotUpdates+=("$i")
+      fi
+    fi
   else
     GotErrors+=("$i")
   fi
@@ -187,27 +224,28 @@ UpdCount="${#GotUpdates[@]}"
 
 ### List what containers got updates or not
 if [[ -n ${NoUpdates[*]} ]] ; then
-  printf "\n\033[0;32mContainers on latest version:\033[0m\n"
+  printf "\n%bContainers on latest version:%b\n" "$c_green" "$c_reset"
   printf "%s\n" "${NoUpdates[@]}"
 fi
 if [[ -n ${GotErrors[*]} ]] ; then
-  printf "\n\033[0;31mContainers with errors, wont get updated:\033[0m\n"
+  printf "\n%bContainers with errors, wont get updated:%b\n" "$c_red" "$c_reset"
   printf "%s\n" "${GotErrors[@]}"
 fi
 if [[ -n ${GotUpdates[*]} ]] ; then 
-   printf "\n\033[0;33mContainers with updates available:\033[0m\n"
-   [[ -z "$UpdYes" ]] && options || printf "%s\n" "${GotUpdates[@]}"
+   printf "\n%bContainers with updates available:%b\n" "$c_yellow" "$c_reset"
+   [[ -z "$AutoUp" ]] && options || printf "%s\n" "${GotUpdates[@]}"
+   [[ $(type -t send_notification) == function ]] && send_notification "${GotUpdates[@]}"
 fi
 
 ### Optionally get updates if there's any 
 if [ -n "$GotUpdates" ] ; then
-  if [ -z "$UpdYes" ] ; then
-  printf "\n\033[0;36mChoose what containers to update.\033[0m\n"
+  if [ -z "$AutoUp" ] ; then
+  printf "\n%bChoose what containers to update.%b\n" "$c_teal" "$c_reset"
   choosecontainers
   else
     SelectedUpdates=( "${GotUpdates[@]}" )
   fi
-  if [ "$UpdYes" == "${UpdYes#[Nn]}" ] ; then
+  if [ "$AutoUp" == "${AutoUp#[Nn]}" ] ; then
     NumberofUpdates="${#SelectedUpdates[@]}"
     CurrentQue=0
     for i in "${SelectedUpdates[@]}"
@@ -221,11 +259,11 @@ if [ -n "$GotUpdates" ] ; then
       ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
       ### Checking if compose-values are empty - hence started with docker run:
       if [ -z "$ContPath" ] ; then 
-        if [ "$DrUp" == "yes" ] ; then
+        if [ "$DRunUp" == "yes" ] ; then
           docker pull "$ContImage"
           printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters"
         else
-          printf "\n\033[33;1m%s\033[0m has no compose labels, probably started with docker run - \033[33;1mskipping\033[0m\n\n" "$i"
+          printf "\n%b%s%b has no compose labels, probably started with docker run - %bskipping%b\n\n" "$c_yellow" "$i" "$c_reset" "$c_yellow" "$c_reset"
         fi
         continue 
       fi
@@ -237,7 +275,7 @@ if [ -n "$GotUpdates" ] ; then
       fi
       ### cd to the compose-file directory to account for people who use relative volumes, eg - ${PWD}/data:data
       cd "$ContPath" || { echo "Path error - skipping $i" ; continue ; }
-      printf "\n\033[0;36mNow updating (%s/%s): \033[0;34m%s\033[0m\n" "$CurrentQue" "$NumberofUpdates" "$i"
+      printf "\n%bNow updating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
       docker pull "$ContImage"
       ### Reformat for multi-compose:
       IFS=',' read -r -a Confs <<< "$ComposeFile" ; unset IFS
@@ -250,9 +288,9 @@ if [ -n "$GotUpdates" ] ; then
         $DockerBin ${CompleteConfs[@]} up -d "$ContName" # unquoted array to allow split - rework?
       fi
     done
-    printf "\033[0;32mAll done!\033[0m\n"
-    [[ -z "$PruneQ" ]] && read -r -p "Would you like to prune dangling images? y/[n]: " PruneQ
-    [[ "$PruneQ" =~ [yY] ]] && docker image prune -f 
+    printf "\n%bAll done!%b\n" "$c_green" "$c_reset"
+    [[ -z "$AutoPrune" ]] && read -r -p "Would you like to prune dangling images? y/[n]: " AutoPrune
+    [[ "$AutoPrune" =~ [yY] ]] && docker image prune -f 
   else
     printf "\nNo updates installed, exiting.\n"
   fi

notify_DSM.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 email notifications on synology DSM
+# Modify to your liking - changing SendMailTo and Subject and content.
+
+send_notification() {
+Updates=("$@")
+UpdToString=$( printf "%s\n" "${Updates[@]}" )
+# change this to your usual destination for synology DSM notification emails
+SendMailTo=me@mydomain.com
+FromHost=$(hostname)
+
+printf "\nSending email notification\n"
+
+ssmtp $SendMailTo << __EOF
+From: "$FromHost" <$SendMailTo>
+date:$(date -R)
+To: <$SendMailTo>
+Subject: [diskstation] Some docker containers need to be updated
+Content-Type: text/plain; charset=UTF-8; format=flowed
+Content-Transfer-Encoding: 7bit
+
+The following docker containers on $FromHost need to be updated:
+
+$UpdToString
+
+ From $FromHost
+
+__EOF
+}

notify_generic.sh

@@ -0,0 +1,13 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+# Copy/rename this file to notify.sh to enable email/text notifications
+# generic sample, the "Hello World" of notification addons
+
+send_notification() {
+  Updates=("$@")
+  UpdToString=$( printf "%s\n" "${Updates[@]}" )
+  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%s\n" "$FromHost" "$UpdToString"
+}