Merge pull request #47 from mag37/agecheck

datecheck merge.

README.md

@@ -1,11 +1,31 @@
-# 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.3.0**: Added a flag `-d N` to choose how many days old 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.
 - **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,21 +35,23 @@ 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]
+ Syntax:     dockcheck.sh [OPTION] [part of name to filter] 
-Example:    dockcheck.sh -a -e nextcloud,heimdall
+ Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall
  
-Options:
+ Options:
--h     Print this Help.
+ -h     Print this Help.
--a|y   Automatic updates, without interaction.
+ -a|y   Automatic updates, without interaction.
--n     No updates, only checking availability.
+ -n     No updates, only checking availability.
--p     Auto-Prune dangling images after update.
+ -e X   Exclude containers, separated by comma.
--e     Exclude containers, separated by comma.
+ -d N   Only update to new images that are N+ days old. Lists too recent with +prefix. 2xSlower.
--r     Allow updating images for docker run, wont update the container.
+ -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:
@@ -58,29 +80,10 @@ 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.~~
-- ~~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 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.
@@ -89,8 +92,7 @@ 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:
+### Check out a spinoff project: [Palleri/DCW](https://github.com/Palleri/DCW) for a WebUI-front with exporters and notifications.
-### [Palleri/dockcheck-web](https://github.com/Palleri/dockcheck-web) for a WebUI-front!
 
 ## Special Thanks:
 - :bison: [t0rnis](https://github.com/t0rnis)   

dc_brief.sh

@@ -16,7 +16,7 @@ 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
+  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}}')

dockcheck.sh

@@ -1,88 +1,83 @@
 #!/usr/bin/env bash
-VERSION="v0.2.1"
+VERSION="v0.3.0"
+### ChangeNotes: Added feature (-d N) to only update to new images that are N+ days old.
 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 -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 "-n     No updates, only checking availability."
-  echo "-e     Exclude containers, separated by comma."
+  echo "-e X   Exclude containers, separated by comma."
+  echo "-d N   Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower."
   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
+Stopped=""
+while getopts "aynprhse: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 ;;
+    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))"
 
-### Set $1 to a variable for name filtering later.
+self_update_git() {
-SearchName="$1"
+  cd "$ScriptWorkDir" || { printf "Path error, skipping update.\n" ; return ; }
-### Create array of excludes
+  [[ $(builtin type -P git) ]] || { printf "Git not installed, skipping update.\n" ; return ; }
-IFS=',' read -r -a Excludes <<< "$Exclude" ; unset IFS
+  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
-### Check if required binary exists in PATH or directory:
+  [ -n "$(git diff --name-only "$ScriptUpstream" "$ScriptName")" ] && {
-if [[ $(builtin type -P "regctl") ]]; then regbin="regctl" ;
+    printf "%s\n" "Pulling the latest version."
-elif [[ -f "./regctl" ]]; then regbin="./regctl" ;
+    git pull --force
-else
+    printf "%s\n" "--- starting over with the updated version ---"
-  read -r -p "Required dependency 'regctl' missing, do you want it downloaded? y/[n] " GetDep
+    cd - || { printf "Path error.\n" ; return ; }
-  if [[ "$GetDep" =~ [yY] ]] ; then
+    exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
-    ### Check arch:
+    exit 1 # exit the old instance
-    case "$(uname --machine)" in
+  }
-      x86_64|amd64) architecture="amd64" ;;
+  echo "Local is already latest."
-      arm64|aarch64) architecture="arm64";;
+}
-      *) echo "Architecture not supported, exiting." ; exit 1;;
+self_update_curl() {
-    esac
+  cp "$ScriptPath" "$ScriptPath".bak
-    RegUrl="https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture"
+  if [[ $(builtin type -P curl) ]]; then 
-    if [[ $(builtin type -P curl) ]]; then curl -L $RegUrl > ./regctl ; chmod +x ./regctl ; regbin="./regctl" ;
+    curl -L $RawUrl > "$ScriptPath" ; chmod +x "$ScriptPath"  
-    elif [[ $(builtin type -P wget) ]]; then wget $RegUrl -O ./regctl ; chmod +x ./regctl ; regbin="./regctl" ;
+    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 "%s\n" "curl/wget not available - get regctl manually from the repo link, quitting."
+    printf "curl not available - download the update manually: %s \n" "$RawUrl"
   fi
-  else
+}
-    printf "%s\n" "Dependency missing, quitting."
+self_update_select() {
-    exit 1
+  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
-fi
-### final check if binary is correct
-$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 
-  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."
-else
-  printf "%s\n" "No docker binaries available, exiting."
-  exit 1
-fi
-
-### Numbered List -function:
-options() {
-num=1
-for i in "${GotUpdates[@]}"; do
-  echo "$num) $i"
-  ((num++))
-done
 }
 
 ### Choose from list -function:
@@ -110,15 +105,96 @@ 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 ; }
+
+### 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" ;
+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
+    ### Check arch:
+    case "$(uname --machine)" in
+      x86_64|amd64) architecture="amd64" ;;
+      arm64|aarch64) architecture="arm64";;
+      *) 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 > "$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
+  else
+    printf "%s\n" "Dependency missing, quitting."
+    exit 1
+  fi
+fi
+### final check if binary is correct
+$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 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."
+else
+  printf "%s\n" "No docker binaries available, exiting."
+  exit 1
+fi
+
+### Numbered List -function:
+options() {
+num=1
+for i in "${GotUpdates[@]}"; do
+  echo "$num) $i"
+  ((num++))
+done
+}
+
+### Listing typed exclusions:
+if [[ -n ${Excludes[*]} ]] ; then
+  printf "\n\033[0;34mExcluding these names:\033[0m\n"
+  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
-  [[ " ${Excludes[*]} " =~ ${i} ]] && continue; # Skip if the container is excluded
+  ### 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}}')
   ### 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
@@ -156,8 +232,12 @@ if [ -n "$GotUpdates" ] ; then
     SelectedUpdates=( "${GotUpdates[@]}" )
   fi
   if [ "$UpdYes" == "${UpdYes#[Nn]}" ] ; then
+    NumberofUpdates="${#SelectedUpdates[@]}"
+    CurrentQue=0
     for i in "${SelectedUpdates[@]}"
     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" }}')
@@ -180,10 +260,11 @@ 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 <<< "$ContConfigFile" ; unset IFS
+      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:

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