mirror of
https://github.com/mag37/dockcheck.git
synced 2026-04-18 02:17:46 +00:00
Compare commits
20 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
24cae63b61 | ||
|
|
05e5b23e7b | ||
|
|
be58805824 | ||
|
|
af0d0d3f6e | ||
|
|
7d1e1637f9 | ||
|
|
31a45f1d84 | ||
|
|
37f33d7a06 | ||
|
|
732a5e69cd | ||
|
|
9156cc44e1 | ||
|
|
fbc9a252f5 | ||
|
|
1f374b5003 | ||
|
|
563dbb8b42 | ||
|
|
31bb2008b9 | ||
|
|
cfa74adc3d | ||
|
|
e2dbd69c5e | ||
|
|
98e996caa3 | ||
|
|
a1e7446753 | ||
|
|
69c06de1bd | ||
|
|
d37e1a1024 | ||
|
|
77f024bb81 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -7,3 +7,5 @@
|
|||||||
regctl
|
regctl
|
||||||
# ignore snooze file
|
# ignore snooze file
|
||||||
snooze.list
|
snooze.list
|
||||||
|
# ignore updates file
|
||||||
|
updates_available.txt
|
||||||
164
README.md
164
README.md
@@ -1,13 +1,15 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="extras/dockcheck_logo_by_booYah187.png" width="160" title="dockcheck">
|
<img src="extras/dockcheck_colour.png" width="300" title="dockcheck">
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://img.shields.io/badge/bash-4.3-green?style=flat-square&logo=gnubash" alt="bash">
|
<img src="https://img.shields.io/badge/bash-4.3-green?style=flat-square&logo=gnubash" alt="bash">
|
||||||
<a href="https://www.gnu.org/licenses/gpl-3.0.html"><img src="https://img.shields.io/badge/license-GPLv3-red?style=flat-square" alt="GPLv3"></a>
|
<a href="https://www.gnu.org/licenses/gpl-3.0.html"><img src="https://img.shields.io/badge/license-GPLv3-red?style=flat-square" alt="GPLv3"></a>
|
||||||
<img src="https://img.shields.io/github/v/tag/mag37/dockcheck?style=flat-square&label=release" alt="release">
|
<img src="https://img.shields.io/github/v/tag/mag37/dockcheck?style=flat-square&label=release" alt="release">
|
||||||
|
<br>
|
||||||
<a href="https://ko-fi.com/mag37"><img src="https://img.shields.io/badge/-Ko--fi-grey?style=flat-square&logo=Ko-fi" alt="Buy me a Coffee"></a>
|
<a href="https://ko-fi.com/mag37"><img src="https://img.shields.io/badge/-Ko--fi-grey?style=flat-square&logo=Ko-fi" alt="Buy me a Coffee"></a>
|
||||||
<a href="https://liberapay.com/user-bin-rob/donate"><img src="https://img.shields.io/badge/-LiberaPay-grey?style=flat-square&logo=liberapay" alt="LiberaPay"></a>
|
<a href="https://liberapay.com/user-bin-rob/donate"><img src="https://img.shields.io/badge/-LiberaPay-grey?style=flat-square&logo=liberapay" alt="LiberaPay"></a>
|
||||||
<a href="https://github.com/sponsors/mag37"><img src="https://img.shields.io/badge/-Sponsor-grey?style=flat-square&logo=github" alt="Github Sponsor"></a>
|
<a href="https://github.com/sponsors/mag37"><img src="https://img.shields.io/badge/-Sponsor-grey?style=flat-square&logo=github" alt="Github Sponsor"></a>
|
||||||
|
<a href="https://www.paypal.com/donate/?business=P2V5MCWRGCNBG&no_recurring=0¤cy_code=SEK"><img src="https://img.shields.io/badge/-PayPal-grey?style=flat-square&logo=paypal" alt="PayPal donation"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2 align="center">CLI tool to automate docker image updates or notifying when updates are available.</h2>
|
<h2 align="center">CLI tool to automate docker image updates or notifying when updates are available.</h2>
|
||||||
@@ -18,36 +20,40 @@
|
|||||||
<h5 align="center">For Podman - see the fork <a href="https://github.com/sudo-kraken/podcheck">sudo-kraken/podcheck</a>!</h4>
|
<h5 align="center">For Podman - see the fork <a href="https://github.com/sudo-kraken/podcheck">sudo-kraken/podcheck</a>!</h4>
|
||||||
|
|
||||||
___
|
___
|
||||||
## :bell: Changelog
|
## Changelog
|
||||||
|
|
||||||
- **v0.6.7**: Snooze feature, curl, and consolidation
|
- **v0.7.3**: Bugfix - unquoted variable in printf list caused occasional issues.
|
||||||
- Added snooze feature to delay notifications
|
- **v0.7.2**:
|
||||||
- Added configurable default curl arguments
|
- Label rework:
|
||||||
- Consolidated and standardized notify template update notifications
|
- Moved up label logic to work globally on the current run.
|
||||||
- Added curl error handling
|
- Only iterating on labeled containers when used with `-l` option, not listing others.
|
||||||
- **v0.6.6**: Notify_v2 bugfixes
|
- Clarified messaging and readme/help texts.
|
||||||
- Clearer readme and error messages
|
- List reformatting for "available updates" numbering to easier highlight and copy:
|
||||||
- Sourcing templates from either project root or subdirectory
|
- Padded with zero, changed `)` to `-`, example: `02 - homer`
|
||||||
- Consistent newline handling
|
- Can be selected by writing `2,3,4` or `02,03,04`.
|
||||||
- Added (when using `-d`) days old message to notification title
|
- **v0.7.1**:
|
||||||
- Added ntfy self hosted domain option to config
|
- Added support for multiple notifications using the same template
|
||||||
- jq fixes to templates (and properly using $jqbin)
|
- Added support for notification output format
|
||||||
- **v0.6.5**: Refactored notification logic. See notify_templates/notify_v2.sh for upgrade steps.
|
- Added support for file output
|
||||||
- Added helper functions to simplify sourcing files and executing functions if they exist.
|
- Added optional configuration variables per channel to (replace `<channel>` with any channel name):
|
||||||
- Created notify_v2.sh wrapper script.
|
- `<channel>_TEMPLATE` : Specify a template
|
||||||
- Simplified and consolidated notification logic within notify_v2.sh.
|
- `<channel>_SKIPSNOOZE` : Skip snooze
|
||||||
- Added support for notification management via environment variables.
|
- `<channel>_CONTAINERSONLY` : Only notify for docker container related updates
|
||||||
- Moved notification secrets to **dockcheck.config**.
|
- `<channel>_ALLOWEMPTY` : Always send notifications, even when empty
|
||||||
- Added retries to wget/curl to not get empty responses when github is slow.
|
- `<channel>_OUTPUT` : Define output format
|
||||||
|
- **v0.7.0**:
|
||||||
|
- Bugfix: snooze dockcheck.sh-self-notification and some config clarification.
|
||||||
|
- Added authentication support to Ntfy.sh.
|
||||||
|
- Added suport for sendmail in the SMTP-template.
|
||||||
___
|
___
|
||||||
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## :mag_right: `dockcheck.sh`
|
## `dockcheck.sh`
|
||||||
```
|
```
|
||||||
$ ./dockcheck.sh -h
|
$ ./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
|
Example: dockcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
@@ -60,7 +66,7 @@ Options:
|
|||||||
-h Print this Help.
|
-h Print this Help.
|
||||||
-i Inform - send a preconfigured notification.
|
-i Inform - send a preconfigured notification.
|
||||||
-I Prints custom releasenote urls alongside each container with updates in CLI output (requires urls.list).
|
-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 Monochrome mode, no printf colour codes and hides progress bar.
|
||||||
-M Prints custom releasenote urls as markdown (requires template support).
|
-M Prints custom releasenote urls as markdown (requires template support).
|
||||||
-n No updates, only checking availability.
|
-n No updates, only checking availability.
|
||||||
@@ -94,7 +100,7 @@ After the updates are complete, you'll get prompted if you'd like to prune dangl
|
|||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
## :nut_and_bolt: Dependencies
|
## Dependencies
|
||||||
- Running docker (duh) and compose, either standalone or plugin. (see [Podman fork](https://github.com/sudo-kraken/podcheck)
|
- 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
|
- 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.
|
- POSIX `xargs`, usually default but can be installed with the `findutils` package - to enable async.
|
||||||
@@ -104,7 +110,7 @@ ___
|
|||||||
- User will be prompted to download `regctl` if not in `PATH` or `PWD`.
|
- 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](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
|
||||||
|
|
||||||
## :tent: Install Instructions
|
## Install Instructions
|
||||||
Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.
|
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`.
|
For OSX/macOS preferably use `/usr/local/bin`.
|
||||||
```sh
|
```sh
|
||||||
@@ -121,19 +127,21 @@ wget -O ~/.local/bin/dockcheck.sh "https://raw.githubusercontent.com/mag37/dockc
|
|||||||
Then call the script anywhere with just `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.
|
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/`.
|
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.
|
Alternatively create an alias where specific flags and values are set.
|
||||||
Example `alias dc=dockcheck.sh -p -x 10 -t 3`.
|
Example `alias dc=dockcheck.sh -p -x 10 -t 3`.
|
||||||
|
|
||||||
## :loudspeaker: Notifications
|
## Notifications
|
||||||
Trigger with the `-i` flag.
|
Triggered with the `-i` flag. Will send a list of containers with updates available and a notification when `dockcheck.sh` itself has an update.
|
||||||
If `notify.sh` is present and configured, it will be used. Otherwise, `notify_v2.sh` will be enabled.
|
`notify_templates/notify_v2.sh` is the default notification wrapper, if `notify.sh` is present and configured, it will override.
|
||||||
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!
|
Example of a cron scheduled job running non-interactive at 10'oclock excluding 1 container and sending notifications:
|
||||||
|
`0 10 * * * /home/user123/.local/bin/dockcheck.sh -nix 10 -e excluded_container1`
|
||||||
|
|
||||||
#### Installation and configuration:
|
#### Installation and configuration:
|
||||||
Make certain your project directory is laid out as below. You only need the notify_v2.sh file and any notification templates you wish to enable, but there is no harm in having all of them present.
|
Set up a directory structure as below.
|
||||||
|
You only need the `notify_templates/notify_v2.sh` file and any notification templates you wish to enable, but there is no harm in having all of them present.
|
||||||
```
|
```
|
||||||
.
|
.
|
||||||
├── notify_templates/
|
├── notify_templates/
|
||||||
@@ -142,6 +150,7 @@ Make certain your project directory is laid out as below. You only need the noti
|
|||||||
│ ├── notify_discord.sh
|
│ ├── notify_discord.sh
|
||||||
│ ├── notify_generic.sh
|
│ ├── notify_generic.sh
|
||||||
│ ├── notify_gotify.sh
|
│ ├── notify_gotify.sh
|
||||||
|
│ ├── notify_HA.sh
|
||||||
│ ├── notify_matrix.sh
|
│ ├── notify_matrix.sh
|
||||||
│ ├── notify_ntfy.sh
|
│ ├── notify_ntfy.sh
|
||||||
│ ├── notify_pushbullet.sh
|
│ ├── notify_pushbullet.sh
|
||||||
@@ -154,27 +163,26 @@ Make certain your project directory is laid out as below. You only need the noti
|
|||||||
├── dockcheck.sh
|
├── dockcheck.sh
|
||||||
└── urls.list # optional
|
└── 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 `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.
|
- Uncomment and set the environment variables related to the enabled notification channels. Eg. `GOTIFY_DOMAIN=""` + `GOTIFY_TOKEN=""`.
|
||||||
It is recommended to only edit the environmental variables in `dockcheck.config` and not make changes directly to the `notify_X.sh` template files within the `notify_templates` subdirectory.
|
|
||||||
If you wish to customize the notify templates yourself, you may copy them to your project root directory alongside the main `dockcheck.sh` script (where they will also be ignored by git).
|
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.
|
Customizing `notify_v2.sh` is handled the same as customizing the templates, but it must be renamed to `notify.sh` within the `dockcheck.sh` root directory.
|
||||||
|
|
||||||
|
|
||||||
#### Legacy installation and configuration:
|
|
||||||
Use a previous version of a `notify_X.sh` template file (tag v0.6.4 or earlier) from the **notify_templates** directory,
|
|
||||||
copy it to `notify.sh` alongside the script, modify it to your needs! (notify.sh is added to .gitignore)
|
|
||||||
|
|
||||||
#### Snooze feature:
|
#### Snooze feature:
|
||||||
**Use case:** You wish to be notified of available updates in a timely manner, but do not require reminders after the initial notification with the same frequency.
|
Configure to receive scheduled notifications only if they're new since the last notification - within a set time frame.
|
||||||
e.g. *Dockcheck is scheduled to run every hour. You will receive an update notification within an hour of availability.*
|
|
||||||
**Snooze enabled:** you will not receive another notification about updates for this container for a configurable period of time.
|
**Example:** *Dockcheck is scheduled to run every hour. You will receive an update notification within an hour of availability.*
|
||||||
**Snooze disabled:** you will receive additional notifications every hour.
|
**Snooze enabled:** You will not receive a repeated notification about an already notified update within the snooze duration.
|
||||||
|
**Snooze disabled:** You will receive additional (possibly repeated) notifications every hour.
|
||||||
|
|
||||||
|
To enable snooze uncomment the `SNOOZE_SECONDS` variable in your `dockcheck.config` and set it to the number of seconds you wish to prevent duplicate alerts.
|
||||||
|
Snooze is split into three categories; container updates, `dockcheck.sh` self updates and notification template updates.
|
||||||
|
|
||||||
To enable snooze, uncomment the `SNOOZE_SECONDS` variable in your `dockcheck.config` file and set it to the number of seconds you wish to prevent duplicate alerts.
|
|
||||||
The true snooze duration will be 60 seconds less than your configure value to account for minor scheduling or script run time issues.
|
|
||||||
If an update becomes available for an item that is not snoozed, notifications will be sent and include all available updates for that item's category, even snoozed items.
|
If an update becomes available for an item that is not snoozed, notifications will be sent and include all available updates for that item's category, even snoozed items.
|
||||||
`dockcheck.sh` updates, notification template updates, and container updates are considered three separate categories.
|
|
||||||
|
The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to account for minor scheduling or run time issues.
|
||||||
|
|
||||||
|
|
||||||
#### Current notify templates:
|
#### Current notify templates:
|
||||||
@@ -185,6 +193,7 @@ If an update becomes available for an item that is not snoozed, notifications wi
|
|||||||
- Read the [QuickStart](extras/apprise_quickstart.md)
|
- Read the [QuickStart](extras/apprise_quickstart.md)
|
||||||
- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications.
|
- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications.
|
||||||
- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
|
- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
|
||||||
|
- [Home Assistant](https://www.home-assistant.io/integrations/notify/) - Connection to the notify [integrations](https://www.home-assistant.io/integrations/#notifications).
|
||||||
- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
|
- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
|
||||||
- [Telegram](https://telegram.org/) - Telegram chat API.
|
- [Telegram](https://telegram.org/) - Telegram chat API.
|
||||||
- [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication.
|
- [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication.
|
||||||
@@ -195,7 +204,23 @@ If an update becomes available for an item that is not snoozed, notifications wi
|
|||||||
Further additions are welcome - suggestions or PRs!
|
Further additions are welcome - suggestions or PRs!
|
||||||
<sub><sup>Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).</sup></sub>
|
<sub><sup>Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).</sup></sub>
|
||||||
|
|
||||||
### :date: Release notes addon
|
#### 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 `<channel>` 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 `<channel>_SKIPSNOOZE` and set it to `true`.
|
||||||
|
- To configure the channel to only send container update notifications, add the variable `<channel>_CONTAINERSONLY` and set it to `true`.
|
||||||
|
- To send notifications even when there are no updates available, add the variable `<channel>_ALLOWEMPTY` and set it to `true`.
|
||||||
|
- To use another notification output format, add the variable `<channel>_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 `<channel>_TEMPLATE` to `dockcheck.config` where `<channel>` 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 `<channel>` in upper case as the prefix rather than the template name.
|
||||||
|
- For example, if `<channel>` is `mynotification` and the template configured is `slack`, you would need to set `MYNOTIFICATION_CHANNEL_ID` and `MYNOTIFICATION_ACCESS_TOKEN`.
|
||||||
|
|
||||||
|
### Release notes addon
|
||||||
There's a function to use a lookup-file to add release note URL's to the notification message.
|
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.
|
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.
|
Modify it as necessary, the names of interest in the left column needs to match your container names.
|
||||||
@@ -212,19 +237,19 @@ nginx -> https://github.com/docker-library/official-images/blob/master/library
|
|||||||
```
|
```
|
||||||
The `urls.list` file is just an example and I'd gladly see that people contribute back when they add their preferred URLs to their lists.
|
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!
|
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.sh`. To disable the subprocess function set `MaxAsync=0`.
|
||||||
|
|
||||||
|
|
||||||
## :chart_with_upwards_trend: Extra plugins and tools:
|
## Extra plugins and tools:
|
||||||
|
|
||||||
### :small_orange_diamond: Using dockcheck.sh with the Synology DSM
|
### Using dockcheck.sh with the Synology DSM
|
||||||
If you run your container through the *Container Manager GUI* - only notifications are supported.
|
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.
|
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).
|
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.
|
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:
|
This is done with the `-c` option, like this:
|
||||||
```
|
```
|
||||||
@@ -234,20 +259,20 @@ dockcheck.sh -c /path/to/exporter/directory
|
|||||||
See the [README.md](./addons/prometheus/README.md) for more detailed information on how to set it up!
|
See the [README.md](./addons/prometheus/README.md) for more detailed information on how to set it up!
|
||||||
<sub><sup>Contributed by [tdralle](https://github.com/tdralle).</sup></sub>
|
<sub><sup>Contributed by [tdralle](https://github.com/tdralle).</sup></sub>
|
||||||
|
|
||||||
### :small_orange_diamond: Zabbix config to monitor docker image updates
|
### Zabbix config to monitor docker image updates
|
||||||
If you already use Zabbix - this config will show numbers of available docker image updates on host.
|
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*
|
Example: *2 Docker Image updates on host-xyz*
|
||||||
See project: [thetorminal/zabbix-docker-image-updates](https://github.com/thetorminal/zabbix-docker-image-updates)
|
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).
|
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).
|
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.
|
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).
|
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:
|
Optionally add labels to compose-files. Currently these are the usable labels:
|
||||||
```
|
```
|
||||||
labels:
|
labels:
|
||||||
@@ -255,11 +280,13 @@ Optionally add labels to compose-files. Currently these are the usable labels:
|
|||||||
mag37.dockcheck.only-specific-container: true
|
mag37.dockcheck.only-specific-container: true
|
||||||
mag37.dockcheck.restart-stack: 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.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).
|
- `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.
|
`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):
|
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):
|
||||||
|
|
||||||
@@ -279,7 +306,7 @@ chmod 755 regctl
|
|||||||
```
|
```
|
||||||
Test it with `./regctl --help` and then either add the file to the same path as *dockcheck.sh* or in your path (eg. `~/.local/bin/regctl`).
|
Test it with `./regctl --help` and then either add the file to the same path as *dockcheck.sh* or in your path (eg. `~/.local/bin/regctl`).
|
||||||
|
|
||||||
## :whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls
|
## Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls
|
||||||
Due to recent changes in [Docker Hub usage and limits](https://docs.docker.com/docker-hub/usage/)
|
Due to recent changes in [Docker Hub usage and limits](https://docs.docker.com/docker-hub/usage/)
|
||||||
>Unauthenticated users: 10 pulls/hour
|
>Unauthenticated users: 10 pulls/hour
|
||||||
>Authenticated users with a free account: 100 pulls/hour
|
>Authenticated users with a free account: 100 pulls/hour
|
||||||
@@ -287,7 +314,7 @@ Due to recent changes in [Docker Hub usage and limits](https://docs.docker.com/d
|
|||||||
This is not an issue for registry checks. But if you have a large stack and pull more than 10 updates at once consider updating more often or to create a free account.
|
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`.
|
You could use/modify the login-wrapper function in the example below to automate the login prior to running `dockcheck.sh`.
|
||||||
|
|
||||||
### :guardsman: Function to auth with docker hub before running
|
### Function to auth with docker hub before running
|
||||||
**Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
|
**Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
|
||||||
```sh
|
```sh
|
||||||
function dchk {
|
function dchk {
|
||||||
@@ -296,31 +323,32 @@ function dchk {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## :warning: `-r flag` disclaimer and warning
|
## `-r flag` disclaimer and warning
|
||||||
**Wont auto-update the containers, only their images. (compose is recommended)**
|
**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` dont support using new images just by restarting a container.
|
||||||
Containers need to be manually stopped, removed and created again to run on the new image.
|
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!
|
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).
|
- No detailed error feedback (just skip + list what's skipped).
|
||||||
- Not respecting `--profile` options when re-creating the container.
|
- Not respecting `--profile` options when re-creating the container.
|
||||||
- Not working well with containers created by **Portainer**.
|
- 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).
|
- **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.
|
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`.
|
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.
|
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)
|
- [avegy](https://github.com/avegy)
|
||||||
- [eichhorn](https://github.com/eichhorn)
|
- [eichhorn](https://github.com/eichhorn)
|
||||||
- [stepdg](https://github.com/stepdg)
|
- [stepdg](https://github.com/stepdg)
|
||||||
|
- [acer2220](https://github.com/acer2220)
|
||||||
|
- [shgew](https://github.com/shgew)
|
||||||
___
|
___
|
||||||
|
|
||||||
### :floppy_disk: The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect.
|
### The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect.
|
||||||
|
|||||||
@@ -26,19 +26,20 @@
|
|||||||
#CurlRetryDelay=1 # Time between curl retries
|
#CurlRetryDelay=1 # Time between curl retries
|
||||||
#CurlRetryCount=3 # Max number of curl retries
|
#CurlRetryCount=3 # Max number of curl retries
|
||||||
#CurlConnectTimeout=5 # Time to wait for curl to establish a connection before failing
|
#CurlConnectTimeout=5 # Time to wait for curl to establish a connection before failing
|
||||||
|
#DisplaySourcedFiles=false # Display what files are being sourced/used
|
||||||
|
|
||||||
### Notify settings
|
### Notify settings
|
||||||
## All commented values are examples only. Modify as needed.
|
## 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
|
## 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 pushbullet pushover slack smtp telegram"
|
# NOTIFY_CHANNELS="apprise discord DSM file generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram file"
|
||||||
#
|
#
|
||||||
## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze
|
## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze
|
||||||
# SNOOZE_SECONDS=86400
|
# SNOOZE_SECONDS=86400
|
||||||
#
|
#
|
||||||
## Uncomment to not send notifications when dockcheck itself has updates.
|
## Uncomment and set to true to disable notifications when dockcheck itself has updates.
|
||||||
# DISABLE_DOCKCHECK_NOTIFICATION=false
|
# 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
|
# 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.
|
## Apprise configuration variables. Set APPRISE_PAYLOAD to make a CLI call or set APPRISE_URL to make an API request instead.
|
||||||
@@ -56,13 +57,18 @@
|
|||||||
# GOTIFY_DOMAIN="https://gotify.domain.tld"
|
# GOTIFY_DOMAIN="https://gotify.domain.tld"
|
||||||
# GOTIFY_TOKEN="token-value"
|
# GOTIFY_TOKEN="token-value"
|
||||||
#
|
#
|
||||||
|
# HA_ENTITY="entity"
|
||||||
|
# HA_TOKEN="token"
|
||||||
|
# HA_URL="https://your.homeassistant.url"
|
||||||
|
#
|
||||||
# MATRIX_ACCESS_TOKEN="token-value"
|
# MATRIX_ACCESS_TOKEN="token-value"
|
||||||
# MATRIX_ROOM_ID="myroom"
|
# MATRIX_ROOM_ID="myroom"
|
||||||
# MATRIX_SERVER_URL="https://matrix.yourdomain.tld"
|
# MATRIX_SERVER_URL="https://matrix.yourdomain.tld"
|
||||||
#
|
#
|
||||||
## ntfy.sh or your custom domain with no trailing /
|
## https://ntfy.sh or your custom domain with https:// and no trailing /
|
||||||
# NTFY_DOMAIN="ntfy.sh"
|
# NTFY_DOMAIN="https://ntfy.sh"
|
||||||
# NTFY_TOPIC_NAME="YourUniqueTopicName"
|
# NTFY_TOPIC_NAME="YourUniqueTopicName"
|
||||||
|
# NTFY_AUTH="" # set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":"
|
||||||
#
|
#
|
||||||
# PUSHBULLET_URL="https://api.pushbullet.com/v2/pushes"
|
# PUSHBULLET_URL="https://api.pushbullet.com/v2/pushes"
|
||||||
# PUSHBULLET_TOKEN="token-value"
|
# PUSHBULLET_TOKEN="token-value"
|
||||||
@@ -81,3 +87,6 @@
|
|||||||
# TELEGRAM_CHAT_ID="mychatid"
|
# TELEGRAM_CHAT_ID="mychatid"
|
||||||
# TELEGRAM_TOKEN="token-value"
|
# TELEGRAM_TOKEN="token-value"
|
||||||
# TELEGRAM_TOPIC_ID="0"
|
# TELEGRAM_TOPIC_ID="0"
|
||||||
|
#
|
||||||
|
# FILE_PATH="${ScriptWorkDir}/updates_available.txt"
|
||||||
|
|
||||||
|
|||||||
60
dockcheck.sh
60
dockcheck.sh
@@ -1,6 +1,6 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
VERSION="v0.6.7"
|
VERSION="v0.7.3"
|
||||||
# ChangeNotes: snooze feature (see readme), curl arguments, cleanup.
|
# ChangeNotes: Bugfix - unquoted variable in list. Also: Please consider donating.
|
||||||
Github="https://github.com/mag37/dockcheck"
|
Github="https://github.com/mag37/dockcheck"
|
||||||
RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
|
RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
|
||||||
|
|
||||||
@@ -14,20 +14,22 @@ ScriptPath="$(readlink -f "$0")"
|
|||||||
ScriptWorkDir="$(dirname "$ScriptPath")"
|
ScriptWorkDir="$(dirname "$ScriptPath")"
|
||||||
|
|
||||||
# Source helper functions
|
# Source helper functions
|
||||||
source_if_exists() {
|
|
||||||
if [[ -s "$1" ]]; then source "$1"; fi
|
|
||||||
}
|
|
||||||
|
|
||||||
source_if_exists_or_fail() {
|
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
|
# 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 Function
|
||||||
Help() {
|
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 "Example: dockcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall"
|
||||||
echo
|
echo
|
||||||
echo "Options:"
|
echo "Options:"
|
||||||
@@ -40,7 +42,7 @@ Help() {
|
|||||||
echo "-h Print this Help."
|
echo "-h Print this Help."
|
||||||
echo "-i Inform - send a preconfigured notification."
|
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 "-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 Monochrome mode, no printf colour codes and hides progress bar."
|
||||||
echo "-M Prints custom releasenote urls as markdown (requires template support)."
|
echo "-M Prints custom releasenote urls as markdown (requires template support)."
|
||||||
echo "-n No updates; only checking availability without interaction."
|
echo "-n No updates; only checking availability without interaction."
|
||||||
@@ -119,8 +121,11 @@ while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:" options; do
|
|||||||
done
|
done
|
||||||
shift "$((OPTIND-1))"
|
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:-}"
|
SearchName="${1:-}"
|
||||||
|
if [[ ! -z "$SearchName" ]]; then
|
||||||
|
SearchName="^(${SearchName//,/|})$"
|
||||||
|
fi
|
||||||
|
|
||||||
# Check if there's a new release of the script
|
# Check if there's a new release of the script
|
||||||
LatestSnippet="$(curl ${CurlArgs} -r 0-200 "$RawUrl" || printf "undefined")"
|
LatestSnippet="$(curl ${CurlArgs} -r 0-200 "$RawUrl" || printf "undefined")"
|
||||||
@@ -337,12 +342,13 @@ dependency_check() {
|
|||||||
dependency_check "regctl" "regbin" "https://github.com/regclient/regclient/releases/latest/download/regctl-linux-TEMP"
|
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"
|
dependency_check "jq" "jqbin" "https://github.com/jqlang/jq/releases/latest/download/jq-linux-TEMP"
|
||||||
|
|
||||||
# Numbered List function
|
# Numbered List function - pads with zero
|
||||||
# if urls.list exists add release note url per line
|
|
||||||
list_options() {
|
list_options() {
|
||||||
num=1
|
local total="${#Updates[@]}"
|
||||||
|
[[ ${#total} < 2 ]] && local pads=2 || local pads="${#total}"
|
||||||
|
local num=1
|
||||||
for update in "${Updates[@]}"; do
|
for update in "${Updates[@]}"; do
|
||||||
echo "$num) $update"
|
printf "%0*d - %s\n" "$pads" "$num" "$update"
|
||||||
((num++))
|
((num++))
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
@@ -418,6 +424,10 @@ check_image() {
|
|||||||
printf "%s\n" "NoUpdates !$i - not checked, no compose file"
|
printf "%s\n" "NoUpdates !$i - not checked, no compose file"
|
||||||
return
|
return
|
||||||
fi
|
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
|
local NoUpdates GotUpdates GotErrors
|
||||||
ImageId=$(docker inspect "$i" --format='{{.Image}}')
|
ImageId=$(docker inspect "$i" --format='{{.Image}}')
|
||||||
@@ -443,7 +453,7 @@ check_image() {
|
|||||||
# Make required functions and variables available to subprocesses
|
# Make required functions and variables available to subprocesses
|
||||||
export -f check_image datecheck
|
export -f check_image datecheck
|
||||||
export Excludes_string="${Excludes[*]:-}" # Can only export scalar variables
|
export Excludes_string="${Excludes[*]:-}" # Can only export scalar variables
|
||||||
export t_out regbin RepoUrl DaysOld DRunUp jqbin
|
export t_out regbin RepoUrl DaysOld DRunUp jqbin OnlyLabel
|
||||||
|
|
||||||
# Check for POSIX xargs with -P option, fallback without async
|
# Check for POSIX xargs with -P option, fallback without async
|
||||||
if (echo "test" | xargs -P 2 >/dev/null 2>&1) && [[ "$MaxAsync" != 0 ]]; then
|
if (echo "test" | xargs -P 2 >/dev/null 2>&1) && [[ "$MaxAsync" != 0 ]]; then
|
||||||
@@ -473,6 +483,8 @@ done < <( \
|
|||||||
xargs $XargsAsync -I {} bash -c 'check_image "{}"' \
|
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
|
# Sort arrays alphabetically
|
||||||
IFS=$'\n'
|
IFS=$'\n'
|
||||||
NoUpdates=($(sort <<<"${NoUpdates[*]:-}"))
|
NoUpdates=($(sort <<<"${NoUpdates[*]:-}"))
|
||||||
@@ -502,6 +514,8 @@ if [[ -n ${GotUpdates[*]:-} ]]; then
|
|||||||
if [[ -s "$ScriptWorkDir/urls.list" ]] && [[ "$PrintReleaseURL" == true ]]; then releasenotes; else Updates=("${GotUpdates[@]}"); fi
|
if [[ -s "$ScriptWorkDir/urls.list" ]] && [[ "$PrintReleaseURL" == true ]]; then releasenotes; else Updates=("${GotUpdates[@]}"); fi
|
||||||
[[ "$AutoMode" == false ]] && list_options || printf "%s\n" "${Updates[@]}"
|
[[ "$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"; }
|
[[ "$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
|
fi
|
||||||
|
|
||||||
# Optionally get updates if there's any
|
# Optionally get updates if there's any
|
||||||
@@ -526,10 +540,6 @@ if [[ -n "${GotUpdates:-}" ]]; then
|
|||||||
ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
|
ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
|
||||||
ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
|
ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
|
||||||
[[ "$ContPath" == "null" ]] && ContPath=""
|
[[ "$ContPath" == "null" ]] && ContPath=""
|
||||||
ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
|
|
||||||
[[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel=""
|
|
||||||
# Checking if Label Only -option is set, and if container got the label
|
|
||||||
[[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping."; continue; } }
|
|
||||||
|
|
||||||
# Checking if compose-values are empty - hence started with docker run
|
# Checking if compose-values are empty - hence started with docker run
|
||||||
if [[ -z "$ContPath" ]]; then
|
if [[ -z "$ContPath" ]]; then
|
||||||
@@ -561,15 +571,14 @@ if [[ -n "${GotUpdates:-}" ]]; then
|
|||||||
[[ "$ContName" == "null" ]] && ContName=""
|
[[ "$ContName" == "null" ]] && ContName=""
|
||||||
ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
|
ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
|
||||||
[[ "$ContEnv" == "null" ]] && ContEnv=""
|
[[ "$ContEnv" == "null" ]] && ContEnv=""
|
||||||
ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
|
|
||||||
[[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel=""
|
|
||||||
ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
|
ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
|
||||||
[[ "$ContRestartStack" == "null" ]] && ContRestartStack=""
|
[[ "$ContRestartStack" == "null" ]] && ContRestartStack=""
|
||||||
ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels")
|
ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels")
|
||||||
[[ "$ContOnlySpecific" == "null" ]] && ContRestartStack=""
|
[[ "$ContOnlySpecific" == "null" ]] && ContRestartStack=""
|
||||||
|
|
||||||
|
printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
|
||||||
# Checking if compose-values are empty - hence started with docker run
|
# Checking if compose-values are empty - hence started with docker run
|
||||||
[[ -z "$ContPath" ]] && continue
|
[[ -z "$ContPath" ]] && { echo "Not a compose container, skipping."; continue; }
|
||||||
|
|
||||||
# cd to the compose-file directory to account for people who use relative volumes
|
# 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; }
|
cd "$ContPath" || { printf "\n%bPath error - skipping%b %s" "$c_red" "$c_reset" "$i"; continue; }
|
||||||
@@ -585,7 +594,6 @@ if [[ -n "${GotUpdates:-}" ]]; then
|
|||||||
# Set variable when compose up should only target the specific container, not the stack
|
# Set variable when compose up should only target the specific container, not the stack
|
||||||
if [[ $OnlySpecific == true ]] || [[ $ContOnlySpecific == true ]]; then SpecificContainer="$ContName"; fi
|
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
|
# Check if the whole stack should be restarted
|
||||||
if [[ "$ContRestartStack" == true ]] || [[ "$ForceRestartStacks" == true ]]; then
|
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; }
|
${DockerBin} ${CompleteConfs} stop; ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
|
||||||
@@ -593,8 +601,8 @@ if [[ -n "${GotUpdates:-}" ]]; then
|
|||||||
${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
|
${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
if [[ "$AutoPrune" == false ]] && [[ "$AutoMode" == false ]]; then printf "\n"; read -rep "Would you like to prune dangling images? y/[n]: " AutoPrune; fi
|
if [[ "$AutoPrune" == false ]] && [[ "$AutoMode" == false ]]; then printf "\n"; read -rep "Would you like to prune all dangling images? y/[n]: " AutoPrune; fi
|
||||||
if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\n Auto pruning.."; docker image prune -f; fi
|
if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\nAuto pruning.."; docker image prune -f; fi
|
||||||
printf "\n%bAll done!%b\n" "$c_green" "$c_reset"
|
printf "\n%bAll done!%b\n" "$c_green" "$c_reset"
|
||||||
else
|
else
|
||||||
printf "\nNo updates installed, exiting.\n"
|
printf "\nNo updates installed, exiting.\n"
|
||||||
|
|||||||
BIN
extras/dockcheck_colour.png
Normal file
BIN
extras/dockcheck_colour.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 144 KiB |
@@ -1,5 +1,5 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_DSM_VERSION="v0.3"
|
NOTIFY_DSM_VERSION="v0.5"
|
||||||
# INFO: ssmtp is deprecated - consider to use msmtp instead.
|
# INFO: ssmtp is deprecated - consider to use msmtp instead.
|
||||||
#
|
#
|
||||||
# mSMTP/sSMTP has to be installed and configured manually.
|
# mSMTP/sSMTP has to be installed and configured manually.
|
||||||
@@ -10,25 +10,39 @@ NOTIFY_DSM_VERSION="v0.3"
|
|||||||
|
|
||||||
MSMTP=$(which msmtp)
|
MSMTP=$(which msmtp)
|
||||||
SSMTP=$(which ssmtp)
|
SSMTP=$(which ssmtp)
|
||||||
|
SENDMAIL=$(which sendmail)
|
||||||
|
|
||||||
if [ -n "$MSMTP" ] ; then
|
if [ -n "$MSMTP" ] ; then
|
||||||
MailPkg=$MSMTP
|
MailPkg=$MSMTP
|
||||||
elif [ -n "$SSMTP" ] ; then
|
elif [ -n "$SSMTP" ] ; then
|
||||||
MailPkg=$SSMTP
|
MailPkg=$SSMTP
|
||||||
|
elif [ -n "$SENDMAIL" ] ; then
|
||||||
|
MailPkg=$SENDMAIL
|
||||||
else
|
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
|
fi
|
||||||
|
|
||||||
trigger_DSM_notification() {
|
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"
|
CfgFile="/usr/syno/etc/synosmtp.conf"
|
||||||
|
|
||||||
# User variables:
|
# User variables:
|
||||||
# Automatically sends to your usual destination for synology DSM notification emails.
|
# 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.
|
# 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"
|
# 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"
|
# e.g. DSM_SUBJECTTAG="Email Subject Prefix"
|
||||||
SenderName=$(grep 'smtp_from_name' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
|
SenderName=$(grep 'smtp_from_name' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
|
||||||
SenderMail=$(grep 'smtp_from_mail' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
|
SenderMail=$(grep 'smtp_from_mail' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
|
||||||
|
|||||||
44
notify_templates/notify_HA.sh
Executable file
44
notify_templates/notify_HA.sh
Executable file
@@ -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
|
||||||
|
}
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_APPRISE_VERSION="v0.3"
|
NOTIFY_APPRISE_VERSION="v0.4"
|
||||||
#
|
#
|
||||||
# Required receiving services must already be set up.
|
# Required receiving services must already be set up.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
||||||
@@ -7,17 +7,28 @@ NOTIFY_APPRISE_VERSION="v0.3"
|
|||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set APPRISE_PAYLOAD in your dockcheck.config file.
|
# 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 API, set APPRISE_URL instead.
|
||||||
|
|
||||||
if [[ -z "${APPRISE_PAYLOAD:-}" ]] && [[ -z "${APPRISE_URL:-}" ]]; then
|
trigger_apprise_notification() {
|
||||||
printf "Apprise notification channel enabled, but required configuration variables are missing. Apprise notifications will not be sent.\n"
|
if [[ -n "$1" ]]; then
|
||||||
|
apprise_channel="$1"
|
||||||
|
else
|
||||||
|
apprise_channel="apprise"
|
||||||
|
fi
|
||||||
|
|
||||||
|
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
|
remove_channel apprise
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_apprise_notification() {
|
if [[ -n "${!ApprisePayloadVar:-}" ]]; then
|
||||||
|
|
||||||
if [[ -n "${APPRISE_PAYLOAD:-}" ]]; then
|
|
||||||
apprise -vv -t "$MessageTitle" -b "$MessageBody" \
|
apprise -vv -t "$MessageTitle" -b "$MessageBody" \
|
||||||
${APPRISE_PAYLOAD}
|
${!ApprisePayloadVar}
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
if [[ $? -gt 0 ]]; then
|
||||||
NotifyError=true
|
NotifyError=true
|
||||||
@@ -29,8 +40,8 @@ trigger_apprise_notification() {
|
|||||||
# pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b
|
# pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b
|
||||||
# tgram://{bot_token}/{chat_id}/'
|
# tgram://{bot_token}/{chat_id}/'
|
||||||
|
|
||||||
if [[ -n "${APPRISE_URL:-}" ]]; then
|
if [[ -n "${!AppriseUrlVar:-}" ]]; then
|
||||||
AppriseURL="${APPRISE_URL}"
|
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
|
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
|
if [[ $? -gt 0 ]]; then
|
||||||
|
|||||||
@@ -1,19 +1,30 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_DISCORD_VERSION="v0.4"
|
NOTIFY_DISCORD_VERSION="v0.5"
|
||||||
#
|
#
|
||||||
# Required receiving services must already be set up.
|
# Required receiving services must already be set up.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# 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.
|
# 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set DISCORD_WEBHOOK_URL in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${DISCORD_WEBHOOK_URL:-}" ]]; then
|
trigger_discord_notification() {
|
||||||
printf "Discord notification channel enabled, but required configuration variables are missing. Discord notifications will not be sent.\n"
|
if [[ -n "$1" ]]; then
|
||||||
|
discord_channel="$1"
|
||||||
|
else
|
||||||
|
discord_channel="discord"
|
||||||
|
fi
|
||||||
|
|
||||||
|
UpperChannel="${discord_channel^^}"
|
||||||
|
|
||||||
|
DiscordWebhookUrlVar="${UpperChannel}_WEBHOOK_URL"
|
||||||
|
|
||||||
|
if [[ -z "${!DiscordWebhookUrlVar:-}" ]]; then
|
||||||
|
printf "The ${discord_channel} notification channel is enabled, but required configuration variables are missing. Discord notifications will not be sent.\n"
|
||||||
|
|
||||||
remove_channel discord
|
remove_channel discord
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_discord_notification() {
|
DiscordWebhookUrl="${!DiscordWebhookUrlVar}" # e.g. DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/<token string>
|
||||||
DiscordWebhookUrl="${DISCORD_WEBHOOK_URL}" # e.g. DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/<token string>
|
|
||||||
|
|
||||||
JsonData=$( "$jqbin" -n \
|
JsonData=$( "$jqbin" -n \
|
||||||
--arg username "$FromHost" \
|
--arg username "$FromHost" \
|
||||||
|
|||||||
22
notify_templates/notify_file.sh
Normal file
22
notify_templates/notify_file.sh
Normal file
@@ -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}
|
||||||
|
|
||||||
|
}
|
||||||
@@ -1,20 +1,32 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_GOTIFY_VERSION="v0.4"
|
NOTIFY_GOTIFY_VERSION="v0.5"
|
||||||
#
|
#
|
||||||
# Required receiving services must already be set up.
|
# Required receiving services must already be set up.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# 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.
|
# 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set GOTIFY_TOKEN and GOTIFY_DOMAIN in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${GOTIFY_TOKEN:-}" ]] || [[ -z "${GOTIFY_DOMAIN:-}" ]]; then
|
trigger_gotify_notification() {
|
||||||
printf "Gotify notification channel enabled, but required configuration variables are missing. Gotify notifications will not be sent.\n"
|
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
|
remove_channel gotify
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_gotify_notification() {
|
GotifyToken="${!GotifyTokenVar}" # e.g. GOTIFY_TOKEN=token-value
|
||||||
GotifyToken="${GOTIFY_TOKEN}" # e.g. GOTIFY_TOKEN=token-value
|
GotifyUrl="${!GotifyUrlVar}/message?token=${GotifyToken}" # e.g. GOTIFY_URL=https://gotify.domain.tld
|
||||||
GotifyUrl="${GOTIFY_DOMAIN}/message?token=${GotifyToken}" # e.g. GOTIFY_URL=https://gotify.domain.tld
|
|
||||||
|
|
||||||
if [[ "$PrintMarkdownURL" == true ]]; then
|
if [[ "$PrintMarkdownURL" == true ]]; then
|
||||||
ContentType="text/markdown"
|
ContentType="text/markdown"
|
||||||
|
|||||||
@@ -1,25 +1,38 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_MATRIX_VERSION="v0.3"
|
NOTIFY_MATRIX_VERSION="v0.4"
|
||||||
#
|
#
|
||||||
# Required receiving services must already be set up.
|
# Required receiving services must already be set up.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# 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.
|
# 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set MATRIX_ACCESS_TOKEN, MATRIX_ROOM_ID, and MATRIX_SERVER_URL in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${MATRIX_ACCESS_TOKEN:-}" ]] || [[ -z "${MATRIX_ROOM_ID}:-" ]] || [[ -z "${MATRIX_SERVER_URL}:-" ]]; then
|
trigger_matrix_notification() {
|
||||||
printf "Matrix notification channel enabled, but required configuration variables are missing. Matrix notifications will not be sent.\n"
|
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
|
remove_channel matrix
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_matrix_notification() {
|
AccessToken="${!AccessTokenVar}" # e.g. MATRIX_ACCESS_TOKEN=token-value
|
||||||
AccessToken="${MATRIX_ACCESS_TOKEN}" # e.g. MATRIX_ACCESS_TOKEN=token-value
|
RoomId="${!RoomIdVar}" # e.g. MATRIX_ROOM_ID=myroom
|
||||||
Room_id="${MATRIX_ROOM_ID}" # e.g. MATRIX_ROOM_ID=myroom
|
MatrixServer="${!MatrixServerVar}" # e.g. MATRIX_SERVER_URL=http://matrix.yourdomain.tld
|
||||||
MatrixServer="${MATRIX_SERVER_URL}" # e.g. MATRIX_SERVER_URL=http://matrix.yourdomain.tld
|
|
||||||
MsgBody="{\"msgtype\":\"m.text\",\"body\":\"$MessageBody\"}"
|
MsgBody="{\"msgtype\":\"m.text\",\"body\":\"$MessageBody\"}"
|
||||||
|
|
||||||
# URL Example: https://matrix.org/_matrix/client/r0/rooms/!xxxxxx:example.com/send/m.room.message?access_token=xxxxxxxx
|
# URL Example: https://matrix.org/_matrix/client/r0/rooms/!xxxxxx:example.com/send/m.room.message?access_token=xxxxxxxx
|
||||||
curl -S -o /dev/null ${CurlArgs} -X POST "$MatrixServer/_matrix/client/r0/rooms/$Room_id/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
|
curl -S -o /dev/null ${CurlArgs} -X POST "$MatrixServer/_matrix/client/r0/rooms/$RoomId/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
if [[ $? -gt 0 ]]; then
|
||||||
NotifyError=true
|
NotifyError=true
|
||||||
|
|||||||
@@ -1,19 +1,32 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_NTFYSH_VERSION="v0.5"
|
NOTIFY_NTFYSH_VERSION="v0.7"
|
||||||
#
|
#
|
||||||
# Setup app and subscription at https://ntfy.sh
|
# 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.
|
# 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.
|
# 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set NTFY_DOMAIN and NTFY_TOPIC_NAME in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${NTFY_DOMAIN:-}" ]] || [[ -z "${NTFY_TOPIC_NAME:-}" ]]; then
|
trigger_ntfy_notification() {
|
||||||
printf "Ntfy notification channel enabled, but required configuration variables are missing. Ntfy notifications will not be sent.\n"
|
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
|
remove_channel ntfy
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_ntfy_notification() {
|
NtfyUrl="${!NtfyDomainVar}/${!NtfyTopicNameVar}"
|
||||||
NtfyUrl="${NTFY_DOMAIN}/${NTFY_TOPIC_NAME}"
|
|
||||||
# e.g.
|
# e.g.
|
||||||
# NTFY_DOMAIN=ntfy.sh
|
# NTFY_DOMAIN=ntfy.sh
|
||||||
# NTFY_TOPIC_NAME=YourUniqueTopicName
|
# NTFY_TOPIC_NAME=YourUniqueTopicName
|
||||||
@@ -24,11 +37,18 @@ trigger_ntfy_notification() {
|
|||||||
ContentType="Markdown: no" #text/plain
|
ContentType="Markdown: no" #text/plain
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
if [[ -n "${!NtfyAuthVar:-}" ]]; then
|
||||||
|
NtfyAuth="-u ${!NtfyAuthVar}"
|
||||||
|
else
|
||||||
|
NtfyAuth=""
|
||||||
|
fi
|
||||||
|
|
||||||
curl -S -o /dev/null ${CurlArgs} \
|
curl -S -o /dev/null ${CurlArgs} \
|
||||||
-H "Title: $MessageTitle" \
|
-H "Title: $MessageTitle" \
|
||||||
-H "$ContentType" \
|
-H "$ContentType" \
|
||||||
-d "$MessageBody" \
|
-d "$MessageBody" \
|
||||||
"$NtfyUrl"
|
$NtfyAuth \
|
||||||
|
-L "$NtfyUrl"
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
if [[ $? -gt 0 ]]; then
|
||||||
NotifyError=true
|
NotifyError=true
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_PUSHBULLET_VERSION="v0.3"
|
NOTIFY_PUSHBULLET_VERSION="v0.4"
|
||||||
#
|
#
|
||||||
# Required receiving services must already be set up.
|
# Required receiving services must already be set up.
|
||||||
# Requires jq installed and in PATH.
|
# Requires jq installed and in PATH.
|
||||||
@@ -7,15 +7,27 @@ NOTIFY_PUSHBULLET_VERSION="v0.3"
|
|||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
# 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set PUSHBULLET_TOKEN and PUSHBULLET_URL in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${PUSHBULLET_URL:-}" ]] || [[ -z "${PUSHBULLET_TOKEN:-}" ]]; then
|
trigger_pushbullet_notification() {
|
||||||
printf "Pushbullet notification channel enabled, but required configuration variables are missing. Pushbullet notifications will not be sent.\n"
|
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
|
remove_channel pushbullet
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_pushbullet_notification() {
|
PushUrl="${!PushUrlVar}" # e.g. PUSHBULLET_URL=https://api.pushbullet.com/v2/pushes
|
||||||
PushUrl="${PUSHBULLET_URL}" # e.g. PUSHBULLET_URL=https://api.pushbullet.com/v2/pushes
|
PushToken="${!PushTokenVar}" # e.g. PUSHBULLET_TOKEN=token-value
|
||||||
PushToken="${PUSHBULLET_TOKEN}" # e.g. PUSHBULLET_TOKEN=token-value
|
|
||||||
|
|
||||||
# Requires jq to process json data
|
# Requires jq to process json data
|
||||||
"$jqbin" -n --arg title "$MessageTitle" --arg body "$MessageBody" '{body: $body, title: $title, type: "note"}' | curl -S -o /dev/null ${CurlArgs} -X POST -H "Access-Token: $PushToken" -H "Content-type: application/json" $PushUrl -d @-
|
"$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 @-
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_PUSHOVER_VERSION="v0.3"
|
NOTIFY_PUSHOVER_VERSION="v0.4"
|
||||||
#
|
#
|
||||||
# Required receiving services must already be set up.
|
# Required receiving services must already be set up.
|
||||||
# Requires jq installed and in PATH.
|
# Requires jq installed and in PATH.
|
||||||
@@ -7,16 +7,29 @@ NOTIFY_PUSHOVER_VERSION="v0.3"
|
|||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
# 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set PUSHOVER_USER_KEY, PUSHOVER_TOKEN, and PUSHOVER_URL in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${PUSHOVER_URL:-}" ]] || [[ -z "${PUSHOVER_USER_KEY:-}" ]] || [[ -z "${PUSHOVER_TOKEN:-}" ]]; then
|
trigger_pushover_notification() {
|
||||||
printf "Pushover notification channel enabled, but required configuration variables are missing. Pushover notifications will not be sent.\n"
|
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
|
remove_channel pushover
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_pushover_notification() {
|
PushoverUrl="${!PushoverUrlVar}" # e.g. PUSHOVER_URL=https://api.pushover.net/1/messages.json
|
||||||
PushoverUrl="${PUSHOVER_URL}" # e.g. PUSHOVER_URL=https://api.pushover.net/1/messages.json
|
PushoverUserKey="${!PushoverUserKeyVar}" # e.g. PUSHOVER_USER_KEY=userkey
|
||||||
PushoverUserKey="${PUSHOVER_USER_KEY}" # e.g. PUSHOVER_USER_KEY=userkey
|
PushoverToken="${!PushoverTokenVar}" # e.g. PUSHOVER_TOKEN=token-value
|
||||||
PushoverToken="${PUSHOVER_TOKEN}" # e.g. PUSHOVER_TOKEN=token-value
|
|
||||||
|
|
||||||
# Sending the notification via Pushover
|
# Sending the notification via Pushover
|
||||||
curl -S -o /dev/null ${CurlArgs} -X POST \
|
curl -S -o /dev/null ${CurlArgs} -X POST \
|
||||||
|
|||||||
@@ -1,20 +1,32 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_SLACK_VERSION="v0.3"
|
NOTIFY_SLACK_VERSION="v0.4"
|
||||||
#
|
#
|
||||||
# Setup app and token at https://api.slack.com/tutorials/tracks/posting-messages-with-curl
|
# Setup app and token at https://api.slack.com/tutorials/tracks/posting-messages-with-curl
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# 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.
|
# 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set SLACK_ACCESS_TOKEN, and SLACK_CHANNEL_ID in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${SLACK_ACCESS_TOKEN:-}" ]] || [[ -z "${SLACK_CHANNEL_ID:-}" ]]; then
|
trigger_slack_notification() {
|
||||||
printf "Slack notification channel enabled, but required configuration variables are missing. Slack notifications will not be sent.\n"
|
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
|
remove_channel slack
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_slack_notification() {
|
AccessToken="${!AccessTokenVar}" # e.g. SLACK_ACCESS_TOKEN=some-token
|
||||||
AccessToken="${SLACK_ACCESS_TOKEN}" # e.g. SLACK_ACCESS_TOKEN=some-token
|
ChannelID="${!ChannelIDVar}" # e.g. CHANNEL_ID=mychannel
|
||||||
ChannelID="${SLACK_CHANNEL_ID}" # e.g. CHANNEL_ID=mychannel
|
|
||||||
SlackUrl="https://slack.com/api/chat.postMessage"
|
SlackUrl="https://slack.com/api/chat.postMessage"
|
||||||
|
|
||||||
curl -S -o /dev/null ${CurlArgs} \
|
curl -S -o /dev/null ${CurlArgs} \
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_SMTP_VERSION="v0.3"
|
NOTIFY_SMTP_VERSION="v0.5"
|
||||||
# INFO: ssmtp is depcerated - consider to use msmtp instead.
|
# INFO: ssmtp is depcerated - consider to use msmtp instead.
|
||||||
#
|
#
|
||||||
# mSMTP/sSMTP has to be installed and configured manually.
|
# mSMTP/sSMTP has to be installed and configured manually.
|
||||||
@@ -7,27 +7,43 @@ NOTIFY_SMTP_VERSION="v0.3"
|
|||||||
# If you instead wish make your own modifications, make a copy in 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set SMTP_MAIL_FROM, SMTP_MAIL_TO, and SMTP_SUBJECT_TAG in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${SMTP_MAIL_FROM:-}" ]] || [[ -z "${SMTP_MAIL_TO:-}" ]] || [[ -z "${SMTP_SUBJECT_TAG:-}" ]]; then
|
|
||||||
printf "SMTP notification channel enabled, but required configuration variables are missing. SMTP notifications will not be sent.\n"
|
|
||||||
|
|
||||||
remove_channel smtp
|
|
||||||
fi
|
|
||||||
|
|
||||||
MSMTP=$(which msmtp)
|
MSMTP=$(which msmtp)
|
||||||
SSMTP=$(which ssmtp)
|
SSMTP=$(which ssmtp)
|
||||||
|
SENDMAIL=$(which sendmail)
|
||||||
|
|
||||||
if [ -n "$MSMTP" ] ; then
|
if [ -n "$MSMTP" ] ; then
|
||||||
MailPkg=$MSMTP
|
MailPkg=$MSMTP
|
||||||
elif [ -n "$SSMTP" ] ; then
|
elif [ -n "$SSMTP" ] ; then
|
||||||
MailPkg=$SSMTP
|
MailPkg=$SSMTP
|
||||||
|
elif [ -n "$SENDMAIL" ] ; then
|
||||||
|
MailPkg=$SENDMAIL
|
||||||
else
|
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
|
fi
|
||||||
|
|
||||||
trigger_smtp_notification() {
|
trigger_smtp_notification() {
|
||||||
SendMailFrom="${SMTP_MAIL_FROM}" # e.g. MAIL_FROM=me@mydomain.tld
|
if [[ -n "$1" ]]; then
|
||||||
SendMailTo="${SMTP_MAIL_TO}" # e.g. MAIL_TO=me@mydomain.tld
|
smtp_channel="$1"
|
||||||
SubjectTag="${SMTP_SUBJECT_TAG}" # e.g. SUBJECT_TAG=dockcheck
|
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
|
$MailPkg $SendMailTo << __EOF
|
||||||
From: "$FromHost" <$SendMailFrom>
|
From: "$FromHost" <$SendMailFrom>
|
||||||
|
|||||||
@@ -1,28 +1,41 @@
|
|||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
NOTIFY_TELEGRAM_VERSION="v0.4"
|
NOTIFY_TELEGRAM_VERSION="v0.5"
|
||||||
#
|
#
|
||||||
# Required receiving services must already be set up.
|
# Required receiving services must already be set up.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# 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.
|
# 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.
|
# Do not modify this file directly within the "notify_templates" subdirectory. Set TELEGRAM_CHAT_ID and TELEGRAM_TOKEN in your dockcheck.config file.
|
||||||
|
|
||||||
if [[ -z "${TELEGRAM_CHAT_ID:-}" ]] || [[ -z "${TELEGRAM_TOKEN:-}" ]]; then
|
trigger_telegram_notification() {
|
||||||
printf "Telegram notification channel enabled, but required configuration variables are missing. Telegram notifications will not be sent.\n"
|
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
|
remove_channel telegram
|
||||||
fi
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
trigger_telegram_notification() {
|
|
||||||
if [[ "$PrintMarkdownURL" == true ]]; then
|
if [[ "$PrintMarkdownURL" == true ]]; then
|
||||||
ParseMode="Markdown"
|
ParseMode="Markdown"
|
||||||
else
|
else
|
||||||
ParseMode="HTML"
|
ParseMode="HTML"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
TelegramToken="${TELEGRAM_TOKEN}" # e.g. TELEGRAM_TOKEN=token-value
|
TelegramToken="${!TelegramTokenVar}" # e.g. TELEGRAM_TOKEN=token-value
|
||||||
TelegramChatId="${TELEGRAM_CHAT_ID}" # e.g. TELEGRAM_CHAT_ID=mychatid
|
TelegramChatId="${!TelegramChatIdVar}" # e.g. TELEGRAM_CHAT_ID=mychatid
|
||||||
TelegramUrl="https://api.telegram.org/bot$TelegramToken"
|
TelegramUrl="https://api.telegram.org/bot$TelegramToken"
|
||||||
TelegramTopicID=${TELEGRAM_TOPIC_ID:="0"}
|
TelegramTopicID=${!TelegramTopicIdVar:="0"}
|
||||||
|
|
||||||
JsonData=$( "$jqbin" -n \
|
JsonData=$( "$jqbin" -n \
|
||||||
--arg chatid "$TelegramChatId" \
|
--arg chatid "$TelegramChatId" \
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
NOTIFY_V2_VERSION="v0.3"
|
NOTIFY_V2_VERSION="v0.6"
|
||||||
#
|
#
|
||||||
# If migrating from an older notify template, remove your existing notify.sh file.
|
# 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.
|
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
||||||
@@ -13,9 +13,33 @@ NOTIFY_V2_VERSION="v0.3"
|
|||||||
# Actual snooze will be 60 seconds less to avoid the chance of missed notifications due to minor scheduling or script run time issues.
|
# 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:-}"
|
snooze="${SNOOZE_SECONDS:-}"
|
||||||
SnoozeFile="${ScriptWorkDir}/snooze.list"
|
SnoozeFile="${ScriptWorkDir}/snooze.list"
|
||||||
|
[[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}"
|
||||||
|
|
||||||
enabled_notify_channels=( ${NOTIFY_CHANNELS:-} )
|
enabled_notify_channels=( ${NOTIFY_CHANNELS:-} )
|
||||||
|
|
||||||
|
# Global output string variable for modification by functions
|
||||||
|
UpdToString=""
|
||||||
|
FormattedOutput=""
|
||||||
|
|
||||||
|
get_channel_template() {
|
||||||
|
local UpperChannel="${1^^}"
|
||||||
|
local TemplateVar="${UpperChannel}_TEMPLATE"
|
||||||
|
if [[ -n "${!TemplateVar:-}" ]]; then
|
||||||
|
printf "${!TemplateVar}"
|
||||||
|
else
|
||||||
|
printf "$1"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
declare -A unique_templates
|
||||||
|
|
||||||
|
for channel in "${enabled_notify_channels[@]}"; do
|
||||||
|
template=$(get_channel_template "${channel}")
|
||||||
|
unique_templates["${template}"]=1
|
||||||
|
done
|
||||||
|
|
||||||
|
enabled_notify_templates=( "${!unique_templates[@]}" )
|
||||||
|
|
||||||
FromHost=$(cat /etc/hostname)
|
FromHost=$(cat /etc/hostname)
|
||||||
|
|
||||||
CurrentEpochTime=$(date +"%Y-%m-%dT%H:%M:%S")
|
CurrentEpochTime=$(date +"%Y-%m-%dT%H:%M:%S")
|
||||||
@@ -23,49 +47,96 @@ CurrentEpochSeconds=$(date +%s)
|
|||||||
|
|
||||||
NotifyError=false
|
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() {
|
remove_channel() {
|
||||||
local temp_array=()
|
local temp_array=()
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
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
|
done
|
||||||
enabled_notify_channels=( "${temp_array[@]}" )
|
enabled_notify_channels=( "${temp_array[@]}" )
|
||||||
}
|
}
|
||||||
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
is_snoozed() {
|
||||||
source_if_exists_or_fail "${ScriptWorkDir}/notify_${channel}.sh" || \
|
if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then
|
||||||
source_if_exists_or_fail "${ScriptWorkDir}/notify_templates/notify_${channel}.sh" || \
|
local found=$(grep -w "$1" "${SnoozeFile}" || printf "")
|
||||||
printf "The notification channel ${channel} is enabled, but notify_${channel}.sh was not found. Check the ${ScriptWorkDir} directory or the notify_templates subdirectory.\n"
|
|
||||||
done
|
|
||||||
|
|
||||||
notify_containers_count() {
|
|
||||||
unset NotifyContainers
|
|
||||||
NotifyContainers=()
|
|
||||||
|
|
||||||
[[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}"
|
|
||||||
|
|
||||||
for update in "$@"
|
|
||||||
do
|
|
||||||
read -a container <<< "${update}"
|
|
||||||
found=$(grep -w "${container[0]}" "${SnoozeFile}" || printf "")
|
|
||||||
|
|
||||||
if [[ -n "${found}" ]]; then
|
if [[ -n "${found}" ]]; then
|
||||||
read -a arr <<< "${found}"
|
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 ))
|
CheckEpochSeconds=$(( $(date -d "${arr[1]}" +%s 2>/dev/null) + ${snooze} - 60 )) || CheckEpochSeconds=$(( $(date -f "%Y-%m-%d" -j "${arr[1]}" +%s) + ${snooze} - 60 ))
|
||||||
if [[ "${CurrentEpochSeconds}" -gt "${CheckEpochSeconds}" ]]; then
|
if [[ "${CurrentEpochSeconds}" -le "${CheckEpochSeconds}" ]]; then
|
||||||
NotifyContainers+=("${update}")
|
printf "true"
|
||||||
|
else
|
||||||
|
printf "false"
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
NotifyContainers+=("${update}")
|
printf "false"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
printf "false"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
unsnoozed_count() {
|
||||||
|
unset Unsnoozed
|
||||||
|
Unsnoozed=()
|
||||||
|
|
||||||
|
for element in "$@"
|
||||||
|
do
|
||||||
|
read -a item <<< "${element}"
|
||||||
|
if [[ $(is_snoozed "${item[0]}") == "false" ]]; then
|
||||||
|
Unsnoozed+=("${element}")
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
|
|
||||||
printf "${#NotifyContainers[@]}"
|
printf "${#Unsnoozed[@]}"
|
||||||
}
|
}
|
||||||
|
|
||||||
update_snooze() {
|
update_snooze() {
|
||||||
|
|
||||||
[[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}"
|
|
||||||
|
|
||||||
for arg in "$@"
|
for arg in "$@"
|
||||||
do
|
do
|
||||||
read -a entry <<< "${arg}"
|
read -a entry <<< "${arg}"
|
||||||
@@ -85,8 +156,6 @@ cleanup_snooze() {
|
|||||||
NotifyEntries=()
|
NotifyEntries=()
|
||||||
switch=""
|
switch=""
|
||||||
|
|
||||||
[[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}"
|
|
||||||
|
|
||||||
for arg in "$@"
|
for arg in "$@"
|
||||||
do
|
do
|
||||||
read -a entry <<< "${arg}"
|
read -a entry <<< "${arg}"
|
||||||
@@ -105,154 +174,233 @@ cleanup_snooze() {
|
|||||||
done <<< "$(grep ${switch} '\.sh ' ${SnoozeFile})"
|
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/<insert_text_cu>/${UpdToString}}"
|
||||||
|
elif [[ "${UpdateType}" == "notify_update" ]]; then
|
||||||
|
FormattedOutput="${FormattedTextTemplate/<insert_text_nu>/${UpdToString}}"
|
||||||
|
elif [[ "${UpdateType}" == "dockcheck_update" ]]; then
|
||||||
|
FormattedOutput="${FormattedTextTemplate/<insert_text_iv>/$4}"
|
||||||
|
FormattedOutput="${FormattedOutput/<insert_text_lv>/$5}"
|
||||||
|
FormattedOutput="${FormattedOutput/<insert_text_rn>/$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() {
|
send_notification() {
|
||||||
[[ -s "$ScriptWorkDir"/urls.list ]] && releasenotes || Updates=("$@")
|
[[ -s "$ScriptWorkDir"/urls.list ]] && releasenotes || Updates=("$@")
|
||||||
|
|
||||||
if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then
|
[[ -n "${snooze}" ]] && cleanup_snooze "${Updates[@]}"
|
||||||
UpdNotifyCount=$(notify_containers_count "${Updates[@]}")
|
|
||||||
else
|
|
||||||
UpdNotifyCount="${#Updates[@]}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
|
UnsnoozedContainers=$(unsnoozed_count "${Updates[@]}")
|
||||||
NotifyError=false
|
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."
|
||||||
|
|
||||||
if [[ "${UpdNotifyCount}" -gt 0 ]]; then
|
|
||||||
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
|
UpdToString="${UpdToString%, }"
|
||||||
UpdToString=${UpdToString%\\n}
|
UpdToString=${UpdToString%\\n}
|
||||||
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
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}")
|
||||||
|
|
||||||
# To be added in the MessageBody if "-d X" was used
|
# Formats UpdToString variable per channel settings
|
||||||
# leading space is left intentionally for clean output
|
format_output "container_update" "$(output_format "${channel}")" "🐋 Containers on $FromHost with updates available:\n<insert_text_cu>\n"
|
||||||
[[ -n "$DaysOld" ]] && msgdaysold="with images ${DaysOld}+ days old " || msgdaysold=""
|
|
||||||
|
|
||||||
MessageTitle="$FromHost - updates ${msgdaysold}available."
|
|
||||||
# Setting the MessageBody variable here.
|
# Setting the MessageBody variable here.
|
||||||
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n${UpdToString}\n"
|
printf -v MessageBody "${FormattedOutput}"
|
||||||
|
|
||||||
exec_if_exists_or_fail trigger_${channel}_notification || \
|
printf "\nSending ${channel} notification"
|
||||||
printf "Attempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${channel}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory.\n"
|
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
|
done
|
||||||
|
|
||||||
[[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${Updates[@]}"
|
if [[ "${Notified}" == "true" ]]; then
|
||||||
|
[[ -n "${snooze}" ]] && [[ -n "${UpdToString}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${Updates[@]}"
|
||||||
|
printf "\n"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
[[ -n "${snooze}" ]] && cleanup_snooze "${Updates[@]}"
|
return 0
|
||||||
}
|
}
|
||||||
|
|
||||||
### Set DISABLE_DOCKCHECK_NOTIFICATION=false in dockcheck.config
|
### Set DISABLE_DOCKCHECK_NOTIFICATION=false in dockcheck.config
|
||||||
### to not send notifications when dockcheck itself has updates.
|
### to not send notifications when dockcheck itself has updates.
|
||||||
dockcheck_notification() {
|
dockcheck_notification() {
|
||||||
if [[ ! "${DISABLE_DOCKCHECK_NOTIFICATION:-}" == "true" ]]; then
|
if [[ ! "${DISABLE_DOCKCHECK_NOTIFICATION:-}" == "true" ]]; then
|
||||||
DockcheckNotify=false
|
UnsnoozedDockcheck=$(unsnoozed_count "dockcheck\.sh")
|
||||||
NotifyError=false
|
NotifyError=false
|
||||||
|
Notified=false
|
||||||
|
|
||||||
if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then
|
|
||||||
found=$(grep -w "dockcheck\.sh" "${SnoozeFile}" || printf "")
|
|
||||||
if [[ -n "${found}" ]]; then
|
|
||||||
read -a arr <<< "${found}"
|
|
||||||
CheckEpochSeconds=$(( $(date -d "${arr[1]}" +%s 2>/dev/null) + ${snooze} - 60 )) || CheckEpochSeconds=$(( $(date -f "%Y-%m-%d" -j "${arr[1]}" +%s) + ${snooze} - 60 ))
|
|
||||||
if [[ "${CurrentEpochSeconds}" -gt "${CheckEpochSeconds}" ]]; then
|
|
||||||
DockcheckNotify=true
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
DockcheckNotify=true
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
DockcheckNotify=true
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ "${DockcheckNotify}" == "true" ]]; then
|
|
||||||
MessageTitle="$FromHost - New version of dockcheck available."
|
MessageTitle="$FromHost - New version of dockcheck available."
|
||||||
# Setting the MessageBody variable here.
|
UpdToString="dockcheck.sh,$1,$2,\"$3\""
|
||||||
printf -v MessageBody "Installed version: $1\nLatest version: $2\n\nChangenotes: $3\n"
|
|
||||||
|
|
||||||
if [[ ${#enabled_notify_channels[@]} -gt 0 ]]; then printf "\n"; fi
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
for channel in "${enabled_notify_channels[@]}"; do
|
||||||
printf "Sending dockcheck update notification - ${channel}\n"
|
local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedDockcheck}" "dockcheck")
|
||||||
exec_if_exists_or_fail trigger_${channel}_notification || \
|
if [[ "${SkipNotification}" == "false" ]]; then
|
||||||
printf "Attempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${channel}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory.\n"
|
local template=$(get_channel_template "${channel}")
|
||||||
|
|
||||||
|
# Formats UpdToString variable per channel settings
|
||||||
|
format_output "dockcheck_update" "$(output_format "${channel}")" "Installed version: <insert_text_iv>\nLatest version: <insert_text_lv>\n\nChangenotes: <insert_text_rn>\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
|
done
|
||||||
|
|
||||||
if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then
|
if [[ "${Notified}" == "true" ]]; then
|
||||||
if [[ "${NotifyError}" == "false" ]]; then
|
[[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "dockcheck.sh"
|
||||||
if [[ -n "${found}" ]]; then
|
printf "\n"
|
||||||
sed -e "s/dockcheck\.sh.*/dockcheck\.sh ${CurrentEpochTime}/" "${SnoozeFile}" > "${SnoozeFile}.new"
|
|
||||||
mv "${SnoozeFile}.new" "${SnoozeFile}"
|
|
||||||
else
|
|
||||||
printf "dockcheck.sh ${CurrentEpochTime}\n" >> "${SnoozeFile}"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
fi
|
fi
|
||||||
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.
|
### to not send notifications when notify scripts themselves have updates.
|
||||||
notify_update_notification() {
|
notify_update_notification() {
|
||||||
if [[ ! "${DISABLE_NOTIFY_UPDATE_NOTIFICATION:-}" == "true" ]]; then
|
if [[ ! "${DISABLE_NOTIFY_NOTIFICATION:-}" == "true" ]]; then
|
||||||
NotifyUpdateNotify=false
|
|
||||||
NotifyError=false
|
NotifyError=false
|
||||||
|
NotifyUpdates=()
|
||||||
|
Notified=false
|
||||||
|
|
||||||
UpdateChannels=( "${enabled_notify_channels[@]}" "v2" )
|
UpdateChannels=( "${enabled_notify_templates[@]}" "v2" )
|
||||||
|
|
||||||
for NotifyScript in "${UpdateChannels[@]}"; do
|
for NotifyScript in "${UpdateChannels[@]}"; do
|
||||||
UpperChannel=$(tr '[:lower:]' '[:upper:]' <<< "$NotifyScript")
|
UpperChannel="${NotifyScript^^}"
|
||||||
VersionVar="NOTIFY_${UpperChannel}_VERSION"
|
VersionVar="NOTIFY_${UpperChannel}_VERSION"
|
||||||
if [[ -n "${!VersionVar:-}" ]]; then
|
if [[ -n "${!VersionVar:-}" ]]; then
|
||||||
RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_${NotifyScript}.sh"
|
RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_${NotifyScript}.sh"
|
||||||
LatestNotifySnippet="$(curl ${CurlArgs} -r 0-150 "$RawNotifyUrl" || printf "undefined")"
|
LatestNotifySnippet="$(curl ${CurlArgs} -r 0-150 "$RawNotifyUrl" || printf "undefined")"
|
||||||
|
if [[ ! "${LatestNotifySnippet}" == "undefined" ]]; then
|
||||||
LatestNotifyRelease="$(echo "$LatestNotifySnippet" | sed -n "/${VersionVar}/s/${VersionVar}=//p" | tr -d '"')"
|
LatestNotifyRelease="$(echo "$LatestNotifySnippet" | sed -n "/${VersionVar}/s/${VersionVar}=//p" | tr -d '"')"
|
||||||
if [[ ! "${LatestNotifyRelease}" == "undefined" ]]; then
|
|
||||||
if [[ "${!VersionVar}" != "${LatestNotifyRelease}" ]] ; then
|
if [[ "${!VersionVar}" != "${LatestNotifyRelease}" ]] ; then
|
||||||
Updates+=("${NotifyScript}.sh ${!VersionVar} -> ${LatestNotifyRelease}")
|
NotifyUpdates+=("${NotifyScript}.sh ${!VersionVar} -> ${LatestNotifyRelease}")
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
|
|
||||||
if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then
|
UpdatesPlusDockcheck=("${NotifyUpdates[@]}")
|
||||||
for update in "${Updates[@]}"; do
|
UpdatesPlusDockcheck+=("dockcheck.sh")
|
||||||
read -a NotifyScript <<< "${update}"
|
[[ -n "${snooze}" ]] && cleanup_snooze "${UpdatesPlusDockcheck[@]}"
|
||||||
found=$(grep -w "${NotifyScript}" "${SnoozeFile}" || printf "")
|
|
||||||
if [[ -n "${found}" ]]; then
|
|
||||||
read -a arr <<< "${found}"
|
|
||||||
CheckEpochSeconds=$(( $(date -d "${arr[1]}" +%s 2>/dev/null) + ${snooze} - 60 )) || CheckEpochSeconds=$(( $(date -f "%Y-%m-%d" -j "${arr[1]}" +%s) + ${snooze} - 60 ))
|
|
||||||
if [[ "${CurrentEpochSeconds}" -gt "${CheckEpochSeconds}" ]]; then
|
|
||||||
NotifyUpdateNotify=true
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
NotifyUpdateNotify=true
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
else
|
|
||||||
NotifyUpdateNotify=true
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ "${NotifyUpdateNotify}" == "true" ]]; then
|
UnsnoozedTemplates=$(unsnoozed_count "${NotifyUpdates[@]}")
|
||||||
if [[ "${#Updates[@]}" -gt 0 ]]; then
|
|
||||||
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
|
||||||
UpdToString=${UpdToString%\\n}
|
|
||||||
NotifyError=false
|
|
||||||
|
|
||||||
MessageTitle="$FromHost - New version of notify templates available."
|
MessageTitle="$FromHost - New version of notify templates available."
|
||||||
|
|
||||||
printf -v MessageBody "Notify templates on $FromHost with updates available:\n${UpdToString}\n"
|
UpdToString=$( printf '%s\\n' "${NotifyUpdates[@]}" )
|
||||||
|
UpdToString="${UpdToString%, }"
|
||||||
|
UpdToString=${UpdToString%\\n}
|
||||||
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
for channel in "${enabled_notify_channels[@]}"; do
|
||||||
printf "Sending notify template update notification - ${channel}\n"
|
local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedTemplates}" "notify")
|
||||||
exec_if_exists_or_fail trigger_${channel}_notification || \
|
|
||||||
printf "Attempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${channel}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory.\n"
|
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<insert_text_nu>\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
|
done
|
||||||
|
|
||||||
[[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${Updates[@]}"
|
if [[ "${Notified}" == "true" ]]; then
|
||||||
|
[[ -n "${snooze}" ]] && [[ -n "${UpdToString}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${NotifyUpdates[@]}"
|
||||||
|
printf "\n"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
UpdatesPlusDockcheck=("${Updates[@]}")
|
return 0
|
||||||
UpdatesPlusDockcheck+=("dockcheck.sh")
|
|
||||||
[[ -n "${snooze}" ]] && cleanup_snooze "${UpdatesPlusDockcheck[@]}"
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user