versionbump

* Start stopped containers (when -s is used) so that updates apply
* Automatically re-stop stopped containers after updating

README.md

@@ -23,6 +23,14 @@ ___
 
 ## Changelog
 
+- **v0.7.7**:
+  - New:
+    - More URLs to urls.list.
+    - Allowing ranges to be used when selecting containers to update.
+    - Added XMPP notification template.
+  - Fixes:
+    - Changed "restart-stack" behavior to down+up instead of stop+up.
+    - `-s` option now recreates stopped containers and then stops them again.
 - **v0.7.6**:
   - New:
     - Added Bark notify-template.
@@ -76,7 +84,7 @@ Options:
 -p     Auto-Prune dangling images after update.
 -r     Allow checking/updating images created by `docker run`, containers need to be recreated manually.
 -R     Skip container recreation after pulling images.
--s     Include stopped containers in the check. (Logic: docker ps -a).
+-s     Include stopped containers, returns to stopped state after recreation.
 -t N   Set a timeout (in seconds) per container for registry checkups, 10 is default.
 -u     Allow automatic self updates - caution as this will pull new code and autorun it.
 -v     Prints current version.
@@ -99,7 +107,7 @@ Containers with updates available:
 03) whoogle-search
 
 Choose what containers to update:
-Enter number(s) separated by comma, [a] for all - [q] to quit: 1,2
+Enter number(s) or range(s) separated by comma (e.g. 1-2,4-5,09), [a] for all - [q] to quit: 1-2
 ```
 
 Then it proceeds to run `pull` and `up -d` on every container with updates.  
@@ -175,7 +183,8 @@ you wish to enable, but there is no harm in having all of them present.
 │   ├── notify_slack.sh
 │   ├── notify_smtp.sh
 │   ├── notify_telegram.sh
-│   └── notify_v2.sh
+│   ├── notify_v2.sh
+│   └── notify_xmpp.sh
 ├── dockcheck.config
 ├── dockcheck.sh
 └── urls.list         # optional
@@ -219,6 +228,7 @@ The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to acco
 - [Slack](https://api.slack.com/tutorials/tracks/posting-messages-with-curl) - Slack curl api
 - SMTP Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP))
 - [Telegram](https://telegram.org/) - Telegram chat API.
+- [XMPP](https://xmpp.org/getting-started/) - XMPP chat notifications.
 
 Further additions are welcome - suggestions or PRs!
 <sub><sup>Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).</sup></sub>

default.config

@@ -95,3 +95,7 @@
 # TELEGRAM_CHAT_ID="mychatid"
 # TELEGRAM_TOKEN="token-value"
 # TELEGRAM_TOPIC_ID="0"
+#
+# XMPP_SOURCE_JID="mybotaccount@mydomain.tld"
+# XMPP_SOURCE_PWD="password"
+# XMPP_DEST_JID="myusername@mydomain.tld"

dockcheck.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-VERSION="v0.7.6"
-# ChangeNotes: Bugfixes and sanitation. Cleanup of default.config - migrate settings manually (optional).
+VERSION="v0.7.7"
+# ChangeNotes: xmpp template added, ranges for selection possible, restart-stack and -s reworked.
 Github="https://github.com/mag37/dockcheck"
 RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
 
@@ -51,7 +51,7 @@ Help() {
   echo "-p     Auto-prune dangling images after update."
   echo "-r     Allow checking/updating images created by 'docker run', containers need to be recreated manually."
   echo "-R     Skip container recreation after pulling images."
-  echo "-s     Include stopped containers in the check. (Logic: docker ps -a)."
+  echo "-s     Include stopped containers, returns to stopped state after recreation."
   echo "-t N   Set a timeout (in seconds) per container for registry checkups, 10 is default."
   echo "-u     Allow automatic self updates - caution as this will pull new code and autorun it."
   echo "-v     Prints current version."
@@ -229,7 +229,7 @@ self_update() {
 
 choosecontainers() {
   while [[ -z "${ChoiceClean:-}" ]]; do
-    read -r -p "Enter number(s) separated by comma, [a] for all - [q] to quit: " Choice
+    read -r -p "Enter number(s) or range(s) separated by comma (e.g. 1-2,4-5,09), [a] for all - [q] to quit: " Choice
     if [[ "$Choice" =~ [qQnN] ]]; then
       [[ -n "${BackupForDays:-}" ]] && remove_backups
       exit 0
@@ -238,12 +238,28 @@ choosecontainers() {
       ChoiceClean=${Choice//[,.:;]/ }
     else
       ChoiceClean=${Choice//[,.:;]/ }
+      SelectedUpdates=()
       for CC in $ChoiceClean; do
-        CC=$((10#$CC)) # Base 10 interpretation to strip leading zeroes
-        if [[ "$CC" -lt 1 || "$CC" -gt $UpdCount ]]; then # Reset choice if out of bounds
-          echo "Number not in list: $CC"; unset ChoiceClean; break 1
+        if [[ "$CC" == *-* ]]; then
+          if [[ "$CC" =~ ^([0-9]+)-([0-9]+)$ ]]; then
+            # Enforce base 10 to avoid octal parsing of leading zeroes
+            RangeStart=$((10#${BASH_REMATCH[1]}))
+            RangeEnd=$((10#${BASH_REMATCH[2]}))
+            if [[ "$RangeStart" -lt 1 || "$RangeEnd" -gt $UpdCount || "$RangeStart" -gt "$RangeEnd" ]]; then
+              echo "Entered list is out of bounds: $CC"; unset ChoiceClean; break 1
+            else
+              for ((idx=RangeStart; idx<=RangeEnd; idx++)); do SelectedUpdates+=( "${GotUpdates[$idx-1]}" ); done
+            fi
+          else
+            echo "Invalid range: $CC"; unset ChoiceClean; break 1
+          fi
         else
-          SelectedUpdates+=( "${GotUpdates[$CC-1]}" )
+          CC=$((10#$CC)) # Base 10 interpretation to strip leading zeroes
+          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
         fi
       done
     fi
@@ -380,7 +396,7 @@ dependency_check() {
           binary_downloader "$AppName" "$AppUrl"
           [[ -f "$ScriptWorkDir/$AppName" ]] && { export "$AppVar"="$ScriptWorkDir/$1" && printf "\n%b%s downloaded.%b\n" "$c_green" "$AppName" "$c_reset"; }
       fi
-    else printf "\n%bDependency missing, exiting.%b\n" "$c_red" "$c_reset"; exit 1;
+    else printf "\n%bDependency '%s' missing, exiting.%b\n" "$c_red" "$AppName" "$c_reset"; exit 1;
     fi
   fi
   # Final check if binary is correct
@@ -634,6 +650,7 @@ if [[ -n "${GotUpdates:-}" ]]; then
       for i in "${SelectedUpdates[@]}"; do
         ((CurrentQue+=1))
         unset CompleteConfs
+        ContStopAfter=false
         # Extract labels and metadata
         ContConfig=$(docker inspect "$i" --format '{{json .}}')
         ContLabels=$($jqbin -r '."Config"."Labels"' <<< "$ContConfig")
@@ -648,15 +665,15 @@ if [[ -n "${GotUpdates:-}" ]]; then
         ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
         [[ "$ContRestartStack" == "null" ]] && ContRestartStack=""
         ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels")
-        [[ "$ContOnlySpecific" == "null" ]] && ContRestartStack=""
+        [[ "$ContOnlySpecific" == "null" ]] && ContOnlySpecific=""
         ContStateRunning=$($jqbin -r '."State"."Running"' <<< "$ContConfig")
         [[ "$ContStateRunning" == "null" ]] && ContStateRunning=""
 
         if [[ "$ContStateRunning" == "true" ]]; then
           printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
         else
-          printf  "\n%bSkipping recreation of %b%s%b as it's not running.%b\n" "$c_yellow" "$c_blue" "$i" "$c_yellow" "$c_reset"
-          continue
+          ContStopAfter=true
+          printf  "\n%bRecreating %b%s%b to apply update - then stopping to return to current state.%b\n" "$c_yellow" "$c_blue" "$i" "$c_yellow" "$c_reset"
         fi
 
         # Checking if compose-values are empty - hence started with docker run
@@ -678,10 +695,15 @@ if [[ -n "${GotUpdates:-}" ]]; then
 
         # Check if the whole stack should be restarted
         if [[ "$ContRestartStack" == true ]] || [[ "$ForceRestartStacks" == true ]]; then
-          ${DockerBin} ${CompleteConfs} stop; ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
+          ${DockerBin} ${CompleteConfs} down; ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
         else
           ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
         fi
+
+        # Restore the stopped state of updated cotainers
+        if [[ "$ContStopAfter" == true ]]; then
+          ${DockerBin} ${CompleteConfs} stop ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
+        fi
       done
     fi
     printf "\n%bAll updates done!%b\n" "$c_green" "$c_reset"
@@ -689,7 +711,7 @@ if [[ -n "${GotUpdates:-}" ]]; then
     # Trigger pruning only when backup-function is not used
     if [[ -z "${BackupForDays:-}" ]]; then
       if [[ "$AutoPrune" == false ]] && [[ "$AutoMode" == false ]]; then printf "\n"; read -rep "Would you like to prune all dangling images? y/[n]: " AutoPrune; fi
-      if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\nAuto pruning.."; docker image prune -f; fi
+      if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\nAuto pruning.."; docker image prune -f && AlreadyPruned="true" ; fi
     fi
 
   else
@@ -699,7 +721,11 @@ else
   printf "\nNo updates available.\n"
 fi
 
-# Clean up old backup image tags if -b is used
-[[ -n "${BackupForDays:-}" ]] && remove_backups
+# Clean up old backup image tags if -b is used otherwise prune if auto-prune is set
+if [[ -n "${BackupForDays:-}" ]]; then
+  remove_backups
+else
+  if [[ "$AutoPrune" == true ]] && [[ "${AlreadyPruned:=false}" != true ]]; then printf "\nAuto pruning.."; docker image prune -f; fi
+fi
 
 exit 0

notify_templates/notify_xmpp.sh

@@ -0,0 +1,47 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+NOTIFY_XMPP_VERSION="v0.1"
+#
+# Requires the package "go-sendxmpp" to be installed and in $PATH.
+#
+# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
+# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
+# Do not modify this file directly within the "notify_templates" subdirectory. 
+# Set XMPP_SOURCE_ID, XMPP_SOURCE_PWD and XMPP_DEST_JID in your dockcheck.config file.
+
+trigger_xmpp_notification() {
+    if [[ -n "$1" ]]; then
+      xmpp_channel="$1"
+    else
+      xmpp_channel="xmpp"
+    fi
+
+    if ! command -v go-sendxmpp &>/dev/null; then
+        printf "\nRequired binary go-sendxmpp missing. XMPP notification will not be sent.\n"
+        remove_channel xmpp
+        return 0
+    fi
+  
+    UpperChannel="${xmpp_channel^^}"
+
+    SourceJidVar="${UpperChannel}_SOURCE_JID"
+    SourcePwdVar="${UpperChannel}_SOURCE_PWD"
+    DestJidVar="${UpperChannel}_DEST_JID"
+
+
+    if [[ -z "${!SourceJidVar:-}" ]] || [[ -z "${!DestJidVar:-}" ]] || [[ -z "${!SourcePwdVar:-}" ]]; then
+        printf "\nRequired configuration variables are missing. XMPP notifications will not be sent.\n"
+        remove_channel xmpp
+        return 0
+    fi
+
+    SourceJid="${!SourceJidVar}" # E.g `mybotaccount@mydomain.tld`
+    SourcePwd="${!SourcePwdVar}" # The password for the account `mybotaccount@mydomain.tld`
+    DestJid="${!DestJidVar}" # E.g `myusername@mydomain.tld`
+
+    echo "$MessageBody" | go-sendxmpp --suppress-root-warning -u "$SourceJid" -p "$SourcePwd" "$DestJid"
+
+    if [[ $? -gt 0 ]]; then
+      NotifyError=true
+    fi
+
+}