diff --git a/.gitignore b/.gitignore
index da5921c..182c4aa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,11 @@
# ignore users custom notify.sh
-/notify.sh
+/notify*.sh
/urls.list
# ignore user config
/dockcheck.config
# ignore the auto-installed regctl
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 e66eb7d..418b50b 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,66 @@
- 
+ 
+
+ 
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!
___
-## :bell: Changelog
-- **v0.6.5**: Refactored notification logic. See notify_templates/notify_v2.sh for upgrade steps.
- - Added helper functions to simplify sourcing files and executing functions if they exist.
- - Created notify_v2.sh wrapper script.
- - Simplified and consolidated notification logic within notify_v2.sh.
- - Added support for notification management via environment variables.
- - Moved notification secrets to **dockcheck.config**.
- - Added retries to wget/curl to not get empty responses when github is slow.
-- **v0.6.4**: Restructured the update process - first pulls all updates, then recreates all containers.
- - Added logic to skip update check on non-compose containers (unless `-r` option).
- - Added option `-F` to revert to `compose up -d ` targeting specific container and not the stack.
- - Also added corresponding label and config-option.
- - Added markdown formatting to `notify_ntfy-sh.sh` template.
-- **v0.6.3**: Some fixes and changes:
- - Stops when a container recreation (compose up -d) fails, also `up`s the whole stack now.
- - `-M`, Markdown format url-releasenotes in notification (requires template rework, look at gotify!)
- - Added [addons/DSM/README.md](./addons/DSM/README.md) for more info Synology DSM info.
- - Permission checks - graceful exit if no docker permissions + checking if root for pkg-manager.
-- **v0.6.2**: Style and colour changes, prometheus hotfix, new options:
- - `-u`, Allow auto self update of dockcheck.sh
- - `-I`, Print container release URLs in the CLI "choose update" list. (please contribute to `urls.list`)
- - Extras: `-m`, Monochrome mode now hides the progress bar.
+## 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.
+ - 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.
+
___
+
-
+## `dockcheck.sh`
-## :mag_right: `dockcheck.sh`
-```
+```shell
$ ./dockcheck.sh -h
-Syntax: dockcheck.sh [OPTION] [part of name to filter]
+Syntax: dockcheck.sh [OPTION] [comma separated names to include]
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.
@@ -62,12 +69,13 @@ 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.
-p Auto-Prune dangling images after update.
--r Allow updating images for docker run, wont 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.
-u Allow automatic self updates - caution as this will pull new code and autorun it.
@@ -75,41 +83,47 @@ Options:
-x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested.
```
-### Basic example:
-```
+### Basic example
+
+```shell
$ ./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.
___
-## :nut_and_bolt: Dependencies
-- Running docker (duh) and compose, either standalone or plugin. (see [Podman fork](https://github.com/sudo-kraken/podcheck)
+## 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.
- [jq](https://github.com/jqlang/jq)
- 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
-## :tent: 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
@@ -120,50 +134,116 @@ 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.
-## :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
-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!
+## Notifications
-V2 installation and configuration (tag v0.6.5 or later):
-Remove or rename `notify.sh` if previously configured using the legacy method.
-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 not to make changes directly to the `notify_X.sh` template files and to use only environment variables defined in `dockcheck.config` using this method.
+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.
-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)
+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
+
+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.
+
+```shell
+ .
+├── notify_templates/
+│ ├── notify_DSM.sh
+│ ├── notify_apprise.sh
+│ ├── notify_bark.sh
+│ ├── notify_discord.sh
+│ ├── notify_generic.sh
+│ ├── notify_gotify.sh
+│ ├── notify_HA.sh
+│ ├── notify_matrix.sh
+│ ├── notify_ntfy.sh
+│ ├── notify_pushbullet.sh
+│ ├── notify_pushover.sh
+│ ├── notify_slack.sh
+│ ├── notify_smtp.sh
+│ ├── notify_telegram.sh
+│ └── notify_v2.sh
+├── dockcheck.config
+├── 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
+
+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.
+
+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.
+
+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 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.sh](https://ntfy.sh/) - HTTP-based pub-sub notifications.
-- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
-- [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.
-- [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops)
+- [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).
+- [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)
- [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 PR!
-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`.
+
+#### Release notes addon
-### :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.
@@ -171,67 +251,102 @@ 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.
-## :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`.
+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
-## :chart_with_upwards_trend: Extra plugins and tools:
+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
+
+### Using dockcheck.sh with the Synology DSM
-### :small_orange_diamond: 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:
-```
+
+```shell
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
-If you already use Zabbix - this config will Shows number of available docker image updates on host.
+### 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:
-```
+
+```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 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).
-## :roller_coaster: Workaround for non **amd64** / **arm64**
+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
@@ -255,40 +372,54 @@ 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
-**Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
-```sh
+### Function to auth with docker hub before running
+
+**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 "$@"
}
```
-## :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.
+`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!
-## :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)
+: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: [markoe01](https://github.com/markoe01)
+:small_orange_diamond: [mushrowan](https://github.com/mushrowan)
+:small_orange_diamond:
___
-### :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
diff --git a/default.config b/default.config
index 9c13be0..f9076a2 100644
--- a/default.config
+++ b/default.config
@@ -1,38 +1,48 @@
-### 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
##
## 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 # 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.
-#DRunUp=true # Allow updating images for docker run, wont update the container.
-#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).
+#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
+##### 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 generic gotify matrix ntfy-sh pushbullet pushover slack smtp telegram"
+# NOTIFY_CHANNELS="apprise bark discord DSM file generic gotify HA matrix ntfy pushbullet pushover slack smtp telegram"
#
-## Uncomment to not send notifications when dockcheck itself has updates.
+## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze
+# SNOOZE_SECONDS=86400
+#
+## 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.
@@ -42,19 +52,31 @@
# 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"
#
+# HA_ENTITY="entity"
+# HA_TOKEN="token"
+# HA_URL="https://your.homeassistant.url"
+#
# MATRIX_ACCESS_TOKEN="token-value"
# MATRIX_ROOM_ID="myroom"
# MATRIX_SERVER_URL="https://matrix.yourdomain.tld"
#
+## https://ntfy.sh or your custom domain with https:// and no trailing /
+# NTFY_DOMAIN="https://ntfy.sh"
# NTFY_TOPIC_NAME="YourUniqueTopicName"
+## 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"
diff --git a/dockcheck.sh b/dockcheck.sh
index cccc6dc..24e7c62 100755
--- a/dockcheck.sh
+++ b/dockcheck.sh
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
-VERSION="v0.6.5"
-# ChangeNotes: Refactored notification logic. See README.md for upgrade steps.
+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"
@@ -13,30 +13,30 @@ ScriptArgs=( "$@" )
ScriptPath="$(readlink -f "$0")"
ScriptWorkDir="$(dirname "$ScriptPath")"
-# Check if there's a new release of the script
-LatestRelease="$(curl --retry 3 --retry-delay 1 --retry-max-time 10 -s -r 0-50 "$RawUrl" | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
-LatestChanges="$(curl --retry 3 --retry-delay 1 --retry-max-time 10 -s -r 0-200 "$RawUrl" | sed -n "/ChangeNotes/s/# ChangeNotes: //p")"
-
# Source helper functions
-source_if_exists() {
- if [[ -s "$1" ]]; then source "$1"; fi
-}
-
source_if_exists_or_fail() {
- [[ -s "$1" ]] && source "$1"
+ if [[ -s "$1" ]]; then
+ source "$1"
+ [[ "${DisplaySourcedFiles:-false}" == true ]] && echo " * sourced config: ${1}"
+ return 0
+ else
+ return 1
+ fi
}
# User customizable defaults
-source_if_exists_or_fail "${HOME}/.config/dockcheck.config" || source_if_exists "${ScriptWorkDir}/dockcheck.config"
+source_if_exists_or_fail "${HOME}/.config/dockcheck.config" || source_if_exists_or_fail "${ScriptWorkDir}/dockcheck.config"
# Help Function
Help() {
- echo "Syntax: dockcheck.sh [OPTION] [part of name to filter]"
+ echo "Syntax: dockcheck.sh [OPTION] [comma separated names to include]"
echo "Example: dockcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall"
echo
echo "Options:"
echo "-a|y Automatic updates, without interaction."
- echo "-c Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory."
+ 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 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."
@@ -44,14 +44,15 @@ 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."
echo "-p Auto-prune dangling images after update."
- echo "-r Allow updating images for docker run; won't update the container."
+ 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 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."
@@ -59,32 +60,41 @@ 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}
-BarWidth=${BarWidth:=50}
-AutoMode=${AutoMode:=false}
-DontUpdate=${DontUpdate:=false}
-AutoPrune=${AutoPrune:=false}
-AutoSelfUpdate=${AutoSelfUpdate:=false}
-OnlyLabel=${OnlyLabel:=false}
-Notify=${Notify:=false}
-ForceRestartStacks=${ForceRestartStacks:=false}
-DRunUp=${DRunUp:=false}
-MonoMode=${MonoMode:=false}
-PrintReleaseURL=${PrintReleaseURL:=false}
-PrintMarkdownURL=${PrintMarkdownURL:=false}
-Stopped=${Stopped:=""}
+Timeout=${Timeout:-10}
+MaxAsync=${MaxAsync:-1}
+BarWidth=${BarWidth:-50}
+AutoMode=${AutoMode:-false}
+DontUpdate=${DontUpdate:-false}
+AutoPrune=${AutoPrune:-false}
+AutoSelfUpdate=${AutoSelfUpdate:-false}
+OnlyLabel=${OnlyLabel:-false}
+Notify=${Notify:-false}
+ForceRestartStacks=${ForceRestartStacks:-false}
+DRunUp=${DRunUp:-false}
+MonoMode=${MonoMode:-false}
+PrintReleaseURL=${PrintReleaseURL:-false}
+PrintMarkdownURL=${PrintMarkdownURL:-false}
+Stopped=${Stopped:-""}
CollectorTextFileDirectory=${CollectorTextFileDirectory:-}
Exclude=${Exclude:-}
DaysOld=${DaysOld:-}
-OnlySpecific=${OnlySpecific:=false}
-SpecificContainer=${SpecificContainer:=""}
+BackupForDays=${BackupForDays:-}
+OnlySpecific=${OnlySpecific:-false}
+SpecificContainer=${SpecificContainer:-""}
+SkipRecreate=${SkipRecreate:-false}
Excludes=()
GotUpdates=()
NoUpdates=()
GotErrors=()
SelectedUpdates=()
+CurlArgs="--retry ${CurlRetryCount:=3} --retry-delay ${CurlRetryDelay:=1} --connect-timeout ${CurlConnectTimeout:=5} -sf"
regbin=""
jqbin=""
@@ -96,9 +106,15 @@ c_blue="\033[0;34m"
c_teal="\033[0;36m"
c_reset="\033[0m"
-while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:" 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} ;;
@@ -111,6 +127,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}" ;;
@@ -122,8 +139,16 @@ while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:" options; do
done
shift "$((OPTIND-1))"
-# Set $1 to a variable for name filtering later
+# Set $1 to a variable for name filtering later, rewriting if multiple
SearchName="${1:-}"
+if [[ ! -z "$SearchName" ]]; then
+ SearchName="^(${SearchName//,/|})$"
+fi
+
+# Check if there's a new release of the script
+LatestSnippet="$(curl ${CurlArgs} -r 0-200 "$RawUrl" || printf "undefined")"
+LatestRelease="$(echo "${LatestSnippet}" | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
+LatestChanges="$(echo "${LatestSnippet}" | sed -n "/ChangeNotes/s/# ChangeNotes: //p")"
# Basic notify configuration check
if [[ "${Notify}" == true ]] && [[ ! -s "${ScriptWorkDir}/notify.sh" ]] && [[ -z "${NOTIFY_CHANNELS:-}" ]]; then
@@ -146,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"
@@ -166,7 +198,7 @@ exec_if_exists_or_fail() {
self_update_curl() {
cp "$ScriptPath" "$ScriptPath".bak
if command -v curl &>/dev/null; then
- curl --retry 3 --retry-delay 1 --retry-max-time 10 -L $RawUrl > "$ScriptPath"; chmod +x "$ScriptPath"
+ curl ${CurlArgs} -L $RawUrl > "$ScriptPath"; chmod +x "$ScriptPath" || { printf "ERROR: Failed to curl updated Dockcheck.sh script. Skipping update.\n"; return 1; }
printf "\n%b---%b starting over with the updated version %b---%b\n" "$c_yellow" "$c_teal" "$c_yellow" "$c_reset"
exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
exit 1 # Exit the old instance
@@ -186,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
}
@@ -199,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[@]}" )
@@ -206,6 +239,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
@@ -217,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"
@@ -270,7 +327,7 @@ binary_downloader() {
*) printf "\n%bArchitecture not supported, exiting.%b\n" "$c_red" "$c_reset"; exit 1;;
esac
GetUrl="${BinaryUrl/TEMP/"$architecture"}"
- if command -v curl &>/dev/null; then curl --retry 3 --retry-delay 1 --retry-max-time 10 -L "$GetUrl" > "$ScriptWorkDir/$BinaryName";
+ if command -v curl &>/dev/null; then curl ${CurlArgs} -L "$GetUrl" > "$ScriptWorkDir/$BinaryName" || { printf "ERROR: Failed to curl binary dependency. Rerun the script to retry.\n"; exit 1; }
elif command -v wget &>/dev/null; then wget --waitretry=1 --timeout=15 -t 10 "$GetUrl" -O "$ScriptWorkDir/$BinaryName";
else printf "\n%bcurl/wget not available - get %s manually from the repo link, exiting.%b" "$c_red" "$BinaryName" "$c_reset"; exit 1;
fi
@@ -332,34 +389,39 @@ dependency_check() {
${!AppVar} "$VerFlag" &> /dev/null || { printf "%s\n" "$AppName is not working - try to remove it and re-download it, exiting."; exit 1; }
}
-# Numbered List function
-# if urls.list exists add release note url per line
+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 - 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
}
# Version check & initiate self update
-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
- read -r -p "Would you like to update? y/[n]: " SelfUpdate
- [[ "$SelfUpdate" =~ [yY] ]] && self_update
- elif [[ "$AutoMode" == true ]] && [[ "$AutoSelfUpdate" == true ]]; then self_update;
- else
- [[ "$Notify" == true ]] && { exec_if_exists_or_fail dockcheck_notification "$VERSION" "$LatestRelease" "$LatestChanges" || printf "Could not source notification function.\n"; }
+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
+ read -r -p "Would you like to update? y/[n]: " SelfUpdate
+ [[ "$SelfUpdate" =~ [yY] ]] && self_update
+ elif [[ "$AutoMode" == true ]] && [[ "$AutoSelfUpdate" == true ]]; then self_update;
+ else
+ [[ "$Notify" == true ]] && { exec_if_exists_or_fail dockcheck_notification "$VERSION" "$LatestRelease" "$LatestChanges" || printf "Could not source notification function.\n"; }
+ fi
fi
+else
+ printf "ERROR: Failed to curl latest Dockcheck.sh release version.\n"
fi
# Version check for notify templates
[[ "$Notify" == true ]] && [[ ! -s "${ScriptWorkDir}/notify.sh" ]] && { exec_if_exists_or_fail notify_update_notification || printf "Could not source notify notification function.\n"; }
-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"
-
# Check docker compose binary
docker info &>/dev/null || { printf "\n%bYour current user does not have permissions to the docker socket - may require root / docker group. Exiting.%b\n" "$c_red" "$c_reset"; exit 1; }
if docker compose version &>/dev/null; then DockerBin="docker compose" ;
@@ -412,6 +474,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}}')
@@ -420,10 +486,10 @@ check_image() {
# Checking for errors while setting the variable
if RegHash=$($t_out "$regbin" -v error image digest --list "$RepoUrl" 2>&1); then
- if [[ "$LocalHash" = *"$RegHash"* ]]; then
+ 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"
@@ -437,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
+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
@@ -467,6 +533,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[*]:-}"))
@@ -496,6 +564,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
@@ -516,14 +586,24 @@ 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=""
- 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; } }
+
+ # 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
@@ -536,65 +616,90 @@ if [[ -n "${GotUpdates:-}" ]]; then
continue
fi
- 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"
-
- 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=""
- 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")
- [[ "$ContOnlySpecific" == "null" ]] && ContRestartStack=""
-
- # Checking if compose-values are empty - hence started with docker run
- [[ -z "$ContPath" ]] && 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)
+ 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
- CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s/%s " "$ContPath" "$conf"; done)
+ printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1
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
- printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
- # 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
- 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
- printf "\n%bAll done!%b\n" "$c_green" "$c_reset"
+ printf "\n%bDone pulling updates.%b\n" "$c_green" "$c_reset"
+
+ 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
+ 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")
+ [[ "$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=""
+ 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
+
+ # 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
+
+ # 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
+ 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
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!
___
___
diff --git a/extras/dockcheck_colour.png b/extras/dockcheck_colour.png
new file mode 100644
index 0000000..1ae6f8f
Binary files /dev/null and b/extras/dockcheck_colour.png differ
diff --git a/notify_templates/notify_DSM.sh b/notify_templates/notify_DSM.sh
index 17d697f..8da3c54 100644
--- a/notify_templates/notify_DSM.sh
+++ b/notify_templates/notify_DSM.sh
@@ -1,32 +1,48 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_DSM_VERSION="v0.2"
+NOTIFY_DSM_VERSION="v0.5"
# INFO: ssmtp is deprecated - consider to use msmtp instead.
#
# mSMTP/sSMTP has to be installed and configured manually.
# The existing DSM Notification Email configuration will be used automatically.
-# Do not modify this file directly. Set DSM_SENDMAILTO and DSM_SUBJECTTAG in your dockcheck.config file.
+# 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 DSM_SENDMAILTO and DSM_SUBJECTTAG in your dockcheck.config file.
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() {
+ 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')
@@ -43,6 +59,11 @@ Content-Transfer-Encoding: 7bit
$MessageBody
From $SenderName
__EOF
+
+if [[ $? -gt 0 ]]; then
+ NotifyError=true
+fi
+
# This ensures DSM's container manager will also see the update
/var/packages/ContainerManager/target/tool/image_upgradable_checker
}
diff --git a/notify_templates/notify_HA.sh b/notify_templates/notify_HA.sh
new file mode 100755
index 0000000..e1f52bd
--- /dev/null
+++ b/notify_templates/notify_HA.sh
@@ -0,0 +1,44 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+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)
+# 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 HA_ENTITY, HA_URL and HA_TOKEN in your dockcheck.config file.
+
+trigger_HA_notification() {
+ 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}' )
+
+ curl -S -o /dev/null ${CurlArgs} \
+ -H "Authorization: Bearer $AccessToken" \
+ -H "Content-Type: application/json" \
+ -d "$JsonData" -X POST $Url
+
+ if [[ $? -gt 0 ]]; then
+ NotifyError=true
+ fi
+}
diff --git a/notify_templates/notify_apprise.sh b/notify_templates/notify_apprise.sh
index e71a4df..d2ab0a5 100644
--- a/notify_templates/notify_apprise.sh
+++ b/notify_templates/notify_apprise.sh
@@ -1,21 +1,38 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_APPRISE_VERSION="v0.2"
+NOTIFY_APPRISE_VERSION="v0.4"
#
# Required receiving services must already be set up.
-# Do not modify this file directly. Set APPRISE_PAYLOAD in your dockcheck.config file.
+# 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 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
+ fi
fi
# e.g. APPRISE_PAYLOAD='mailto://myemail:mypass@gmail.com
@@ -23,8 +40,12 @@ trigger_apprise_notification() {
# pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b
# tgram://{bot_token}/{chat_id}/'
- if [[ -n "${APPRISE_URL:-}" ]]; then
- AppriseURL="${APPRISE_URL}"
- curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL # e.g. APPRISE_URL=http://apprise.mydomain.tld:1234/notify/apprise
+ 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
+ NotifyError=true
+ fi
fi
}
\ No newline at end of file
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
diff --git a/notify_templates/notify_discord.sh b/notify_templates/notify_discord.sh
index a28cda5..4ac050a 100644
--- a/notify_templates/notify_discord.sh
+++ b/notify_templates/notify_discord.sh
@@ -1,18 +1,39 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_DISCORD_VERSION="v0.2"
+NOTIFY_DISCORD_VERSION="v0.5"
#
# Required receiving services must already be set up.
-# Do not modify this file directly. 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
+# 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.
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
- MsgBody="{\"username\":\"$FromHost\",\"content\":\"$MessageBody\"}"
- curl -sS -o /dev/null --fail -X POST -H "Content-Type: application/json" -d "$MsgBody" "$DiscordWebhookUrl"
+ 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" \
+ --arg body "$MessageBody" \
+ '{"username": $username, "content": $body}' )
+
+ curl -S -o /dev/null ${CurlArgs} -X POST -H "Content-Type: application/json" -d "$JsonData" "$DiscordWebhookUrl"
+
+ if [[ $? -gt 0 ]]; then
+ NotifyError=true
+ fi
}
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 f66e7e8..66e04ef 100644
--- a/notify_templates/notify_gotify.sh
+++ b/notify_templates/notify_gotify.sh
@@ -1,18 +1,32 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_GOTIFY_VERSION="v0.3"
+NOTIFY_GOTIFY_VERSION="v0.5"
#
# Required receiving services must already be set up.
-# Do not modify this file directly. 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
+# 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.
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"
@@ -20,11 +34,15 @@ trigger_gotify_notification() {
ContentType="text/plain"
fi
- JsonData=$( jq -n \
+ JsonData=$( "$jqbin" -n \
--arg body "$MessageBody" \
--arg title "$MessageTitle" \
--arg type "$ContentType" \
'{message: $body, title: $title, priority: 5, extras: {"client::display": {"contentType": $type}}}' )
- curl -s -S --data "${JsonData}" -H 'Content-Type: application/json' -X POST "${GotifyUrl}" 1> /dev/null
+ curl -S -o /dev/null ${CurlArgs} --data "${JsonData}" -H 'Content-Type: application/json' -X POST "${GotifyUrl}" 1> /dev/null
+
+ if [[ $? -gt 0 ]]; then
+ NotifyError=true
+ fi
}
diff --git a/notify_templates/notify_matrix.sh b/notify_templates/notify_matrix.sh
index 87215ae..fbdb332 100644
--- a/notify_templates/notify_matrix.sh
+++ b/notify_templates/notify_matrix.sh
@@ -1,21 +1,40 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_MATRIX_VERSION="v0.2"
+NOTIFY_MATRIX_VERSION="v0.5"
#
# Required receiving services must already be set up.
-# Do not modify this file directly. 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
+# 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.
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
- MsgBody="{\"msgtype\":\"m.text\",\"body\":\"$MessageBody\"}"
+ 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=$($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 -sS -o /dev/null --fail -X POST "$MatrixServer/_matrix/client/r0/rooms/$Room_id/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
-}
\ No newline at end of file
+ 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
+ fi
+}
diff --git a/notify_templates/notify_ntfy-sh.sh b/notify_templates/notify_ntfy-sh.sh
deleted file mode 100644
index 0b5cc3a..0000000
--- a/notify_templates/notify_ntfy-sh.sh
+++ /dev/null
@@ -1,27 +0,0 @@
-### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_NTFYSH_VERSION="v0.3"
-#
-# Setup app and subscription at https://ntfy.sh
-# Do not modify this file directly. Set NTFY_TOPIC_NAME in your dockcheck.config file.
-
-if [[ -z "${NTFY_TOPIC_NAME:-}" ]]; then
- printf "Ntfy.sh notification channel enabled, but required configuration variables are missing. Ntfy.sh notifications will not be sent.\n"
-
- remove_channel ntfy-sh
-fi
-
-trigger_ntfy-sh_notification() {
- NtfyUrl="ntfy.sh/${NTFY_TOPIC_NAME}" # e.g. NTFY_TOPIC_NAME=YourUniqueTopicName
-
- if [[ "$PrintMarkdownURL" == true ]]; then
- ContentType="Markdown: yes"
- else
- ContentType="Markdown: no" #text/plain
- fi
-
- curl -sS -o /dev/null --show-error --fail \
- -H "Title: $MessageTitle" \
- -H "$ContentType" \
- -d "$MessageBody" \
- "$NtfyUrl"
-}
diff --git a/notify_templates/notify_ntfy.sh b/notify_templates/notify_ntfy.sh
new file mode 100644
index 0000000..dff7234
--- /dev/null
+++ b/notify_templates/notify_ntfy.sh
@@ -0,0 +1,56 @@
+### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
+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.
+
+trigger_ntfy_notification() {
+ 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
+
+ if [[ "$PrintMarkdownURL" == true ]]; then
+ ContentType="Markdown: yes"
+ else
+ ContentType="Markdown: no" #text/plain
+ fi
+
+ if [[ -n "${!NtfyAuthVar:-}" ]]; then
+ NtfyAuth="-u ${!NtfyAuthVar}"
+ else
+ NtfyAuth=""
+ fi
+
+ curl -S -o /dev/null ${CurlArgs} \
+ -H "Title: $MessageTitle" \
+ -H "$ContentType" \
+ -d "$MessageBody" \
+ $NtfyAuth \
+ -L "$NtfyUrl"
+
+ if [[ $? -gt 0 ]]; then
+ NotifyError=true
+ fi
+}
diff --git a/notify_templates/notify_pushbullet.sh b/notify_templates/notify_pushbullet.sh
index 4bad2ff..b061e1c 100644
--- a/notify_templates/notify_pushbullet.sh
+++ b/notify_templates/notify_pushbullet.sh
@@ -1,20 +1,38 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_PUSHBULLET_VERSION="v0.2"
+NOTIFY_PUSHBULLET_VERSION="v0.4"
#
# Required receiving services must already be set up.
# Requires jq installed and in PATH.
-# Do not modify this file directly. 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
+# 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 PUSHBULLET_TOKEN and PUSHBULLET_URL in your dockcheck.config file.
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
- jq -n --arg title "$MessageTitle" --arg body "$MessageBody" '{body: $body, title: $title, type: "note"}' | curl -sS -o /dev/null --show-error --fail -X POST -H "Access-Token: $PushToken" -H "Content-type: application/json" $PushUrl -d @-
-}
\ No newline at end of file
+ "$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 @-
+
+ if [[ $? -gt 0 ]]; then
+ NotifyError=true
+ fi
+}
diff --git a/notify_templates/notify_pushover.sh b/notify_templates/notify_pushover.sh
index 16fff6a..92eea46 100644
--- a/notify_templates/notify_pushover.sh
+++ b/notify_templates/notify_pushover.sh
@@ -1,26 +1,45 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_PUSHOVER_VERSION="v0.2"
+NOTIFY_PUSHOVER_VERSION="v0.4"
#
# Required receiving services must already be set up.
# Requires jq installed and in PATH.
-# Do not modify this file directly. 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
+# 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 PUSHOVER_USER_KEY, PUSHOVER_TOKEN, and PUSHOVER_URL in your dockcheck.config file.
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 -sS -o /dev/null --show-error --fail -X POST \
+ curl -S -o /dev/null ${CurlArgs} -X POST \
-F "token=$PushoverToken" \
-F "user=$PushoverUserKey" \
-F "title=$MessageTitle" \
-F "message=$MessageBody" \
$PushoverUrl
+
+ if [[ $? -gt 0 ]]; then
+ NotifyError=true
+ fi
}
\ No newline at end of file
diff --git a/notify_templates/notify_slack.sh b/notify_templates/notify_slack.sh
index 6dc3b28..e2616e2 100644
--- a/notify_templates/notify_slack.sh
+++ b/notify_templates/notify_slack.sh
@@ -1,22 +1,40 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_SLACK_VERSION="v0.2"
+NOTIFY_SLACK_VERSION="v0.4"
#
# Setup app and token at https://api.slack.com/tutorials/tracks/posting-messages-with-curl
-# Do not modify this file directly. 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
+# 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.
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 -sS -o /dev/null --show-error --fail \
+ curl -S -o /dev/null ${CurlArgs} \
-d "text=$MessageBody" -d "channel=$ChannelID" \
-H "Authorization: Bearer $AccessToken" \
-X POST $SlackUrl
+
+ if [[ $? -gt 0 ]]; then
+ NotifyError=true
+ fi
}
diff --git a/notify_templates/notify_smtp.sh b/notify_templates/notify_smtp.sh
index 8573640..89bd9bc 100644
--- a/notify_templates/notify_smtp.sh
+++ b/notify_templates/notify_smtp.sh
@@ -1,31 +1,49 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_SMTP_VERSION="v0.2"
+NOTIFY_SMTP_VERSION="v0.5"
# INFO: ssmtp is depcerated - consider to use msmtp instead.
#
# mSMTP/sSMTP has to be installed and configured manually.
-# Do not modify this file directly. 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
+# 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 SMTP_MAIL_FROM, SMTP_MAIL_TO, and SMTP_SUBJECT_TAG in your dockcheck.config file.
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() {
-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>
@@ -38,4 +56,8 @@ Content-Transfer-Encoding: 7bit
$MessageBody
__EOF
+
+if [[ $? -gt 0 ]]; then
+ NotifyError=true
+fi
}
diff --git a/notify_templates/notify_telegram.sh b/notify_templates/notify_telegram.sh
index 1230524..785a037 100644
--- a/notify_templates/notify_telegram.sh
+++ b/notify_templates/notify_telegram.sh
@@ -1,27 +1,52 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_TELEGRAM_VERSION="v0.2"
+NOTIFY_TELEGRAM_VERSION="v0.5"
#
# Required receiving services must already be set up.
-# Do not modify this file directly. 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
+# 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.
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"}
- TelegramData="{\"chat_id\":\"$TelegramChatId\",\"text\":\"$MessageBody\",\"message_thread_id\":\"$TelegramTopicID\",\"disable_notification\": false}"
+ TelegramTopicID=${!TelegramTopicIdVar:="0"}
- curl -sS -o /dev/null --fail -X POST "$TelegramUrl/sendMessage" -H 'Content-Type: application/json' -d "$TelegramData"
+ JsonData=$( "$jqbin" -n \
+ --arg chatid "$TelegramChatId" \
+ --arg text "$MessageBody" \
+ --arg thread "$TelegramTopicID" \
+ --arg parse_mode "$ParseMode" \
+ '{"chat_id": $chatid, "text": $text, "message_thread_id": $thread, "disable_notification": false, "parse_mode": $parse_mode, "disable_web_page_preview": true}' )
+
+ curl -S -o /dev/null ${CurlArgs} -X POST "$TelegramUrl/sendMessage" -H 'Content-Type: application/json' -d "$JsonData"
+
+ if [[ $? -gt 0 ]]; then
+ NotifyError=true
+ fi
}
diff --git a/notify_templates/notify_v2.sh b/notify_templates/notify_v2.sh
index 3beb5ef..a44870a 100644
--- a/notify_templates/notify_v2.sh
+++ b/notify_templates/notify_v2.sh
@@ -1,84 +1,406 @@
-NOTIFY_V2_VERSION="v0.1"
+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.
+# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script and rename to notify.sh.
# Enable and configure all required notification variables in your dockcheck.config file, e.g.:
# NOTIFY_CHANNELS=apprise gotify slack
# SLACK_TOKEN=xoxb-some-token-value
# GOTIFY_TOKEN=some.token
+# Number of seconds to snooze identical update notifications based on local image name
+# or dockcheck.sh/notify.sh template file updates.
+# 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:-} )
-FromHost=$(hostname)
+# 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 2>/dev/null)" || FromHost="$(hostname 2>/dev/null)" || FromHost="UNKNOWN"
+
+CurrentEpochTime=$(date +"%Y-%m-%dT%H:%M:%S")
+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 "${ScriptWorkDir}/notify_templates/notify_${channel}.sh"
-done
+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}" -le "${CheckEpochSeconds}" ]]; then
+ printf "true"
+ else
+ printf "false"
+ fi
+ else
+ 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 "${#Unsnoozed[@]}"
+}
+
+update_snooze() {
+ for arg in "$@"
+ do
+ read -a entry <<< "${arg}"
+ found=$(grep -w "${entry[0]}" "${SnoozeFile}" || printf "")
+
+ if [[ -n "${found}" ]]; then
+ sed -e "s/${entry[0]}.*/${entry[0]} ${CurrentEpochTime}/" "${SnoozeFile}" > "${SnoozeFile}.new"
+ mv "${SnoozeFile}.new" "${SnoozeFile}"
+ else
+ printf "${entry[0]} ${CurrentEpochTime}\n" >> "${SnoozeFile}"
+ fi
+ done
+}
+
+cleanup_snooze() {
+ unset NotifyEntries
+ NotifyEntries=()
+ switch=""
+
+ for arg in "$@"
+ do
+ read -a entry <<< "${arg}"
+ NotifyEntries+=("${entry[0]}")
+ done
+
+ if [[ ! "${NotifyEntries[@]}" == *".sh"* ]]; then
+ switch="-v"
+ fi
+
+ while read -r entry datestamp; do
+ if [[ ! "${NotifyEntries[@]}" == *"$entry"* ]]; then
+ sed -e "/${entry}/d" "${SnoozeFile}" > "${SnoozeFile}.new"
+ mv "${SnoozeFile}.new" "${SnoozeFile}"
+ fi
+ 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=("$@")
+
+ [[ -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
- printf "\nSending ${channel} notification\n"
+ local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedContainers}" "container")
+ if [[ "${SkipNotification}" == "false" ]]; then
+ local template=$(get_channel_template "${channel}")
- MessageTitle="$FromHost - updates available."
- # Setting the MessageBody variable here.
- printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString\n"
+ # Formats UpdToString variable per channel settings
+ format_output "container_update" "$(output_format "${channel}")" "🐋 Containers on $FromHost with updates available:\n\n"
- exec_if_exists trigger_${channel}_notification "$@"
+ # 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
}
### Set DISABLE_DOCKCHECK_NOTIFICATION=false in dockcheck.config
### to not send notifications when dockcheck itself has updates.
dockcheck_notification() {
- if [[ ! "${DISABLE_DOCKCHECK_NOTIFICATION:-}" = "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 [[ ! "${DISABLE_DOCKCHECK_NOTIFICATION:-}" == "true" ]]; then
+ UnsnoozedDockcheck=$(unsnoozed_count "dockcheck\.sh")
+ NotifyError=false
+ Notified=false
+
+ MessageTitle="$FromHost - New version of dockcheck available."
+ UpdToString="dockcheck.sh,$1,$2,\"$3\""
- 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 trigger_${channel}_notification
+ 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
done
+
+ if [[ "${Notified}" == "true" ]]; then
+ [[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "dockcheck.sh"
+ printf "\n"
+ fi
fi
+
+ return 0
}
-### Set DISABLE_NOTIFY_UPDATE_NOTIFICATION=false in dockcheck.config
+### Set DISABLE_NOTIFY_NOTIFICATION=false in dockcheck.config
### to not send notifications when notify scripts themselves have updates.
notify_update_notification() {
- if [[ ! "${DISABLE_NOTIFY_UPDATE_NOTIFICATION:-}" = "true" ]]; then
- update_channels=( "${enabled_notify_channels[@]}" "v2" )
+ if [[ ! "${DISABLE_NOTIFY_NOTIFICATION:-}" == "true" ]]; then
+ NotifyError=false
+ NotifyUpdates=()
+ Notified=false
- for notify_script in "${update_channels[@]}"; do
- upper_channel=$(tr '[:lower:]' '[:upper:]' <<< "$notify_script")
- VersionVar="NOTIFY_${upper_channel}_VERSION"
- if [[ -n "${!VersionVar}" ]]; then
- RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_${notify_script}.sh"
- LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_${upper_channel}_VERSION/s/NOTIFY_${upper_channel}_VERSION=//p" | tr -d '"')"
- LatestNotifyRelease=${LatestNotifyRelease:-undefined}
- if [[ ! "${LatestNotifyRelease}" = "undefined" ]]; then
- if [[ "${!VersionVar}" != "$LatestNotifyRelease" ]] ; then
- MessageTitle="$FromHost - New version of notify_${notify_script}.sh available."
+ UpdateChannels=( "${enabled_notify_templates[@]}" "v2" )
- printf -v MessageBody "notify_${notify_script}.sh update available:\n ${!VersionVar} -> $LatestNotifyRelease\n"
+ for NotifyScript in "${UpdateChannels[@]}"; do
+ 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")"
+ if [[ ! "${LatestNotifySnippet}" == "undefined" ]]; then
+ LatestNotifyRelease="$(echo "$LatestNotifySnippet" | sed -n "/${VersionVar}/s/${VersionVar}=//p" | tr -d '"')"
- for channel in "${enabled_notify_channels[@]}"; do
- printf "Sending notify_${notify_script}.sh update notification - ${channel}\n"
- exec_if_exists trigger_${channel}_notification
- done
+ if [[ "${!VersionVar}" != "${LatestNotifyRelease}" ]] ; then
+ NotifyUpdates+=("${NotifyScript}.sh ${!VersionVar} -> ${LatestNotifyRelease}")
fi
fi
fi
done
+
+ 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
}
diff --git a/notify_templates/urls.list b/notify_templates/urls.list
index 31ad44a..e69838a 100644
--- a/notify_templates/urls.list
+++ b/notify_templates/urls.list
@@ -1,49 +1,105 @@
-# This is a list of container names and releasenote urls, separated by space.
-# Modify, add and (if necessary) remove to fit your needs.
# Additions are welcome! Append your list to the git-repo, use generic names and sensible urls.
+# Modify, add and (if necessary) remove to fit your needs.
+# This is a list of container names and releasenote urls, separated by space.
-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
-vaultwarden-server https://github.com/dani-garcia/vaultwarden/releases
-bruceforce-vaultwarden-backup https://github.com/Bruceforce/vaultwarden-backup/blob/main/CHANGELOG.md
actual_server https://actualbudget.org/blog
-gotify https://github.com/gotify/server/releases
-traefik https://github.com/traefik/traefik/releases
-caddy https://github.com/caddyserver/caddy/releases
-homarr https://github.com/homarr-labs/homarr/releases
-dozzle https://github.com/amir20/dozzle/releases
-beszel https://github.com/henrygd/beszel/releases
-forgejo https://codeberg.org/forgejo/forgejo/releases
-dockge https://github.com/louislam/dockge/releases
-cup https://github.com/sergi0g/cup/releases
-
-calibre https://github.com/linuxserver/docker-calibre/releases
-calibre-web https://github.com/linuxserver/docker-calibre-web/releases
-readarr https://github.com/Readarr/Readarr/releases
+adguardhome https://github.com/AdguardTeam/AdGuardHome/releases
+apprise-api https://github.com/linuxserver/docker-apprise-api/releases
audiobookshelf https://github.com/advplyr/audiobookshelf/releases
-
-gluetun https://github.com/qdm12/gluetun/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
+immich_redis https://github.com/valkey-io/valkey/releases
+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
+lubelogger https://github.com/hargata/lubelog/releases
+mattermost https://github.com/mattermost/mattermost/releases
+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
prowlarr-ls https://github.com/linuxserver/docker-prowlarr/releases
+qbittorrent https://www.qbittorrent.org/news
+qbittorrent-nox https://www.qbittorrent.org/news
+radarr https://github.com/Radarr/Radarr/releases/
+radarr-ls https://github.com/linuxserver/docker-radarr/releases
+readarr https://github.com/Readarr/Readarr/releases
+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
-sonarr https://github.com/linuxserver/docker-sonarr/releases
-radarr https://github.com/linuxserver/docker-radarr/releases
-lidarr https://github.com/linuxserver/docker-lidarr/releases
-jellyseerr https://github.com/Fallenbagel/jellyseerr/releases
-jellyfin https://github.com/jellyfin/jellyfin/releases
-tautulli https://github.com/Tautulli/Tautulli/releases
-cleanuperr https://github.com/flmorg/cleanuperr/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
-
-home-assistant https://github.com/home-assistant/docker/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
-mqtt https://github.com/eclipse/mosquitto/tags
-
-bookstack https://github.com/BookStackApp/BookStack/releases
-lubelogger https://github.com/hargata/lubelog/releases
-mealie https://github.com/mealie-recipes/mealie/releases
-flatnotes https://github.com/dullage/flatnotes/releases