version bump, ntfy.sh and errors on registry fail

ignore the auto-installed regctl

.gitignore

@@ -0,0 +1,4 @@
+# ignore users custom notify.sh
+/notify.sh
+# ignore the auto-installed regctl
+regctl

README.md

@@ -12,51 +12,49 @@
 </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>
+<h2 align="center">Now with a simple Apprise integration!</h2>
+<h4 align="center">With features like excluding specific containers, filter by name, auto-prune dangling images and more.</h4>
 
-
-### :bell: Recent changes
+___
+## :bell: Changelog
+- **v0.3.4**: Added ntfy.sh template and error message on registry fail.
+- **v0.3.3**: Added Apprise template and the option `-i` inform - to send notifications.
 - **v0.3.2**: Added a notify function to wrap a notify-script, currently DSM/Ssmtp + template script.
 - **v0.3.1**: Addded option `-m` , monochrome mode - no printf color codes.
 - **v0.3.0**: Added option `-d N`, age (days) 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. 
 ___
 
-## Dependencies
-Running docker (duh) and compose, either standalone or plugin.   
-[`regclient/regctl`](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))   
-User will be prompted to download `regctl` if not in `PATH` or `PWD`
+## :nut_and_bolt: Dependencies
+- Running docker (duh) and compose, either standalone or plugin.   
+- [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))   
+  - User will be prompted to download `regctl` if not in `PATH` or `PWD`.   
+  - regctl requires `amd64/arm64` - see [workaround](#workaround-for-non-amd64--arm64) if other architecture is used.
 ___
 
 
 ![](extras/example.gif)
 
-## `dockcheck.sh`
+## :mag_right: `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 -y -d 10 -e nextcloud,heimdall
  
  Options:
- -h     Print this Help.
  -a|y   Automatic updates, without interaction.
- -n     No updates, only checking availability.
+ -d N   Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
  -e X   Exclude containers, separated by comma.
- -d N   Only update to new images that are N+ days old. Lists too recent with +prefix. 2xSlower.
+ -h     Print this Help.
+ -i     Inform - send a preconfigured notification.
+ -m     Monochrome mode, no printf color codes.
+ -n     No updates, only checking availability.
  -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).
+ -s     Include stopped containers in the check. (Logic: docker ps -a)
 ```
 
-Basic example:
+### Basic example:
 ```
 $ ./dockcheck.sh
 . . .
@@ -75,28 +73,58 @@ Enter number(s) separated by comma, [a] for all - [q] to quit:
 Then it proceedes to run `pull` and `up -d` on every container with updates.   
 After the updates are complete, you'll get prompted if you'd like to prune dangling images.
 
-### Notifications:
+## :loudspeaker: Notifications
+Trigger with the `-i` flag.   
+Run it scheduled with `-ni` to only get notified when there's updates available!  
 
-A simple email notification function is added, with a generic example and DSM/Ssmtp script by [yoyoma2](https://github.com/yoyoma2). Further addons are welcome, suggestions or PR!   
+Use a `notify_X.sh` template file, copy it to `notify.sh`, modify it to your needs!   
+Current templates:
+- Synology [DSM](https://www.synology.com/en-global/dsm)
+- Email with [sSMTP](https://wiki.debian.org/sSMTP)  
+- Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications)
+  - both native [caronc/apprise](https://github.com/caronc/apprise) and the standalone [linuxserver/docker-apprise-api](https://github.com/linuxserver/docker-apprise-api)
+  - Read the [QuickStart](extras/apprise_quickstart.md)
 
-### :warning: `-r flag` disclaimer and warning
-**Wont auto-update the containers, only their images. (compose is recommended)**   
-`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.
+Further additions are welcome - suggestions or PR!   
+<sub><sup>Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).</sup></sub>  
 
-### :hammer: Known issues
+## :roller_coaster: Workaround for non **amd64** / **arm64**
+`regctl` provides binaries for amd64/arm64, to use on other architecture you could try this workaround.
+Run regctl in a container wrapped in a shell script. Copied from [regclient/docs/install.md](https://github.com/regclient/regclient/blob/main/docs/install.md):
+
+```sh
+cat >regctl <<EOF
+#!/bin/sh
+opts=""
+case "\$*" in
+  "registry login"*) opts="-t";;
+esac
+docker container run \$opts -i --rm --net host \\
+  -u "\$(id -u):\$(id -g)" -e HOME -v \$HOME:\$HOME \\
+  -v /etc/docker/certs.d:/etc/docker/certs.d:ro \\
+  ghcr.io/regclient/regctl:latest "\$@"
+EOF
+chmod 755 regctl
+```
+Test it with `./regctl --help` and then either add the file to the same path as *dockcheck.sh* or in your path (eg. `~/.local/bin/regctl`).
+
+## :hammer: Known issues
 - 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.
+## :warning: `-r flag` disclaimer and warning
+**Wont auto-update the containers, only their images. (compose is recommended)**   
+`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.
 
-# License
+## :scroll: License
 dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
+
+### :floppy_disk: The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in the mirror.
+
 ___
 
-### Check out a spinoff project: [Palleri/DCW](https://github.com/Palleri/DCW) for a WebUI-front with exporters and notifications.
 
 ## Special Thanks
 - :bison: [t0rnis](https://github.com/t0rnis)   

dockcheck.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-VERSION="v0.3.2"
-### ChangeNotes: Added a notify function - template and email script (DSM etc)
+VERSION="v0.3.4"
+### ChangeNotes: Added ntfy.sh template and error message on registry fail.
 Github="https://github.com/mag37/dockcheck"
 RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
 
@@ -14,7 +14,6 @@ ScriptWorkDir="$(dirname "$ScriptPath")"
 LatestRelease="$(curl -s -r 0-50 $RawUrl | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
 LatestChanges="$(curl -s -r 0-200 $RawUrl | sed -n "/ChangeNotes/s/### ChangeNotes: //p")"
 
-[ -s $ScriptWorkDir/notify.sh ] && source $ScriptWorkDir/notify.sh
 
 ### Help Function:
 Help() {
@@ -26,6 +25,7 @@ Help() {
   echo "-d N   Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower."
   echo "-e X   Exclude containers, separated by comma."
   echo "-h     Print this Help."
+  echo "-i     Inform - send a preconfigured notification."
   echo "-m     Monochrome mode, no printf color codes."
   echo "-n     No updates, only checking availability."
   echo "-p     Auto-Prune dangling images after update."
@@ -41,14 +41,14 @@ c_blue="\033[0;34m"
 c_teal="\033[0;36m"
 c_reset="\033[0m"
 
-
 Stopped=""
-while getopts "aynprhsme:d:" options; do
+while getopts "aynprhisme:d:" options; do
   case "${options}" in
     a|y) AutoUp="yes" ;;
     n)   AutoUp="no" ;;
     r)   DRunUp="yes" ;;
     p)   AutoPrune="yes" ;;
+    i)   [ -s $ScriptWorkDir/notify.sh ] && { source $ScriptWorkDir/notify.sh ; Notify="yes" ; } ;;
     e)   Exclude=${OPTARG} ;;
     m)   declare c_{red,green,yellow,blue,teal,reset}="" ;;
     s)   Stopped="-a" ;;
@@ -198,7 +198,7 @@ for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}')
   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 RegHash=$($regbin image digest --list "$RepoUrl" 2>&1) ; then
     if [[ "$LocalHash" = *"$RegHash"* ]] ; then 
       NoUpdates+=("$i") 
     else 
@@ -209,7 +209,8 @@ for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}')
       fi
     fi
   else
-    GotErrors+=("$i")
+    # Here the RegHash is the result of an error code.
+    GotErrors+=("$i - ${RegHash}")
   fi
 done
 
@@ -230,11 +231,12 @@ fi
 if [[ -n ${GotErrors[*]} ]] ; then
   printf "\n%bContainers with errors, wont get updated:%b\n" "$c_red" "$c_reset"
   printf "%s\n" "${GotErrors[@]}"
+  printf "%binfo:%b 'unauthorized' often means not found in a public registry.%b\n" "$c_blue" "$c_reset"
 fi
 if [[ -n ${GotUpdates[*]} ]] ; then 
    printf "\n%bContainers with updates available:%b\n" "$c_yellow" "$c_reset"
    [[ -z "$AutoUp" ]] && options || printf "%s\n" "${GotUpdates[@]}"
-   [[ $(type -t send_notification) == function ]] && send_notification "${GotUpdates[@]}"
+   [[ ! -z "$Notify" ]] && { [[ $(type -t send_notification) == function ]] && send_notification "${GotUpdates[@]}" || printf "Could not source notification function.\n" ; }
 fi
 
 ### Optionally get updates if there's any 

extras/apprise_quickstart.md

@@ -0,0 +1,130 @@
+# A small guide on getting started with Apprise notifications.
+
+
+## Standalone docker container: [linuxserver/apprise-api](https://hub.docker.com/r/linuxserver/apprise-api)
+
+Set up the docker compose as preferred:
+```yaml
+---
+version: "2.1"
+services:
+  apprise-api:
+    image: lscr.io/linuxserver/apprise-api:latest
+    container_name: apprise-api
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=Etc/UTC
+    volumes:
+      - /path/to/apprise-api/config:/config
+    ports:
+      - 8000:8000
+    restart: unless-stopped
+```
+
+Then browse to the webui.
+![](apprise-ex1.png)
+Here you'll click **Configuration Manager**, read the overview and then click on **Configuration**.
+Under **Configuration** you'll craft/paste your notification config. 
+
+![](apprise-ex2.png)
+The simplest way is just paste the url's as is (like in the example above).    
+There are many ways to customize with tags, groups, json and more. Read [caronc/apprise-api](https://github.com/caronc/apprise-api) for more info!   
+
+Look at the [apprise wiki: Notification Services](https://github.com/caronc/apprise/wiki) for more info about how the url syntax for different services works.   
+
+
+You can also use the [caronc/apprise-api](https://github.com/caronc/apprise-api) to host the api as a frontend to an already existing **Apprise**-setup on the host.
+
+
+### Customize the **notify.sh** file.
+After you're done with the setup of the container and tried your notifications, you can copy the `notify_apprise.sh` file to `notify.sh` and start editing it.
+
+Comment out/remove the bare metal apprise-command (starting with `apprise -vv -t...`). 
+Uncomment and edit the `AppriseURL` variable and *curl* line
+It should look something like this when curling the API:
+```bash
+send_notification() {
+Updates=("$@")
+UpdToString=$( printf "%s\n" "${Updates[@]}" )
+FromHost=$(hostname)
+
+printf "\nSending Apprise notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+read -d '\n' MessageBody << __EOF
+Containers on $FromHost with updates available:
+
+$UpdToString
+
+__EOF
+
+AppriseURL="http://IP.or.mydomain.tld:8000/notify/apprise"
+curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
+
+}
+```
+
+That's all!
+___
+___
+
+
+## On host installed **Apprise**
+Follow the official guide on [caronc/apprise](https://github.com/caronc/apprise)! 
+
+### A brief, basic "get started"
+
+- Install **apprise** 
+    - python package `pip install apprise`
+    - packaged in EPEL/Fedora `dnf install apprise`
+    - packaged in AUR `[yay/pikaur/paru/other] apprise`
+
+- Create a config file with your notification credentials (source of notifications):
+```ini
+mailto://user:password@yahoo.com
+slack://token_a/token_b/token_c
+kodi://example.com
+```
+Then either source the notifications with `-c=/path/to/config/apprise` or store them in *PATH* to skip referencing (`~/.apprise` or `~/.config/apprise`).
+
+- Test apprise with a single notification:
+    - `apprise -vv -t 'test title' -b 'test notification body' 'mailto://myemail:mypass@gmail.com'`
+- Set up your notification URL's and test them.
+    - Look at the [apprise wiki: Notification Services](https://github.com/caronc/apprise/wiki) for more info about how the url syntax for different services works.   
+
+### When done, customize the **notify.sh** file.
+After you're done with the setup of the container and tried your notifications, you can copy the `notify_apprise.sh` file to `notify.sh` and start editing it.
+
+Replace the url's corresponding to the services you've configured.
+```bash
+send_notification() {
+Updates=("$@")
+UpdToString=$( printf "%s\n" "${Updates[@]}" )
+FromHost=$(hostname)
+
+printf "\nSending Apprise notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+read -d '\n' MessageBody << __EOF
+Containers on $FromHost with updates available:
+
+$UpdToString
+
+__EOF
+
+# Modify to fit your setup:
+apprise -vv -t "$MessageTitle" -b "$MessageBody" \
+   mailto://myemail:mypass@gmail.com \
+   mastodons://{token}@{host} \
+   pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b \
+   tgram://{bot_token}/{chat_id}/
+
+}
+```
+
+That's all!
+___
+___

notify_DSM.sh

@@ -1,25 +1,30 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-# Copy/rename this file to notify.sh to enable email notifications on synology DSM
+#
+# Copy/rename this file to notify.sh to enable email notifications on Synology DSM
+# DSM Notification Email has to be configured manually.
 # Modify to your liking - changing SendMailTo and Subject and content.
 
 send_notification() {
 Updates=("$@")
 UpdToString=$( printf "%s\n" "${Updates[@]}" )
-# change this to your usual destination for synology DSM notification emails
-SendMailTo=me@mydomain.com
 FromHost=$(hostname)
 
-printf "\nSending email notification\n"
+# User variables:
+# change this to your usual destination for synology DSM notification emails
+SendMailTo="me@mydomain.com"
+SubjectTag="diskstation"
+
+printf "\nSending email notification.\n"
 
 ssmtp $SendMailTo << __EOF
 From: "$FromHost" <$SendMailTo>
 date:$(date -R)
 To: <$SendMailTo>
-Subject: [diskstation] Some docker containers need to be updated
+Subject: [$SubjectTag] Updates available on $FromHost
 Content-Type: text/plain; charset=UTF-8; format=flowed
 Content-Transfer-Encoding: 7bit
 
-The following docker containers on $FromHost need to be updated:
+The following containers on $FromHost have updates available:
 
 $UpdToString
 

notify_apprise.sh

@@ -0,0 +1,37 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Required receiving services must already be set up.
+# Modify to fit your setup - if API, set AppriseURL to your Apprise ip/domain.
+
+send_notification() {
+Updates=("$@")
+UpdToString=$( printf "%s\n" "${Updates[@]}" )
+FromHost=$(hostname)
+
+printf "\nSending Apprise notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+read -d '\n' MessageBody << __EOF
+Containers on $FromHost with updates available:
+
+$UpdToString
+
+__EOF
+
+# Modify to fit your setup:
+apprise -vv -t "$MessageTitle" -b "$MessageBody" \
+   mailto://myemail:mypass@gmail.com \
+   mastodons://{token}@{host} \
+   pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b \
+   tgram://{bot_token}/{chat_id}/
+
+### If you use the Apprise-API - Comment out the apprise command above.
+### Uncomment the AppriseURL and the curl-line below:
+# AppriseURL="http://apprise.mydomain.tld:1234/notify/apprise"
+# curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
+
+}
+
+

notify_generic.sh

@@ -1,5 +1,6 @@
 ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-# Copy/rename this file to notify.sh to enable email/text notifications
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
 # generic sample, the "Hello World" of notification addons
 
 send_notification() {

notify_ntfy-sh.sh

@@ -0,0 +1,31 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snippet.
+# Setup app and subscription at https://ntfy.sh
+# Use your unique Topic Name in the URL below.
+
+send_notification() {
+Updates=("$@")
+UpdToString=$( printf "%s\n" "${Updates[@]}" )
+FromHost=$(hostname)
+
+printf "\nSending ntfy.sh notification\n"
+
+MessageTitle="$FromHost - updates available."
+# Setting the MessageBody variable here.
+read -d '\n' MessageBody << __EOF
+Containers on $FromHost with updates available:
+
+$UpdToString
+
+__EOF
+
+# Modify to fit your setup:
+NtfyUrl="ntfy.sh/YourUniqueTopicName"
+
+curl -sS -o /dev/null --show-error --fail \
+  -H "Title: $MessageTitle" \
+  -d "$MessageBody" \
+  $NtfyUrl
+
+}

notify_ssmtp.sh

@@ -0,0 +1,32 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+#
+# Copy/rename this file to notify.sh to enable the notification snipppet.
+# sSMTP has to be installed and configured manually.
+# Modify to fit your setup - changing SendMailFrom, SendMailTo, SubjectTag
+
+send_notification() {
+Updates=("$@")
+UpdToString=$( printf "%s\n" "${Updates[@]}" )
+FromHost=$(hostname)
+
+# User variables:
+SendMailFrom="me@mydomain.tld"
+SendMailTo="me@mydomain.tld"
+SubjectTag="dockcheck"
+
+printf "\nSending email notification.\n"
+
+ssmtp $SendMailTo << __EOF
+From: "$FromHost" <$SendMailFrom>
+date:$(date -R)
+To: <$SendMailTo>
+Subject: [$SubjectTag] Updates available on $FromHost
+Content-Type: text/plain; charset=UTF-8; format=flowed
+Content-Transfer-Encoding: 7bit
+
+The following containers on $FromHost have updates available:
+
+$UpdToString
+
+__EOF
+}