From 4e0b705b8ba9e6af124bd26526441f2430952803 Mon Sep 17 00:00:00 2001 From: singularity0821 <17620644+singularity0821@users.noreply.github.com> Date: Sun, 14 Dec 2025 11:49:56 +0100 Subject: [PATCH 01/10] Sanitize message for Matrix notifications (#243) * Sanitize message for Matrix notifications * Use variable for jq and increment version of Matrix script --------- Co-authored-by: martin --- notify_templates/notify_matrix.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/notify_templates/notify_matrix.sh b/notify_templates/notify_matrix.sh index efdf37d..fbdb332 100644 --- a/notify_templates/notify_matrix.sh +++ b/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" @@ -37,4 +37,4 @@ trigger_matrix_notification() { if [[ $? -gt 0 ]]; then NotifyError=true fi -} \ No newline at end of file +} From fc5c5db72bfa0bf5a676341e7c99661ebd17b043 Mon Sep 17 00:00:00 2001 From: smoochy <34371932+smoochy@users.noreply.github.com> Date: Sun, 25 Jan 2026 10:47:48 +0100 Subject: [PATCH 02/10] [Issue 255] Fix Notifiy also checking for /etc/HOSTNAME (#256) * - Adjusted **FromHost** variable to have fallback options when `cat /etc/hostname` or `hostname` command fails. * - Bumped Version to 0.7 --- notify_templates/notify_v2.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/notify_templates/notify_v2.sh b/notify_templates/notify_v2.sh index 5ff088f..a44870a 100644 --- a/notify_templates/notify_v2.sh +++ b/notify_templates/notify_v2.sh @@ -1,4 +1,4 @@ -NOTIFY_V2_VERSION="v0.6" +NOTIFY_V2_VERSION="v0.7" # # If migrating from an older notify template, remove your existing notify.sh file. # Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script. @@ -40,7 +40,7 @@ done enabled_notify_templates=( "${!unique_templates[@]}" ) -FromHost=$(cat /etc/hostname) +FromHost="$(cat /etc/hostname 2>/dev/null)" || FromHost="$(hostname 2>/dev/null)" || FromHost="UNKNOWN" CurrentEpochTime=$(date +"%Y-%m-%dT%H:%M:%S") CurrentEpochSeconds=$(date +%s) From c9a4150b6732573e27594277b6ad2e171dfae8a0 Mon Sep 17 00:00:00 2001 From: smoochy Date: Mon, 26 Jan 2026 20:14:47 +0100 Subject: [PATCH 03/10] Adjusted default.config & readme --- README.md | 134 ++++++++++++++++++++++++++++++++----------------- default.config | 46 ++++++++--------- 2 files changed, 111 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index f811796..5346b53 100644 --- a/README.md +++ b/README.md @@ -18,40 +18,41 @@

:whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks only for actual pulls - read more

For Podman - see the fork sudo-kraken/podcheck!
- ___ + ## Changelog - **v0.7.5**: - - 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 `-B`. - - Fixes: - - Bugfix for `-s` *Stopped* to not recreate stopped containers after update. + - 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 `-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. - - Allows for more control and possible pipeline integration. - - Fixes: - - Bugfix for *value too great* error due to leading zeroes - solved with base10 conversion. - - Clean up of some legacy readme sections. + - Added new option `-R`: + - Will skip container recreation after pulling images. + - Allows for more control and possible pipeline integration. + - Fixes: + - Bugfix for *value too great* error due to leading zeroes - solved with base10 conversion. + - Clean up of some legacy readme sections. - **v0.7.3**: Bugfix - unquoted variable in printf list caused occasional issues. - **v0.7.2**: - - Label rework: - - Moved up label logic to work globally on the current run. - - Only iterating on labeled containers when used with `-l` option, not listing others. - - Clarified messaging and readme/help texts. - - List reformatting for "available updates" numbering to easier highlight and copy: - - Padded with zero, changed `)` to `-`, example: `02 - homer` - - Can be selected by writing `2,3,4` or `02,03,04`. + - Label rework: + - Moved up label logic to work globally on the current run. + - Only iterating on labeled containers when used with `-l` option, not listing others. + - Clarified messaging and readme/help texts. + - List reformatting for "available updates" numbering to easier highlight and copy: + - Padded with zero, changed `)` to `-`, example: `02 - homer` + - Can be selected by writing `2,3,4` or `02,03,04`. + ___ - -![](extras/example.gif) +![example.gif](extras/example.gif) ## `dockcheck.sh` -``` + +```shell $ ./dockcheck.sh -h Syntax: dockcheck.sh [OPTION] [comma separated names to include] Example: dockcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall @@ -82,8 +83,9 @@ Options: -x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested. ``` -### Basic example: -``` +### Basic example + +```shell $ ./dockcheck.sh [##################################################] 5/5 @@ -99,12 +101,14 @@ Containers with updates available: Choose what containers to update: Enter number(s) separated by comma, [a] for all - [q] to quit: 1,2 ``` + Then it proceeds 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. ___ ## Dependencies + - Running docker (duh) and compose, either standalone or plugin. (see [Podman fork](https://github.com/sudo-kraken/podcheck)) - Bash shell or compatible shell of at least v4.3 - POSIX `xargs`, usually default but can be installed with the `findutils` package - to enable async. @@ -112,12 +116,14 @@ ___ - User will be prompted to install with package manager or download static binary. - [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](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used. + - regctl requires `amd64/arm64` - see [workaround](#workaround-for-non-amd64--arm64) if other architecture is used. ## Install Instructions + Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**. For OSX/macOS preferably use `/usr/local/bin`. -```sh + +```shell # basic example with curl: curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o ~/.local/bin/dockcheck.sh chmod +x ~/.local/bin/dockcheck.sh @@ -128,25 +134,31 @@ wget -O ~/.local/bin/dockcheck.sh "https://raw.githubusercontent.com/mag37/dockc # OSX or macOS version with curl: curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o /usr/local/bin/dockcheck.sh && chmod +x /usr/local/bin/dockcheck.sh ``` + Then call the script anywhere with just `dockcheck.sh`. Add preferred `notify.sh`-template to the same directory - this will not be touched by the scripts self-update function. ## Configuration + To modify settings and have them persist through updates - copy the `default.config` to `dockcheck.config` alongside the script or in `~/.config/`. Alternatively create an alias where specific flags and values are set. Example `alias dc=dockcheck.sh -p -x 10 -t 3`. ## Notifications + Triggered with the `-i` flag. Will send a list of containers with updates available and a notification when `dockcheck.sh` itself has an update. `notify_templates/notify_v2.sh` is the default notification wrapper, if `notify.sh` is present and configured, it will override. Example of a cron scheduled job running non-interactive at 10'oclock excluding 1 container and sending notifications: `0 10 * * * /home/user123/.local/bin/dockcheck.sh -nix 10 -e excluded_container1` -#### Installation and configuration: +## Installation and configuration + Set up a directory structure as below. -You only need the `notify_templates/notify_v2.sh` file and any notification templates you wish to enable, but there is no harm in having all of them present. -``` +You only need the `notify_templates/notify_v2.sh` file and any notification templates +you wish to enable, but there is no harm in having all of them present. + +```shell . ├── notify_templates/ │ ├── notify_DSM.sh @@ -167,14 +179,15 @@ You only need the `notify_templates/notify_v2.sh` file and any notification temp ├── dockcheck.sh └── urls.list # optional ``` + - Uncomment and set the `NOTIFY_CHANNELS=""` environment variable in `dockcheck.config` to a space separated string of your desired notification channels to enable. - Uncomment and set the environment variables related to the enabled notification channels. Eg. `GOTIFY_DOMAIN=""` + `GOTIFY_TOKEN=""`. It's recommended to only do configuration with variables within `dockcheck.config` and not modify `notify_templates/notify_X.sh` directly. If you wish to customize the notify templates yourself, you may copy them to your project root directory alongside the main `dockcheck.sh` (where they're also ignored by git). Customizing `notify_v2.sh` is handled the same as customizing the templates, but it must be renamed to `notify.sh` within the `dockcheck.sh` root directory. +### Snooze feature -#### Snooze feature: Configure to receive scheduled notifications only if they're new since the last notification - within a set time frame. **Example:** *Dockcheck is scheduled to run every hour. You will receive an update notification within an hour of availability.* @@ -188,8 +201,8 @@ If an update becomes available for an item that is not snoozed, notifications wi The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to account for minor scheduling or run time issues. +### Current notify templates -#### Current notify templates: - Synology [DSM](https://www.synology.com/en-global/dsm) - Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP)) - Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications) @@ -208,11 +221,14 @@ The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to acco Further additions are welcome - suggestions or PRs! Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2). -#### Notification channel configuration: +### Notification channel configuration + All required environment variables for each notification channel are provided in the default.config file as comments and must be uncommented and modified for your requirements. For advanced users, additional functionality is available via custom configurations and environment variables. Use cases - all configured in `dockcheck.config`: -(replace `` with the upper case name of the of the channel as listed in `NOTIFY_CHANNELS` variable, eg `TELEGRAM_SKIPSNOOZE`) +(replace `` with the upper case name of the of the channel as listed in +`NOTIFY_CHANNELS` variable, eg `TELEGRAM_SKIPSNOOZE`) + - To bypass the snooze feature, even when enabled, add the variable `_SKIPSNOOZE` and set it to `true`. - To configure the channel to only send container update notifications, add the variable `_CONTAINERSONLY` and set it to `true`. - To send notifications even when there are no updates available, add the variable `_ALLOWEMPTY` and set it to `true`. @@ -224,7 +240,8 @@ Use cases - all configured in `dockcheck.config`: - Add all other environment variables required for the chosen template to function with `` in upper case as the prefix rather than the template name. - For example, if `` is `mynotification` and the template configured is `slack`, you would need to set `MYNOTIFICATION_CHANNEL_ID` and `MYNOTIFICATION_ACCESS_TOKEN`. -### Release notes addon +## Release notes addon + There's a function to use a lookup-file to add release note URL's to the notification message. Copy the notify_templates/`urls.list` file to the script directory, it will be used automatically if it's there. Modify it as necessary, the names of interest in the left column needs to match your container names. @@ -232,22 +249,28 @@ To also list the URL's in the CLI output (choose containers list) use the `-I` o For Markdown formatting also add the `-M` option. (**this requires the template to be compatible - see gotify for example**) The output of the notification will look something like this: -``` + +```shell Containers on hostname with updates available: apprise-api -> https://github.com/linuxserver/docker-apprise-api/releases homer -> https://github.com/bastienwirtz/homer/releases nginx -> https://github.com/docker-library/official-images/blob/master/library/nginx ... ``` + The `urls.list` file is just an example and I'd gladly see that people contribute back when they add their preferred URLs to their lists. ## Asyncronous update checks with **xargs**; `-x N` option. (default=1) + Pass `-x N` where N is number of subprocesses allowed, experiment in your environment to find a suitable max! -Change the default value by editing the `MaxAsync=N` variable in `dockcheck.sh`. To disable the subprocess function set `MaxAsync=0`. +Change the default value by editing the `MaxAsync=N` variable in `dockcheck.config`. To disable the subprocess function set `MaxAsync=0`. ## Image Backups; `-b N` to backup previous images as custom (retagged) images for easy rollback + When the option `BackupForDays` is set **dockcheck** will store the image being updated as a backup, retagged with a different name and removed due to age configured (*BackupForDays*) in a future run. -Let's say we're updating `b4bz/homer:latest` - then before replacing the current image it will be retagged with the name `dockcheck/homer:2025-10-26_1132_latest` +Let's say we're updating `b4bz/homer:latest` - then before replacing the current image +it will be retagged with the name `dockcheck/homer:2025-10-26_1132_latest` + - `dockcheck` as repo name to not interfere with others. - `homer` is the image. - `2025-10-26_1132` is the time when running the script. @@ -263,17 +286,20 @@ Backed up images will not be removed if neither `-b` flag nor `BackupForDays` co Use the capital option `-B` to list currently backed up images. Or list all images with `docker images`. To manually remove any backed up images, do `docker rmi dockcheck/homer:2025-10-26_1132_latest`. -## Extra plugins and tools: +## Extra plugins and tools ### Using dockcheck.sh with the Synology DSM + If you run your container through the *Container Manager GUI* - only notifications are supported. While if running manual (vanilla docker compose CLI) will allow you to use the update function too. Some extra setup to tie together with Synology DSM - check out the [addons/DSM/README.md](./addons/DSM/README.md). ### Prometheus and node_exporter + Dockcheck can be used together with [Prometheus](https://github.com/prometheus/prometheus) and [node_exporter](https://github.com/prometheus/node_exporter) to export metrics via the file collector, scheduled with cron or likely. This is done with the `-c` option, like this: -``` + +```shell dockcheck.sh -c /path/to/exporter/directory ``` @@ -281,26 +307,32 @@ See the [README.md](./addons/prometheus/README.md) for more detailed information Contributed by [tdralle](https://github.com/tdralle). ### Zabbix config to monitor docker image updates + If you already use Zabbix - this config will show numbers of available docker image updates on host. Example: *2 Docker Image updates on host-xyz* See project: [thetorminal/zabbix-docker-image-updates](https://github.com/thetorminal/zabbix-docker-image-updates) ### Serve REST API to list all available updates + A custom python script to serve a REST API to get pulled into other monitoring tools like [homepage](https://github.com/gethomepage/homepage). See [discussion here](https://github.com/mag37/dockcheck/discussions/146). ### Wrapper Script for Unraid's User Scripts + A custom bash wrapper script to allow the usage of dockcheck as a Unraid User Script plugin. See [discussion here](https://github.com/mag37/dockcheck/discussions/145). ## Labels + Optionally add labels to compose-files. Currently these are the usable labels: -``` + +```yaml labels: mag37.dockcheck.update: true mag37.dockcheck.only-specific-container: true mag37.dockcheck.restart-stack: true ``` + - `mag37.dockcheck.update: true` will when used with the `-l` option only check and update containers with this label set and skip the rest. - `mag37.dockcheck.only-specific-container: true` works instead of the `-F` option, specifying the updated container when doing compose up, like `docker compose up -d homer`. - `mag37.dockcheck.restart-stack: true` works instead of the `-f` option, forcing stop+restart on the whole compose-stack (Caution: Will restart on every updated container within stack). @@ -308,10 +340,11 @@ Optionally add labels to compose-files. Currently these are the usable labels: Adding or modifying labels in compose-files requires a restart of the container to take effect. ## 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 +```shell cat >regctl <Unauthenticated users: 10 pulls/hour >Authenticated users with a free account: 100 pulls/hour @@ -336,8 +371,11 @@ This is not an issue for registry checks. But if you have a large stack and pull You could use/modify the login-wrapper function in the example below to automate the login prior to running `dockcheck.sh`. ### Function to auth with docker hub before running -**Example** - Change names, paths, and remove cat+password flag if you rather get prompted: -```sh + +**Example** - Change names, paths, and remove cat+password flag if you rather get +prompted: + +```shell function dchk { cat ~/pwd.txt | docker login --username YourUser --password-stdin ~/dockcheck.sh "$@" @@ -345,22 +383,26 @@ function dchk { ``` ## `-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. +`docker run` doesn't 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. Using the `-r` option together with eg. `-i` and `-n` to just check for updates and send notifications and not update is safe though! ## 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**. - **Watchtower** might cause issues due to retagging images when checking for updates (and thereby pulling new images). ## Debugging + If you hit issues, you could check the output of the `extras/errorCheck.sh` script for clues. Another option is to run the main script with debugging in a subshell `bash -x dockcheck.sh` - if there's a particular container/image that's causing issues you can filter for just that through `bash -x dockcheck.sh nginx`. ## License + dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license. ## Sponsorlist @@ -378,4 +420,4 @@ dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/l ___ -### The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect. +## The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect diff --git a/default.config b/default.config index 90abfa5..43baea6 100644 --- a/default.config +++ b/default.config @@ -5,30 +5,30 @@ ## Uncomment and set your preferred configuration variables here ## This will not be replaced on updates -#Timeout=10 # Set a timeout (in seconds) per container for registry checkups. -#MaxAsync=10 # Set max asynchronous subprocesses, 1 default, 0 to disable. -#BarWidth=50 # The character width of the progress bar -#AutoMode=true # Automatic updates, without interaction. -#DontUpdate=true # No updates; only checking availability without interaction. -#AutoPrune=true # Auto-Prune dangling images after update. -#AutoSelfUpdate=true # Allow automatic self updates - caution as this will pull new code and autorun it. -#Notify=true # Inform - send a preconfigured notification. -#Exclude="one,two" # Exclude containers, separated by comma. -#DaysOld="5" # Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower. -#Stopped="-a" # Include stopped containers in the check. (Logic: docker ps -a). -#OnlyLabel=true # Only update if label is set. See readme. +#AutoMode=true # Automatic updates, without interaction. +#AutoPrune=true # Auto-Prune dangling images after update. +#AutoSelfUpdate=true # Allow automatic self updates - caution as this will pull new code and autorun it. +#BackupForDays=7 # Enable backups of images and removes backups older than N days. +#BarWidth=50 # The character width of the progress bar +#CurlConnectTimeout=5 # Time to wait for curl to establish a connection before failing +#CurlRetryCount=3 # Max number of curl retries +#CurlRetryDelay=1 # Time between curl retries +#DaysOld="5" # Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower. +#DisplaySourcedFiles=false # Display what files are being sourced/used +#DontUpdate=true # No updates; only checking availability without interaction. +#DRunUp=true # Allows for checking containers, which had been created using 'docker run' and don't use docker compose. Won't update the containers. +#Exclude="one,two" # Exclude containers, separated by comma. #ForceRestartStacks=true # Force stop+start stack after update. Caution: restarts once for every updated container within stack. -#DRunUp=true # Allow updating images for docker run, wont update the container. -#SkipRecreate # Skip container recreation after pulling images. -#MonoMode=true # Monochrome mode, no printf colour codes and hides progress bar. -#PrintReleaseURL=true # Prints custom releasenote urls alongside each container with updates (requires urls.list)` -#PrintMarkdownURL=true # Prints custom releasenote urls as markdown -#OnlySpecific=true # Only compose up the specific container, not the whole compose. (useful for master-compose structure). -#CurlRetryDelay=1 # Time between curl retries -#CurlRetryCount=3 # Max number of curl retries -#CurlConnectTimeout=5 # Time to wait for curl to establish a connection before failing -#DisplaySourcedFiles=false # Display what files are being sourced/used -#BackupForDays=7 # Enable backups of images and removes backups older than N days. +#MaxAsync=10 # Set max asynchronous subprocesses, 1 default, 0 to disable. +#MonoMode=true # Monochrome mode, no printf colour codes and hides progress bar. +#Notify=true # Inform - send a preconfigured notification. +#OnlyLabel=true # Only update if label is set. See readme. +#OnlySpecific=true # Only compose up the specific container, not the whole compose. (useful for master-compose structure). +#PrintMarkdownURL=true # Prints custom releasenote urls as markdown +#PrintReleaseURL=true # Prints custom releasenote urls alongside each container with updates (requires urls.list)` +#SkipRecreate # Skip container recreation after pulling images. +#Stopped="-a" # Include stopped containers in the check. (Logic: docker ps -a). +#Timeout=10 # Set a timeout (in seconds) per container for registry checkups. ### Notify settings ## All commented values are examples only. Modify as needed. From 9c780b8b3566161d0a5fc7ec9da4f77b41dc6eb8 Mon Sep 17 00:00:00 2001 From: mag37 Date: Tue, 27 Jan 2026 09:31:19 +0100 Subject: [PATCH 04/10] Consistent sub-headers --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5346b53..1d1e660 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@

:whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks only for actual pulls - read more

For Podman - see the fork sudo-kraken/podcheck!
+ ___ ## Changelog @@ -152,7 +153,7 @@ Triggered with the `-i` flag. Will send a list of containers with updates availa Example of a cron scheduled job running non-interactive at 10'oclock excluding 1 container and sending notifications: `0 10 * * * /home/user123/.local/bin/dockcheck.sh -nix 10 -e excluded_container1` -## Installation and configuration +#### Installation and configuration Set up a directory structure as below. You only need the `notify_templates/notify_v2.sh` file and any notification templates @@ -186,7 +187,7 @@ you wish to enable, but there is no harm in having all of them present. It's recommended to only do configuration with variables within `dockcheck.config` and not modify `notify_templates/notify_X.sh` directly. If you wish to customize the notify templates yourself, you may copy them to your project root directory alongside the main `dockcheck.sh` (where they're also ignored by git). Customizing `notify_v2.sh` is handled the same as customizing the templates, but it must be renamed to `notify.sh` within the `dockcheck.sh` root directory. -### Snooze feature +#### Snooze feature Configure to receive scheduled notifications only if they're new since the last notification - within a set time frame. @@ -201,7 +202,7 @@ If an update becomes available for an item that is not snoozed, notifications wi The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to account for minor scheduling or run time issues. -### Current notify templates +#### Current notify templates - Synology [DSM](https://www.synology.com/en-global/dsm) - Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP)) @@ -221,7 +222,7 @@ The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to acco Further additions are welcome - suggestions or PRs! Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2). -### Notification channel configuration +#### Notification channel configuration All required environment variables for each notification channel are provided in the default.config file as comments and must be uncommented and modified for your requirements. For advanced users, additional functionality is available via custom configurations and environment variables. @@ -240,7 +241,7 @@ Use cases - all configured in `dockcheck.config`: - Add all other environment variables required for the chosen template to function with `` in upper case as the prefix rather than the template name. - For example, if `` is `mynotification` and the template configured is `slack`, you would need to set `MYNOTIFICATION_CHANNEL_ID` and `MYNOTIFICATION_ACCESS_TOKEN`. -## Release notes addon +#### Release notes addon There's a function to use a lookup-file to add release note URL's to the notification message. Copy the notify_templates/`urls.list` file to the script directory, it will be used automatically if it's there. From 9755c32f8cc02b4eb924b4c7a89465af8186ee60 Mon Sep 17 00:00:00 2001 From: solitudechn Date: Wed, 28 Jan 2026 17:19:34 +0800 Subject: [PATCH 05/10] add-bark-notify (#259) --- default.config | 4 ++- notify_templates/notify_bark.sh | 46 +++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 notify_templates/notify_bark.sh diff --git a/default.config b/default.config index 90abfa5..77e18d1 100644 --- a/default.config +++ b/default.config @@ -34,7 +34,7 @@ ## All commented values are examples only. Modify as needed. ## ## Uncomment the line below and specify the notification channels you wish to enable in a space separated string -# NOTIFY_CHANNELS="apprise discord DSM file generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram file" +# NOTIFY_CHANNELS="apprise discord DSM file generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram bark file" # ## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze # SNOOZE_SECONDS=86400 @@ -90,4 +90,6 @@ # TELEGRAM_TOKEN="token-value" # TELEGRAM_TOPIC_ID="0" # +# BARK_KEY="" +# # FILE_PATH="${ScriptWorkDir}/updates_available.txt" diff --git a/notify_templates/notify_bark.sh b/notify_templates/notify_bark.sh new file mode 100644 index 0000000..c720cf2 --- /dev/null +++ b/notify_templates/notify_bark.sh @@ -0,0 +1,46 @@ +#!/bin/bash + +# NOTIFY_BARK_VERSION="v1.0" + +trigger_bark_notification() { + local channel="$1" + + if [[ -z "$jqbin" ]]; then + for path in "$jqbin" "jq" "./jq" "../jq" "./jq-linux-TEMP" "../jq-linux-TEMP"; do + if command -v "$path" &>/dev/null; then jqbin="$path"; break; fi + done + fi + [[ -z "$jqbin" ]] && { echo "Error: jq missing"; return 1; } + + [[ -z "$BARK_KEY" ]] && { echo "Error: Key not set"; return 1; } + + local sound="${BARK_SOUND:-hello}" + local group="${BARK_GROUP:-Dockcheck}" + local icon_url="${BARK_ICON_URL:-https://raw.githubusercontent.com/mag37/dockcheck/main/logo.png}" + + + local title="${MessageTitle%.}" + local newline=$'\n' + local formatted_body="## $title${newline}${newline}---${newline}${newline}$MessageBody" + + local json_payload=$( "$jqbin" -n \ + --arg title "$title" \ + --arg body "$formatted_body" \ + --arg group "$group" \ + --arg sound "$sound" \ + --arg icon "$icon_url" \ + '{ + "title": $title, + "markdown": $body, + "group": $group, + "sound": $sound, + "icon": $icon, + }' ) + + + if curl -s -f -X POST "https://api.day.app/$BARK_KEY" \ + -H "Content-Type: application/json; charset=utf-8" \ + -d "$json_payload" > /dev/null 2>&1; then + echo "Bark notification sent successfully (Markdown): $title" + fi +} \ No newline at end of file From 1584f23d330c6181263b3c17f789df63b3d29b10 Mon Sep 17 00:00:00 2001 From: smoochy Date: Wed, 28 Jan 2026 21:39:51 +0100 Subject: [PATCH 06/10] - Adjusted description of "-r" parameter - Adjusted order of parameters between dockcheck.sh and readme - Added missing parameter values from readme into dockcheck.sh --- README.md | 2 +- default.config | 2 +- dockcheck.sh | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1d1e660..0f93af5 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ Options: -M Prints custom releasenote urls as markdown (requires template support). -n No updates, only checking availability. -p Auto-Prune dangling images after update. --r Allow checking for updates/updating images for docker run containers. Won't update the container. +-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). -t N Set a timeout (in seconds) per container for registry checkups, 10 is default. diff --git a/default.config b/default.config index 43baea6..9920947 100644 --- a/default.config +++ b/default.config @@ -16,7 +16,7 @@ #DaysOld="5" # Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower. #DisplaySourcedFiles=false # Display what files are being sourced/used #DontUpdate=true # No updates; only checking availability without interaction. -#DRunUp=true # Allows for checking containers, which had been created using 'docker run' and don't use docker compose. Won't update the containers. +#DRunUp=true # Allow checking/updating images created by `docker run`, containers need to be recreated manually. #Exclude="one,two" # Exclude containers, separated by comma. #ForceRestartStacks=true # Force stop+start stack after update. Caution: restarts once for every updated container within stack. #MaxAsync=10 # Set max asynchronous subprocesses, 1 default, 0 to disable. diff --git a/dockcheck.sh b/dockcheck.sh index 906ed0d..7115571 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -36,7 +36,7 @@ Help() { echo "-a|y Automatic updates, without interaction." echo "-b N Enable image backups and sets number of days to keep from pruning." echo "-B List currently backed up images, then exit." - echo "-c Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory." + echo "-c D Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory." 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 "-f Force stop+start stack after update. Caution: restarts once for every updated container within stack." @@ -49,10 +49,10 @@ Help() { echo "-M Prints custom releasenote urls as markdown (requires template support)." echo "-n No updates; only checking availability without interaction." 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 "-r Allow checking for updates/updating images for docker run containers. Won't update the container." echo "-s Include stopped containers in the check. (Logic: docker ps -a)." - echo "-t Set a timeout (in seconds) per container for registry checkups, 10 is default." + 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." echo "-x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested." From 6e3b7ee419241110187ba63a5aaa635b2fabc1f9 Mon Sep 17 00:00:00 2001 From: mag37 Date: Thu, 29 Jan 2026 09:42:33 +0100 Subject: [PATCH 07/10] Added Bark to README and minor cleanups --- README.md | 14 ++++++++------ default.config | 18 ++++++++++-------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0f93af5..9810726 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,7 @@ you wish to enable, but there is no harm in having all of them present. ├── notify_templates/ │ ├── notify_DSM.sh │ ├── notify_apprise.sh +│ ├── notify_bark.sh │ ├── notify_discord.sh │ ├── notify_generic.sh │ ├── notify_gotify.sh @@ -204,20 +205,21 @@ The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to acco #### Current notify templates -- Synology [DSM](https://www.synology.com/en-global/dsm) -- Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [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) -- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications. +- [Bark](https://bark.day.app/) - iOS Push notifications. +- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks. +- [DSM](https://www.synology.com/en-global/dsm) - Synology. - [Gotify](https://gotify.net/) - a simple server for sending and receiving messages. - [Home Assistant](https://www.home-assistant.io/integrations/notify/) - Connection to the notify [integrations](https://www.home-assistant.io/integrations/#notifications). -- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features. -- [Telegram](https://telegram.org/) - Telegram chat API. - [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication. +- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications. +- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features. - [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops) -- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks. - [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. Further additions are welcome - suggestions or PRs! Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2). diff --git a/default.config b/default.config index 330d45f..f9076a2 100644 --- a/default.config +++ b/default.config @@ -1,4 +1,4 @@ -### Custom user variables +##### Custom user variables ##### ## Copy this file to "dockcheck.config" to make it active ## Can be placed in ~/.config/ or alongside dockcheck.sh ## @@ -30,11 +30,12 @@ #Stopped="-a" # Include stopped containers in the check. (Logic: docker ps -a). #Timeout=10 # Set a timeout (in seconds) per container for registry checkups. -### Notify settings +##### NOTIFY SETTINGS BELOW ##### +## ## All commented values are examples only. Modify as needed. ## ## Uncomment the line below and specify the notification channels you wish to enable in a space separated string -# NOTIFY_CHANNELS="apprise discord DSM file generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram bark file" +# NOTIFY_CHANNELS="apprise bark discord DSM file generic gotify HA matrix ntfy pushbullet pushover slack smtp telegram" # ## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze # SNOOZE_SECONDS=86400 @@ -51,11 +52,15 @@ # tgram://{bot_token}/{chat_id}/' # APPRISE_URL="http://apprise.mydomain.tld:1234/notify/apprise" # +# BARK_KEY="key-value" +# # DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/" # # DSM_SENDMAILTO="me@mydomain.com" # DSM_SUBJECTTAG="Email Subject Prefix" # +# FILE_PATH="${ScriptWorkDir}/updates_available.txt" +# # GOTIFY_DOMAIN="https://gotify.domain.tld" # GOTIFY_TOKEN="token-value" # @@ -70,7 +75,8 @@ ## https://ntfy.sh or your custom domain with https:// and no trailing / # NTFY_DOMAIN="https://ntfy.sh" # NTFY_TOPIC_NAME="YourUniqueTopicName" -# NTFY_AUTH="" # set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":" +## Auth method, set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":" +# NTFY_AUTH="" # # PUSHBULLET_URL="https://api.pushbullet.com/v2/pushes" # PUSHBULLET_TOKEN="token-value" @@ -89,7 +95,3 @@ # TELEGRAM_CHAT_ID="mychatid" # TELEGRAM_TOKEN="token-value" # TELEGRAM_TOPIC_ID="0" -# -# BARK_KEY="" -# -# FILE_PATH="${ScriptWorkDir}/updates_available.txt" From 6c969c91695ff6cab90e4c43ebcd42f9168acbe8 Mon Sep 17 00:00:00 2001 From: mag37 Date: Thu, 29 Jan 2026 09:59:45 +0100 Subject: [PATCH 08/10] mend --- dockcheck.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dockcheck.sh b/dockcheck.sh index 7115571..aa895bb 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -49,7 +49,7 @@ Help() { echo "-M Prints custom releasenote urls as markdown (requires template support)." echo "-n No updates; only checking availability without interaction." 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 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 "-t N Set a timeout (in seconds) per container for registry checkups, 10 is default." From fc0b1a2505942ce51582ce384d684f47df9f22c9 Mon Sep 17 00:00:00 2001 From: mag37 Date: Thu, 29 Jan 2026 13:06:07 +0100 Subject: [PATCH 09/10] Versionbump, changenotes --- README.md | 17 ++++++++--------- dockcheck.sh | 4 ++-- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9810726..418b50b 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,14 @@ ___ ## Changelog +- **v0.7.6**: + - New: + - Added Bark notify-template. + - Fixes: + - Sanitized message for Matrix notification. + - Fixed hostname fallback for notifications. + - Clenaed up README.md some. + - Sorted and clarified `default.config` - migrate your settings manually (optional). - **v0.7.5**: - Added new option **BackupForDays**; `-b N` and `-B`: - Backup an image before pulling a new version for easy rollback in case of breakage. @@ -37,15 +45,6 @@ ___ - Fixes: - Bugfix for *value too great* error due to leading zeroes - solved with base10 conversion. - Clean up of some legacy readme sections. -- **v0.7.3**: Bugfix - unquoted variable in printf list caused occasional issues. -- **v0.7.2**: - - Label rework: - - Moved up label logic to work globally on the current run. - - Only iterating on labeled containers when used with `-l` option, not listing others. - - Clarified messaging and readme/help texts. - - List reformatting for "available updates" numbering to easier highlight and copy: - - Padded with zero, changed `)` to `-`, example: `02 - homer` - - Can be selected by writing `2,3,4` or `02,03,04`. ___ diff --git a/dockcheck.sh b/dockcheck.sh index aa895bb..24e7c62 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -VERSION="v0.7.5" -# ChangeNotes: New option -b N to backup image before pulling for easy rollback. +VERSION="v0.7.6" +# ChangeNotes: Bugfixes and sanitation. Cleanup of default.config - migrate settings manually (optional). Github="https://github.com/mag37/dockcheck" RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" From 7785e869d3ca5e2b9fd1d6e84ec80c18fee668fa Mon Sep 17 00:00:00 2001 From: singularity0821 <17620644+singularity0821@users.noreply.github.com> Date: Fri, 6 Feb 2026 18:07:58 +0100 Subject: [PATCH 10/10] Add additional URLs to urls.list (#263) * Sanitize message for Matrix notifications * Use variable for jq and increment version of Matrix script * Add additional URLs to urls.list --------- Co-authored-by: martin --- notify_templates/urls.list | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/notify_templates/urls.list b/notify_templates/urls.list index aeba433..e69838a 100644 --- a/notify_templates/urls.list +++ b/notify_templates/urls.list @@ -3,33 +3,47 @@ # This is a list of container names and releasenote urls, separated by space. actual_server https://actualbudget.org/blog +adguardhome https://github.com/AdguardTeam/AdGuardHome/releases apprise-api https://github.com/linuxserver/docker-apprise-api/releases audiobookshelf https://github.com/advplyr/audiobookshelf/releases +authentik_server https://github.com/goauthentik/authentik/releases +authentik_worker https://github.com/goauthentik/authentik/releases +barassistant https://github.com/karlomikus/bar-assistant//releases +barassistant_api https://github.com/karlomikus/bar-assistant/releases bazarr https://github.com/morpheus65535/bazarr/releases bazarr-ls https://github.com/linuxserver/docker-bazarr/releases beszel https://github.com/henrygd/beszel/releases +booklore https://github.com/booklore-app/BookLore/releases bookstack https://github.com/BookStackApp/BookStack/releases bruceforce-vaultwarden-backup https://github.com/Bruceforce/vaultwarden-backup/blob/main/CHANGELOG.md caddy https://github.com/caddyserver/caddy/releases 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 +collabora https://github.com/CollaboraOnline/online/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 +databasus https://github.com/databasus/databasus/releases dockge https://github.com/louislam/dockge/releases dozzle https://github.com/amir20/dozzle/releases +esphome https://github.com/esphome/esphome/releases +feishin https://github.com/jeffvli/feishin/releases flatnotes https://github.com/dullage/flatnotes/releases forgejo https://codeberg.org/forgejo/forgejo/releases fressrss https://github.com/FreshRSS/FreshRSS/releases +frigate https://github.com/blakeblackshear/frigate/releases gerbil https://github.com/fosrl/gerbil/releases +glances https://github.com/nicolargo/glances/releases gluetun https://github.com/qdm12/gluetun/releases go2rtc https://github.com/AlexxIT/go2rtc/releases +godoxy https://github.com/yusing/godoxy/releases gotify https://github.com/gotify/server/releases hbbr https://github.com/rustdesk/rustdesk-server/releases hbbs https://github.com/rustdesk/rustdesk-server/releases homarr https://github.com/homarr-labs/homarr/releases home-assistant https://github.com/home-assistant/core/releases/ +homepage https://github.com/gethomepage/homepage/releases homer https://github.com/bastienwirtz/homer/releases immich_machine_learning https://github.com/immich-app/immich/releases immich_postgres https://github.com/tensorchord/VectorChord/releases @@ -38,6 +52,7 @@ immich_server https://github.com/immich-app/immich/releases jellyfin https://github.com/jellyfin/jellyfin/releases jellyseerr https://github.com/Fallenbagel/jellyseerr/releases jellystat https://github.com/CyferShepard/Jellystat/releases +karakeep https://github.com/karakeep-app/karakeep/releases librespeed https://github.com/librespeed/speedtest/releases lidarr https://github.com/Lidarr/Lidarr/releases/ lidarr-ls https://github.com/linuxserver/docker-lidarr/releases @@ -47,9 +62,12 @@ 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 +navidrome https://github.com/navidrome/navidrome/releases 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 +opencloud https://github.com/opencloud-eu/opencloud/releases +outline https://github.com/outline/outline/releases owncast https://github.com/owncast/owncast/releases pangolin https://github.com/fosrl/pangolin/releases prowlarr https://github.com/Prowlarr/Prowlarr/releases @@ -63,18 +81,25 @@ readeck https://codeberg.org/readeck/readeck/releases recyclarr https://github.com/recyclarr/recyclarr/releases roundcubemail https://github.com/roundcube/roundcubemail/releases sabnzbd https://github.com/linuxserver/docker-sabnzbd/releases +scanopy https://github.com/scanopy/scanopy/releases scrutiny https://github.com/AnalogJ/scrutiny/releases sftpgo https://github.com/drakkan/sftpgo/releases slskd https://github.com/slskd/slskd/releases snappymail https://github.com/the-djmaze/snappymail/releases +stirling-pdf https://github.com/Stirling-Tools/Stirling-PDF/releases sonarr https://github.com/Sonarr/Sonarr/releases/ sonarr-ls https://github.com/linuxserver/docker-sonarr/releases +synapse https://github.com/element-hq/synapse/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 +uptime-kuma https://github.com/louislam/uptime-kuma/releases vaultwarden-server https://github.com/dani-garcia/vaultwarden/releases +vikunja https://github.com/go-vikunja/vikunja/releases +wallos https://github.com/ellite/Wallos/releases watchtower https://github.com/beatkind/watchtower/releases +wopiserver https://github.com/cs3org/wopiserver/releases wud https://github.com/getwud/wud/releases zigbee2mqtt https://github.com/Koenkk/zigbee2mqtt/releases