From fbc9a252f555384c7602dc7ef38418b6431490c5 Mon Sep 17 00:00:00 2001 From: xmirakulix Date: Sat, 2 Aug 2025 08:04:43 +0200 Subject: [PATCH 01/27] update SMTP template, added suport for sendmail (#219) * update smtp template, add suport for sendmail * add sendmail to DSM and bump version * correct errormsg and version number --- notify_templates/notify_DSM.sh | 7 +++++-- notify_templates/notify_smtp.sh | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/notify_templates/notify_DSM.sh b/notify_templates/notify_DSM.sh index 08d85c1..3afe0ab 100644 --- a/notify_templates/notify_DSM.sh +++ b/notify_templates/notify_DSM.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_DSM_VERSION="v0.3" +NOTIFY_DSM_VERSION="v0.4" # INFO: ssmtp is deprecated - consider to use msmtp instead. # # mSMTP/sSMTP has to be installed and configured manually. @@ -10,13 +10,16 @@ NOTIFY_DSM_VERSION="v0.3" MSMTP=$(which msmtp) SSMTP=$(which ssmtp) +SENDMAIL=$(which sendmail) if [ -n "$MSMTP" ] ; then MailPkg=$MSMTP elif [ -n "$SSMTP" ] ; then MailPkg=$SSMTP +elif [ -n "$SENDMAIL" ] ; then + MailPkg=$SENDMAIL else - echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1 + echo "No msmtp, ssmtp or sendmail binary found in PATH: $PATH" ; exit 1 fi trigger_DSM_notification() { diff --git a/notify_templates/notify_smtp.sh b/notify_templates/notify_smtp.sh index f07588c..9cfc76c 100644 --- a/notify_templates/notify_smtp.sh +++ b/notify_templates/notify_smtp.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_SMTP_VERSION="v0.3" +NOTIFY_SMTP_VERSION="v0.4" # INFO: ssmtp is depcerated - consider to use msmtp instead. # # mSMTP/sSMTP has to be installed and configured manually. @@ -15,13 +15,16 @@ fi MSMTP=$(which msmtp) SSMTP=$(which ssmtp) +SENDMAIL=$(which sendmail) if [ -n "$MSMTP" ] ; then MailPkg=$MSMTP elif [ -n "$SSMTP" ] ; then MailPkg=$SSMTP +elif [ -n "$SENDMAIL" ] ; then + MailPkg=$SENDMAIL else - echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1 + echo "No msmtp, ssmtp or sendmail binary found in PATH: $PATH" ; exit 1 fi trigger_smtp_notification() { From 9156cc44e1a9bd788f7a6638d7dff7d48299faec Mon Sep 17 00:00:00 2001 From: op4lat <155382511+op4lat@users.noreply.github.com> Date: Mon, 11 Aug 2025 15:16:38 -0400 Subject: [PATCH 02/27] Ntfy.sh and authentication (#220) * default.config: add NtfyAuth= * notify_templates/notify_ntfy.sh: implement NtfyAuth --------- Co-authored-by: Lat Co-authored-by: mag37 --- default.config | 1 + notify_templates/notify_ntfy.sh | 11 +++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/default.config b/default.config index cecb493..3ecc4d8 100644 --- a/default.config +++ b/default.config @@ -68,6 +68,7 @@ ## 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 ":" # # PUSHBULLET_URL="https://api.pushbullet.com/v2/pushes" # PUSHBULLET_TOKEN="token-value" diff --git a/notify_templates/notify_ntfy.sh b/notify_templates/notify_ntfy.sh index d413a2c..e19f455 100644 --- a/notify_templates/notify_ntfy.sh +++ b/notify_templates/notify_ntfy.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_NTFYSH_VERSION="v0.5" +NOTIFY_NTFYSH_VERSION="v0.6" # # Setup app and subscription at https://ntfy.sh # Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script. @@ -24,11 +24,18 @@ trigger_ntfy_notification() { ContentType="Markdown: no" #text/plain fi + if [[ -n "${NTFY_AUTH:-}" ]]; then + NtfyAuth="-u $NTFY_AUTH" + else + NtfyAuth="" + fi + curl -S -o /dev/null ${CurlArgs} \ -H "Title: $MessageTitle" \ -H "$ContentType" \ -d "$MessageBody" \ - "$NtfyUrl" + $NtfyAuth \ + -L "$NtfyUrl" if [[ $? -gt 0 ]]; then NotifyError=true From 732a5e69cda2676849db9bcbaa9cb95001d0c71c Mon Sep 17 00:00:00 2001 From: vorezal <37914382+vorezal@users.noreply.github.com> Date: Mon, 11 Aug 2025 15:17:01 -0400 Subject: [PATCH 03/27] Reword disable notification comment for clarity and use update_snooze for dockcheck notifications. (#221) Co-authored-by: Matthew Oleksowicz --- default.config | 4 ++-- notify_templates/notify_v2.sh | 13 ++----------- 2 files changed, 4 insertions(+), 13 deletions(-) diff --git a/default.config b/default.config index 3ecc4d8..47b6189 100644 --- a/default.config +++ b/default.config @@ -37,9 +37,9 @@ ## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze # SNOOZE_SECONDS=86400 # -## Uncomment to not send notifications when dockcheck itself has updates. +## Uncomment and set to true to disable notifications when dockcheck itself has updates. # DISABLE_DOCKCHECK_NOTIFICATION=false -## Uncomment to not send notifications when notify scripts themselves have updates. +## Uncomment and set to true to disable notifications when notify scripts themselves have updates. # DISABLE_NOTIFY_NOTIFICATION=false # ## Apprise configuration variables. Set APPRISE_PAYLOAD to make a CLI call or set APPRISE_URL to make an API request instead. diff --git a/notify_templates/notify_v2.sh b/notify_templates/notify_v2.sh index c2d8538..a256311 100644 --- a/notify_templates/notify_v2.sh +++ b/notify_templates/notify_v2.sh @@ -1,4 +1,4 @@ -NOTIFY_V2_VERSION="v0.4" +NOTIFY_V2_VERSION="v0.5" # # 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. @@ -177,16 +177,7 @@ dockcheck_notification() { printf "Attempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${channel}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory.\n" done - if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then - if [[ "${NotifyError}" == "false" ]]; then - if [[ -n "${found}" ]]; then - sed -e "s/dockcheck\.sh.*/dockcheck\.sh ${CurrentEpochTime}/" "${SnoozeFile}" > "${SnoozeFile}.new" - mv "${SnoozeFile}.new" "${SnoozeFile}" - else - printf "dockcheck.sh ${CurrentEpochTime}\n" >> "${SnoozeFile}" - fi - fi - fi + [[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "dockcheck.sh" fi fi From 37f33d7a063ebfd892979ba7786f226162a96448 Mon Sep 17 00:00:00 2001 From: mag37 Date: Mon, 11 Aug 2025 21:36:51 +0200 Subject: [PATCH 04/27] Snooze bugfix, added auth support to ntfy.sh and sendmail support to SMTP --- README.md | 6 +++++- dockcheck.sh | 6 +++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5719489..4499857 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,11 @@ ___ ## :bell: Changelog -- **v0.6.9**: # +- **v0.7.0**: + - Bugfix: snooze dockcheck.sh-self-notification and some config clarification. + - Added authentication support to Ntfy.sh. + - Added suport for sendmail in the SMTP-template. +- **v0.6.9**: - Bugfix: label logic didn't skip recreation (skipped pulling). - Added comma separated search filtering so you can selectively search exactly which containers to check/update. - eg: `dockcheck.sh -yp homer,dozzle` diff --git a/dockcheck.sh b/dockcheck.sh index c4a8587..9de58f5 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -VERSION="v0.6.9" -# ChangeNotes: bugfix label logic and added comma separated search filtering +VERSION="v0.7.0" +# ChangeNotes: Snooze bugfix, added auth support to ntfy.sh and sendmail support to SMTP Github="https://github.com/mag37/dockcheck" RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" @@ -601,7 +601,7 @@ if [[ -n "${GotUpdates:-}" ]]; then fi done if [[ "$AutoPrune" == false ]] && [[ "$AutoMode" == false ]]; then printf "\n"; read -rep "Would you like to prune dangling images? y/[n]: " AutoPrune; fi - if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\n Auto pruning.."; docker image prune -f; fi + if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\nAuto pruning.."; docker image prune -f; fi printf "\n%bAll done!%b\n" "$c_green" "$c_reset" else printf "\nNo updates installed, exiting.\n" From 31a45f1d84f6fbd2bff65e71ddb20d9d8ef5ff40 Mon Sep 17 00:00:00 2001 From: vorezal <37914382+vorezal@users.noreply.github.com> Date: Mon, 15 Sep 2025 05:25:23 -0400 Subject: [PATCH 05/27] Add file notification channel (#222) * Add file notification channel * Bypass file channel notifications for dockcheck.sh script * Implement notification channel template reuse and advanced configuration variables. * Fix text insertion formatting for dockcheck script and container updates. * Fix dockcheck.sh notification csv and text output. * Fix ntfy variable references and replace tr for uppercase conversion. * Fix ALLOWEMPTY logic, undefined snippet case, and README formatting. * Refactor notification send/skip logic. Adjust missing variable return codes. * Adjust notifications README section for clarity and readability. --------- Co-authored-by: Matthew Oleksowicz --- .gitignore | 2 + README.md | 82 ++++-- default.config | 4 +- dockcheck.sh | 6 +- notify_templates/notify_DSM.sh | 17 +- notify_templates/notify_HA.sh | 31 +- notify_templates/notify_apprise.sh | 33 ++- notify_templates/notify_discord.sh | 27 +- notify_templates/notify_file.sh | 22 ++ notify_templates/notify_gotify.sh | 30 +- notify_templates/notify_matrix.sh | 35 ++- notify_templates/notify_ntfy.sh | 33 ++- notify_templates/notify_pushbullet.sh | 30 +- notify_templates/notify_pushover.sh | 33 ++- notify_templates/notify_slack.sh | 30 +- notify_templates/notify_smtp.sh | 33 ++- notify_templates/notify_telegram.sh | 33 ++- notify_templates/notify_v2.sh | 406 ++++++++++++++++++-------- 18 files changed, 620 insertions(+), 267 deletions(-) create mode 100644 notify_templates/notify_file.sh diff --git a/.gitignore b/.gitignore index e5a2ded..182c4aa 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,5 @@ regctl # ignore snooze file snooze.list +# ignore updates file +updates_available.txt \ No newline at end of file diff --git a/README.md b/README.md index 4499857..f8f4d17 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,16 @@ ___ ## :bell: Changelog +- **v0.7.1**: + - Added support for multiple notifications using the same template + - Added support for notification output format + - Added support for file output + - Added optional configuration variables per channel to (replace <channel> with any channel name): + - <channel>\_TEMPLATE : Specify a template + - <channel>\_SKIPSNOOZE : Skip snooze + - <channel>\_CONTAINERSONLY : Only notify for docker container related updates + - <channel>\_ALLOWEMPTY : Always send notifications, even when empty + - <channel>\_OUTPUT : Define output format - **v0.7.0**: - Bugfix: snooze dockcheck.sh-self-notification and some config clarification. - Added authentication support to Ntfy.sh. @@ -126,13 +136,15 @@ Alternatively create an alias where specific flags and values are set. Example `alias dc=dockcheck.sh -p -x 10 -t 3`. ## :loudspeaker: Notifications -Trigger with the `-i` flag. -If `notify.sh` is present and configured, it will be used. Otherwise, `notify_v2.sh` will be enabled. -Will send a list of containers with updates available and a notification when `dockcheck.sh` itself has an update. -Run it scheduled with `-ni` to only get notified when there's updates available! +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: -Make certain your project directory is laid out as below. You only need the notify_v2.sh file and any notification templates you wish to enable, but there is no harm in having all of them present. +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. ``` . ├── notify_templates/ @@ -154,27 +166,27 @@ Make certain your project directory is laid out as below. You only need the noti ├── 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. -It is recommended to only edit the environmental variables in `dockcheck.config` and not make changes directly to the `notify_X.sh` template files within the `notify_templates` subdirectory. -If you wish to customize the notify templates yourself, you may copy them to your project root directory alongside the main `dockcheck.sh` script (where they will also be ignored by git). +- 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. -#### Legacy installation and configuration: -Use a previous version of a `notify_X.sh` template file (tag v0.6.4 or earlier) from the **notify_templates** directory, -copy it to `notify.sh` alongside the script, modify it to your needs! (notify.sh is added to .gitignore) - #### Snooze feature: -**Use case:** You wish to be notified of available updates in a timely manner, but do not require reminders after the initial notification with the same frequency. -e.g. *Dockcheck is scheduled to run every hour. You will receive an update notification within an hour of availability.* -**Snooze enabled:** you will not receive another notification about updates for this container for a configurable period of time. -**Snooze disabled:** you will receive additional notifications every hour. +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.* +**Snooze enabled:** You will not receive a repeated notification about an already notified update within the snooze duration. +**Snooze disabled:** You will receive additional (possibly repeated) notifications every hour. + +To enable snooze uncomment the `SNOOZE_SECONDS` variable in your `dockcheck.config` and set it to the number of seconds you wish to prevent duplicate alerts. +Snooze is split into three categories; container updates, `dockcheck.sh` self updates and notification template updates. -To enable snooze, uncomment the `SNOOZE_SECONDS` variable in your `dockcheck.config` file and set it to the number of seconds you wish to prevent duplicate alerts. -The true snooze duration will be 60 seconds less than your configure value to account for minor scheduling or script run time issues. If an update becomes available for an item that is not snoozed, notifications will be sent and include all available updates for that item's category, even snoozed items. -`dockcheck.sh` updates, notification template updates, and container updates are considered three separate categories. + +The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to account for minor scheduling or run time issues. #### Current notify templates: @@ -193,15 +205,31 @@ If an update becomes available for an item that is not snoozed, notifications wi - [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 -Further additions are welcome - suggestions or PRs! -Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2). +Further additions are welcome - suggestions or PRs! +Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2). + +#### 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`) +- 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`. +- To use another notification output format, add the variable `_OUTPUT` and set it to `csv`, `json`, or `text`. If unset or set to an invalid value, defaults to `text`. +- To send multiple notifications using the same notification template: + - Strings in the `NOTIFY_CHANNELS` list are now treated as unique names and do not necessarily refer to the notification template that will be called, though they do by default. + - Add another notification channel to `NOTIFY_CHANNELS` in `dockcheck.config`. The name can contain upper and lower case letters, numbers and underscores, but can't start with a number. + - Add the variable `_TEMPLATE` to `dockcheck.config` where `` is the name of the channel added above and set the value to an available notification template script (`slack`, `apprise`, `gotify`, etc.) + - 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`. ### :date: 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. -To also list the URL's in the CLI output (choose containers list) use the `-I` option or variable config. -For Markdown formatting also add the `-M` option. (**this requires the template to be compatible - see gotify for example**) +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. +To also list the URL's in the CLI output (choose containers list) use the `-I` option or variable config. +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: ``` diff --git a/default.config b/default.config index 47b6189..d5d21aa 100644 --- a/default.config +++ b/default.config @@ -32,7 +32,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 generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram" +# NOTIFY_CHANNELS="apprise discord DSM file generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram file" # ## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze # SNOOZE_SECONDS=86400 @@ -87,4 +87,6 @@ # TELEGRAM_CHAT_ID="mychatid" # TELEGRAM_TOKEN="token-value" # TELEGRAM_TOPIC_ID="0" +# +# FILE_PATH="${ScriptWorkDir}/updates_available.txt" diff --git a/dockcheck.sh b/dockcheck.sh index 9de58f5..d46f4da 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -VERSION="v0.7.0" -# ChangeNotes: Snooze bugfix, added auth support to ntfy.sh and sendmail support to SMTP +VERSION="v0.7.1" +# ChangeNotes: Add support for multiple notifications of the same type, output formatting, and file output Github="https://github.com/mag37/dockcheck" RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" @@ -507,6 +507,8 @@ if [[ -n ${GotUpdates[*]:-} ]]; then if [[ -s "$ScriptWorkDir/urls.list" ]] && [[ "$PrintReleaseURL" == true ]]; then releasenotes; else Updates=("${GotUpdates[@]}"); fi [[ "$AutoMode" == false ]] && list_options || printf "%s\n" "${Updates[@]}" [[ "$Notify" == true ]] && { exec_if_exists_or_fail send_notification "${GotUpdates[@]}" || printf "\nCould not source notification function.\n"; } +else + [[ "$Notify" == true ]] && [[ ! -s "${ScriptWorkDir}/notify.sh" ]] && { exec_if_exists_or_fail send_notification "${GotUpdates[@]}" || printf "\nCould not source notification function.\n"; } fi # Optionally get updates if there's any diff --git a/notify_templates/notify_DSM.sh b/notify_templates/notify_DSM.sh index 3afe0ab..8da3c54 100644 --- a/notify_templates/notify_DSM.sh +++ b/notify_templates/notify_DSM.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_DSM_VERSION="v0.4" +NOTIFY_DSM_VERSION="v0.5" # INFO: ssmtp is deprecated - consider to use msmtp instead. # # mSMTP/sSMTP has to be installed and configured manually. @@ -23,15 +23,26 @@ else fi trigger_DSM_notification() { + if [[ -n "$1" ]]; then + DSM_channel="$1" + else + DSM_channel="DSM" + fi + +UpperChannel="${DSM_channel^^}" + +DSMSendmailToVar="${UpperChannel}_SENDMAILTO" +DSMSubjectTagVar="${UpperChannel}_SUBJECTTAG" + CfgFile="/usr/syno/etc/synosmtp.conf" # User variables: # Automatically sends to your usual destination for synology DSM notification emails. # You can also manually override by assigning something else to DSM_SENDMAILTO in dockcheck.config. -SendMailTo=${DSM_SENDMAILTO:-$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')} +SendMailTo=${!DSMSendmailToVar:-$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')} # e.g. DSM_SENDMAILTO="me@mydomain.com" -SubjectTag=${DSM_SUBJECTTAG:-$(grep 'eventsubjectprefix' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')} +SubjectTag=${!DSMSubjectTagVar:-$(grep 'eventsubjectprefix' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')} # e.g. DSM_SUBJECTTAG="Email Subject Prefix" SenderName=$(grep 'smtp_from_name' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p') SenderMail=$(grep 'smtp_from_mail' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p') diff --git a/notify_templates/notify_HA.sh b/notify_templates/notify_HA.sh index dda74be..e1f52bd 100755 --- a/notify_templates/notify_HA.sh +++ b/notify_templates/notify_HA.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_HA_VERSION="v0.1" +NOTIFY_HA_VERSION="v0.2" # # This is an integration that makes it possible to send notifications via Home Assistant (https://www.home-assistant.io/integrations/notify/) # You need to generate a long-lived access token in Home Sssistant to be used here (https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token) @@ -7,15 +7,28 @@ NOTIFY_HA_VERSION="v0.1" # 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 HA_ENTITY, HA_URL and HA_TOKEN in your dockcheck.config file. -if [[ -z "${HA_ENTITY:-}" ]] || [[ -z "${HA_URL:-}" ]] || [[ -z "${HA_TOKEN:-}" ]]; then - printf "Home Assistant notification channel enabled, but required configuration variables are missing. Home assistant notifications will not be sent.\n" - - remove_channel HA -fi - trigger_HA_notification() { - AccessToken="${HA_TOKEN}" - Url="${HA_URL}/api/services/notify/${HA_ENTITY}" + if [[ -n "$1" ]]; then + HA_channel="$1" + else + HA_channel="HA" + fi + + UpperChannel="${HA_channel^^}" + + HAEntityVar="${UpperChannel}_ENTITY" + HAUrlVar="${UpperChannel}_URL" + HATokenVar="${UpperChannel}_TOKEN" + + if [[ -z "${!HAEntityVar:-}" ]] || [[ -z "${!HAUrlVar:-}" ]] || [[ -z "${!HATokenVar:-}" ]]; then + printf "The ${HA_channel} notification channel is enabled, but required configuration variables are missing. Home assistant notifications will not be sent.\n" + + remove_channel HA + return 0 + fi + + AccessToken="${!HATokenVar}" + Url="${!HAUrlVar}/api/services/notify/${!HAEntityVar}" JsonData=$( "$jqbin" -n \ --arg body "$MessageBody" \ '{"title": "dockcheck update", "message": $body}' ) diff --git a/notify_templates/notify_apprise.sh b/notify_templates/notify_apprise.sh index 1fa94de..d2ab0a5 100644 --- a/notify_templates/notify_apprise.sh +++ b/notify_templates/notify_apprise.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_APPRISE_VERSION="v0.3" +NOTIFY_APPRISE_VERSION="v0.4" # # 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. @@ -7,17 +7,28 @@ NOTIFY_APPRISE_VERSION="v0.3" # Do not modify this file directly within the "notify_templates" subdirectory. Set APPRISE_PAYLOAD in your dockcheck.config file. # If API, set APPRISE_URL instead. -if [[ -z "${APPRISE_PAYLOAD:-}" ]] && [[ -z "${APPRISE_URL:-}" ]]; then - printf "Apprise notification channel enabled, but required configuration variables are missing. Apprise notifications will not be sent.\n" - - remove_channel apprise -fi - trigger_apprise_notification() { + if [[ -n "$1" ]]; then + apprise_channel="$1" + else + apprise_channel="apprise" + fi - if [[ -n "${APPRISE_PAYLOAD:-}" ]]; then + UpperChannel="${apprise_channel^^}" + + ApprisePayloadVar="${UpperChannel}_PAYLOAD" + AppriseUrlVar="${UpperChannel}_URL" + + if [[ -z "${!ApprisePayloadVar:-}" ]] && [[ -z "${!AppriseUrlVar:-}" ]]; then + printf "The ${apprise_channel} notification channel is enabled, but required configuration variables are missing. Apprise notifications will not be sent.\n" + + remove_channel apprise + return 0 + fi + + if [[ -n "${!ApprisePayloadVar:-}" ]]; then apprise -vv -t "$MessageTitle" -b "$MessageBody" \ - ${APPRISE_PAYLOAD} + ${!ApprisePayloadVar} if [[ $? -gt 0 ]]; then NotifyError=true @@ -29,8 +40,8 @@ trigger_apprise_notification() { # pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b # tgram://{bot_token}/{chat_id}/' - if [[ -n "${APPRISE_URL:-}" ]]; then - AppriseURL="${APPRISE_URL}" + if [[ -n "${!AppriseUrlVar:-}" ]]; then + AppriseURL="${!AppriseUrlVar}" curl -S -o /dev/null ${CurlArgs} -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL # e.g. APPRISE_URL=http://apprise.mydomain.tld:1234/notify/apprise if [[ $? -gt 0 ]]; then diff --git a/notify_templates/notify_discord.sh b/notify_templates/notify_discord.sh index fa1a32d..4ac050a 100644 --- a/notify_templates/notify_discord.sh +++ b/notify_templates/notify_discord.sh @@ -1,19 +1,30 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_DISCORD_VERSION="v0.4" +NOTIFY_DISCORD_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. # 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 DISCORD_WEBHOOK_URL in your dockcheck.config file. -if [[ -z "${DISCORD_WEBHOOK_URL:-}" ]]; then - printf "Discord notification channel enabled, but required configuration variables are missing. Discord notifications will not be sent.\n" - - remove_channel discord -fi - trigger_discord_notification() { - DiscordWebhookUrl="${DISCORD_WEBHOOK_URL}" # e.g. DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/ + if [[ -n "$1" ]]; then + discord_channel="$1" + else + discord_channel="discord" + fi + + UpperChannel="${discord_channel^^}" + + DiscordWebhookUrlVar="${UpperChannel}_WEBHOOK_URL" + + if [[ -z "${!DiscordWebhookUrlVar:-}" ]]; then + printf "The ${discord_channel} notification channel is enabled, but required configuration variables are missing. Discord notifications will not be sent.\n" + + remove_channel discord + return 0 + fi + + DiscordWebhookUrl="${!DiscordWebhookUrlVar}" # e.g. DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/ JsonData=$( "$jqbin" -n \ --arg username "$FromHost" \ diff --git a/notify_templates/notify_file.sh b/notify_templates/notify_file.sh new file mode 100644 index 0000000..75aa74a --- /dev/null +++ b/notify_templates/notify_file.sh @@ -0,0 +1,22 @@ +### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. +NOTIFY_FILE_VERSION="v0.1" +# +# 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. + +trigger_file_notification() { + if [[ -n "$1" ]]; then + file_channel="$1" + UpperChannel=$(tr '[:lower:]' '[:upper:]' <<< "$file_channel") + else + file_channel="file" + UpperChannel="FILE" + fi + + FilePathVar="${UpperChannel}_PATH" + + NotifyFile="${!FilePathVar:=${ScriptWorkDir}/updates_available.txt}" + + echo "${MessageBody}" > ${NotifyFile} + +} diff --git a/notify_templates/notify_gotify.sh b/notify_templates/notify_gotify.sh index d3d2c67..66e04ef 100644 --- a/notify_templates/notify_gotify.sh +++ b/notify_templates/notify_gotify.sh @@ -1,20 +1,32 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_GOTIFY_VERSION="v0.4" +NOTIFY_GOTIFY_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. # 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 GOTIFY_TOKEN and GOTIFY_DOMAIN in your dockcheck.config file. -if [[ -z "${GOTIFY_TOKEN:-}" ]] || [[ -z "${GOTIFY_DOMAIN:-}" ]]; then - printf "Gotify notification channel enabled, but required configuration variables are missing. Gotify notifications will not be sent.\n" - - remove_channel gotify -fi - trigger_gotify_notification() { - GotifyToken="${GOTIFY_TOKEN}" # e.g. GOTIFY_TOKEN=token-value - GotifyUrl="${GOTIFY_DOMAIN}/message?token=${GotifyToken}" # e.g. GOTIFY_URL=https://gotify.domain.tld + if [[ -n "$1" ]]; then + gotify_channel="$1" + else + gotify_channel="gotify" + fi + + UpperChannel="${gotify_channel^^}" + + GotifyTokenVar="${UpperChannel}_TOKEN" + GotifyUrlVar="${UpperChannel}_DOMAIN" + + if [[ -z "${!GotifyTokenVar:-}" ]] || [[ -z "${!GotifyUrlVar:-}" ]]; then + printf "The ${gotify_channel} notification channel is enabled, but required configuration variables are missing. Gotify notifications will not be sent.\n" + + remove_channel gotify + return 0 + fi + + GotifyToken="${!GotifyTokenVar}" # e.g. GOTIFY_TOKEN=token-value + GotifyUrl="${!GotifyUrlVar}/message?token=${GotifyToken}" # e.g. GOTIFY_URL=https://gotify.domain.tld if [[ "$PrintMarkdownURL" == true ]]; then ContentType="text/markdown" diff --git a/notify_templates/notify_matrix.sh b/notify_templates/notify_matrix.sh index bcff5d2..efdf37d 100644 --- a/notify_templates/notify_matrix.sh +++ b/notify_templates/notify_matrix.sh @@ -1,25 +1,38 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_MATRIX_VERSION="v0.3" +NOTIFY_MATRIX_VERSION="v0.4" # # 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. # 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 MATRIX_ACCESS_TOKEN, MATRIX_ROOM_ID, and MATRIX_SERVER_URL in your dockcheck.config file. -if [[ -z "${MATRIX_ACCESS_TOKEN:-}" ]] || [[ -z "${MATRIX_ROOM_ID}:-" ]] || [[ -z "${MATRIX_SERVER_URL}:-" ]]; then - printf "Matrix notification channel enabled, but required configuration variables are missing. Matrix notifications will not be sent.\n" - - remove_channel matrix -fi - trigger_matrix_notification() { - AccessToken="${MATRIX_ACCESS_TOKEN}" # e.g. MATRIX_ACCESS_TOKEN=token-value - Room_id="${MATRIX_ROOM_ID}" # e.g. MATRIX_ROOM_ID=myroom - MatrixServer="${MATRIX_SERVER_URL}" # e.g. MATRIX_SERVER_URL=http://matrix.yourdomain.tld + if [[ -n "$1" ]]; then + matrix_channel="$1" + else + matrix_channel="matrix" + fi + + UpperChannel="${matrix_channel^^}" + + AccessTokenVar="${UpperChannel}_ACCESS_TOKEN" + RoomIdVar="${UpperChannel}_ROOM_ID" + MatrixServerVar="${UpperChannel}_SERVER_URL" + + if [[ -z "${!AccessTokenVar:-}" ]] || [[ -z "${!RoomIdVar:-}" ]] || [[ -z "${!MatrixServerVar:-}" ]]; then + printf "The ${matrix_channel} notification channel is enabled, but required configuration variables are missing. Matrix notifications will not be sent.\n" + + remove_channel matrix + return 0 + fi + + 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\"}" # 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/$Room_id/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody" + 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" if [[ $? -gt 0 ]]; then NotifyError=true diff --git a/notify_templates/notify_ntfy.sh b/notify_templates/notify_ntfy.sh index e19f455..dff7234 100644 --- a/notify_templates/notify_ntfy.sh +++ b/notify_templates/notify_ntfy.sh @@ -1,19 +1,32 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_NTFYSH_VERSION="v0.6" +NOTIFY_NTFYSH_VERSION="v0.7" # # Setup app and subscription at https://ntfy.sh # 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 NTFY_DOMAIN and NTFY_TOPIC_NAME in your dockcheck.config file. -if [[ -z "${NTFY_DOMAIN:-}" ]] || [[ -z "${NTFY_TOPIC_NAME:-}" ]]; then - printf "Ntfy notification channel enabled, but required configuration variables are missing. Ntfy notifications will not be sent.\n" - - remove_channel ntfy -fi - trigger_ntfy_notification() { - NtfyUrl="${NTFY_DOMAIN}/${NTFY_TOPIC_NAME}" + if [[ -n "$1" ]]; then + ntfy_channel="$1" + else + ntfy_channel="ntfy" + fi + + UpperChannel="${ntfy_channel^^}" + + NtfyDomainVar="${UpperChannel}_DOMAIN" + NtfyTopicNameVar="${UpperChannel}_TOPIC_NAME" + NtfyAuthVar="${UpperChannel}_AUTH" + + if [[ -z "${!NtfyDomainVar:-}" ]] || [[ -z "${!NtfyTopicNameVar:-}" ]]; then + printf "The ${ntfy_channel} notification channel is enabled, but required configuration variables are missing. Ntfy notifications will not be sent.\n" + + remove_channel ntfy + return 0 + fi + + NtfyUrl="${!NtfyDomainVar}/${!NtfyTopicNameVar}" # e.g. # NTFY_DOMAIN=ntfy.sh # NTFY_TOPIC_NAME=YourUniqueTopicName @@ -24,8 +37,8 @@ trigger_ntfy_notification() { ContentType="Markdown: no" #text/plain fi - if [[ -n "${NTFY_AUTH:-}" ]]; then - NtfyAuth="-u $NTFY_AUTH" + if [[ -n "${!NtfyAuthVar:-}" ]]; then + NtfyAuth="-u ${!NtfyAuthVar}" else NtfyAuth="" fi diff --git a/notify_templates/notify_pushbullet.sh b/notify_templates/notify_pushbullet.sh index 78dec0b..b061e1c 100644 --- a/notify_templates/notify_pushbullet.sh +++ b/notify_templates/notify_pushbullet.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_PUSHBULLET_VERSION="v0.3" +NOTIFY_PUSHBULLET_VERSION="v0.4" # # Required receiving services must already be set up. # Requires jq installed and in PATH. @@ -7,15 +7,27 @@ NOTIFY_PUSHBULLET_VERSION="v0.3" # 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 PUSHBULLET_TOKEN and PUSHBULLET_URL in your dockcheck.config file. -if [[ -z "${PUSHBULLET_URL:-}" ]] || [[ -z "${PUSHBULLET_TOKEN:-}" ]]; then - printf "Pushbullet notification channel enabled, but required configuration variables are missing. Pushbullet notifications will not be sent.\n" - - remove_channel pushbullet -fi - trigger_pushbullet_notification() { - PushUrl="${PUSHBULLET_URL}" # e.g. PUSHBULLET_URL=https://api.pushbullet.com/v2/pushes - PushToken="${PUSHBULLET_TOKEN}" # e.g. PUSHBULLET_TOKEN=token-value + if [[ -n "$1" ]]; then + pushbullet_channel="$1" + else + pushbullet_channel="pushbullet" + fi + + UpperChannel="${pushbullet_channel^^}" + + PushUrlVar="${UpperChannel}_URL" + PushTokenVar="${UpperChannel}_TOKEN" + + if [[ -z "${!PushUrlVar:-}" ]] || [[ -z "${!PushTokenVar:-}" ]]; then + printf "The ${pushbullet_channel} notification channel is enabled, but required configuration variables are missing. Pushbullet notifications will not be sent.\n" + + remove_channel pushbullet + return 0 + fi + + PushUrl="${!PushUrlVar}" # e.g. PUSHBULLET_URL=https://api.pushbullet.com/v2/pushes + PushToken="${!PushTokenVar}" # e.g. PUSHBULLET_TOKEN=token-value # Requires jq to process json data "$jqbin" -n --arg title "$MessageTitle" --arg body "$MessageBody" '{body: $body, title: $title, type: "note"}' | curl -S -o /dev/null ${CurlArgs} -X POST -H "Access-Token: $PushToken" -H "Content-type: application/json" $PushUrl -d @- diff --git a/notify_templates/notify_pushover.sh b/notify_templates/notify_pushover.sh index 60ffad6..92eea46 100644 --- a/notify_templates/notify_pushover.sh +++ b/notify_templates/notify_pushover.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_PUSHOVER_VERSION="v0.3" +NOTIFY_PUSHOVER_VERSION="v0.4" # # Required receiving services must already be set up. # Requires jq installed and in PATH. @@ -7,16 +7,29 @@ NOTIFY_PUSHOVER_VERSION="v0.3" # 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 PUSHOVER_USER_KEY, PUSHOVER_TOKEN, and PUSHOVER_URL in your dockcheck.config file. -if [[ -z "${PUSHOVER_URL:-}" ]] || [[ -z "${PUSHOVER_USER_KEY:-}" ]] || [[ -z "${PUSHOVER_TOKEN:-}" ]]; then - printf "Pushover notification channel enabled, but required configuration variables are missing. Pushover notifications will not be sent.\n" - - remove_channel pushover -fi - trigger_pushover_notification() { - PushoverUrl="${PUSHOVER_URL}" # e.g. PUSHOVER_URL=https://api.pushover.net/1/messages.json - PushoverUserKey="${PUSHOVER_USER_KEY}" # e.g. PUSHOVER_USER_KEY=userkey - PushoverToken="${PUSHOVER_TOKEN}" # e.g. PUSHOVER_TOKEN=token-value + if [[ -n "$1" ]]; then + pushover_channel="$1" + else + pushover_channel="pushover" + fi + + UpperChannel="${pushover_channel^^}" + + PushoverUrlVar="${UpperChannel}_URL" + PushoverUserKeyVar="${UpperChannel}_USER_KEY" + PushoverTokenVar="${UpperChannel}_TOKEN" + + if [[ -z "${!PushoverUrlVar:-}" ]] || [[ -z "${!PushoverUserKeyVar:-}" ]] || [[ -z "${!PushoverTokenVar:-}" ]]; then + printf "The ${pushover_channel} notification channel is enabled, but required configuration variables are missing. Pushover notifications will not be sent.\n" + + remove_channel pushover + return 0 + fi + + PushoverUrl="${!PushoverUrlVar}" # e.g. PUSHOVER_URL=https://api.pushover.net/1/messages.json + PushoverUserKey="${!PushoverUserKeyVar}" # e.g. PUSHOVER_USER_KEY=userkey + PushoverToken="${!PushoverTokenVar}" # e.g. PUSHOVER_TOKEN=token-value # Sending the notification via Pushover curl -S -o /dev/null ${CurlArgs} -X POST \ diff --git a/notify_templates/notify_slack.sh b/notify_templates/notify_slack.sh index 0a9cd7a..e2616e2 100644 --- a/notify_templates/notify_slack.sh +++ b/notify_templates/notify_slack.sh @@ -1,20 +1,32 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_SLACK_VERSION="v0.3" +NOTIFY_SLACK_VERSION="v0.4" # # Setup app and token at https://api.slack.com/tutorials/tracks/posting-messages-with-curl # 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 SLACK_ACCESS_TOKEN, and SLACK_CHANNEL_ID in your dockcheck.config file. -if [[ -z "${SLACK_ACCESS_TOKEN:-}" ]] || [[ -z "${SLACK_CHANNEL_ID:-}" ]]; then - printf "Slack notification channel enabled, but required configuration variables are missing. Slack notifications will not be sent.\n" - - remove_channel slack -fi - trigger_slack_notification() { - AccessToken="${SLACK_ACCESS_TOKEN}" # e.g. SLACK_ACCESS_TOKEN=some-token - ChannelID="${SLACK_CHANNEL_ID}" # e.g. CHANNEL_ID=mychannel + if [[ -n "$1" ]]; then + slack_channel="$1" + else + slack_channel="slack" + fi + + UpperChannel="${slack_channel^^}" + + AccessTokenVar="${UpperChannel}_ACCESS_TOKEN" + ChannelIDVar="${UpperChannel}_CHANNEL_ID" + + if [[ -z "${!AccessTokenVar:-}" ]] || [[ -z "${!ChannelIDVar:-}" ]]; then + printf "The ${slack_channel} notification channel is enabled, but required configuration variables are missing. Slack notifications will not be sent.\n" + + remove_channel slack + return 0 + fi + + AccessToken="${!AccessTokenVar}" # e.g. SLACK_ACCESS_TOKEN=some-token + ChannelID="${!ChannelIDVar}" # e.g. CHANNEL_ID=mychannel SlackUrl="https://slack.com/api/chat.postMessage" curl -S -o /dev/null ${CurlArgs} \ diff --git a/notify_templates/notify_smtp.sh b/notify_templates/notify_smtp.sh index 9cfc76c..89bd9bc 100644 --- a/notify_templates/notify_smtp.sh +++ b/notify_templates/notify_smtp.sh @@ -1,5 +1,5 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_SMTP_VERSION="v0.4" +NOTIFY_SMTP_VERSION="v0.5" # INFO: ssmtp is depcerated - consider to use msmtp instead. # # mSMTP/sSMTP has to be installed and configured manually. @@ -7,12 +7,6 @@ NOTIFY_SMTP_VERSION="v0.4" # 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 SMTP_MAIL_FROM, SMTP_MAIL_TO, and SMTP_SUBJECT_TAG in your dockcheck.config file. -if [[ -z "${SMTP_MAIL_FROM:-}" ]] || [[ -z "${SMTP_MAIL_TO:-}" ]] || [[ -z "${SMTP_SUBJECT_TAG:-}" ]]; then - printf "SMTP notification channel enabled, but required configuration variables are missing. SMTP notifications will not be sent.\n" - - remove_channel smtp -fi - MSMTP=$(which msmtp) SSMTP=$(which ssmtp) SENDMAIL=$(which sendmail) @@ -28,9 +22,28 @@ else fi trigger_smtp_notification() { -SendMailFrom="${SMTP_MAIL_FROM}" # e.g. MAIL_FROM=me@mydomain.tld -SendMailTo="${SMTP_MAIL_TO}" # e.g. MAIL_TO=me@mydomain.tld -SubjectTag="${SMTP_SUBJECT_TAG}" # e.g. SUBJECT_TAG=dockcheck + if [[ -n "$1" ]]; then + smtp_channel="$1" + else + smtp_channel="smtp" + fi + + UpperChannel="${smtp_channel^^}" + + SendMailFromVar="${UpperChannel}_MAIL_FROM" + SendMailToVar="${UpperChannel}_MAIL_TO" + SubjectTagVar="${UpperChannel}_SUBJECT_TAG" + + if [[ -z "${!SendMailFromVar:-}" ]] || [[ -z "${!SendMailToVar:-}" ]] || [[ -z "${!SubjectTagVar:-}" ]]; then + printf "The ${smtp_channel} notification channel is enabled, but required configuration variables are missing. SMTP notifications will not be sent.\n" + + remove_channel smtp + return 0 + fi + + SendMailFrom="${!SendMailFromVar}" # e.g. MAIL_FROM=me@mydomain.tld + SendMailTo="${!SendMailToVar}" # e.g. MAIL_TO=me@mydomain.tld + SubjectTag="${!SubjectTagVar}" # e.g. SUBJECT_TAG=dockcheck $MailPkg $SendMailTo << __EOF From: "$FromHost" <$SendMailFrom> diff --git a/notify_templates/notify_telegram.sh b/notify_templates/notify_telegram.sh index 4f114eb..785a037 100644 --- a/notify_templates/notify_telegram.sh +++ b/notify_templates/notify_telegram.sh @@ -1,28 +1,41 @@ ### DISCLAIMER: This is a third party addition to dockcheck - best effort testing. -NOTIFY_TELEGRAM_VERSION="v0.4" +NOTIFY_TELEGRAM_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. # 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 TELEGRAM_CHAT_ID and TELEGRAM_TOKEN in your dockcheck.config file. -if [[ -z "${TELEGRAM_CHAT_ID:-}" ]] || [[ -z "${TELEGRAM_TOKEN:-}" ]]; then - printf "Telegram notification channel enabled, but required configuration variables are missing. Telegram notifications will not be sent.\n" - - remove_channel telegram -fi - trigger_telegram_notification() { + if [[ -n "$1" ]]; then + telegram_channel="$1" + else + telegram_channel="telegram" + fi + + UpperChannel="${telegram_channel^^}" + + TelegramTokenVar="${UpperChannel}_TOKEN" + TelegramChatIdVar="${UpperChannel}_CHAT_ID" + TelegramTopicIdVar="${UpperChannel}_TOPIC_ID" + + if [[ -z "${!TelegramChatIdVar:-}" ]] || [[ -z "${!TelegramTokenVar:-}" ]]; then + printf "The ${telegram_channel} notification channel is enabled, but required configuration variables are missing. Telegram notifications will not be sent.\n" + + remove_channel telegram + return 0 + fi + if [[ "$PrintMarkdownURL" == true ]]; then ParseMode="Markdown" else ParseMode="HTML" fi - TelegramToken="${TELEGRAM_TOKEN}" # e.g. TELEGRAM_TOKEN=token-value - TelegramChatId="${TELEGRAM_CHAT_ID}" # e.g. TELEGRAM_CHAT_ID=mychatid + TelegramToken="${!TelegramTokenVar}" # e.g. TELEGRAM_TOKEN=token-value + TelegramChatId="${!TelegramChatIdVar}" # e.g. TELEGRAM_CHAT_ID=mychatid TelegramUrl="https://api.telegram.org/bot$TelegramToken" - TelegramTopicID=${TELEGRAM_TOPIC_ID:="0"} + TelegramTopicID=${!TelegramTopicIdVar:="0"} JsonData=$( "$jqbin" -n \ --arg chatid "$TelegramChatId" \ diff --git a/notify_templates/notify_v2.sh b/notify_templates/notify_v2.sh index a256311..5ff088f 100644 --- a/notify_templates/notify_v2.sh +++ b/notify_templates/notify_v2.sh @@ -1,4 +1,4 @@ -NOTIFY_V2_VERSION="v0.5" +NOTIFY_V2_VERSION="v0.6" # # 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. @@ -13,9 +13,33 @@ NOTIFY_V2_VERSION="v0.5" # Actual snooze will be 60 seconds less to avoid the chance of missed notifications due to minor scheduling or script run time issues. snooze="${SNOOZE_SECONDS:-}" SnoozeFile="${ScriptWorkDir}/snooze.list" +[[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}" enabled_notify_channels=( ${NOTIFY_CHANNELS:-} ) +# Global output string variable for modification by functions +UpdToString="" +FormattedOutput="" + +get_channel_template() { + local UpperChannel="${1^^}" + local TemplateVar="${UpperChannel}_TEMPLATE" + if [[ -n "${!TemplateVar:-}" ]]; then + printf "${!TemplateVar}" + else + printf "$1" + fi +} + +declare -A unique_templates + +for channel in "${enabled_notify_channels[@]}"; do + template=$(get_channel_template "${channel}") + unique_templates["${template}"]=1 +done + +enabled_notify_templates=( "${!unique_templates[@]}" ) + FromHost=$(cat /etc/hostname) CurrentEpochTime=$(date +"%Y-%m-%dT%H:%M:%S") @@ -23,49 +47,96 @@ CurrentEpochSeconds=$(date +%s) NotifyError=false +for template in "${enabled_notify_templates[@]}"; do + source_if_exists_or_fail "${ScriptWorkDir}/notify_${template}.sh" || \ + source_if_exists_or_fail "${ScriptWorkDir}/notify_templates/notify_${template}.sh" || \ + printf "The notification channel template ${template} is enabled, but notify_${template}.sh was not found. Check the ${ScriptWorkDir} directory or the notify_templates subdirectory.\n" +done + +skip_snooze() { + local UpperChannel="${1^^}" + local SkipSnoozeVar="${UpperChannel}_SKIPSNOOZE" + if [[ "${!SkipSnoozeVar:-}" == "true" ]]; then + printf "true" + else + printf "false" + fi +} + +allow_empty() { + local UpperChannel="${1^^}" + local AllowEmptyVar="${UpperChannel}_ALLOWEMPTY" + if [[ "${!AllowEmptyVar:-}" == "true" ]]; then + printf "true" + else + printf "false" + fi +} + +containers_only() { + local UpperChannel="${1^^}" + local ContainersOnlyVar="${UpperChannel}_CONTAINERSONLY" + if [[ "${!ContainersOnlyVar:-}" == "true" ]]; then + printf "true" + else + printf "false" + fi +} + +output_format() { + local UpperChannel="${1^^}" + local OutputFormatVar="${UpperChannel}_OUTPUT" + if [[ -z "${!OutputFormatVar:-}" ]]; then + printf "text" + else + printf "${!OutputFormatVar:-}" + fi +} + remove_channel() { local temp_array=() for channel in "${enabled_notify_channels[@]}"; do - [[ "${channel}" != "$1" ]] && temp_array+=("${channel}") + local channel_template=$(get_channel_template "${channel}") + [[ "${channel_template}" != "$1" ]] && temp_array+=("${channel}") done enabled_notify_channels=( "${temp_array[@]}" ) } -for channel in "${enabled_notify_channels[@]}"; do - source_if_exists_or_fail "${ScriptWorkDir}/notify_${channel}.sh" || \ - source_if_exists_or_fail "${ScriptWorkDir}/notify_templates/notify_${channel}.sh" || \ - printf "The notification channel ${channel} is enabled, but notify_${channel}.sh was not found. Check the ${ScriptWorkDir} directory or the notify_templates subdirectory.\n" -done - -notify_containers_count() { - unset NotifyContainers - NotifyContainers=() - - [[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}" - - for update in "$@" - do - read -a container <<< "${update}" - found=$(grep -w "${container[0]}" "${SnoozeFile}" || printf "") - +is_snoozed() { + if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then + local found=$(grep -w "$1" "${SnoozeFile}" || printf "") if [[ -n "${found}" ]]; then read -a arr <<< "${found}" CheckEpochSeconds=$(( $(date -d "${arr[1]}" +%s 2>/dev/null) + ${snooze} - 60 )) || CheckEpochSeconds=$(( $(date -f "%Y-%m-%d" -j "${arr[1]}" +%s) + ${snooze} - 60 )) - if [[ "${CurrentEpochSeconds}" -gt "${CheckEpochSeconds}" ]]; then - NotifyContainers+=("${update}") + if [[ "${CurrentEpochSeconds}" -le "${CheckEpochSeconds}" ]]; then + printf "true" + else + printf "false" fi else - NotifyContainers+=("${update}") + printf "false" + fi + else + printf "false" + fi +} + +unsnoozed_count() { + unset Unsnoozed + Unsnoozed=() + + for element in "$@" + do + read -a item <<< "${element}" + if [[ $(is_snoozed "${item[0]}") == "false" ]]; then + Unsnoozed+=("${element}") fi done - printf "${#NotifyContainers[@]}" + printf "${#Unsnoozed[@]}" } update_snooze() { - - [[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}" - for arg in "$@" do read -a entry <<< "${arg}" @@ -85,8 +156,6 @@ cleanup_snooze() { NotifyEntries=() switch="" - [[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}" - for arg in "$@" do read -a entry <<< "${arg}" @@ -105,41 +174,130 @@ cleanup_snooze() { done <<< "$(grep ${switch} '\.sh ' ${SnoozeFile})" } +format_output() { + local UpdateType="$1" + local OutputFormat="$2" + local FormattedTextTemplate="$3" + local tempcsv="" + + if [[ ! "${UpdateType}" == "dockcheck_update" ]]; then + tempcsv="${UpdToString// -> /,}" + tempcsv="${tempcsv//.sh /.sh,}" + else + tempcsv="${UpdToString}" + fi + + if [[ "${OutputFormat}" == "csv" ]]; then + if [[ -z "${UpdToString}" ]]; then + FormattedOutput="None" + else + FormattedOutput="${tempcsv}" + fi + elif [[ "${OutputFormat}" == "json" ]]; then + if [[ -z "${UpdToString}" ]]; then + FormattedOutput='{"updates": []}' + else + if [[ "${UpdateType}" == "container_update" ]]; then + # container updates case + FormattedOutput=$(jq --compact-output --null-input --arg updates "${tempcsv}" '($updates | split("\\n")) | map(split(",")) | {"updates": map({"container_name": .[0], "release_notes": .[1]})} | del(..|nulls)') + elif [[ "${UpdateType}" == "notify_update" ]]; then + # script updates case + FormattedOutput=$(jq --compact-output --null-input --arg updates "${tempcsv}" '($updates | split("\\n")) | map(split(",")) | {"updates": map({"script_name": .[0], "installed_version": .[1], "latest_version": .[2]})}') + elif [[ "${UpdateType}" == "dockcheck_update" ]]; then + # dockcheck update case + FormattedOutput=$(jq --compact-output --null-input --arg updates "${tempcsv}" '($updates | split("\\n")) | map(split(",")) | {"updates": map({"script_name": .[0], "installed_version": .[1], "latest_version": .[2], "release_notes": (.[3:] | join(","))})}') + else + FormattedOutput="Invalid input" + fi + fi + else + if [[ -z "${UpdToString}" ]]; then + FormattedOutput="None" + else + if [[ "${UpdateType}" == "container_update" ]]; then + FormattedOutput="${FormattedTextTemplate//${UpdToString}}" + elif [[ "${UpdateType}" == "notify_update" ]]; then + FormattedOutput="${FormattedTextTemplate//${UpdToString}}" + elif [[ "${UpdateType}" == "dockcheck_update" ]]; then + FormattedOutput="${FormattedTextTemplate//$4}" + FormattedOutput="${FormattedOutput//$5}" + FormattedOutput="${FormattedOutput//$6}" + else + FormattedOutput="Invalid input" + fi + fi + fi +} + +skip_notification() { + # Skip notification logic. Default to false. Handle all cases, and only those cases, where notifications should be skipped. + local SkipNotification="false" + local Channel="$1" + local UnsnoozedCount="$2" + local NotificationType="$3" + + if [[ $(containers_only "${Channel}") == "true" ]] && [[ "${NotificationType}" != "container" ]]; then + # Do not send notifications through channels only configured for container update notifications + SkipNotification="true" + else + # Handle empty update cases separately + if [[ -z "${UpdToString}" ]]; then + if [[ $(allow_empty "${Channel}") == "false" ]]; then + # Do not send notifications if there are none and allow_empty is false + SkipNotification="true" + fi + else + if [[ $(skip_snooze "${Channel}") == "false" ]] && [[ ${UnsnoozedCount} -eq 0 ]]; then + # Do not send notifications if there are any, they are all snoozed, and skip_snooze is false + SkipNotification="true" + fi + fi + fi + + printf "${SkipNotification}" +} + send_notification() { [[ -s "$ScriptWorkDir"/urls.list ]] && releasenotes || Updates=("$@") - if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then - UpdNotifyCount=$(notify_containers_count "${Updates[@]}") - else - UpdNotifyCount="${#Updates[@]}" - fi - - NotifyError=false - - if [[ "${UpdNotifyCount}" -gt 0 ]]; then - UpdToString=$( printf '%s\\n' "${Updates[@]}" ) - UpdToString=${UpdToString%\\n} - - for channel in "${enabled_notify_channels[@]}"; do - printf "\nSending ${channel} notification\n" - - # To be added in the MessageBody if "-d X" was used - # leading space is left intentionally for clean output - [[ -n "$DaysOld" ]] && msgdaysold="with images ${DaysOld}+ days old " || msgdaysold="" - - MessageTitle="$FromHost - updates ${msgdaysold}available." - # Setting the MessageBody variable here. - printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n${UpdToString}\n" - - exec_if_exists_or_fail trigger_${channel}_notification || \ - printf "Attempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${channel}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory.\n" - done - - [[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${Updates[@]}" - fi - [[ -n "${snooze}" ]] && cleanup_snooze "${Updates[@]}" + UnsnoozedContainers=$(unsnoozed_count "${Updates[@]}") + NotifyError=false + Notified="false" + + # To be added in the MessageBody if "-d X" was used + # Trailing space is left intentionally for clean output + [[ -n "$DaysOld" ]] && msgdaysold="with images ${DaysOld}+ days old " || msgdaysold="" + MessageTitle="$FromHost - updates ${msgdaysold}available." + + UpdToString=$( printf '%s\\n' "${Updates[@]}" ) + UpdToString="${UpdToString%, }" + UpdToString=${UpdToString%\\n} + + for channel in "${enabled_notify_channels[@]}"; do + local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedContainers}" "container") + if [[ "${SkipNotification}" == "false" ]]; then + local template=$(get_channel_template "${channel}") + + # Formats UpdToString variable per channel settings + format_output "container_update" "$(output_format "${channel}")" "🐋 Containers on $FromHost with updates available:\n\n" + + # Setting the MessageBody variable here. + printf -v MessageBody "${FormattedOutput}" + + printf "\nSending ${channel} notification" + exec_if_exists_or_fail trigger_${template}_notification "${channel}" || \ + printf "\nAttempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${template}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory." + Notified="true" + fi + done + + if [[ "${Notified}" == "true" ]]; then + [[ -n "${snooze}" ]] && [[ -n "${UpdToString}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${Updates[@]}" + printf "\n" + fi + return 0 } @@ -147,37 +305,34 @@ send_notification() { ### to not send notifications when dockcheck itself has updates. dockcheck_notification() { if [[ ! "${DISABLE_DOCKCHECK_NOTIFICATION:-}" == "true" ]]; then - DockcheckNotify=false + UnsnoozedDockcheck=$(unsnoozed_count "dockcheck\.sh") NotifyError=false + Notified=false - if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then - found=$(grep -w "dockcheck\.sh" "${SnoozeFile}" || printf "") - if [[ -n "${found}" ]]; then - read -a arr <<< "${found}" - CheckEpochSeconds=$(( $(date -d "${arr[1]}" +%s 2>/dev/null) + ${snooze} - 60 )) || CheckEpochSeconds=$(( $(date -f "%Y-%m-%d" -j "${arr[1]}" +%s) + ${snooze} - 60 )) - if [[ "${CurrentEpochSeconds}" -gt "${CheckEpochSeconds}" ]]; then - DockcheckNotify=true - fi - else - DockcheckNotify=true + MessageTitle="$FromHost - New version of dockcheck available." + UpdToString="dockcheck.sh,$1,$2,\"$3\"" + + for channel in "${enabled_notify_channels[@]}"; do + local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedDockcheck}" "dockcheck") + if [[ "${SkipNotification}" == "false" ]]; then + local template=$(get_channel_template "${channel}") + + # Formats UpdToString variable per channel settings + format_output "dockcheck_update" "$(output_format "${channel}")" "Installed version: \nLatest version: \n\nChangenotes: \n" "$1" "$2" "$3" + + # Setting the MessageBody variable here. + printf -v MessageBody "${FormattedOutput}" + + printf "\nSending dockcheck update notification - ${channel}" + exec_if_exists_or_fail trigger_${template}_notification "${channel}" || \ + printf "\nAttempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${template}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory." + Notified="true" fi - else - DockcheckNotify=true - fi - - if [[ "${DockcheckNotify}" == "true" ]]; then - MessageTitle="$FromHost - New version of dockcheck available." - # Setting the MessageBody variable here. - printf -v MessageBody "Installed version: $1\nLatest version: $2\n\nChangenotes: $3\n" - - if [[ ${#enabled_notify_channels[@]} -gt 0 ]]; then printf "\n"; fi - for channel in "${enabled_notify_channels[@]}"; do - printf "Sending dockcheck update notification - ${channel}\n" - exec_if_exists_or_fail trigger_${channel}_notification || \ - printf "Attempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${channel}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory.\n" - done + done + if [[ "${Notified}" == "true" ]]; then [[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "dockcheck.sh" + printf "\n" fi fi @@ -188,68 +343,63 @@ dockcheck_notification() { ### to not send notifications when notify scripts themselves have updates. notify_update_notification() { if [[ ! "${DISABLE_NOTIFY_NOTIFICATION:-}" == "true" ]]; then - NotifyUpdateNotify=false NotifyError=false NotifyUpdates=() + Notified=false - UpdateChannels=( "${enabled_notify_channels[@]}" "v2" ) + UpdateChannels=( "${enabled_notify_templates[@]}" "v2" ) for NotifyScript in "${UpdateChannels[@]}"; do - UpperChannel=$(tr '[:lower:]' '[:upper:]' <<< "$NotifyScript") + UpperChannel="${NotifyScript^^}" VersionVar="NOTIFY_${UpperChannel}_VERSION" if [[ -n "${!VersionVar:-}" ]]; then RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_${NotifyScript}.sh" LatestNotifySnippet="$(curl ${CurlArgs} -r 0-150 "$RawNotifyUrl" || printf "undefined")" - LatestNotifyRelease="$(echo "$LatestNotifySnippet" | sed -n "/${VersionVar}/s/${VersionVar}=//p" | tr -d '"')" - if [[ ! "${LatestNotifyRelease}" == "undefined" ]]; then + if [[ ! "${LatestNotifySnippet}" == "undefined" ]]; then + LatestNotifyRelease="$(echo "$LatestNotifySnippet" | sed -n "/${VersionVar}/s/${VersionVar}=//p" | tr -d '"')" + if [[ "${!VersionVar}" != "${LatestNotifyRelease}" ]] ; then - NotifyUpdates+=("${NotifyScript}.sh ${!VersionVar} -> ${LatestNotifyRelease}") + NotifyUpdates+=("${NotifyScript}.sh ${!VersionVar} -> ${LatestNotifyRelease}") fi fi fi done - if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then - for update in "${NotifyUpdates[@]}"; do - read -a NotifyScript <<< "${update}" - found=$(grep -w "${NotifyScript}" "${SnoozeFile}" || printf "") - if [[ -n "${found}" ]]; then - read -a arr <<< "${found}" - CheckEpochSeconds=$(( $(date -d "${arr[1]}" +%s 2>/dev/null) + ${snooze} - 60 )) || CheckEpochSeconds=$(( $(date -f "%Y-%m-%d" -j "${arr[1]}" +%s) + ${snooze} - 60 )) - if [[ "${CurrentEpochSeconds}" -gt "${CheckEpochSeconds}" ]]; then - NotifyUpdateNotify=true - fi - else - NotifyUpdateNotify=true - fi - done - else - NotifyUpdateNotify=true - fi - - if [[ "${NotifyUpdateNotify}" == "true" ]]; then - if [[ "${#NotifyUpdates[@]}" -gt 0 ]]; then - UpdToString=$( printf '%s\\n' "${NotifyUpdates[@]}" ) - UpdToString=${UpdToString%\\n} - NotifyError=false - - MessageTitle="$FromHost - New version of notify templates available." - - printf -v MessageBody "Notify templates on $FromHost with updates available:\n${UpdToString}\n" - - for channel in "${enabled_notify_channels[@]}"; do - printf "Sending notify template update notification - ${channel}\n" - exec_if_exists_or_fail trigger_${channel}_notification || \ - printf "Attempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${channel}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory.\n" - done - - [[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${NotifyUpdates[@]}" - fi - fi - UpdatesPlusDockcheck=("${NotifyUpdates[@]}") UpdatesPlusDockcheck+=("dockcheck.sh") [[ -n "${snooze}" ]] && cleanup_snooze "${UpdatesPlusDockcheck[@]}" + + UnsnoozedTemplates=$(unsnoozed_count "${NotifyUpdates[@]}") + + MessageTitle="$FromHost - New version of notify templates available." + + UpdToString=$( printf '%s\\n' "${NotifyUpdates[@]}" ) + UpdToString="${UpdToString%, }" + UpdToString=${UpdToString%\\n} + + for channel in "${enabled_notify_channels[@]}"; do + local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedTemplates}" "notify") + + if [[ "${SkipNotification}" == "false" ]]; then + local template=$(get_channel_template "${channel}") + + # Formats UpdToString variable per channel settings + format_output "notify_update" "$(output_format "${channel}")" "Notify templates on $FromHost with updates available:\n\n" + + # Setting the MessageBody variable here. + printf -v MessageBody "${FormattedOutput}" + + printf "\nSending notify template update notification - ${channel}" + exec_if_exists_or_fail trigger_${template}_notification "${channel}" || \ + printf "\nAttempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${template}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory." + Notified="true" + fi + done + + if [[ "${Notified}" == "true" ]]; then + [[ -n "${snooze}" ]] && [[ -n "${UpdToString}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${NotifyUpdates[@]}" + printf "\n" + fi fi return 0 From 7d1e1637f93a62f09ef741a4289624f49d6544a4 Mon Sep 17 00:00:00 2001 From: mag37 Date: Mon, 15 Sep 2025 11:49:09 +0200 Subject: [PATCH 06/27] formatting + sponsors + removed emojis Removed emojis - don't want it to look like just about any AI-slop. Added more sponsors. Changed some formatting. --- README.md | 92 +++++++++++++++++++++++++++---------------------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index f8f4d17..c3bb07c 100644 --- a/README.md +++ b/README.md @@ -20,18 +20,18 @@
For Podman - see the fork sudo-kraken/podcheck!
___ -## :bell: Changelog +## Changelog - **v0.7.1**: - Added support for multiple notifications using the same template - Added support for notification output format - Added support for file output - - Added optional configuration variables per channel to (replace <channel> with any channel name): - - <channel>\_TEMPLATE : Specify a template - - <channel>\_SKIPSNOOZE : Skip snooze - - <channel>\_CONTAINERSONLY : Only notify for docker container related updates - - <channel>\_ALLOWEMPTY : Always send notifications, even when empty - - <channel>\_OUTPUT : Define output format + - Added optional configuration variables per channel to (replace `` with any channel name): + - `_TEMPLATE` : Specify a template + - `_SKIPSNOOZE` : Skip snooze + - `_CONTAINERSONLY` : Only notify for docker container related updates + - `_ALLOWEMPTY` : Always send notifications, even when empty + - `_OUTPUT` : Define output format - **v0.7.0**: - Bugfix: snooze dockcheck.sh-self-notification and some config clarification. - Added authentication support to Ntfy.sh. @@ -53,7 +53,7 @@ ___ ![](extras/example.gif) -## :mag_right: `dockcheck.sh` +## `dockcheck.sh` ``` $ ./dockcheck.sh -h Syntax: dockcheck.sh [OPTION] [comma separated names to include] @@ -103,7 +103,7 @@ After the updates are complete, you'll get prompted if you'd like to prune dangl ___ -## :nut_and_bolt: Dependencies +## 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. @@ -113,7 +113,7 @@ ___ - 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. -## :tent: Install Instructions +## 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 @@ -130,12 +130,12 @@ wget -O ~/.local/bin/dockcheck.sh "https://raw.githubusercontent.com/mag37/dockc 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. -## :handbag: Configuration +## 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`. -## :loudspeaker: Notifications +## 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. @@ -169,19 +169,18 @@ You only need the `notify_templates/notify_v2.sh` file and any notification temp - 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. +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: 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.* -**Snooze enabled:** You will not receive a repeated notification about an already notified update within the snooze duration. -**Snooze disabled:** You will receive additional (possibly repeated) notifications every hour. +**Example:** *Dockcheck is scheduled to run every hour. You will receive an update notification within an hour of availability.* +**Snooze enabled:** You will not receive a repeated notification about an already notified update within the snooze duration. +**Snooze disabled:** You will receive additional (possibly repeated) notifications every hour. -To enable snooze uncomment the `SNOOZE_SECONDS` variable in your `dockcheck.config` and set it to the number of seconds you wish to prevent duplicate alerts. +To enable snooze uncomment the `SNOOZE_SECONDS` variable in your `dockcheck.config` and set it to the number of seconds you wish to prevent duplicate alerts. Snooze is split into three categories; container updates, `dockcheck.sh` self updates and notification template updates. If an update becomes available for an item that is not snoozed, notifications will be sent and include all available updates for that item's category, even snoozed items. @@ -209,9 +208,9 @@ Further additions are welcome - suggestions or PRs! Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2). #### 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`: +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`) - 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`. @@ -224,12 +223,12 @@ 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`. -### :date: 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. -To also list the URL's in the CLI output (choose containers list) use the `-I` option or variable config. -For Markdown formatting also add the `-M` option. (**this requires the template to be compatible - see gotify for example**) +### 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. +To also list the URL's in the CLI output (choose containers list) use the `-I` option or variable config. +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: ``` @@ -241,19 +240,19 @@ nginx -> https://github.com/docker-library/official-images/blob/master/library ``` 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. -## :fast_forward: Asyncronous update checks with **xargs**; `-x N` option. (default=1) +## 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`. -## :chart_with_upwards_trend: Extra plugins and tools: +## Extra plugins and tools: -### :small_orange_diamond: Using dockcheck.sh with the Synology DSM +### 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). -### :small_orange_diamond: Prometheus and node_exporter +### 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: ``` @@ -263,20 +262,20 @@ dockcheck.sh -c /path/to/exporter/directory See the [README.md](./addons/prometheus/README.md) for more detailed information on how to set it up! Contributed by [tdralle](https://github.com/tdralle). -### :small_orange_diamond: Zabbix config to monitor docker image updates +### 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) -### :small_orange_diamond: Serve REST API to list all available 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). -### :small_orange_diamond: Wrapper Script for Unraid's User Scripts +### 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). -## :bookmark: Labels +## Labels Optionally add labels to compose-files. Currently these are the usable labels: ``` labels: @@ -288,7 +287,7 @@ Optionally add labels to compose-files. Currently these are the usable labels: - `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). -## :roller_coaster: Workaround for non **amd64** / **arm64** +## 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): @@ -308,7 +307,7 @@ 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`). -## :whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls +## Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls Due to recent changes in [Docker Hub usage and limits](https://docs.docker.com/docker-hub/usage/) >Unauthenticated users: 10 pulls/hour >Authenticated users with a free account: 100 pulls/hour @@ -316,7 +315,7 @@ Due to recent changes in [Docker Hub usage and limits](https://docs.docker.com/d This is not an issue for registry checks. But if you have a large stack and pull more than 10 updates at once consider updating more often or to create a free account. You could use/modify the login-wrapper function in the example below to automate the login prior to running `dockcheck.sh`. -### :guardsman: Function to auth with docker hub before running +### Function to auth with docker hub before running **Example** - Change names, paths, and remove cat+password flag if you rather get prompted: ```sh function dchk { @@ -325,31 +324,32 @@ function dchk { } ``` -## :warning: `-r flag` disclaimer and 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. Using the `-r` option together with eg. `-i` and `-n` to just check for updates and send notifications and not update is safe though! -## :hammer: Known issues +## 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). -## :wrench: Debugging +## 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`. -## :scroll: License +## License dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license. -## :heartpulse: Sponsorlist +## Sponsorlist - [avegy](https://github.com/avegy) - [eichhorn](https://github.com/eichhorn) - [stepdg](https://github.com/stepdg) - +- [acer2220](https://github.com/acer2220) +- [shgew](https://github.com/shgew) ___ -### :floppy_disk: 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. From af0d0d3f6ea8b6c3869fe2784a34ba947c7ae01f Mon Sep 17 00:00:00 2001 From: mag37 Date: Fri, 3 Oct 2025 09:22:17 +0200 Subject: [PATCH 07/27] label and update list rework (#229) * Reformatting the updates available list * rewritten list padding to be dynamic * Label rework + clearer messages (#228) - Moved up label check and logic to earlier in the process, to iterate the whole run the same way if `-l` option is passed. - Added messaging to make it clearer. - Clarified Readme and --help message. - Clarified prune message (to mean ALL dangling, not just currently updated). --- README.md | 27 +++++++++++++-------------- dockcheck.sh | 33 ++++++++++++++++----------------- 2 files changed, 29 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index c3bb07c..c677456 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,15 @@ ___ ## Changelog + +- **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`. - **v0.7.1**: - Added support for multiple notifications using the same template - Added support for notification output format @@ -36,18 +45,6 @@ ___ - Bugfix: snooze dockcheck.sh-self-notification and some config clarification. - Added authentication support to Ntfy.sh. - Added suport for sendmail in the SMTP-template. -- **v0.6.9**: - - Bugfix: label logic didn't skip recreation (skipped pulling). - - Added comma separated search filtering so you can selectively search exactly which containers to check/update. - - eg: `dockcheck.sh -yp homer,dozzle` -- **v0.6.8**: - - Bugfix: Unbound variable in notify_v2.sh - - New option: "DisplaySourcedFiles" *config* added to list what files get sourced -- **v0.6.7**: Snooze feature, curl, and consolidation - - Added snooze feature to delay notifications - - Added configurable default curl arguments - - Consolidated and standardized notify template update notifications - - Added curl error handling ___ @@ -69,7 +66,7 @@ Options: -h Print this Help. -i Inform - send a preconfigured notification. -I Prints custom releasenote urls alongside each container with updates in CLI output (requires urls.list). --l Only update if label is set. See readme. +-l Only include containers with label set. See readme. -m Monochrome mode, no printf colour codes and hides progress bar. -M Prints custom releasenote urls as markdown (requires template support). -n No updates, only checking availability. @@ -283,10 +280,12 @@ Optionally add labels to compose-files. Currently these are the usable labels: mag37.dockcheck.only-specific-container: true mag37.dockcheck.restart-stack: true ``` -- `mag37.dockcheck.update: true` will when used with the `-l` option only update containers with this label and skip the rest. Will still list updates as usual. +- `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). +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): diff --git a/dockcheck.sh b/dockcheck.sh index d46f4da..fec5085 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -VERSION="v0.7.1" -# ChangeNotes: Add support for multiple notifications of the same type, output formatting, and file output +VERSION="v0.7.2" +# ChangeNotes: Reformatted updates list, rewrote label logic to work globally when used with `-l`. Github="https://github.com/mag37/dockcheck" RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" @@ -42,7 +42,7 @@ Help() { echo "-h Print this Help." echo "-i Inform - send a preconfigured notification." echo "-I Prints custom releasenote urls alongside each container with updates in CLI output (requires urls.list)." - echo "-l Only update if label is set. See readme." + echo "-l Only include containers with label set. See readme." echo "-m Monochrome mode, no printf colour codes and hides progress bar." echo "-M Prints custom releasenote urls as markdown (requires template support)." echo "-n No updates; only checking availability without interaction." @@ -342,12 +342,13 @@ dependency_check() { dependency_check "regctl" "regbin" "https://github.com/regclient/regclient/releases/latest/download/regctl-linux-TEMP" dependency_check "jq" "jqbin" "https://github.com/jqlang/jq/releases/latest/download/jq-linux-TEMP" -# Numbered List function -# if urls.list exists add release note url per line +# Numbered List function - pads with zero list_options() { - num=1 + local total="${#Updates[@]}" + [[ ${#total} < 2 ]] && local pads=2 || local pads="${#total}" + local num=1 for update in "${Updates[@]}"; do - echo "$num) $update" + printf "%0*d - %s\n" $pads $num $update ((num++)) done } @@ -423,6 +424,10 @@ check_image() { printf "%s\n" "NoUpdates !$i - not checked, no compose file" return fi + # Checking if Label Only -option is set, and if container got the label + ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels") + [[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel="" + [[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "Skip $i"; return; } } local NoUpdates GotUpdates GotErrors ImageId=$(docker inspect "$i" --format='{{.Image}}') @@ -448,7 +453,7 @@ check_image() { # Make required functions and variables available to subprocesses export -f check_image datecheck export Excludes_string="${Excludes[*]:-}" # Can only export scalar variables -export t_out regbin RepoUrl DaysOld DRunUp jqbin +export t_out regbin RepoUrl DaysOld DRunUp jqbin OnlyLabel # Check for POSIX xargs with -P option, fallback without async if (echo "test" | xargs -P 2 >/dev/null 2>&1) && [[ "$MaxAsync" != 0 ]]; then @@ -478,6 +483,8 @@ done < <( \ xargs $XargsAsync -I {} bash -c 'check_image "{}"' \ ) +[[ "$OnlyLabel" == true ]] && printf "\n%bLabel option active:%b Only checking containers with labels set.\n" "$c_blue" "$c_reset" + # Sort arrays alphabetically IFS=$'\n' NoUpdates=($(sort <<<"${NoUpdates[*]:-}")) @@ -533,10 +540,6 @@ if [[ -n "${GotUpdates:-}" ]]; then ContImage=$(docker inspect "$i" --format='{{.Config.Image}}') ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels") [[ "$ContPath" == "null" ]] && ContPath="" - ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels") - [[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel="" - # Checking if Label Only -option is set, and if container got the label - [[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping."; continue; } } # Checking if compose-values are empty - hence started with docker run if [[ -z "$ContPath" ]]; then @@ -568,8 +571,6 @@ if [[ -n "${GotUpdates:-}" ]]; then [[ "$ContName" == "null" ]] && ContName="" ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels") [[ "$ContEnv" == "null" ]] && ContEnv="" - ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels") - [[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel="" ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels") [[ "$ContRestartStack" == "null" ]] && ContRestartStack="" ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels") @@ -578,8 +579,6 @@ if [[ -n "${GotUpdates:-}" ]]; then printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset" # Checking if compose-values are empty - hence started with docker run [[ -z "$ContPath" ]] && { echo "Not a compose container, skipping."; continue; } - # Checking if Label Only -option is set, and if container got the label - [[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping."; continue; } } # cd to the compose-file directory to account for people who use relative volumes cd "$ContPath" || { printf "\n%bPath error - skipping%b %s" "$c_red" "$c_reset" "$i"; continue; } @@ -602,7 +601,7 @@ if [[ -n "${GotUpdates:-}" ]]; then ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; } fi done - if [[ "$AutoPrune" == false ]] && [[ "$AutoMode" == false ]]; then printf "\n"; read -rep "Would you like to prune dangling images? y/[n]: " AutoPrune; fi + 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 printf "\n%bAll done!%b\n" "$c_green" "$c_reset" else From be58805824c75d3a97154bb3902f0b68c50dca30 Mon Sep 17 00:00:00 2001 From: mag37 Date: Mon, 6 Oct 2025 10:18:38 +0200 Subject: [PATCH 08/27] hot-patch unquoted variable in updates list --- dockcheck.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dockcheck.sh b/dockcheck.sh index fec5085..65e0882 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -348,7 +348,7 @@ list_options() { [[ ${#total} < 2 ]] && local pads=2 || local pads="${#total}" local num=1 for update in "${Updates[@]}"; do - printf "%0*d - %s\n" $pads $num $update + printf "%0*d - %s\n" "$pads" "$num" "$update" ((num++)) done } From 05e5b23e7bb9cf0cf5f5930576cf9fda6ed76e06 Mon Sep 17 00:00:00 2001 From: mag37 Date: Tue, 7 Oct 2025 08:24:31 +0200 Subject: [PATCH 09/27] bugfix - unquoted var in list Versionbump. --- dockcheck.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dockcheck.sh b/dockcheck.sh index 65e0882..42c241a 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -VERSION="v0.7.2" -# ChangeNotes: Reformatted updates list, rewrote label logic to work globally when used with `-l`. +VERSION="v0.7.3" +# ChangeNotes: Bugfix - unquoted variable in list. Also: Please consider donating. Github="https://github.com/mag37/dockcheck" RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" From 24cae63b61e033640cb12891144126f12b61e603 Mon Sep 17 00:00:00 2001 From: mag37 Date: Tue, 7 Oct 2025 08:25:44 +0200 Subject: [PATCH 10/27] bugfix - unquoted var in list Versionbump. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c677456..9f7e04e 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ ___ ## Changelog - +- **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. From 12a51d8e8351dd560972b3d584c8f2b6d45604c1 Mon Sep 17 00:00:00 2001 From: mag37 Date: Wed, 8 Oct 2025 19:00:29 +0200 Subject: [PATCH 11/27] added new sponsors --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9f7e04e..60733bf 100644 --- a/README.md +++ b/README.md @@ -344,11 +344,15 @@ dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/l ## Sponsorlist -- [avegy](https://github.com/avegy) -- [eichhorn](https://github.com/eichhorn) -- [stepdg](https://github.com/stepdg) -- [acer2220](https://github.com/acer2220) -- [shgew](https://github.com/shgew) +:small_orange_diamond: [avegy](https://github.com/avegy) +:small_orange_diamond: [eichhorn](https://github.com/eichhorn) +:small_orange_diamond: [stepdg](https://github.com/stepdg) +:small_orange_diamond: [acer2220](https://github.com/acer2220) +:small_orange_diamond: [shgew](https://github.com/shgew) +:small_orange_diamond: [jonas3456](https://github.com/jonas3456) +:small_orange_diamond: [4ndreasH](https://github.com/4ndreasH) +:small_orange_diamond: + ___ ### The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect. From 8970ee3f20c31ef9a61e0e5795b0647250f78941 Mon Sep 17 00:00:00 2001 From: mag37 Date: Tue, 21 Oct 2025 20:47:10 +0200 Subject: [PATCH 12/27] added to the sponsorlist --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 60733bf..a9fc38f 100644 --- a/README.md +++ b/README.md @@ -351,7 +351,9 @@ dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/l :small_orange_diamond: [shgew](https://github.com/shgew) :small_orange_diamond: [jonas3456](https://github.com/jonas3456) :small_orange_diamond: [4ndreasH](https://github.com/4ndreasH) -:small_orange_diamond: +:small_orange_diamond: [markoe01](https://github.com/markoe01) +:small_orange_diamond: [mushrowan](https://github.com/mushrowan) +:small_orange_diamond: ___ From 7ea97d06ce21dd164f641348cec415b6ae3309b8 Mon Sep 17 00:00:00 2001 From: mag37 Date: Sat, 1 Nov 2025 09:14:49 +0100 Subject: [PATCH 13/27] New option -R and bugfix + cleanup (#236) * Cleaned up legacy structure * Add -R flag to skip container recreation after pulling images (#235) * Added new -R option: Skip Container recreation --------- Co-authored-by: mag37 Co-authored-by: NapalmZ --- README.md | 16 +++--- default.config | 2 +- dockcheck.sh | 101 +++++++++++++++++++---------------- extras/apprise_quickstart.md | 30 ++--------- 4 files changed, 71 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index a9fc38f..a4228cd 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,14 @@ ___ ## Changelog -- **v0.7.3**: Bugfix - unquoted variable in printf list caused occasional issues. +- **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. +- **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. @@ -41,10 +48,6 @@ ___ - `_CONTAINERSONLY` : Only notify for docker container related updates - `_ALLOWEMPTY` : Always send notifications, even when empty - `_OUTPUT` : Define output format -- **v0.7.0**: - - Bugfix: snooze dockcheck.sh-self-notification and some config clarification. - - Added authentication support to Ntfy.sh. - - Added suport for sendmail in the SMTP-template. ___ @@ -72,6 +75,7 @@ Options: -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 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. -u Allow automatic self updates - caution as this will pull new code and autorun it. @@ -353,7 +357,7 @@ dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/l :small_orange_diamond: [4ndreasH](https://github.com/4ndreasH) :small_orange_diamond: [markoe01](https://github.com/markoe01) :small_orange_diamond: [mushrowan](https://github.com/mushrowan) -:small_orange_diamond: +:small_orange_diamond: ___ diff --git a/default.config b/default.config index d5d21aa..2b5f75c 100644 --- a/default.config +++ b/default.config @@ -19,6 +19,7 @@ #OnlyLabel=true # Only update if label is set. See readme. #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 @@ -89,4 +90,3 @@ # TELEGRAM_TOPIC_ID="0" # # FILE_PATH="${ScriptWorkDir}/updates_available.txt" - diff --git a/dockcheck.sh b/dockcheck.sh index 42c241a..a3ebef0 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -VERSION="v0.7.3" -# ChangeNotes: Bugfix - unquoted variable in list. Also: Please consider donating. +VERSION="v0.7.4" +# ChangeNotes: New option -R to pull without recreation. Fixes: value too great error, legacy cleanups. Github="https://github.com/mag37/dockcheck" RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" @@ -47,6 +47,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 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." @@ -78,6 +79,7 @@ Exclude=${Exclude:-} DaysOld=${DaysOld:-} OnlySpecific=${OnlySpecific:-false} SpecificContainer=${SpecificContainer:-""} +SkipRecreate=${SkipRecreate:-false} Excludes=() GotUpdates=() NoUpdates=() @@ -95,7 +97,7 @@ c_blue="\033[0;34m" c_teal="\033[0;36m" c_reset="\033[0m" -while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:" options; do +while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:R" options; do case "${options}" in a|y) AutoMode=true ;; c) CollectorTextFileDirectory="${OPTARG}" ;; @@ -110,6 +112,7 @@ while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:" options; do M) PrintMarkdownURL=true ;; n) DontUpdate=true; AutoMode=true;; p) AutoPrune=true ;; + R) SkipRecreate=true ;; r) DRunUp=true ;; s) Stopped="-a" ;; t) Timeout="${OPTARG}" ;; @@ -213,6 +216,7 @@ choosecontainers() { else ChoiceClean=${Choice//[,.:;]/ } 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 else @@ -554,53 +558,58 @@ if [[ -n "${GotUpdates:-}" ]]; then docker pull "$ContImage" || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; } done - printf "\n%bDone pulling updates. %bRecreating updated containers.%b\n" "$c_green" "$c_blue" "$c_reset" + printf "\n%bDone pulling updates.%b\n" "$c_green" "$c_reset" - CurrentQue=0 - for i in "${SelectedUpdates[@]}"; do - ((CurrentQue+=1)) - unset CompleteConfs - # Extract labels and metadata - ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}') - ContImage=$(docker inspect "$i" --format='{{.Config.Image}}') - ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels") - [[ "$ContPath" == "null" ]] && ContPath="" - ContConfigFile=$($jqbin -r '."com.docker.compose.project.config_files"' <<< "$ContLabels") - [[ "$ContConfigFile" == "null" ]] && ContConfigFile="" - ContName=$($jqbin -r '."com.docker.compose.service"' <<< "$ContLabels") - [[ "$ContName" == "null" ]] && ContName="" - ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels") - [[ "$ContEnv" == "null" ]] && ContEnv="" - ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels") - [[ "$ContRestartStack" == "null" ]] && ContRestartStack="" - ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels") - [[ "$ContOnlySpecific" == "null" ]] && ContRestartStack="" + if [[ "$SkipRecreate" == true ]]; then + printf "%bSkipping container recreation due to -R.%b\n" "$c_yellow" "$c_reset" + else + printf "%bRecreating updated containers.%b\n" "$c_blue" "$c_reset" + CurrentQue=0 + for i in "${SelectedUpdates[@]}"; do + ((CurrentQue+=1)) + unset CompleteConfs + # Extract labels and metadata + ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}') + ContImage=$(docker inspect "$i" --format='{{.Config.Image}}') + ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels") + [[ "$ContPath" == "null" ]] && ContPath="" + ContConfigFile=$($jqbin -r '."com.docker.compose.project.config_files"' <<< "$ContLabels") + [[ "$ContConfigFile" == "null" ]] && ContConfigFile="" + ContName=$($jqbin -r '."com.docker.compose.service"' <<< "$ContLabels") + [[ "$ContName" == "null" ]] && ContName="" + ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels") + [[ "$ContEnv" == "null" ]] && ContEnv="" + ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels") + [[ "$ContRestartStack" == "null" ]] && ContRestartStack="" + ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels") + [[ "$ContOnlySpecific" == "null" ]] && ContRestartStack="" - printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset" - # Checking if compose-values are empty - hence started with docker run - [[ -z "$ContPath" ]] && { echo "Not a compose container, skipping."; continue; } + printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset" + # Checking if compose-values are empty - hence started with docker run + [[ -z "$ContPath" ]] && { echo "Not a compose container, skipping."; continue; } - # cd to the compose-file directory to account for people who use relative volumes - cd "$ContPath" || { printf "\n%bPath error - skipping%b %s" "$c_red" "$c_reset" "$i"; continue; } - ## Reformatting path + multi compose - if [[ $ContConfigFile == '/'* ]]; then - CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s " "$conf"; done) - else - CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s/%s " "$ContPath" "$conf"; done) - fi - # Check if the container got an environment file set and reformat it - ContEnvs="" - if [[ -n "$ContEnv" ]]; then ContEnvs=$(for env in ${ContEnv//,/ }; do printf -- "--env-file %s " "$env"; done); fi - # Set variable when compose up should only target the specific container, not the stack - if [[ $OnlySpecific == true ]] || [[ $ContOnlySpecific == true ]]; then SpecificContainer="$ContName"; fi + # cd to the compose-file directory to account for people who use relative volumes + cd "$ContPath" || { printf "\n%bPath error - skipping%b %s" "$c_red" "$c_reset" "$i"; continue; } + ## Reformatting path + multi compose + if [[ $ContConfigFile == '/'* ]]; then + CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s " "$conf"; done) + else + CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s/%s " "$ContPath" "$conf"; done) + fi + # Check if the container got an environment file set and reformat it + ContEnvs="" + if [[ -n "$ContEnv" ]]; then ContEnvs=$(for env in ${ContEnv//,/ }; do printf -- "--env-file %s " "$env"; done); fi + # Set variable when compose up should only target the specific container, not the stack + if [[ $OnlySpecific == true ]] || [[ $ContOnlySpecific == true ]]; then SpecificContainer="$ContName"; fi - # 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; } - else - ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; } - fi - done + # 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; } + else + ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; } + fi + done + fi 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 printf "\n%bAll done!%b\n" "$c_green" "$c_reset" diff --git a/extras/apprise_quickstart.md b/extras/apprise_quickstart.md index 2d1ddd6..c526492 100644 --- a/extras/apprise_quickstart.md +++ b/extras/apprise_quickstart.md @@ -38,35 +38,15 @@ You can also use the [caronc/apprise-api](https://github.com/caronc/apprise-api) ### 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. +After you're done with the setup of the container and tried your notifications, you need to follow the configuration setup (explained in detail in the README). +Briefly: Copy `default.config` to `dockcheck.config` then edit it to change the following, `APPRISE_URL` matching your environment: -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 - -} +NOTIFY_CHANNELS="apprise" +APPRISE_URL="http://apprise.mydomain.tld:1234/notify/apprise" ``` -That's all! +That's it! ___ ___ From c34d52bde064f1dc7506891c17ad995c2bc0e909 Mon Sep 17 00:00:00 2001 From: mag37 Date: Sat, 1 Nov 2025 09:25:11 +0100 Subject: [PATCH 14/27] the missing ) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a4228cd..3b0209e 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ After the updates are complete, you'll get prompted if you'd like to prune dangl ___ ## Dependencies -- Running docker (duh) and compose, either standalone or plugin. (see [Podman fork](https://github.com/sudo-kraken/podcheck) +- 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. - [jq](https://github.com/jqlang/jq) From c33c9f4387a5a9a40496a0107f8abff24ab26e64 Mon Sep 17 00:00:00 2001 From: Oleh Astappiev <4512729+astappiev@users.noreply.github.com> Date: Thu, 13 Nov 2025 06:17:25 +0100 Subject: [PATCH 15/27] Fix version check condition (#239) --- dockcheck.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dockcheck.sh b/dockcheck.sh index a3ebef0..a0150df 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -358,7 +358,7 @@ list_options() { } # Version check & initiate self update -if [[ "$LatestRelease" != "undefined" ]]; then +if [[ "$LatestSnippet" != "undefined" ]]; then if [[ "$VERSION" != "$LatestRelease" ]]; then printf "New version available! %b%s%b ⇒ %b%s%b \n Change Notes: %s \n" "$c_yellow" "$VERSION" "$c_reset" "$c_green" "$LatestRelease" "$c_reset" "$LatestChanges" if [[ "$AutoMode" == false ]]; then From f1cc8190f9426c2208189872d5099b4c596d54ba Mon Sep 17 00:00:00 2001 From: Andrei Mateescu Date: Fri, 12 Dec 2025 12:00:42 +0200 Subject: [PATCH 16/27] Add the Pangolin stack to urls.list (#241) Adds a few items from the Pangolin stack (https://github.com/fosrl/) and others that are usually used together. --- notify_templates/urls.list | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/notify_templates/urls.list b/notify_templates/urls.list index 2b31c3b..aeba433 100644 --- a/notify_templates/urls.list +++ b/notify_templates/urls.list @@ -15,12 +15,14 @@ calibre https://github.com/linuxserver/docker-calibre/releases calibre-web https://github.com/linuxserver/docker-calibre-web/releases cleanuperr https://github.com/flmorg/cleanuperr/releases cross-seed https://github.com/cross-seed/cross-seed/releases +crowdsec https://github.com/crowdsecurity/crowdsec/releases cup https://github.com/sergi0g/cup/releases dockge https://github.com/louislam/dockge/releases dozzle https://github.com/amir20/dozzle/releases flatnotes https://github.com/dullage/flatnotes/releases forgejo https://codeberg.org/forgejo/forgejo/releases fressrss https://github.com/FreshRSS/FreshRSS/releases +gerbil https://github.com/fosrl/gerbil/releases gluetun https://github.com/qdm12/gluetun/releases go2rtc https://github.com/AlexxIT/go2rtc/releases gotify https://github.com/gotify/server/releases @@ -45,9 +47,11 @@ mealie https://github.com/mealie-recipes/mealie/releases meilisearch https://github.com/meilisearch/meilisearch/releases monica https://github.com/monicahq/monica/releases mqtt https://github.com/eclipse/mosquitto/tags +newt https://github.com/fosrl/newt/releases nextcloud-aio-mastercontainer https://github.com/nextcloud/all-in-one/releases nginx https://github.com/docker-library/official-images/blob/master/library/nginx owncast https://github.com/owncast/owncast/releases +pangolin https://github.com/fosrl/pangolin/releases prowlarr https://github.com/Prowlarr/Prowlarr/releases prowlarr-ls https://github.com/linuxserver/docker-prowlarr/releases qbittorrent https://www.qbittorrent.org/news @@ -66,6 +70,7 @@ snappymail https://github.com/the-djmaze/snappymail/releases sonarr https://github.com/Sonarr/Sonarr/releases/ sonarr-ls https://github.com/linuxserver/docker-sonarr/releases syncthing https://github.com/syncthing/syncthing/releases +tailscale https://github.com/tailscale/tailscale/releases tautulli https://github.com/Tautulli/Tautulli/releases thelounge https://github.com/thelounge/thelounge/releases traefik https://github.com/traefik/traefik/releases From 8ee5575081ecf2c4bc712307b0119d78b088069a Mon Sep 17 00:00:00 2001 From: mag37 Date: Fri, 12 Dec 2025 11:12:57 +0100 Subject: [PATCH 17/27] Added option -b to enable image backups pre pull. (#242) * added new variables, options and setup * datecheck function rewrite * moved the cleanup and prune logic to always run. Changed some wording on messages. * added function to print currently backed up images * Patched bugfix to not recreate stopped containers * changed the RepoDigests grab and logic * Moved the backup - cleanup to always trigger if -b option is used. Added -p&-b warning. * version bump and readme fixes --- README.md | 51 +++++++++++++------- default.config | 1 + dockcheck.sh | 128 ++++++++++++++++++++++++++++++++++++++++--------- 3 files changed, 140 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 3b0209e..f811796 100644 --- a/README.md +++ b/README.md @@ -13,15 +13,22 @@

CLI tool to automate docker image updates or notifying when updates are available.

-

selective updates, exclude containers, custom labels, notification plugins, prune when done etc.

+

selective updates, include/exclude containers, image backups, custom labels, notification plugins, prune when done etc.

-

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

+

: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. - **v0.7.4**: - Added new option `-R`: - Will skip container recreation after pulling images. @@ -38,16 +45,6 @@ ___ - 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`. -- **v0.7.1**: - - Added support for multiple notifications using the same template - - Added support for notification output format - - Added support for file output - - Added optional configuration variables per channel to (replace `` with any channel name): - - `_TEMPLATE` : Specify a template - - `_SKIPSNOOZE` : Skip snooze - - `_CONTAINERSONLY` : Only notify for docker container related updates - - `_ALLOWEMPTY` : Always send notifications, even when empty - - `_OUTPUT` : Define output format ___ @@ -61,6 +58,8 @@ Example: dockcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall Options: -a|y Automatic updates, without interaction. +-b N Enable image backups and sets number of days to keep from pruning. +-B List currently backed up images, then exit. -c D Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory. -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. @@ -86,18 +85,19 @@ Options: ### Basic example: ``` $ ./dockcheck.sh -. . . +[##################################################] 5/5 + Containers on latest version: glances homer Containers with updates available: -1) adguardhome -2) syncthing -3) whoogle-search +01) adguardhome +02) syncthing +03) whoogle-search Choose what containers to update: -Enter number(s) separated by comma, [a] for all - [q] to quit: +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. @@ -245,6 +245,23 @@ The `urls.list` file is just an example and I'd gladly see that people contribut 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`. +## 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` +- `dockcheck` as repo name to not interfere with others. +- `homer` is the image. +- `2025-10-26_1132` is the time when running the script. +- `latest` is the tag of the image. + +Then if an update breaks, you could restore the image by stopping the container, delete the new image, eg. `docker rmi b4bz/homer:latest`, then retag the backup as latest `docker tag dockcheck/homer:_latest b4bz/homer:latest`. +After that, start the container again (now with the backup image active) and it will be updated as usual next time you run dockcheck or other updates. + +The backed up images will be removed if they're older than *BackupForDays* value (passed as `-b N` or set in the `dockcheck.config` with `BackupForDays=N`) and then pruned. +If configured for eg. 7 days, force earlier cleaning by just passing a lower number of days, eg. `-b 2` to clean everything older than 2 days. +Backed up images will not be removed if neither `-b` flag nor `BackupForDays` config variable is set. + +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: diff --git a/default.config b/default.config index 2b5f75c..90abfa5 100644 --- a/default.config +++ b/default.config @@ -28,6 +28,7 @@ #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. ### Notify settings ## All commented values are examples only. Modify as needed. diff --git a/dockcheck.sh b/dockcheck.sh index a0150df..906ed0d 100755 --- a/dockcheck.sh +++ b/dockcheck.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -VERSION="v0.7.4" -# ChangeNotes: New option -R to pull without recreation. Fixes: value too great error, legacy cleanups. +VERSION="v0.7.5" +# ChangeNotes: New option -b N to backup image before pulling for easy rollback. Github="https://github.com/mag37/dockcheck" RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" @@ -34,6 +34,8 @@ Help() { echo echo "Options:" 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 "-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." @@ -58,6 +60,12 @@ Help() { echo "Project source: $Github" } +# Print current backups function +print_backups() { + printf "\n%b---%b Currently backed up images %b---%b\n\n" "$c_teal" "$c_blue" "$c_teal" "$c_reset" + docker images | sed -ne '/^REPOSITORY/p' -ne '/^dockcheck/p' +} + # Initialise variables Timeout=${Timeout:-10} MaxAsync=${MaxAsync:-1} @@ -77,6 +85,7 @@ Stopped=${Stopped:-""} CollectorTextFileDirectory=${CollectorTextFileDirectory:-} Exclude=${Exclude:-} DaysOld=${DaysOld:-} +BackupForDays=${BackupForDays:-} OnlySpecific=${OnlySpecific:-false} SpecificContainer=${SpecificContainer:-""} SkipRecreate=${SkipRecreate:-false} @@ -97,9 +106,15 @@ c_blue="\033[0;34m" c_teal="\033[0;36m" c_reset="\033[0m" -while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:R" options; do +# Timestamps +RunTimestamp=$(date +'%Y-%m-%d_%H%M') +RunEpoch=$(date +'%s') + +while getopts "ayb:BfFhiIlmMnprsuvc:e:d:t:x:R" options; do case "${options}" in a|y) AutoMode=true ;; + b) BackupForDays="${OPTARG}" ;; + B) print_backups; exit 0 ;; c) CollectorTextFileDirectory="${OPTARG}" ;; d) DaysOld=${OPTARG} ;; e) Exclude=${OPTARG} ;; @@ -156,6 +171,13 @@ if [[ -n "$DaysOld" ]]; then exit 2 fi fi +if [[ -n "$BackupForDays" ]]; then + if ! [[ $BackupForDays =~ ^[0-9]+$ ]]; then + printf "-b argument given (%s) is not a number.\n" "$BackupForDays" + exit 2 + fi + [[ "$AutoPrune" == true ]] && printf "%bWARNING: When -b option is used, -p has no function.%b\n" "$c_yellow" "$c_reset" +fi if [[ -n "$CollectorTextFileDirectory" ]]; then if ! [[ -d $CollectorTextFileDirectory ]]; then printf "The directory (%s) does not exist.\n" "$CollectorTextFileDirectory" @@ -196,11 +218,11 @@ self_update() { printf "\n%s\n" "Pulling the latest version." git pull --force || { printf "%bGit error,%b manually pull/clone.\n" "$c_red" "$c_reset"; return; } printf "\n%s\n" "--- starting over with the updated version ---" - cd - || { printf "%bPath error.%b\n" "$c_red"; return; } + cd - || { printf "%bPath error.%b\n" "$c_red" "$c_reset"; return; } exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments exit 0 # exit the old instance else - cd - || { printf "%bPath error.%b\n" "$c_red"; return; } + cd - || { printf "%bPath error.%b\n" "$c_red" "$c_reset"; return; } self_update_curl fi } @@ -209,6 +231,7 @@ choosecontainers() { while [[ -z "${ChoiceClean:-}" ]]; do read -r -p "Enter number(s) separated by comma, [a] for all - [q] to quit: " Choice if [[ "$Choice" =~ [qQnN] ]]; then + [[ -n "${BackupForDays:-}" ]] && remove_backups exit 0 elif [[ "$Choice" =~ [aAyY] ]]; then SelectedUpdates=( "${GotUpdates[@]}" ) @@ -228,16 +251,39 @@ choosecontainers() { } datecheck() { - ImageDate=$("$regbin" -v error image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1) + ImageDate="$1" + DaysMax="$2" ImageEpoch=$(date -d "$ImageDate" +%s 2>/dev/null) || ImageEpoch=$(date -f "%Y-%m-%d" -j "$ImageDate" +%s) - ImageAge=$(( ( $(date +%s) - ImageEpoch )/86400 )) - if [[ "$ImageAge" -gt "$DaysOld" ]]; then + ImageAge=$(( ( RunEpoch - ImageEpoch )/86400 )) + if [[ "$ImageAge" -gt "$DaysMax" ]]; then return 0 else return 1 fi } +remove_backups() { + IFS=$'\n' + CleanupCount=0 + for backup_img in $(docker images --format "{{.Repository}} {{.Tag}}" | sed -n '/^dockcheck/p'); do + repo_name=${backup_img% *} + backup_tag=${backup_img#* } + backup_date=${backup_tag%%_*} + # UNTAGGING HERE + if datecheck "$backup_date" "$BackupForDays"; then + [[ "$CleanupCount" == 0 ]] && printf "\n%bRemoving backed up images older then %s days.%b\n" "$c_blue" "$BackupForDays" "$c_reset" + docker rmi "${repo_name}:${backup_tag}" && ((CleanupCount+=1)) + fi + done + unset IFS + if [[ "$CleanupCount" == 0 ]]; then + printf "\nNo backup images to remove.\n" + else + [[ "$CleanupCount" -gt 1 ]] && b_phrase="backups" || b_phrase="backup" + printf "\n%b%s%b %s removed.%b\n" "$c_green" "$CleanupCount" "$c_teal" "$b_phrase" "$c_reset" + fi +} + progress_bar() { QueCurrent="$1" QueTotal="$2" @@ -443,7 +489,7 @@ check_image() { if [[ "$LocalHash" == *"$RegHash"* ]]; then printf "%s\n" "NoUpdates $i" else - if [[ -n "${DaysOld:-}" ]] && ! datecheck; then + if [[ -n "${DaysOld:-}" ]] && ! datecheck $("$regbin" -v error image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1) "$DaysOld" ; then printf "%s\n" "NoUpdates +$i ${ImageAge}d" else printf "%s\n" "GotUpdates $i" @@ -457,7 +503,7 @@ check_image() { # Make required functions and variables available to subprocesses export -f check_image datecheck export Excludes_string="${Excludes[*]:-}" # Can only export scalar variables -export t_out regbin RepoUrl DaysOld DRunUp jqbin OnlyLabel +export t_out regbin RepoUrl DaysOld DRunUp jqbin OnlyLabel RunTimestamp RunEpoch # Check for POSIX xargs with -P option, fallback without async if (echo "test" | xargs -P 2 >/dev/null 2>&1) && [[ "$MaxAsync" != 0 ]]; then @@ -540,11 +586,25 @@ if [[ -n "${GotUpdates:-}" ]]; then for i in "${SelectedUpdates[@]}"; do ((CurrentQue+=1)) printf "\n%bNow updating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset" - ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}') - ContImage=$(docker inspect "$i" --format='{{.Config.Image}}') - ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels") + ContConfig=$(docker inspect "$i" --format '{{json .}}') + ContImage=$($jqbin -r '."Config"."Image"' <<< "$ContConfig") + ImageId=$($jqbin -r '."Image"' <<< "$ContConfig") + ContPath=$($jqbin -r '."Config"."Labels"."com.docker.compose.project.working_dir"' <<< "$ContConfig") [[ "$ContPath" == "null" ]] && ContPath="" + # Add new backup tag prior to pulling if option is set + if [[ -n "${BackupForDays:-}" ]]; then + ImageConfig=$(docker image inspect "$ImageId" --format '{{ json . }}') + ContRepoDigests=$($jqbin -r '.RepoDigests[0]' <<< "$ImageConfig") + [[ "$ContRepoDigests" == "null" ]] && ContRepoDigests="" + ContRepo=${ContImage%:*} + ContApp=${ContRepo#*/} + [[ "$ContImage" =~ ":" ]] && ContTag=${ContImage#*:} || ContTag="latest" + BackupName="dockcheck/${ContApp}:${RunTimestamp}_${ContTag}" + docker tag "$ImageId" "$BackupName" + printf "%b%s backed up as %s%b\n" "$c_teal" "$i" "$BackupName" "$c_reset" + fi + # Checking if compose-values are empty - hence started with docker run if [[ -z "$ContPath" ]]; then if [[ "$DRunUp" == true ]]; then @@ -556,7 +616,13 @@ if [[ -n "${GotUpdates:-}" ]]; then continue fi - docker pull "$ContImage" || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; } + if docker pull "$ContImage"; then + # Removal of the -tag image left behind from backup + if [[ ! -z "${ContRepoDigests:-}" ]] && [[ -n "${BackupForDays:-}" ]]; then docker rmi "$ContRepoDigests"; fi + else + printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1 + fi + done printf "\n%bDone pulling updates.%b\n" "$c_green" "$c_reset" @@ -569,8 +635,8 @@ if [[ -n "${GotUpdates:-}" ]]; then ((CurrentQue+=1)) unset CompleteConfs # Extract labels and metadata - ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}') - ContImage=$(docker inspect "$i" --format='{{.Config.Image}}') + ContConfig=$(docker inspect "$i" --format '{{json .}}') + ContLabels=$($jqbin -r '."Config"."Labels"' <<< "$ContConfig") ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels") [[ "$ContPath" == "null" ]] && ContPath="" ContConfigFile=$($jqbin -r '."com.docker.compose.project.config_files"' <<< "$ContLabels") @@ -583,14 +649,22 @@ if [[ -n "${GotUpdates:-}" ]]; then [[ "$ContRestartStack" == "null" ]] && ContRestartStack="" ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels") [[ "$ContOnlySpecific" == "null" ]] && ContRestartStack="" + 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 + fi - printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset" # Checking if compose-values are empty - hence started with docker run [[ -z "$ContPath" ]] && { echo "Not a compose container, skipping."; continue; } # cd to the compose-file directory to account for people who use relative volumes cd "$ContPath" || { printf "\n%bPath error - skipping%b %s" "$c_red" "$c_reset" "$i"; continue; } - ## Reformatting path + multi compose + # Reformatting path + multi compose if [[ $ContConfigFile == '/'* ]]; then CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s " "$conf"; done) else @@ -610,14 +684,22 @@ if [[ -n "${GotUpdates:-}" ]]; then fi done fi - 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 - printf "\n%bAll done!%b\n" "$c_green" "$c_reset" + printf "\n%bAll updates done!%b\n" "$c_green" "$c_reset" + + # 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 + fi + else - printf "\nNo updates installed, exiting.\n" + printf "\nNo updates installed.\n" fi else - printf "\nNo updates available, exiting.\n" + printf "\nNo updates available.\n" fi +# Clean up old backup image tags if -b is used +[[ -n "${BackupForDays:-}" ]] && remove_backups + exit 0 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 18/27] 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 19/27] [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 20/27] 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 21/27] 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 22/27] 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 23/27] - 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 24/27] 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 25/27] 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 26/27] 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 27/27] 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