first PoC for writing old+new image digests to log, more work needed!

* Sanitize message for Matrix notifications

* Use variable for jq and increment version of Matrix script

---------

Co-authored-by: martin <martin@meissnitzer.dev>

README.md

@@ -13,9 +13,9 @@
 </p>
 
 <h2 align="center">CLI tool to automate docker image updates or notifying when updates are available.</h2>
-<h3 align="center">selective updates, exclude containers, custom labels, notification plugins, prune when done etc.</h3>
+<h3 align="center">selective updates, include/exclude containers, image backups, custom labels, notification plugins, prune when done etc.</h3>
 
-<h4 align="center">:whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls - <a href="#whale-docker-hub-pull-limit-chart_with_downwards_trend-not-an-issue-for-checks-but-for-actual-pulls">read more</a></h4>
+<h4 align="center">:whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks only for actual pulls - <a href="#whale-docker-hub-pull-limit-chart_with_downwards_trend-not-an-issue-for-checks-but-for-actual-pulls">read more</a></h4>
 
 <h5 align="center">For Podman - see the fork <a href="https://github.com/sudo-kraken/podcheck">sudo-kraken/podcheck</a>!</h4>
 
@@ -26,7 +26,9 @@ ___
     - Added new option **BackupForDays**; `-b N` and `-B`:
       - Backup an image before pulling a new version for easy rollback in case of breakage.
       - Removes backed up images older than *N* days.
-      - List currently backed up images with `-K`.
+      - List currently backed up images with `-B`.
+    - Fixes:
+      - Bugfix for `-s` *Stopped* to not recreate stopped containers after update.
 - **v0.7.4**:
     - Added new option `-R`:
       - Will skip container recreation after pulling images.

dockcheck.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-VERSION="v0.7.4"
-# ChangeNotes: New option -R to pull without recreation. Fixes: value too great error, legacy cleanups.
+VERSION="v0.7.5"
+# ChangeNotes: New option -b N to backup image before pulling for easy rollback.
 Github="https://github.com/mag37/dockcheck"
 RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
 
@@ -271,7 +271,7 @@ remove_backups() {
     backup_date=${backup_tag%%_*}
     # UNTAGGING HERE
     if datecheck "$backup_date" "$BackupForDays"; then
-      [[ "$CleanupCount" == 0 ]] && echo "Removing backed up images older then $BackupForDays days."
+      [[ "$CleanupCount" == 0 ]] && printf "\n%bRemoving backed up images older then %s days.%b\n" "$c_blue" "$BackupForDays" "$c_reset"
       docker rmi "${repo_name}:${backup_tag}" && ((CleanupCount+=1))
     fi
   done
@@ -279,7 +279,8 @@ remove_backups() {
   if [[ "$CleanupCount" == 0 ]]; then
     printf "\nNo backup images to remove.\n"
   else
-    printf "\n%b%s%b backup removed.%b\n" "$c_green" "$CleanupCount" "$c_teal" "$c_reset"
+    [[ "$CleanupCount" -gt 1 ]] && b_phrase="backups" || b_phrase="backup"
+    printf "\n%b%s%b %s removed.%b\n" "$c_green" "$CleanupCount" "$c_teal" "$b_phrase" "$c_reset"
   fi
 }
 
@@ -581,6 +582,25 @@ if [[ -n "${GotUpdates:-}" ]]; then
 
     NumberofUpdates="${#SelectedUpdates[@]}"
 
+    # TODO: move this to proper place + setup optarg etc.
+    # Digest log setup
+    LogDigestChanges="true"
+    LogPath="$ScriptWorkDir/updatelog"
+    if [[ -n "${LogDigestChanges}" ]]; then
+      LogStore=()
+      LogStore+=("$(printf "%-30s %s > %s\n" "IMAGE:TAG" "OLD DIGEST" "NEW DIGEST")")
+    fi
+
+    # TODO: move this to proper place
+    get_image_facts(){
+      ImageConfig=$(docker image inspect "$ImageId" --format '{{ json . }}')
+      ContRepoDigests=$($jqbin -r '.RepoDigests[0]' <<< "$ImageConfig")
+      [[ "$ContRepoDigests" == "null" ]] && ContRepoDigests=""
+      ContRepo=${ContImage%:*}
+      ContApp=${ContRepo#*/}
+      [[ "$ContImage" =~ ":" ]] && ContTag=${ContImage#*:} || ContTag="latest"
+    }
+
     CurrentQue=0
     for i in "${SelectedUpdates[@]}"; do
       ((CurrentQue+=1))
@@ -591,19 +611,17 @@ if [[ -n "${GotUpdates:-}" ]]; then
       ContPath=$($jqbin -r '."Config"."Labels"."com.docker.compose.project.working_dir"' <<< "$ContConfig")
       [[ "$ContPath" == "null" ]] && ContPath=""
 
+
       # Add new backup tag prior to pulling if option is set
       if [[ -n "${BackupForDays:-}" ]]; then
-        ImageConfig=$(docker image inspect "$ImageId" --format '{{ json . }}')
-        ContRepoDigests=$($jqbin -r '.RepoDigests[0]' <<< "$ImageConfig")
-        [[ "$ContRepoDigests" == "null" ]] && ContRepoDigests=""
-        ContRepo=${ContImage%:*}
-        ContApp=${ContRepo#*/}
-        [[ "$ContImage" =~ ":" ]] && ContTag=${ContImage#*:} || ContTag="latest"
+        get_image_facts
         BackupName="dockcheck/${ContApp}:${RunTimestamp}_${ContTag}"
         docker tag "$ImageId" "$BackupName"
         printf "%b%s backed up as %s%b\n" "$c_teal" "$i" "$BackupName" "$c_reset"
       fi
 
+      [[ -n "${LogDigestChanges}" ]] && get_image_facts
+
       # Checking if compose-values are empty - hence started with docker run
       if [[ -z "$ContPath" ]]; then
         if [[ "$DRunUp" == true ]]; then
@@ -618,12 +636,17 @@ if [[ -n "${GotUpdates:-}" ]]; then
       if docker pull "$ContImage"; then
         # Removal of the <none>-tag image left behind from backup
         if [[ ! -z "${ContRepoDigests:-}" ]] && [[ -n "${BackupForDays:-}" ]]; then docker rmi "$ContRepoDigests"; fi
+        if [[ -n "${LogDigestChanges}" ]]; then
+          NewDigest=$(docker image inspect "$ContImage" --format '{{index .RepoDigests 0 }}')
+          LogStore+=("$(printf "%-30s %s > %s\n" "$i:$ContTag" "$ContRepoDigests" "$NewDigest")")
+        fi
       else
         printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1
       fi
 
     done
     printf "\n%bDone pulling updates.%b\n" "$c_green" "$c_reset"
+    [[ -n "${LogDigestChanges}" ]] && { printf "%s\n" "${LogStore[@]}" > "${LogPath}_$(date +'%Y-%m-%d_%H%M')"; }
 
     if [[ "$SkipRecreate" == true ]]; then
       printf "%bSkipping container recreation due to -R.%b\n" "$c_yellow" "$c_reset"

notify_templates/notify_matrix.sh

@@ -1,5 +1,5 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_MATRIX_VERSION="v0.4"
+NOTIFY_MATRIX_VERSION="v0.5"
 #
 # Required receiving services must already be set up.
 # Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
@@ -29,7 +29,7 @@ trigger_matrix_notification() {
   AccessToken="${!AccessTokenVar}" # e.g. MATRIX_ACCESS_TOKEN=token-value
   RoomId="${!RoomIdVar}" # e.g. MATRIX_ROOM_ID=myroom
   MatrixServer="${!MatrixServerVar}" # e.g. MATRIX_SERVER_URL=http://matrix.yourdomain.tld
-  MsgBody="{\"msgtype\":\"m.text\",\"body\":\"$MessageBody\"}"
+  MsgBody=$($jqbin -Rn --arg body "$MessageBody" '{msgtype:"m.text", body:$body}')
 
   # URL Example:  https://matrix.org/_matrix/client/r0/rooms/!xxxxxx:example.com/send/m.room.message?access_token=xxxxxxxx
   curl -S -o /dev/null ${CurlArgs} -X POST "$MatrixServer/_matrix/client/r0/rooms/$RoomId/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"

notify_templates/urls.list

@@ -15,12 +15,14 @@ calibre https://github.com/linuxserver/docker-calibre/releases
 calibre-web https://github.com/linuxserver/docker-calibre-web/releases
 cleanuperr https://github.com/flmorg/cleanuperr/releases
 cross-seed https://github.com/cross-seed/cross-seed/releases
+crowdsec https://github.com/crowdsecurity/crowdsec/releases
 cup https://github.com/sergi0g/cup/releases
 dockge https://github.com/louislam/dockge/releases
 dozzle https://github.com/amir20/dozzle/releases
 flatnotes https://github.com/dullage/flatnotes/releases
 forgejo https://codeberg.org/forgejo/forgejo/releases
 fressrss https://github.com/FreshRSS/FreshRSS/releases
+gerbil https://github.com/fosrl/gerbil/releases
 gluetun https://github.com/qdm12/gluetun/releases
 go2rtc https://github.com/AlexxIT/go2rtc/releases
 gotify https://github.com/gotify/server/releases
@@ -45,9 +47,11 @@ mealie https://github.com/mealie-recipes/mealie/releases
 meilisearch https://github.com/meilisearch/meilisearch/releases
 monica https://github.com/monicahq/monica/releases
 mqtt https://github.com/eclipse/mosquitto/tags
+newt https://github.com/fosrl/newt/releases
 nextcloud-aio-mastercontainer https://github.com/nextcloud/all-in-one/releases
 nginx https://github.com/docker-library/official-images/blob/master/library/nginx
 owncast https://github.com/owncast/owncast/releases
+pangolin https://github.com/fosrl/pangolin/releases
 prowlarr https://github.com/Prowlarr/Prowlarr/releases
 prowlarr-ls https://github.com/linuxserver/docker-prowlarr/releases
 qbittorrent https://www.qbittorrent.org/news
@@ -66,6 +70,7 @@ snappymail https://github.com/the-djmaze/snappymail/releases
 sonarr https://github.com/Sonarr/Sonarr/releases/
 sonarr-ls https://github.com/linuxserver/docker-sonarr/releases
 syncthing https://github.com/syncthing/syncthing/releases
+tailscale https://github.com/tailscale/tailscale/releases
 tautulli https://github.com/Tautulli/Tautulli/releases
 thelounge https://github.com/thelounge/thelounge/releases
 traefik https://github.com/traefik/traefik/releases