version bump+info

style: Add pre-commit checks and code cleanup

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+    - id: check-yaml
+    - id: check-added-large-files
+    - id: trailing-whitespace
+      args: [--markdown-linebreak-ext=md]
+    - id: end-of-file-fixer
+    - id: mixed-line-ending
+      args: ['--fix=lf']

README.md

@@ -1,8 +1,7 @@
 <p align="center">
   <img src="extras/dockcheck_logo_by_booYah187.png" width="160" title="dockcheck">
 </p>
-<p align="center"> 
-  <img src="https://img.shields.io/badge/coded%20by%20Human-100%25-yellow?style=flat-square" alt="No AI!">
+<p align="center">
   <img src="https://img.shields.io/badge/bash-4.3-green?style=flat-square&logo=gnubash" alt="bash">
   <a href="https://www.gnu.org/licenses/gpl-3.0.html"><img src="https://img.shields.io/badge/license-GPLv3-red?style=flat-square" alt="GPLv3"></a>
   <img src="https://img.shields.io/github/v/tag/mag37/dockcheck?style=flat-square&label=release" alt="release">
@@ -11,25 +10,24 @@
   <a href="https://github.com/sponsors/mag37"><img src="https://img.shields.io/badge/-Sponsor-grey?style=flat-square&logo=github" alt="Github Sponsor"></a>
 </p>
 
-<h3 align="center">A script checking updates for docker images <b>without pulling</b><br>Then selectively auto-update containers.</h3>
-<h2 align="center">Now with a simple Apprise integration!</h2>
-<h4 align="center">With features like excluding specific containers, filter by name, auto-prune dangling images and more.</h4>
+<h3 align="center">CLI tool to automate docker image updates. <br>No <b>pre-pull</b>, selective, optional notifications and prune when done.</h3>
+<h2 align="center">Now with simple notification integrations!</h2>
+<h4 align="center">With features like excluding specific containers, custom container labels, auto-prune when done and more.</h4>
 
 ___
 ## :bell: Changelog
-- **v0.3.5**: Added a simple progress bar for the registry checkup.
-- **v0.3.4**: Added ntfy.sh template and error message on registry fail.
-- **v0.3.3**: Added Apprise template and the option `-i` inform - to send notifications.
-- **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.
-___
 
-## :nut_and_bolt: 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`.   
-  - regctl requires `amd64/arm64` - see [workaround](#workaround-for-non-amd64--arm64) if other architecture is used.
+- **v0.4.8**: Rewrote prune logic to not prompt with options `-a|-y` or `-n`. Auto prune with `-p`.
+- **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.
+- **v0.3.7**: Added support for [labels](#bookmark-labels), added the `-f` option (force restart stack).
+- **v0.3.6**: Added pushbullet template.
+- **v0.3.5**: Added a simple progress bar for the registry checkup.
 ___
 
 
@@ -38,22 +36,27 @@ ___
 ## :mag_right: `dockcheck.sh`
 ```
 $ ./dockcheck.sh -h
- Syntax:     dockcheck.sh [OPTION] [part of name to filter]
- Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall
- 
- Options:
- -a|y   Automatic updates, without interaction.
- -d N   Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
- -e X   Exclude containers, separated by comma.
- -h     Print this Help.
- -i     Inform - send a preconfigured notification.
- -m     Monochrome mode, no printf color codes.
- -n     No updates, only checking availability.
- -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)
+Syntax:     dockcheck.sh [OPTION] [part of name to filter]
+Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall
+
+Options:"
+-a|y   Automatic updates, without interaction.
+-d N   Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
+-e X   Exclude containers, separated by comma.
+-f     Force stack restart after update. Caution: restarts once for every updated container within stack.
+-h     Print this Help.
+-i     Inform - send a preconfigured notification.
+-l     Only update if label is set. See readme.
+-m     Monochrome mode, no printf color codes.
+-n     No updates, only checking availability.
+-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.
 ```
 
+
 ### Basic example:
 ```
 $ ./dockcheck.sh
@@ -70,24 +73,62 @@ Containers with updates available:
 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.   
+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.
 
+___
+
+## :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.
+
+## :tent: Install Instructions
+Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.
+```sh
+# basic example with curl:
+curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o ~/.local/bin/dockcheck.sh
+chmod +x ~/.local/bin/dockcheck.sh
+
+# or oneliner with wget:
+wget -O ~/.local/bin/dockcheck.sh "https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" && chmod +x ~/.local/bin/dockcheck.sh
+```
+Then call the script anywhere with just `dockcheck.sh`.
+Add preferred `notify.sh`-template to the same directory - this will not be touched by the scripts self-update function.
+
+
 ## :loudspeaker: Notifications
-Trigger with the `-i` flag.   
+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!   
-Current templates:
+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:**
 - 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.
 
-Further additions are welcome - suggestions or PR!   
+Further additions are welcome - suggestions or PR!  
 <sub><sup>Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).</sup></sub>  
 
+## :bookmark: Labels
+Optionally add labels to compose-files. Currently these are the usable labels:
+```
+    labels:
+      mag37.dockcheck.restart-stack: true
+      mag37.dockcheck.update: true
+```
+- `mag37.dockcheck.restart-stack: true` works instead of the `-f` option, forcing stop+restart on the whole compose-stack (Caution: Will restart on every updated container within stack).
+- `mag37.dockcheck.update: true` will when used with the `-l` option only update containers with this label and skip the rest. Will still list updates as usual.
+
 ## :roller_coaster: Workaround for non **amd64** / **arm64**
 `regctl` provides binaries for amd64/arm64, to use on other architecture you could try this workaround.
 Run regctl in a container wrapped in a shell script. Copied from [regclient/docs/install.md](https://github.com/regclient/regclient/blob/main/docs/install.md):
@@ -108,24 +149,33 @@ 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
+**Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
+```sh
+function dchk {
+  cat ~/pwd.txt | docker login --username YourUser --password-stdin
+  ~/dockcheck.sh "$@"
+}
+```
+
 ## :hammer: Known issues
 - 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.
 
 ## :warning: `-r flag` disclaimer and warning
-**Wont auto-update the containers, only their images. (compose is recommended)**   
+**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.
 
 ## :scroll: License
 dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
 
-### :floppy_disk: The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in the mirror.
+### :floppy_disk: The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect.
 
 ___
 
 
 ## Special Thanks
-- :bison: [t0rnis](https://github.com/t0rnis)   
+- :bison: [t0rnis](https://github.com/t0rnis)  
 - :leopard: [Palleri](https://github.com/Palleri)

dockcheck.sh

@@ -1,13 +1,12 @@
 #!/usr/bin/env bash
-VERSION="v0.3.5"
-### ChangeNotes: Added a simple handcrafted progress bar.
+VERSION="v0.4.8"
+### ChangeNotes: Rewrote prune to not prompt (default no) if -a|-y or -n flags are used. -p will still autoprune.
 Github="https://github.com/mag37/dockcheck"
 RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
 
 ### Variables for self updating
 ScriptArgs=( "$@" )
 ScriptPath="$(readlink -f "$0")"
-ScriptName="$(basename "$ScriptPath")"
 ScriptWorkDir="$(dirname "$ScriptPath")"
 
 ### Check if there's a new release of the script:
@@ -17,20 +16,24 @@ LatestChanges="$(curl -s -r 0-200 $RawUrl | sed -n "/ChangeNotes/s/### ChangeNot
 
 ### Help Function:
 Help() {
-  echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]" 
+  echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]"
   echo "Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall"
   echo
   echo "Options:"
   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 "-f     Force stack restart after update. Caution: restarts once for every updated container within stack."
   echo "-h     Print this Help."
   echo "-i     Inform - send a preconfigured notification."
+  echo "-l     Only update if label is set. See readme."
   echo "-m     Monochrome mode, no printf color codes."
   echo "-n     No updates, only checking availability."
   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 "-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."
 }
 
 ### Colors:
@@ -41,17 +44,22 @@ c_blue="\033[0;34m"
 c_teal="\033[0;36m"
 c_reset="\033[0m"
 
+Timeout=10
 Stopped=""
-while getopts "aynprhisme:d:" options; do
+while getopts "aynpfrhlisvme:d:t:" options; do
   case "${options}" in
     a|y) AutoUp="yes" ;;
     n)   AutoUp="no" ;;
     r)   DRunUp="yes" ;;
     p)   AutoPrune="yes" ;;
-    i)   [ -s $ScriptWorkDir/notify.sh ] && { source $ScriptWorkDir/notify.sh ; Notify="yes" ; } ;;
+    l)   OnlyLabel=true ;;
+    f)   ForceRestartStacks=true ;;
+    i)   [ -s "$ScriptWorkDir"/notify.sh ] && { source "$ScriptWorkDir"/notify.sh ; Notify="yes" ; } ;;
     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 ;;
     h|*) Help ; exit 2 ;;
@@ -59,37 +67,35 @@ while getopts "aynprhisme:d:" options; do
 done
 shift "$((OPTIND-1))"
 
-self_update_git() {
-  cd "$ScriptWorkDir" || { printf "Path error, skipping update.\n" ; return ; }
-  [[ $(builtin type -P git) ]] || { printf "Git not installed, skipping update.\n" ; return ; }
-  ScriptUpstream=$(git rev-parse --abbrev-ref --symbolic-full-name "@{upstream}") || { printf "Script not in git directory, choose a different method.\n" ; self_update_select ; return ; }
-  git fetch
-  [ -n "$(git diff --name-only "$ScriptUpstream" "$ScriptName")" ] && {
-    printf "%s\n" "Pulling the latest version."
-    git pull --force
-    printf "%s\n" "--- starting over with the updated version ---"
-    cd - || { printf "Path error.\n" ; return ; }
-    exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
-    exit 1 # exit the old instance
-  }
-  echo "Local is already latest."
-}
 self_update_curl() {
   cp "$ScriptPath" "$ScriptPath".bak
-  if [[ $(builtin type -P curl) ]]; then 
-    curl -L $RawUrl > "$ScriptPath" ; chmod +x "$ScriptPath"  
-    printf "%s\n" "--- starting over with the updated version ---"
+  if [[ $(builtin type -P curl) ]]; then
+    curl -L $RawUrl > "$ScriptPath" ; chmod +x "$ScriptPath"
+    printf "\n%s\n" "--- starting over with the updated version ---"
+    exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
+    exit 1 # exit the old instance
+  elif [[ $(builtin type -P wget) ]]; then
+    wget $RawUrl -O "$ScriptPath" ; chmod +x "$ScriptPath"
+    printf "\n%s\n" "--- starting over with the updated version ---"
     exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
     exit 1 # exit the old instance
   else
-    printf "curl not available - download the update manually: %s \n" "$RawUrl"
+    printf "curl/wget not available - download the update manually: %s \n" "$Github"
   fi
 }
-self_update_select() {
-  read -r -p "Choose update procedure (or do it manually) - git/curl/[no]: " SelfUpQ
-  if [[ "$SelfUpQ" == "git" ]]; then self_update_git ;
-  elif [[ "$SelfUpQ" == "curl" ]]; then self_update_curl ; 
-  else printf "Download it manually from the repo: %s \n\n" "$Github"
+
+self_update() {
+  cd "$ScriptWorkDir" || { printf "Path error, skipping update.\n" ; return ; }
+  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 ---"
+    cd - || { printf "Path error.\n" ; return ; }
+    exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
+    exit 1 # exit the old instance
+  else
+    cd - || { printf "Path error.\n" ; return ; }
+    self_update_curl
   fi
 }
 
@@ -97,7 +103,7 @@ self_update_select() {
 choosecontainers() {
   while [[ -z "$ChoiceClean" ]]; do
     read -r -p "Enter number(s) separated by comma, [a] for all - [q] to quit: " Choice
-    if [[ "$Choice" =~ [qQnN] ]] ; then 
+    if [[ "$Choice" =~ [qQnN] ]] ; then
       exit 0
     elif [[ "$Choice" =~ [aAyY] ]] ; then
       SelectedUpdates=( "${GotUpdates[@]}" )
@@ -120,8 +126,8 @@ choosecontainers() {
 
 datecheck() {
   ImageDate=$($regbin image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1 )
-  ImageAge=$((($(date +%s) - $(date -d "$ImageDate" +%s))/86400))
-  if [ $ImageAge -gt $DaysOld ] ; then
+  ImageAge=$(( ( $(date +%s) - $(date -d "$ImageDate" +%s) )/86400 ))
+  if [ "$ImageAge" -gt "$DaysOld" ] ; then
     return 0
   else
     return 1
@@ -131,17 +137,23 @@ datecheck() {
 progress_bar() {
   QueCurrent="$1"
   QueTotal="$2"
-  ((Percent=100*${QueCurrent}/${QueTotal}))
-  ((Complete=50*${Percent}/100)) # change first number for width (50)
-  ((Left=50-${Complete})) # change first number for width (50)
+  ((Percent=100*QueCurrent/QueTotal))
+  ((Complete=50*Percent/100)) # change first number for width (50)
+  ((Left=50-Complete)) # change first number for width (50)
   BarComplete=$(printf "%${Complete}s" | tr " " "#")
   BarLeft=$(printf "%${Left}s" | tr " " "-")
-  [[ $QueTotal == $QueCurrent ]] || printf "\r[%s%s] %s/%s " $BarComplete $BarLeft $QueCurrent $QueTotal
-  [[ $QueTotal == $QueCurrent ]] && printf "\r[%b%s%b] %s/%s \n" $c_teal $BarComplete $c_reset $QueCurrent $QueTotal
+  [[ "$QueTotal" == "$QueCurrent" ]] || printf "\r[%s%s] %s/%s " "$BarComplete" "$BarLeft" "$QueCurrent" "$QueTotal"
+  [[ "$QueTotal" == "$QueCurrent" ]] && printf "\r[%b%s%b] %s/%s \n" "$c_teal" "$BarComplete" "$c_reset" "$QueCurrent" "$QueTotal"
 }
 
 ### Version check & initiate self update
-[[ "$VERSION" != "$LatestRelease" ]] && { printf "New version available! Local: %s - Latest: %s \n Change Notes: %s \n" "$VERSION" "$LatestRelease" "$LatestChanges" ; [[ -z "$AutoUp" ]] && self_update_select ; }
+if [[ "$VERSION" != "$LatestRelease" ]] ; then
+  printf "New version available! %b%s%b ⇒ %b%s%b \n Change Notes: %s \n" "$c_yellow" "$VERSION" "$c_reset" "$c_green" "$LatestRelease" "$c_reset" "$LatestChanges"
+  if [[ -z "$AutoUp" ]] ; then
+    read -r -p "Would you like to update? y/[n]: " SelfUpdate
+    [[ "$SelfUpdate" =~ [yY] ]] && self_update
+  fi
+fi
 
 ### Set $1 to a variable for name filtering later.
 SearchName="$1"
@@ -196,31 +208,42 @@ done
 
 ### Listing typed exclusions:
 if [[ -n ${Excludes[*]} ]] ; then
-  printf "\n%bExcluding these names:%b\n" $c_blue $c_reset
+  printf "\n%bExcluding these names:%b\n" "$c_blue" "$c_reset"
   printf "%s\n" "${Excludes[@]}"
   printf "\n"
 fi
 
 # Variables for progress_bar function
-DocCount=$(docker ps --filter "name=$SearchName" --format '{{.Names}}' | wc -l)
+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))
-  progress_bar $RegCheckQue $DocCount
+  progress_bar "$RegCheckQue" "$DocCount"
   ### Looping every item over the list of excluded names and skipping:
-  for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done 
+  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:
-  if RegHash=$($regbin image digest --list "$RepoUrl" 2>&1) ; then
-    if [[ "$LocalHash" = *"$RegHash"* ]] ; then 
-      NoUpdates+=("$i") 
-    else 
+  # Checking for errors while setting the variable:
+  if RegHash=$(${t_out} $regbin image digest --list "$RepoUrl" 2>&1) ; then
+    if [[ "$LocalHash" = *"$RegHash"* ]] ; then
+      NoUpdates+=("$i")
+    else
       if [[ -n "$DaysOld" ]] && ! datecheck ; then
-        NoUpdates+=("+$i ${ImageAge}d") 
-      else 
+        NoUpdates+=("+$i ${ImageAge}d")
+      else
         GotUpdates+=("$i")
       fi
     fi
@@ -231,11 +254,12 @@ for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}')
 done
 
 ### Sort arrays alphabetically
-IFS=$'\n' 
+IFS=$'\n'
 NoUpdates=($(sort <<<"${NoUpdates[*]}"))
 GotUpdates=($(sort <<<"${GotUpdates[*]}"))
-GotErrors=($(sort <<<"${GotErrors[*]}"))
 unset IFS
+
+
 ### Define how many updates are available
 UpdCount="${#GotUpdates[@]}"
 
@@ -247,15 +271,15 @@ fi
 if [[ -n ${GotErrors[*]} ]] ; then
   printf "\n%bContainers with errors, wont get updated:%b\n" "$c_red" "$c_reset"
   printf "%s\n" "${GotErrors[@]}"
-  printf "%binfo:%b 'unauthorized' often means not found in a public registry.%b\n" "$c_blue" "$c_reset"
+  printf "%binfo:%b 'unauthorized' often means not found in a public registry.\n" "$c_blue" "$c_reset"
 fi
-if [[ -n ${GotUpdates[*]} ]] ; then 
+if [[ -n ${GotUpdates[*]} ]] ; then
    printf "\n%bContainers with updates available:%b\n" "$c_yellow" "$c_reset"
    [[ -z "$AutoUp" ]] && options || printf "%s\n" "${GotUpdates[@]}"
-   [[ ! -z "$Notify" ]] && { [[ $(type -t send_notification) == function ]] && send_notification "${GotUpdates[@]}" || printf "Could not source notification function.\n" ; }
+   [[ -n "$Notify" ]] && { [[ $(type -t send_notification) == function ]] && send_notification "${GotUpdates[@]}" || printf "Could not source notification function.\n" ; }
 fi
 
-### Optionally get updates if there's any 
+### Optionally get updates if there's any
 if [ -n "$GotUpdates" ] ; then
   if [ -z "$AutoUp" ] ; then
   printf "\n%bChoose what containers to update.%b\n" "$c_teal" "$c_reset"
@@ -275,40 +299,42 @@ if [ -n "$GotUpdates" ] ; then
       ContName=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.service" }}')
       ContEnv=$(docker inspect "$i" --format '{{index .Config.Labels "com.docker.compose.project.environment_file" }}')
       ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
+      ContUpdateLabel=$(docker inspect "$i" --format '{{ index .Config.Labels "mag37.dockcheck.update" }}')
+      ContRestartStack=$(docker inspect "$i" --format '{{ index .Config.Labels "mag37.dockcheck.restart-stack" }}')
       ### Checking if compose-values are empty - hence started with docker run:
-      if [ -z "$ContPath" ] ; then 
+      if [ -z "$ContPath" ] ; 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%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
-      ### Checking if "com.docker.compose.project.config_files" returns the full path to the config file or just the file name
-      if [[ $ContConfigFile = '/'* ]] ; then
-        ComposeFile="$ContConfigFile"
-      else
-        ComposeFile="$ContPath/$ContConfigFile"
+        continue
       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%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
-      for conf in "${Confs[@]}"; do CompleteConfs+="-f $conf " ; done 
-      
-      ### Check if the container got an environment file set, use it if so:
-      if [ -n "$ContEnv" ]; then 
-        $DockerBin ${CompleteConfs[@]} --env-file "$ContEnv" up -d "$ContName" # unquoted array to allow split - rework?
+      ## Reformatting path + multi compose
+      if [[ $ContConfigFile = '/'* ]] ; then
+        CompleteConfs=$(for conf in ${ContConfigFile//,/ } ; do printf -- "-f %s " "$conf"; done)
       else
-        $DockerBin ${CompleteConfs[@]} up -d "$ContName" # unquoted array to allow split - rework?
+        CompleteConfs=$(for conf in ${ContConfigFile//,/ } ; do printf -- "-f %s/%s " "$ContPath" "$conf"; done)
+      fi
+      printf "\n%bNow updating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
+      ### Checking if Label Only -option is set, and if container got the label
+      [[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping." ; continue ; } }
+      docker pull "$ContImage"
+      ### Check if the container got an environment file set and reformat it
+      if [ -n "$ContEnv" ]; then ContEnvs=$(for env in ${ContEnv//,/ } ; do printf -- "--env-file %s " "$env"; done) ; fi
+      ### Check if the whole stack should be restarted
+      if [[ "$ContRestartStack" == true ]] || [[ "$ForceRestartStacks" == true ]] ; then
+        $DockerBin ${CompleteConfs} stop ; $DockerBin ${CompleteConfs} ${ContEnvs} up -d
+      else
+        $DockerBin ${CompleteConfs} ${ContEnvs} up -d ${ContName}
       fi
     done
     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 
+    if [[ -z "$AutoPrune" ]] && [[ -z "$AutoUp" ]]; then read -r -p "Would you like to prune dangling images? y/[n]: " AutoPrune ; fi
+    [[ "$AutoPrune" =~ [yY] ]] && docker image prune -f
   else
     printf "\nNo updates installed, exiting.\n"
   fi
@@ -317,4 +343,3 @@ else
 fi
 
 exit 0
-

extras/apprise_quickstart.md

@@ -25,13 +25,13 @@ services:
 Then browse to the webui.
 ![](apprise-ex1.png)
 Here you'll click **Configuration Manager**, read the overview and then click on **Configuration**.
-Under **Configuration** you'll craft/paste your notification config. 
+Under **Configuration** you'll craft/paste your notification config.
 
 ![](apprise-ex2.png)
-The simplest way is just paste the url's as is (like in the example above).    
-There are many ways to customize with tags, groups, json and more. Read [caronc/apprise-api](https://github.com/caronc/apprise-api) for more info!   
+The simplest way is just paste the url's as is (like in the example above).  
+There are many ways to customize with tags, groups, json and more. Read [caronc/apprise-api](https://github.com/caronc/apprise-api) for more info!  
 
-Look at the [apprise wiki: Notification Services](https://github.com/caronc/apprise/wiki) for more info about how the url syntax for different services works.   
+Look at the [apprise wiki: Notification Services](https://github.com/caronc/apprise/wiki) for more info about how the url syntax for different services works.  
 
 
 You can also use the [caronc/apprise-api](https://github.com/caronc/apprise-api) to host the api as a frontend to an already existing **Apprise**-setup on the host.
@@ -40,7 +40,7 @@ You can also use the [caronc/apprise-api](https://github.com/caronc/apprise-api)
 ### Customize the **notify.sh** file.
 After you're done with the setup of the container and tried your notifications, you can copy the `notify_apprise.sh` file to `notify.sh` and start editing it.
 
-Comment out/remove the bare metal apprise-command (starting with `apprise -vv -t...`). 
+Comment out/remove the bare metal apprise-command (starting with `apprise -vv -t...`).
 Uncomment and edit the `AppriseURL` variable and *curl* line
 It should look something like this when curling the API:
 ```bash
@@ -72,11 +72,11 @@ ___
 
 
 ## On host installed **Apprise**
-Follow the official guide on [caronc/apprise](https://github.com/caronc/apprise)! 
+Follow the official guide on [caronc/apprise](https://github.com/caronc/apprise)!
 
 ### A brief, basic "get started"
 
-- Install **apprise** 
+- Install **apprise**
     - python package `pip install apprise`
     - packaged in EPEL/Fedora `dnf install apprise`
     - packaged in AUR `[yay/pikaur/paru/other] apprise`
@@ -92,7 +92,7 @@ Then either source the notifications with `-c=/path/to/config/apprise` or store
 - Test apprise with a single notification:
     - `apprise -vv -t 'test title' -b 'test notification body' 'mailto://myemail:mypass@gmail.com'`
 - Set up your notification URL's and test them.
-    - Look at the [apprise wiki: Notification Services](https://github.com/caronc/apprise/wiki) for more info about how the url syntax for different services works.   
+    - Look at the [apprise wiki: Notification Services](https://github.com/caronc/apprise/wiki) for more info about how the url syntax for different services works.  
 
 ### When done, customize the **notify.sh** file.
 After you're done with the setup of the container and tried your notifications, you can copy the `notify_apprise.sh` file to `notify.sh` and start editing it.

extras/dc_brief.sh

@@ -29,7 +29,7 @@ for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
 done
 
 ### Sort arrays alphabetically
-IFS=$'\n' 
+IFS=$'\n'
 NoUpdates=($(sort <<<"${NoUpdates[*]}"))
 GotUpdates=($(sort <<<"${GotUpdates[*]}"))
 GotErrors=($(sort <<<"${GotErrors[*]}"))
@@ -44,7 +44,7 @@ if [[ -n ${GotErrors[*]} ]] ; then
   printf "\n\033[0;31mContainers with errors, wont get updated:\033[0m\n"
   printf "%s\n" "${GotErrors[@]}"
 fi
-if [[ -n ${GotUpdates[*]} ]] ; then 
+if [[ -n ${GotUpdates[*]} ]] ; then
    printf "\n\033[0;33mContainers with updates available:\033[0m\n"
    printf "%s\n" "${GotUpdates[@]}"
 fi

extras/errorCheck.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 SearchName="$1"
-for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do  
+for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
   echo "------------ $i ------------"
   ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir" }}')
   [ -z "$ContPath" ] && { "$i has no compose labels - skipping" ; continue ; }
@@ -8,7 +8,7 @@ for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
   ContName=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.service" }}')
   ContEnv=$(docker inspect "$i" --format '{{index .Config.Labels "com.docker.compose.project.environment_file" }}')
   ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
-  
+
   if [[ $ContConfigFile = '/'* ]] ; then
     ComposeFile="$ContConfigFile"
   else

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
-# DSM Notification Email has to be configured manually.
+# Copy/rename this file to notify.sh to enable the notification snipppet.
+# 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
-SendMailTo="me@mydomain.com"
-SubjectTag="diskstation"
+# Automatically sends to your usual destination for synology DSM notification emails.
+# You can also manually override by assigning something else to SendMailTo below.
+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
-From: "$FromHost" <$SendMailTo>
+$MAIL $SendMailTo << __EOF
+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_apprise.sh

@@ -33,5 +33,3 @@ apprise -vv -t "$MessageTitle" -b "$MessageBody" \
 # curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
 
 }
-
-

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

@@ -0,0 +1,28 @@
+### 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 MatrixServer, Room_id and AccessToken
+
+send_notification() {
+    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"
+
+    # Modify to fit your setup:
+    AccessToken="Your Matrix token here"
+    Room_id="Enter Room_id here"
+    MatrixServer="Enter Your HomeServer URL"
+    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"
+
+}

notify_pushbullet.sh

@@ -0,0 +1,27 @@
+### 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.
+# Requires jq installed and in PATH.
+# Modify to fit your setup - set Url and Token.
+
+send_notification() {
+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.
+MessageBody="Containers on $FromHost with updates available: $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 @-
+
+}

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>

notify_telegram.sh

@@ -0,0 +1,27 @@
+### 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 TelegramChatId and TelegramToken.
+
+send_notification() {
+    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"
+
+    # Modify to fit your setup:
+    TelegramToken="Your Telegram token here"
+    TelegramChatId="Your Telegram ChatId here"
+    TelegramUrl="https://api.telegram.org/bot$TelegramToken"
+    TelegramTopicID=12345678 ## Set to 0 if not using specific topic within chat
+    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"
+
+}