version bump, ntfy.sh and errors on registry fail

ignore the auto-installed regctl

.gitignore

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

README.md

@@ -12,28 +12,22 @@
 </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: Changelog
+## :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
+## :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))   
+- [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.
 ___
@@ -41,7 +35,7 @@ ___
 
 ![](extras/example.gif)
 
-## `dockcheck.sh`
+## :mag_right: `dockcheck.sh`
 ```
 $ ./dockcheck.sh -h
  Syntax:     dockcheck.sh [OPTION] [part of name to filter]
@@ -60,7 +54,7 @@ $ ./dockcheck.sh -h
  -s     Include stopped containers in the check. (Logic: docker ps -a)
 ```
 
-Basic example:
+### Basic example:
 ```
 $ ./dockcheck.sh
 . . .
@@ -79,7 +73,7 @@ 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.
 
-### :loudspeaker: Notifications
+## :loudspeaker: Notifications
 Trigger with the `-i` flag.   
 Run it scheduled with `-ni` to only get notified when there's updates available!  
 
@@ -89,24 +83,14 @@ Current templates:
 - 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)
 
 Further additions are welcome - suggestions or PR!   
-Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).  
+<sub><sup>Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).</sup></sub>  
 
-
+## :roller_coaster: Workaround for non **amd64** / **arm64**
-### :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.
-
-### :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.
-
-### 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 contianer wrapped in a shell script. Copied from [regclient/docs/install.md](https://github.com/regclient/regclient/blob/main/docs/install.md):
+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
@@ -124,15 +108,23 @@ 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`
+## :warning: `-r flag` disclaimer and warning
-Just a brief, slimmed down version of the script to only print what containers got updates, no updates or errors.
+**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.3"
+VERSION="v0.3.4"
-### ChangeNotes: Added option -i, inform - notify. Added Appraise template.
+### 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"
 
@@ -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,6 +231,7 @@ 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"

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_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
+
+}