+Recent Changes

Added a "Recent Changes" - section up top to make it easier to see what's new with versions.

README.md

@@ -1,5 +1,11 @@
 # dockcheck
 ### A script checking updates for docker images **without pulling** - then selectively auto-update some/all containers.  
+### :pushpin: Recent changes:
+- **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. 
+- **v0.1.8:** Added option to prune dangling images. 
 ___
 
 ## Dependencies:
@@ -15,13 +21,14 @@ ___
 ```
 $ ./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.
 -p     Auto-Prune dangling images after update.
+-e     Exclude containers, separated by comma.
 -r     Allow updating images for docker run, wont update the container.
 ```
 
@@ -66,21 +73,18 @@ Containers need to be manually stopped, removed and created again to run on the
 - ~~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.~~
+- ~~Pull not respecting image:tags, always defaulting to latest~~
+- ~~Not respecting multi-compose projects using multiple `-f` like `...override.yml` or similar.~~
+- ~~Not being able to exclude specific containers.~~
 
 ### :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.
 
-## `dupc_function.sh`
-Function to quickly check for updates on a single contianer or list of containers by name. **Without the need of pulling**.  
-Preferably placed in `.bashrc` or similar.
-Example:
-```
-$ dupc ng
-Updates available for local_nginx.
-nginx_reverse is already latest.
-Updates available for paperless-ng.
-```
 # License
 dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
 ___

dc_brief.sh

@@ -0,0 +1,51 @@
+#!/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
+  [[ " ${Excludes[*]} " =~ ${i} ]] && continue; # Skip if the container is excluded
+  printf ". "
+  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>/dev/null) ; then
+    if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi
+  else
+    GotErrors+=("$i")
+  fi
+done
+
+### Sort arrays alphabetically
+IFS=$'\n' 
+NoUpdates=($(sort <<<"${NoUpdates[*]}"))
+GotUpdates=($(sort <<<"${GotUpdates[*]}"))
+GotErrors=($(sort <<<"${GotErrors[*]}"))
+unset IFS
+
+### List what containers got updates or not
+if [[ -n ${NoUpdates[*]} ]] ; then
+  printf "\n\033[0;32mContainers on latest version:\033[0m\n"
+  printf "%s\n" "${NoUpdates[@]}"
+fi
+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 
+   printf "\n\033[0;33mContainers with updates available:\033[0m\n"
+   printf "%s\n" "${GotUpdates[@]}"
+fi
+printf "\n\n"

dockcheck.sh

@@ -1,30 +1,32 @@
 #!/usr/bin/env bash
-VERSION="v0.1.8"
+VERSION="v0.2.1"
 Github="https://github.com/mag37/dockcheck"
 
 ### Check if there's a new release of the script:
-LatestRelease="$(curl -s -r 0-40 https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
+LatestRelease="$(curl -s -r 0-50 https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh | 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"
 
 ### 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
@@ -32,6 +34,8 @@ shift "$((OPTIND-1))"
 
 ### 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" ;
@@ -108,6 +112,7 @@ choosecontainers() {
 
 ### Check the image-hash of every running container VS the registry
 for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
+  [[ " ${Excludes[*]} " =~ ${i} ]] && continue; # Skip if the container is excluded
   printf ". "
   RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
   LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
@@ -130,22 +135,22 @@ UpdCount="${#GotUpdates[@]}"
 
 ### List what containers got updates or not
 if [[ -n ${NoUpdates[*]} ]] ; then
-  printf "\n\033[32;1mContainers on latest version:\033[0m\n"
+  printf "\n\033[0;32mContainers on latest version:\033[0m\n"
   printf "%s\n" "${NoUpdates[@]}"
 fi
 if [[ -n ${GotErrors[*]} ]] ; then
-  printf "\n\033[33;1mContainers with errors, wont get updated:\033[0m\n"
+  printf "\n\033[0;31mContainers with errors, wont get updated:\033[0m\n"
   printf "%s\n" "${GotErrors[@]}"
 fi
 if [[ -n ${GotUpdates[*]} ]] ; then 
-   printf "\n\033[31;1mContainers with updates available:\033[0m\n"
+   printf "\n\033[0;33mContainers with updates available:\033[0m\n"
    [[ -z "$UpdYes" ]] && options || printf "%s\n" "${GotUpdates[@]}"
 fi
 
 ### Optionally get updates if there's any 
 if [ -n "$GotUpdates" ] ; then
   if [ -z "$UpdYes" ] ; then
-  printf "\n\033[36;1mChoose what containers to update.\033[0m\n"
+  printf "\n\033[0;36mChoose what containers to update.\033[0m\n"
   choosecontainers
   else
     SelectedUpdates=( "${GotUpdates[@]}" )
@@ -156,10 +161,11 @@ if [ -n "$GotUpdates" ] ; then
       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" }}')
+      ContEnv=$(docker inspect "$i" --format '{{index .Config.Labels "com.docker.compose.project.environment_file" }}')
+      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
-          ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
           docker pull "$ContImage"
           printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters"
         else
@@ -175,8 +181,17 @@ if [ -n "$GotUpdates" ] ; then
       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 ; }
-      $DockerBin -f "$ComposeFile" pull "$ContName"
+      docker pull "$ContImage"
-      $DockerBin -f "$ComposeFile" up -d "$ContName"
+      ### Reformat for multi-compose:
+      IFS=',' read -r -a Confs <<< "$ContConfigFile" ; 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?
+      else
+        $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

dupc_function.sh

@@ -1,29 +0,0 @@
-#!/bin/bash
-
-### Requires the regctl binary.
-### Get it here: https://github.com/regclient/regclient/releases
-
-### Preferably placed in .bashrc or similar
-
-### Set the full path to the binary or just regctl if in PATH:
-regctl="/home/gw-tdc/dockers/regctl"
-
-dupc () {
-  if [[ "$@" == "help" ]]; then 
-    echo "No container name given, here's the list of currently running containers:" 
-    docker ps --format '{{.Names}}'
-  else
-    for i in $(docker ps --filter "name=$@" --format '{{.Names}}')
-    do
-      RepoUrl=$(docker inspect $i --format='{{.Config.Image}}')
-      LocalHash=$(docker image inspect $RepoUrl --format '{{.RepoDigests}}')
-      RegHash=$($regctl image digest --list $RepoUrl 2>/dev/null)
-      if [ $? -eq 0 ] ; then
-        if [[ "$LocalHash" = *"$RegHash"* ]] ; then printf "$i is already latest.\n" ; else printf "$i got updates.\n" ; fi
-      else
-        printf "$i got errors, no check possible.\n"
-      fi 
-    done
-  fi
-}
-dupc $1