Merge pull request #39 from mag37/fixing

Fixes `dc_brief.sh` to only exclude exact matches.

README.md

@@ -1,5 +1,28 @@
-# dockcheck
+<p align="center">
-### A script checking updates for docker images **without pulling** - then selectively auto-update some/all containers.  
+  <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!">
+  <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">
+  <a href="https://ko-fi.com/mag37"><img src="https://img.shields.io/badge/-Ko--fi-grey?style=flat-square&logo=Ko-fi" alt="Buy me a Coffee"></a>
+  <a href="https://liberapay.com/user-bin-rob/donate"><img src="https://img.shields.io/badge/-LiberaPay-grey?style=flat-square&logo=liberapay" alt="LiberaPay"></a>
+  <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>
+<h4 align="center">With features like excluding specific containers, filter by name, auto-prune dangling images and more.</h4</h3>
+
+
+### :pushpin: Recent changes:
+- **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.
+- **v0.2.1**: Added option to exclude a list of containers.
+- **v0.2.1**: Added multi-compose support (eg. override). 
+- **v0.2.0**: Fixed error with container:tag definition. 
+- **v0.1.9:** Fixed custom env-support. 
 ___
 
 ## Dependencies:
@@ -9,18 +32,19 @@ User will be prompted to download `regctl` if not in `PATH` or `PWD`
 ___
 
 
-![](https://github.com/mag37/dockcheck/blob/main/example.gif)
+![](extras/example.gif)
 
 ## `dockcheck.sh`
 ```
 $ ./dockcheck.sh -h
 Syntax:     dockcheck.sh [OPTION] [part of name to filter]
-Example:    dockcheck.sh -a ng
+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.
 ```
@@ -51,26 +75,9 @@ After the updates are complete, you'll get prompted if you'd like to prune dangl
 `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.
 
-
-### :beetle: Squashed Bugs:
-- ~~No options for running without updates or auto update.~~
-- ~~No filter to check only specific containers.~~
-- ~~Faulty registry checkups stopped the updates completely.~~
-- ~~No clear checks to skip containers producing errors.~~
-- ~~Multi-digest images didn't correctly check with registry, giving false positives on updates.~~
-- ~~Not working with filenames other than `docker-compose.yml`~~
-- ~~Lists are not alphabetically sorted (due to stacks and other parameters)~~
-- ~~Old `docker-compose` binary-check sometimes returned false error~~
-- ~~Stacks gets updated as whole, even if only one service is chosen.~~
-- ~~Path broken occationally (from inspect) - probably due to old docker-compose binary.~~
-- ~~Script breaks if one of the chosen containers are a `docker run` container.~~
-- ~~Using relative paths for volumes eg. `${PWD}/data:data` will create the volumes where you stand.~~
-- ~~Having no curl/wget leads to corrupt `regctl` without alerting.~~
-- ~~Using custom `.env` files does not work.~~
-
 ### :hammer: Known issues
-- ~~No granular choice of what to update (except initial name filter).~~
 - No detailed error feedback (just skip + list what's skipped) .
+- Not respecting `--profile` options when re-creating the container.
 
 ## `dc_brief.sh`
 Just a brief, slimmed down version of the script to only print what containers got updates, no updates or errors.
@@ -80,7 +87,7 @@ dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/l
 ___
 
 ## Check out a spinoff brother-project:
-### [Palleri/dockcheck-web](https://github.com/Palleri/dockcheck-web) for a WebUI-front!
+### [Palleri/DCW](https://github.com/Palleri/DCW) for a WebUI-front with exporters and notifications.
 
 ## Special Thanks:
 - :bison: [t0rnis](https://github.com/t0rnis)   

dc_brief.sh

@@ -1,8 +1,22 @@
+#!/usr/bin/env bash
+
 ### If not in PATH, set full path. Else just "regctl"
 regbin="regctl"
+### options to allow exclude:
+while getopts "e:" options; do
+  case "${options}" in
+    e) Exclude=${OPTARG} ;;
+    *) exit 0 ;;
+  esac
+done
+shift "$((OPTIND-1))"
+### Create array of excludes
+IFS=',' read -r -a Excludes <<< "$Exclude" ; unset IFS
+
 SearchName="$1"
 
 for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
+  for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done
   printf ". "
   RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
   LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
@@ -34,3 +48,4 @@ if [[ -n ${GotUpdates[*]} ]] ; then
    printf "\n\033[0;33mContainers with updates available:\033[0m\n"
    printf "%s\n" "${GotUpdates[@]}"
 fi
+printf "\n\n"

dockcheck.sh

@@ -1,37 +1,112 @@
 #!/usr/bin/env bash
-VERSION="v0.1.9"
+VERSION="v0.2.4"
+### ChangeNotes: Fixes to the Exclude-option to only exclude exact matches. +cleaning
 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:
-LatestRelease="$(curl -s -r 0-50 https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
+LatestRelease="$(curl -s -r 0-50 $RawUrl | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
-[ "$VERSION" != "$LatestRelease" ] && printf "New version available! Latest: %s - Local: %s \nGrab it here: %s \n\n" "$LatestRelease" "$VERSION" "$Github"
+LatestChanges="$(curl -s -r 0-200 $RawUrl | sed -n "/ChangeNotes/s/### ChangeNotes: //p")"
 
 ### Help Function:
 Help() {
   echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]" 
-  echo "Example:    dockcheck.sh -a ng"
+  echo "Example:    dockcheck.sh -a -e nextcloud,heimdall"
   echo
   echo "Options:"
   echo "-h     Print this Help."
   echo "-a|y   Automatic updates, without interaction."
   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"
 }
 
-while getopts "aynprh" options; do
+while getopts "aynprhe:" 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 ;;
   esac
 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 checkout "$ScriptUpstream"
+    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 ---"
+    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"
+  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"
+  fi
+}
+
+### Choose from list -function:
+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 
+      exit 0
+    elif [[ "$Choice" =~ [aAyY] ]] ; then
+      SelectedUpdates=( "${GotUpdates[@]}" )
+      ChoiceClean=${Choice//[,.:;]/ }
+    else
+      ChoiceClean=${Choice//[,.:;]/ }
+      for CC in $ChoiceClean ; do
+        if [[ "$CC" -lt 1 || "$CC" -gt $UpdCount ]] ; then # reset choice if out of bounds
+          echo "Number not in list: $CC" ; unset ChoiceClean ; break 1
+        else
+          SelectedUpdates+=( "${GotUpdates[$CC-1]}" )
+        fi
+      done
+    fi
+  done
+  printf "\nUpdating containers:\n"
+  printf "%s\n" "${SelectedUpdates[@]}"
+  printf "\n"
+}
+
+### 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 ; }
+
 ### Set $1 to a variable for name filtering later.
 SearchName="$1"
+### Create array of excludes
+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" ;
@@ -60,10 +135,8 @@ fi
 $regbin version &> /dev/null  || { printf "%s\n" "regctl is not working - try to remove it and re-download it, exiting."; exit 1; }
 
 ### Check docker compose binary:
-if docker compose version &> /dev/null ; then 
+if docker compose version &> /dev/null ; then DockerBin="docker compose" ;
-  DockerBin="docker compose"
+elif docker-compose -v &> /dev/null; then DockerBin="docker-compose" ;
-elif docker-compose -v &> /dev/null; then
-  DockerBin="docker-compose"
 elif docker -v &> /dev/null; then
   printf "%s\n" "No docker compose binary available, using plain docker (Not recommended!)"
   printf "%s\n" "'docker run' will ONLY update images, not the container itself."
@@ -81,33 +154,17 @@ for i in "${GotUpdates[@]}"; do
 done
 }
 
-### Choose from list -function:
+### Listing typed exclusions:
-choosecontainers() {
+if [[ -n ${Excludes[*]} ]] ; then
-  while [[ -z "$ChoiceClean" ]]; do
+  printf "\n\033[0;34mExcluding these names:\033[0m\n"
-    read -r -p "Enter number(s) separated by comma, [a] for all - [q] to quit: " Choice
+  printf "%s\n" "${Excludes[@]}"
-    if [[ "$Choice" =~ [qQnN] ]] ; then 
-      exit 0
-    elif [[ "$Choice" =~ [aAyY] ]] ; then
-      SelectedUpdates=( "${GotUpdates[@]}" )
-      ChoiceClean=${Choice//[,.:;]/ }
-    else
-      ChoiceClean=${Choice//[,.:;]/ }
-      for CC in $ChoiceClean ; do
-        if [[ "$CC" -lt 1 || "$CC" -gt $UpdCount ]] ; then # reset choice if out of bounds
-          echo "Number not in list: $CC" ; unset ChoiceClean ; break 1
-        else
-          SelectedUpdates+=( "${GotUpdates[$CC-1]}" )
-        fi
-      done
-    fi
-  done
-  printf "\nUpdating containers:\n"
-  printf "%s\n" "${SelectedUpdates[@]}"
   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
+  ### Looping every item over the list of excluded names and skipping:
+  for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done 
   printf ". "
   RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
   LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
@@ -151,8 +208,12 @@ if [ -n "$GotUpdates" ] ; then
     SelectedUpdates=( "${GotUpdates[@]}" )
   fi
   if [ "$UpdYes" == "${UpdYes#[Nn]}" ] ; then
+    NumberofUpdates="${#SelectedUpdates[@]}"
+    CurrentQue=0
     for i in "${SelectedUpdates[@]}"
-    do 
+    do
+      ((CurrentQue+=1))
+      unset CompleteConfs
       ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir" }}')
       ContConfigFile=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.config_files" }}')
       ContName=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.service" }}')
@@ -175,13 +236,18 @@ if [ -n "$GotUpdates" ] ; then
         ComposeFile="$ContPath/$ContConfigFile"
       fi
       ### cd to the compose-file directory to account for people who use relative volumes, eg - ${PWD}/data:data
-      cd "$(dirname "${ComposeFile}")" || { echo "Path error - skipping $i" ; continue ; }
+      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"
       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 -f "$ComposeFile" --env-file "$ContEnv" up -d "$ContName"
+        $DockerBin ${CompleteConfs[@]} --env-file "$ContEnv" up -d "$ContName" # unquoted array to allow split - rework?
       else
-        $DockerBin -f "$ComposeFile" up -d "$ContName"
+        $DockerBin ${CompleteConfs[@]} up -d "$ContName" # unquoted array to allow split - rework?
       fi
     done
     printf "\033[0;32mAll done!\033[0m\n"

errorCheck.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+SearchName="$1"
+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 ; }
+  ContConfigFile=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.config_files" }}')
+  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
+    ComposeFile="$ContPath/$ContConfigFile"
+  fi
+
+  echo -e "Service name:\t\t$ContName"
+  echo -e "Project working dir:\t$ContPath"
+  echo -e "Compose files:\t\t$ComposeFile"
+  echo -e "Environment files:\t$ContEnv"
+  echo -e "Container image:\t$ContImage"
+  echo
+  echo "Mounts:"
+  docker inspect  -f '{{ range .Mounts }}{{ .Source }}:{{ .Destination }}{{ printf "\n" }}{{ end }}' "$i"
+  echo
+done

extras/temp

@@ -0,0 +1 @@
+temp