mirror of
https://github.com/mag37/dockcheck.git
synced 2026-02-14 23:38:15 +01:00
Compare commits
No commits in common. "main" and "v0.5.0" have entirely different histories.
35 changed files with 527 additions and 2503 deletions
8
.gitignore
vendored
8
.gitignore
vendored
|
|
@ -1,11 +1,5 @@
|
||||||
# ignore users custom notify.sh
|
# ignore users custom notify.sh
|
||||||
/notify*.sh
|
/notify.sh
|
||||||
/urls.list
|
/urls.list
|
||||||
# ignore user config
|
|
||||||
/dockcheck.config
|
|
||||||
# ignore the auto-installed regctl
|
# ignore the auto-installed regctl
|
||||||
regctl
|
regctl
|
||||||
# ignore snooze file
|
|
||||||
snooze.list
|
|
||||||
# ignore updates file
|
|
||||||
updates_available.txt
|
|
||||||
386
README.md
386
README.md
|
|
@ -1,352 +1,154 @@
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="extras/dockcheck_colour.png" width="300" title="dockcheck">
|
<img src="extras/dockcheck_logo_by_booYah187.png" width="160" 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>
|
<h3 align="center">CLI tool to automate docker image updates. <br>No <b>pre-pull</b>, selective, optional notifications and prune when done.</h3>
|
||||||
<h3 align="center">selective updates, include/exclude containers, image backups, custom labels, notification plugins, prune when done etc.</h3>
|
<h2 align="center">Now with simple notification integrations!</h2>
|
||||||
|
<h4 align="center">With features like excluding specific containers, custom container labels, auto-prune when done and more.</h4>
|
||||||
<h4 align="center">:whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks only for actual pulls - <a href="#whale-docker-hub-pull-limit-chart_with_downwards_trend-not-an-issue-for-checks-but-for-actual-pulls">read more</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.5.0**: Rewritten notify logic - all templates are adjusted and should be migrated!
|
||||||
|
- Copy the custom settings from your current template to the new version of the same template.
|
||||||
- **v0.7.6**:
|
- Look into, copy and customize the `urls.list` file if that's of interest.
|
||||||
- New:
|
- Other changes:
|
||||||
- Added Bark notify-template.
|
- Added Discord notify template.
|
||||||
- Fixes:
|
- Verbosity changed of `regctl`.
|
||||||
- Sanitized message for Matrix notification.
|
- **v0.4.9**: Added a function to enrich the notify-message with release note URLs. See [Release notes addon](https://github.com/mag37/dockcheck#date-release-notes-addon-to-notifications)
|
||||||
- Fixed hostname fallback for notifications.
|
- **v0.4.8**: Rewrote prune logic to not prompt with options `-a|-y` or `-n`. Auto prune with `-p`.
|
||||||
- Clenaed up README.md some.
|
- **v0.4.7**: Notification Template changes to gotify(new!), DSM(improved), SMTP(deprecation alternative).
|
||||||
- Sorted and clarified `default.config` - migrate your settings manually (optional).
|
- **v0.4.6**: Compatibility changes to timeout, due to busybox.
|
||||||
- **v0.7.5**:
|
- **v0.4.5**: Bugfixes, compatibility changes to timeout and arrays.
|
||||||
- Added new option **BackupForDays**; `-b N` and `-B`:
|
- **v0.4.3**: Added timeout option to skip container if registry check takes too long (10s default).
|
||||||
- Backup an image before pulling a new version for easy rollback in case of breakage.
|
|
||||||
- Removes backed up images older than *N* days.
|
|
||||||
- List currently backed up images with `-B`.
|
|
||||||
- Fixes:
|
|
||||||
- Bugfix for `-s` *Stopped* to not recreate stopped containers after update.
|
|
||||||
- **v0.7.4**:
|
|
||||||
- Added new option `-R`:
|
|
||||||
- Will skip container recreation after pulling images.
|
|
||||||
- Allows for more control and possible pipeline integration.
|
|
||||||
- Fixes:
|
|
||||||
- Bugfix for *value too great* error due to leading zeroes - solved with base10 conversion.
|
|
||||||
- Clean up of some legacy readme sections.
|
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## `dockcheck.sh`
|
|
||||||
|
|
||||||
```shell
|
## :mag_right: `dockcheck.sh`
|
||||||
|
```
|
||||||
$ ./dockcheck.sh -h
|
$ ./dockcheck.sh -h
|
||||||
Syntax: dockcheck.sh [OPTION] [comma separated names to include]
|
Syntax: dockcheck.sh [OPTION] [part of name to filter]
|
||||||
Example: dockcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall
|
Example: dockcheck.sh -y -d 10 -e nextcloud,heimdall
|
||||||
|
|
||||||
Options:
|
Options:"
|
||||||
-a|y Automatic updates, without interaction.
|
-a|y Automatic updates, without interaction.
|
||||||
-b N Enable image backups and sets number of days to keep from pruning.
|
|
||||||
-B List currently backed up images, then exit.
|
|
||||||
-c D Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory.
|
|
||||||
-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
|
-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
|
||||||
-e X Exclude containers, separated by comma.
|
-e X Exclude containers, separated by comma.
|
||||||
-f Force stop+start stack after update. Caution: restarts once for every updated container within stack.
|
-f Force stack restart after update. Caution: restarts once for every updated container within stack.
|
||||||
-F Only compose up the specific container, not the whole compose stack (useful for master-compose structure).
|
|
||||||
-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).
|
-l Only update if label is set. See readme.
|
||||||
-l Only include containers with label set. See readme.
|
-m Monochrome mode, no printf color codes.
|
||||||
-m Monochrome mode, no printf colour codes and hides progress bar.
|
|
||||||
-M Prints custom releasenote urls as markdown (requires template support).
|
|
||||||
-n No updates, only checking availability.
|
-n No updates, only checking availability.
|
||||||
-p Auto-Prune dangling images after update.
|
-p Auto-Prune dangling images after update.
|
||||||
-r Allow checking/updating images created by `docker run`, containers need to be recreated manually.
|
-r Allow updating images for docker run, wont update the container.
|
||||||
-R Skip container recreation after pulling images.
|
|
||||||
-s Include stopped containers in the check. (Logic: docker ps -a).
|
-s Include stopped containers in the check. (Logic: docker ps -a).
|
||||||
-t N Set a timeout (in seconds) per container for registry checkups, 10 is default.
|
-t Set a timeout (in seconds) per container for registry checkups, 10 is default.
|
||||||
-u Allow automatic self updates - caution as this will pull new code and autorun it.
|
|
||||||
-v Prints current version.
|
-v Prints current version.
|
||||||
-x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Basic example
|
|
||||||
|
|
||||||
```shell
|
### Basic example:
|
||||||
|
```
|
||||||
$ ./dockcheck.sh
|
$ ./dockcheck.sh
|
||||||
[##################################################] 5/5
|
. . .
|
||||||
|
|
||||||
Containers on latest version:
|
Containers on latest version:
|
||||||
glances
|
glances
|
||||||
homer
|
homer
|
||||||
|
|
||||||
Containers with updates available:
|
Containers with updates available:
|
||||||
01) adguardhome
|
1) adguardhome
|
||||||
02) syncthing
|
2) syncthing
|
||||||
03) whoogle-search
|
3) whoogle-search
|
||||||
|
|
||||||
Choose what containers to update:
|
Choose what containers to update:
|
||||||
Enter number(s) separated by comma, [a] for all - [q] to quit: 1,2
|
Enter number(s) separated by comma, [a] for all - [q] to quit:
|
||||||
```
|
```
|
||||||
|
Then it proceedes to run `pull` and `up -d` on every container with updates.
|
||||||
Then it proceeds to run `pull` and `up -d` on every container with updates.
|
|
||||||
After the updates are complete, you'll get prompted if you'd like to prune dangling images.
|
After the updates are complete, you'll get prompted if you'd like to prune dangling images.
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
## Dependencies
|
## :nut_and_bolt: Dependencies
|
||||||
|
- Running docker (duh) and compose, either standalone or plugin.
|
||||||
- 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.
|
|
||||||
- [jq](https://github.com/jqlang/jq)
|
|
||||||
- User will be prompted to install with package manager or download static binary.
|
|
||||||
- [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))
|
- [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))
|
||||||
- User will be prompted to download `regctl` if not in `PATH` or `PWD`.
|
- User will be prompted to download `regctl` if not in `PATH` or `PWD`.
|
||||||
- regctl requires `amd64/arm64` - see [workaround](#workaround-for-non-amd64--arm64) if other architecture is used.
|
- regctl requires `amd64/arm64` - see [workaround](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
|
||||||
|
|
||||||
## Install Instructions
|
## :tent: Install Instructions
|
||||||
|
Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.
|
||||||
Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.
|
```sh
|
||||||
For OSX/macOS preferably use `/usr/local/bin`.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# basic example with curl:
|
# basic example with curl:
|
||||||
curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o ~/.local/bin/dockcheck.sh
|
curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o ~/.local/bin/dockcheck.sh
|
||||||
chmod +x ~/.local/bin/dockcheck.sh
|
chmod +x ~/.local/bin/dockcheck.sh
|
||||||
|
|
||||||
# or oneliner with wget:
|
# or oneliner with wget:
|
||||||
wget -O ~/.local/bin/dockcheck.sh "https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" && chmod +x ~/.local/bin/dockcheck.sh
|
wget -O ~/.local/bin/dockcheck.sh "https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh" && chmod +x ~/.local/bin/dockcheck.sh
|
||||||
|
|
||||||
# OSX or macOS version with curl:
|
|
||||||
curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o /usr/local/bin/dockcheck.sh && chmod +x /usr/local/bin/dockcheck.sh
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Then call the script anywhere with just `dockcheck.sh`.
|
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.
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
To modify settings and have them persist through updates - copy the `default.config` to `dockcheck.config` alongside the script or in `~/.config/`.
|
## :loudspeaker: Notifications
|
||||||
Alternatively create an alias where specific flags and values are set.
|
Trigger with the `-i` flag.
|
||||||
Example `alias dc=dockcheck.sh -p -x 10 -t 3`.
|
Run it scheduled with `-ni` to only get notified when there's updates available!
|
||||||
|
|
||||||
## Notifications
|
|
||||||
|
|
||||||
Triggered with the `-i` flag. Will send a list of containers with updates available and a notification when `dockcheck.sh` itself has an update.
|
|
||||||
`notify_templates/notify_v2.sh` is the default notification wrapper, if `notify.sh` is present and configured, it will override.
|
|
||||||
|
|
||||||
Example of a cron scheduled job running non-interactive at 10'oclock excluding 1 container and sending notifications:
|
|
||||||
`0 10 * * * /home/user123/.local/bin/dockcheck.sh -nix 10 -e excluded_container1`
|
|
||||||
|
|
||||||
#### Installation and configuration
|
|
||||||
|
|
||||||
Set up a directory structure as below.
|
|
||||||
You only need the `notify_templates/notify_v2.sh` file and any notification templates
|
|
||||||
you wish to enable, but there is no harm in having all of them present.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
.
|
|
||||||
├── notify_templates/
|
|
||||||
│ ├── notify_DSM.sh
|
|
||||||
│ ├── notify_apprise.sh
|
|
||||||
│ ├── notify_bark.sh
|
|
||||||
│ ├── notify_discord.sh
|
|
||||||
│ ├── notify_generic.sh
|
|
||||||
│ ├── notify_gotify.sh
|
|
||||||
│ ├── notify_HA.sh
|
|
||||||
│ ├── notify_matrix.sh
|
|
||||||
│ ├── notify_ntfy.sh
|
|
||||||
│ ├── notify_pushbullet.sh
|
|
||||||
│ ├── notify_pushover.sh
|
|
||||||
│ ├── notify_slack.sh
|
|
||||||
│ ├── notify_smtp.sh
|
|
||||||
│ ├── notify_telegram.sh
|
|
||||||
│ └── notify_v2.sh
|
|
||||||
├── dockcheck.config
|
|
||||||
├── dockcheck.sh
|
|
||||||
└── urls.list # optional
|
|
||||||
```
|
|
||||||
|
|
||||||
- Uncomment and set the `NOTIFY_CHANNELS=""` environment variable in `dockcheck.config` to a space separated string of your desired notification channels to enable.
|
|
||||||
- Uncomment and set the environment variables related to the enabled notification channels. Eg. `GOTIFY_DOMAIN=""` + `GOTIFY_TOKEN=""`.
|
|
||||||
|
|
||||||
It's recommended to only do configuration with variables within `dockcheck.config` and not modify `notify_templates/notify_X.sh` directly. If you wish to customize the notify templates yourself, you may copy them to your project root directory alongside the main `dockcheck.sh` (where they're also ignored by git).
|
|
||||||
Customizing `notify_v2.sh` is handled the same as customizing the templates, but it must be renamed to `notify.sh` within the `dockcheck.sh` root directory.
|
|
||||||
|
|
||||||
#### Snooze feature
|
|
||||||
|
|
||||||
Configure to receive scheduled notifications only if they're new since the last notification - within a set time frame.
|
|
||||||
|
|
||||||
**Example:** *Dockcheck is scheduled to run every hour. You will receive an update notification within an hour of availability.*
|
|
||||||
**Snooze enabled:** You will not receive a repeated notification about an already notified update within the snooze duration.
|
|
||||||
**Snooze disabled:** You will receive additional (possibly repeated) notifications every hour.
|
|
||||||
|
|
||||||
To enable snooze uncomment the `SNOOZE_SECONDS` variable in your `dockcheck.config` and set it to the number of seconds you wish to prevent duplicate alerts.
|
|
||||||
Snooze is split into three categories; container updates, `dockcheck.sh` self updates and notification template updates.
|
|
||||||
|
|
||||||
If an update becomes available for an item that is not snoozed, notifications will be sent and include all available updates for that item's category, even snoozed items.
|
|
||||||
|
|
||||||
The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to account for minor scheduling or run time issues.
|
|
||||||
|
|
||||||
#### Current notify templates
|
|
||||||
|
|
||||||
|
Use a `notify_X.sh` template file from the **notify_templates** directory, copy it to `notify.sh` alongside the script, modify it to your needs! (notify.sh is added to .gitignore)
|
||||||
|
**Current templates:**
|
||||||
|
- Synology [DSM](https://www.synology.com/en-global/dsm)
|
||||||
|
- Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP))
|
||||||
- Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications)
|
- Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications)
|
||||||
- both native [caronc/apprise](https://github.com/caronc/apprise) and the standalone [linuxserver/docker-apprise-api](https://github.com/linuxserver/docker-apprise-api)
|
- both native [caronc/apprise](https://github.com/caronc/apprise) and the standalone [linuxserver/docker-apprise-api](https://github.com/linuxserver/docker-apprise-api)
|
||||||
- Read the [QuickStart](extras/apprise_quickstart.md)
|
- Read the [QuickStart](extras/apprise_quickstart.md)
|
||||||
- [Bark](https://bark.day.app/) - iOS Push notifications.
|
- [ntfy.sh](https://ntfy.sh/) - HTTP-based pub-sub notifications.
|
||||||
- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks.
|
|
||||||
- [DSM](https://www.synology.com/en-global/dsm) - Synology.
|
|
||||||
- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
|
- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
|
||||||
- [Home Assistant](https://www.home-assistant.io/integrations/notify/) - Connection to the notify [integrations](https://www.home-assistant.io/integrations/#notifications).
|
|
||||||
- [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication.
|
|
||||||
- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications.
|
|
||||||
- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
|
- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
|
||||||
- [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops)
|
|
||||||
- [Slack](https://api.slack.com/tutorials/tracks/posting-messages-with-curl) - Slack curl api
|
|
||||||
- SMTP Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP))
|
|
||||||
- [Telegram](https://telegram.org/) - Telegram chat API.
|
- [Telegram](https://telegram.org/) - Telegram chat API.
|
||||||
|
- [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication.
|
||||||
|
- [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops)
|
||||||
|
|
||||||
Further additions are welcome - suggestions or PRs!
|
Further additions are welcome - suggestions or PR!
|
||||||
<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>
|
||||||
|
|
||||||
#### 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.
|
|
||||||
Copy the notify_templates/`urls.list` file to the script directory, it will be used automatically if it's there.
|
|
||||||
Modify it as necessary, the names of interest in the left column needs to match your container names.
|
|
||||||
To also list the URL's in the CLI output (choose containers list) use the `-I` option or variable config.
|
|
||||||
For Markdown formatting also add the `-M` option. (**this requires the template to be compatible - see gotify for example**)
|
|
||||||
|
|
||||||
|
### :date: Release notes addon to Notifications
|
||||||
|
There's a function to use a lookup-file to add release note URL's to the notification message.
|
||||||
|
Copy the notify_templates/`urls.list` file to the script directory, it will be used automatically if it's there. Modify it as necessary, the names of interest in the left column needs to match your container names.
|
||||||
The output of the notification will look something like this:
|
The output of the notification will look something like this:
|
||||||
|
```
|
||||||
```shell
|
|
||||||
Containers on hostname with updates available:
|
Containers on hostname with updates available:
|
||||||
apprise-api -> https://github.com/linuxserver/docker-apprise-api/releases
|
apprise-api -> https://github.com/linuxserver/docker-apprise-api/releases
|
||||||
homer -> https://github.com/bastienwirtz/homer/releases
|
homer -> https://github.com/bastienwirtz/homer/releases
|
||||||
nginx -> https://github.com/docker-library/official-images/blob/master/library/nginx
|
nginx -> https://github.com/docker-library/official-images/blob/master/library/nginx
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
The `urls.list` file is just an example and I'd gladly see that people contribute back when they add their preferred URLs to their lists.
|
The `urls.list` file is just an example and I'd gladly see that people contribute back when they add their preferred URLs to their lists.
|
||||||
|
|
||||||
## Asyncronous update checks with **xargs**; `-x N` option. (default=1)
|
## :bookmark: Labels
|
||||||
|
|
||||||
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.config`. To disable the subprocess function set `MaxAsync=0`.
|
|
||||||
|
|
||||||
## Image Backups; `-b N` to backup previous images as custom (retagged) images for easy rollback
|
|
||||||
|
|
||||||
When the option `BackupForDays` is set **dockcheck** will store the image being updated as a backup, retagged with a different name and removed due to age configured (*BackupForDays*) in a future run.
|
|
||||||
Let's say we're updating `b4bz/homer:latest` - then before replacing the current image
|
|
||||||
it will be retagged with the name `dockcheck/homer:2025-10-26_1132_latest`
|
|
||||||
|
|
||||||
- `dockcheck` as repo name to not interfere with others.
|
|
||||||
- `homer` is the image.
|
|
||||||
- `2025-10-26_1132` is the time when running the script.
|
|
||||||
- `latest` is the tag of the image.
|
|
||||||
|
|
||||||
Then if an update breaks, you could restore the image by stopping the container, delete the new image, eg. `docker rmi b4bz/homer:latest`, then retag the backup as latest `docker tag dockcheck/homer:<date>_latest b4bz/homer:latest`.
|
|
||||||
After that, start the container again (now with the backup image active) and it will be updated as usual next time you run dockcheck or other updates.
|
|
||||||
|
|
||||||
The backed up images will be removed if they're older than *BackupForDays* value (passed as `-b N` or set in the `dockcheck.config` with `BackupForDays=N`) and then pruned.
|
|
||||||
If configured for eg. 7 days, force earlier cleaning by just passing a lower number of days, eg. `-b 2` to clean everything older than 2 days.
|
|
||||||
Backed up images will not be removed if neither `-b` flag nor `BackupForDays` config variable is set.
|
|
||||||
|
|
||||||
Use the capital option `-B` to list currently backed up images. Or list all images with `docker images`.
|
|
||||||
To manually remove any backed up images, do `docker rmi dockcheck/homer:2025-10-26_1132_latest`.
|
|
||||||
|
|
||||||
## Extra plugins and tools
|
|
||||||
|
|
||||||
### Using dockcheck.sh with the Synology DSM
|
|
||||||
|
|
||||||
If you run your container through the *Container Manager GUI* - only notifications are supported.
|
|
||||||
While if running manual (vanilla docker compose CLI) will allow you to use the update function too.
|
|
||||||
Some extra setup to tie together with Synology DSM - check out the [addons/DSM/README.md](./addons/DSM/README.md).
|
|
||||||
|
|
||||||
### Prometheus and node_exporter
|
|
||||||
|
|
||||||
Dockcheck can be used together with [Prometheus](https://github.com/prometheus/prometheus) and [node_exporter](https://github.com/prometheus/node_exporter) to export metrics via the file collector, scheduled with cron or likely.
|
|
||||||
This is done with the `-c` option, like this:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
dockcheck.sh -c /path/to/exporter/directory
|
|
||||||
```
|
|
||||||
|
|
||||||
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>
|
|
||||||
|
|
||||||
### Zabbix config to monitor docker image updates
|
|
||||||
|
|
||||||
If you already use Zabbix - this config will show numbers of available docker image updates on host.
|
|
||||||
Example: *2 Docker Image updates on host-xyz*
|
|
||||||
See project: [thetorminal/zabbix-docker-image-updates](https://github.com/thetorminal/zabbix-docker-image-updates)
|
|
||||||
|
|
||||||
### Serve REST API to list all available updates
|
|
||||||
|
|
||||||
A custom python script to serve a REST API to get pulled into other monitoring tools like [homepage](https://github.com/gethomepage/homepage).
|
|
||||||
See [discussion here](https://github.com/mag37/dockcheck/discussions/146).
|
|
||||||
|
|
||||||
### Wrapper Script for Unraid's User Scripts
|
|
||||||
|
|
||||||
A custom bash wrapper script to allow the usage of dockcheck as a Unraid User Script plugin.
|
|
||||||
See [discussion here](https://github.com/mag37/dockcheck/discussions/145).
|
|
||||||
|
|
||||||
## Labels
|
|
||||||
|
|
||||||
Optionally add labels to compose-files. Currently these are the usable labels:
|
Optionally add labels to compose-files. Currently these are the usable labels:
|
||||||
|
|
||||||
```yaml
|
|
||||||
labels:
|
|
||||||
mag37.dockcheck.update: true
|
|
||||||
mag37.dockcheck.only-specific-container: true
|
|
||||||
mag37.dockcheck.restart-stack: true
|
|
||||||
```
|
```
|
||||||
|
labels:
|
||||||
- `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.restart-stack: true
|
||||||
- `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.update: true
|
||||||
|
```
|
||||||
- `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).
|
||||||
|
- `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.
|
||||||
|
|
||||||
Adding or modifying labels in compose-files requires a restart of the container to take effect.
|
## :roller_coaster: Workaround for non **amd64** / **arm64**
|
||||||
|
|
||||||
## Workaround for non **amd64** / **arm64**
|
|
||||||
|
|
||||||
`regctl` provides binaries for amd64/arm64, to use on other architecture you could try this workaround.
|
`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):
|
||||||
|
|
||||||
```shell
|
```sh
|
||||||
cat >regctl <<EOF
|
cat >regctl <<EOF
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
opts=""
|
opts=""
|
||||||
|
|
@ -360,66 +162,40 @@ docker container run \$opts -i --rm --net host \\
|
||||||
EOF
|
EOF
|
||||||
chmod 755 regctl
|
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`).
|
||||||
|
|
||||||
## Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls
|
## :guardsman: Function to auth with docker hub before running
|
||||||
|
**Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
|
||||||
Due to recent changes in [Docker Hub usage and limits](https://docs.docker.com/docker-hub/usage/)
|
```sh
|
||||||
>Unauthenticated users: 10 pulls/hour
|
|
||||||
>Authenticated users with a free account: 100 pulls/hour
|
|
||||||
|
|
||||||
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`.
|
|
||||||
|
|
||||||
### Function to auth with docker hub before running
|
|
||||||
|
|
||||||
**Example** - Change names, paths, and remove cat+password flag if you rather get
|
|
||||||
prompted:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
function dchk {
|
function dchk {
|
||||||
cat ~/pwd.txt | docker login --username YourUser --password-stdin
|
cat ~/pwd.txt | docker login --username YourUser --password-stdin
|
||||||
~/dockcheck.sh "$@"
|
~/dockcheck.sh "$@"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## `-r flag` disclaimer and warning
|
## :hammer: Known issues
|
||||||
|
|
||||||
**Wont auto-update the containers, only their images. (compose is recommended)**
|
|
||||||
`docker run` doesn't support using new images just by restarting a container.
|
|
||||||
Containers need to be manually stopped, removed and created again to run on the new image.
|
|
||||||
Using the `-r` option together with eg. `-i` and `-n` to just check for updates and send notifications and not update is safe though!
|
|
||||||
|
|
||||||
## Known issues
|
|
||||||
|
|
||||||
- No detailed error feedback (just skip + list what's skipped).
|
- 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).
|
||||||
|
|
||||||
## Debugging
|
## :warning: `-r flag` disclaimer and warning
|
||||||
|
**Wont auto-update the containers, only their images. (compose is recommended)**
|
||||||
|
`docker run` dont support using new images just by restarting a container.
|
||||||
|
Containers need to be manually stopped, removed and created again to run on the new image.
|
||||||
|
|
||||||
If you hit issues, you could check the output of the `extras/errorCheck.sh` script for clues.
|
## :wrench: Debugging
|
||||||
|
If you hit issues, you could check the output of the `extras/errorCheck.sh` script for clues.
|
||||||
Another option is to run the main script with debugging in a subshell `bash -x dockcheck.sh` - if there's a particular container/image that's causing issues you can filter for just that through `bash -x dockcheck.sh nginx`.
|
Another option is to run the main script with debugging in a subshell `bash -x dockcheck.sh` - if there's a particular container/image that's causing issues you can filter for just that through `bash -x dockcheck.sh nginx`.
|
||||||
|
|
||||||
## License
|
## :scroll: 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.
|
||||||
|
|
||||||
## Sponsorlist
|
## :heartpulse: Sponsorlist
|
||||||
|
|
||||||
:small_orange_diamond: [avegy](https://github.com/avegy)
|
- [avegy](https://github.com/avegy)
|
||||||
:small_orange_diamond: [eichhorn](https://github.com/eichhorn)
|
|
||||||
:small_orange_diamond: [stepdg](https://github.com/stepdg)
|
|
||||||
:small_orange_diamond: [acer2220](https://github.com/acer2220)
|
|
||||||
:small_orange_diamond: [shgew](https://github.com/shgew)
|
|
||||||
:small_orange_diamond: [jonas3456](https://github.com/jonas3456)
|
|
||||||
:small_orange_diamond: [4ndreasH](https://github.com/4ndreasH)
|
|
||||||
:small_orange_diamond: [markoe01](https://github.com/markoe01)
|
|
||||||
:small_orange_diamond: [mushrowan](https://github.com/mushrowan)
|
|
||||||
:small_orange_diamond:
|
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
## The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect
|
### :floppy_disk: The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,35 +0,0 @@
|
||||||
## Using Dockcheck in DSM
|
|
||||||
Dockcheck cannot directly update containers managed in the Container Manager GUI, but it can still be used to notify you of containers with updates available. There are two ways to be notified, each with their own caveats:
|
|
||||||
|
|
||||||
1. Enabling email notifications within the Task Scheduler (_step 6i below_) will send an email that includes the entire script as run. This will not include the `urls.list` links to release notes, but it will show a full list of containers checked, up to date, and needing updates (following the args included in the scheduled task).
|
|
||||||
2. The [DSM notification template](https://github.com/mag37/dockcheck/blob/main/notify_templates/notify_DSM.sh) will enable Dockcheck to directly send an email when using the `-i` flag. This is most useful when paired with an accurate [urls.list](https://github.com/mag37/dockcheck/blob/next063/notify_templates/urls.list) file, and results in a neat succinct email notification of only containers to be updated.
|
|
||||||
|
|
||||||
This is a user preference, and both notifications are not necessary. However, regardless of the notification method, it is necessary to set up a scheduled task to run Dockcheck at a set interval (otherwise it will only run when manually triggered).
|
|
||||||
|
|
||||||
|
|
||||||
## Automate Dockcheck with DSM Task Scheduler:
|
|
||||||
|
|
||||||
1. Open Control Panel and navigate to Task Scheduler
|
|
||||||
2. Create a Scheduled Task > User-defined script
|
|
||||||
3. Task Name: Dockcheck
|
|
||||||
4. User: root
|
|
||||||
5. Schedule: _User Preference_
|
|
||||||
6. Task Settings:
|
|
||||||
1. ✔ Send run details by email (include preferred email) _This is the optional step as described above)_
|
|
||||||
2. User-defined script: `export HOME=/root && cd /path/to/dockcheck && ./dockcheck.sh -n -i -I ` _or other custom args_
|
|
||||||
8. Click OK, accept warning message
|
|
||||||
|
|
||||||
|
|
||||||
## Set up the DSM Notification template
|
|
||||||
|
|
||||||
Copy the [dockcheck/notify_templates/notify_DSM.sh](https://github.com/mag37/dockcheck/blob/main/notify_templates/notify_DSM.sh) to the same directory as where you keep `dockcheck.sh`.
|
|
||||||
Use as is (uses your default notification email setting) or edit and override manually.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Made with much help and contribution from [@firmlyundecided](https://github.com/firmlyundecided) and [@yoyoma2](https://github.com/yoyoma2).
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB |
|
|
@ -1,61 +0,0 @@
|
||||||
## [Prometheus](https://github.com/prometheus/prometheus) and [node_exporter](https://github.com/prometheus/node_exporter)
|
|
||||||
Dockcheck is capable to export metrics to prometheus via the text file collector provided by the node_exporter.
|
|
||||||
In order to do so the -c flag has to be specified followed by the file path that is configured in the text file collector of the node_exporter.
|
|
||||||
A simple cron job can be configured to export these metrics on a regular interval as shown in the sample below:
|
|
||||||
|
|
||||||
```
|
|
||||||
0 1 * * * /root/dockcheck.sh -n -c /var/lib/node_exporter/textfile_collector
|
|
||||||
```
|
|
||||||
|
|
||||||
The following metrics are exported to prometheus
|
|
||||||
|
|
||||||
```
|
|
||||||
# HELP dockcheck_images_analyzed Docker images that have been analyzed
|
|
||||||
# TYPE dockcheck_images_analyzed gauge
|
|
||||||
dockcheck_images_analyzed 22
|
|
||||||
# HELP dockcheck_images_outdated Docker images that are outdated
|
|
||||||
# TYPE dockcheck_images_outdated gauge
|
|
||||||
dockcheck_images_outdated 7
|
|
||||||
# HELP dockcheck_images_latest Docker images that are outdated
|
|
||||||
# TYPE dockcheck_images_latest gauge
|
|
||||||
dockcheck_images_latest 14
|
|
||||||
# HELP dockcheck_images_error Docker images with analysis errors
|
|
||||||
# TYPE dockcheck_images_error gauge
|
|
||||||
dockcheck_images_error 1
|
|
||||||
# HELP dockcheck_images_analyze_timestamp_seconds Last dockercheck run time
|
|
||||||
# TYPE dockcheck_images_analyze_timestamp_seconds gauge
|
|
||||||
dockcheck_images_analyze_timestamp_seconds 1737924029
|
|
||||||
```
|
|
||||||
|
|
||||||
Once those metrics are exported they can be used to define alarms as shown below
|
|
||||||
|
|
||||||
```
|
|
||||||
- alert: dockcheck_images_outdated
|
|
||||||
expr: sum by(instance) (dockcheck_images_outdated) > 0
|
|
||||||
for: 15s
|
|
||||||
labels:
|
|
||||||
severity: warning
|
|
||||||
annotations:
|
|
||||||
summary: "{{ $labels.instance }} has {{ $value }} outdated docker images."
|
|
||||||
description: "{{ $labels.instance }} has {{ $value }} outdated docker images."
|
|
||||||
- alert: dockcheck_images_error
|
|
||||||
expr: sum by(instance) (dockcheck_images_error) > 0
|
|
||||||
for: 15s
|
|
||||||
labels:
|
|
||||||
severity: warning
|
|
||||||
annotations:
|
|
||||||
summary: "{{ $labels.instance }} has {{ $value }} docker images having an error."
|
|
||||||
description: "{{ $labels.instance }} has {{ $value }} docker images having an error."
|
|
||||||
- alert: dockercheck_image_last_analyze
|
|
||||||
expr: (time() - dockcheck_images_analyze_timestamp_seconds) > (3600 * 24 * 3)
|
|
||||||
for: 15s
|
|
||||||
labels:
|
|
||||||
severity: warning
|
|
||||||
annotations:
|
|
||||||
summary: "{{ $labels.instance }} has not updated the dockcheck statistics for more than 3 days."
|
|
||||||
description: "{{ $labels.instance }} has not updated the dockcheck statistics for more than 3 days."
|
|
||||||
```
|
|
||||||
|
|
||||||
There is a reference Grafana dashboard in [grafana/grafana_dashboard.json](./grafana/grafana_dashboard.json).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,382 +0,0 @@
|
||||||
{
|
|
||||||
"__inputs": [
|
|
||||||
{
|
|
||||||
"name": "DS_PROMETHEUS",
|
|
||||||
"label": "prometheus",
|
|
||||||
"description": "",
|
|
||||||
"type": "datasource",
|
|
||||||
"pluginId": "prometheus",
|
|
||||||
"pluginName": "Prometheus"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"__elements": {},
|
|
||||||
"__requires": [
|
|
||||||
{
|
|
||||||
"type": "grafana",
|
|
||||||
"id": "grafana",
|
|
||||||
"name": "Grafana",
|
|
||||||
"version": "11.4.0"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "datasource",
|
|
||||||
"id": "prometheus",
|
|
||||||
"name": "Prometheus",
|
|
||||||
"version": "1.0.0"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "panel",
|
|
||||||
"id": "table",
|
|
||||||
"name": "Table",
|
|
||||||
"version": ""
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"annotations": {
|
|
||||||
"list": [
|
|
||||||
{
|
|
||||||
"builtIn": 1,
|
|
||||||
"datasource": {
|
|
||||||
"type": "grafana",
|
|
||||||
"uid": "-- Grafana --"
|
|
||||||
},
|
|
||||||
"enable": true,
|
|
||||||
"hide": true,
|
|
||||||
"iconColor": "rgba(0, 211, 255, 1)",
|
|
||||||
"name": "Annotations & Alerts",
|
|
||||||
"type": "dashboard"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"editable": true,
|
|
||||||
"fiscalYearStartMonth": 0,
|
|
||||||
"graphTooltip": 0,
|
|
||||||
"id": null,
|
|
||||||
"links": [],
|
|
||||||
"panels": [
|
|
||||||
{
|
|
||||||
"datasource": {
|
|
||||||
"type": "prometheus",
|
|
||||||
"uid": "${DS_PROMETHEUS}"
|
|
||||||
},
|
|
||||||
"fieldConfig": {
|
|
||||||
"defaults": {
|
|
||||||
"color": {
|
|
||||||
"mode": "thresholds"
|
|
||||||
},
|
|
||||||
"custom": {
|
|
||||||
"align": "auto",
|
|
||||||
"cellOptions": {
|
|
||||||
"type": "auto"
|
|
||||||
},
|
|
||||||
"inspect": false
|
|
||||||
},
|
|
||||||
"mappings": [],
|
|
||||||
"thresholds": {
|
|
||||||
"mode": "absolute",
|
|
||||||
"steps": [
|
|
||||||
{
|
|
||||||
"color": "green",
|
|
||||||
"value": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"color": "red",
|
|
||||||
"value": 80
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"overrides": [
|
|
||||||
{
|
|
||||||
"matcher": {
|
|
||||||
"id": "byName",
|
|
||||||
"options": "last_analyze_timestamp"
|
|
||||||
},
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"id": "unit",
|
|
||||||
"value": "dateTimeAsIso"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"matcher": {
|
|
||||||
"id": "byName",
|
|
||||||
"options": "last_analyze_since"
|
|
||||||
},
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"id": "unit",
|
|
||||||
"value": "s"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "custom.cellOptions",
|
|
||||||
"value": {
|
|
||||||
"mode": "gradient",
|
|
||||||
"type": "color-background"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "thresholds",
|
|
||||||
"value": {
|
|
||||||
"mode": "absolute",
|
|
||||||
"steps": [
|
|
||||||
{
|
|
||||||
"color": "green",
|
|
||||||
"value": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"color": "red",
|
|
||||||
"value": 259200
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"matcher": {
|
|
||||||
"id": "byName",
|
|
||||||
"options": "images_outdated"
|
|
||||||
},
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"id": "custom.cellOptions",
|
|
||||||
"value": {
|
|
||||||
"mode": "gradient",
|
|
||||||
"type": "color-background"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "thresholds",
|
|
||||||
"value": {
|
|
||||||
"mode": "absolute",
|
|
||||||
"steps": [
|
|
||||||
{
|
|
||||||
"color": "green",
|
|
||||||
"value": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"color": "red",
|
|
||||||
"value": 1
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"matcher": {
|
|
||||||
"id": "byName",
|
|
||||||
"options": "images_error"
|
|
||||||
},
|
|
||||||
"properties": [
|
|
||||||
{
|
|
||||||
"id": "custom.cellOptions",
|
|
||||||
"value": {
|
|
||||||
"mode": "gradient",
|
|
||||||
"type": "color-background"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "thresholds",
|
|
||||||
"value": {
|
|
||||||
"mode": "absolute",
|
|
||||||
"steps": [
|
|
||||||
{
|
|
||||||
"color": "green",
|
|
||||||
"value": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"color": "red",
|
|
||||||
"value": 1
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"gridPos": {
|
|
||||||
"h": 14,
|
|
||||||
"w": 24,
|
|
||||||
"x": 0,
|
|
||||||
"y": 0
|
|
||||||
},
|
|
||||||
"id": 2,
|
|
||||||
"options": {
|
|
||||||
"cellHeight": "sm",
|
|
||||||
"footer": {
|
|
||||||
"countRows": false,
|
|
||||||
"fields": "",
|
|
||||||
"reducer": [
|
|
||||||
"sum"
|
|
||||||
],
|
|
||||||
"show": false
|
|
||||||
},
|
|
||||||
"frameIndex": 1,
|
|
||||||
"showHeader": true,
|
|
||||||
"sortBy": []
|
|
||||||
},
|
|
||||||
"pluginVersion": "11.4.0",
|
|
||||||
"targets": [
|
|
||||||
{
|
|
||||||
"disableTextWrap": false,
|
|
||||||
"editorMode": "code",
|
|
||||||
"exemplar": false,
|
|
||||||
"expr": "sum by(instance) (dockcheck_images_analyzed)",
|
|
||||||
"format": "table",
|
|
||||||
"fullMetaSearch": false,
|
|
||||||
"hide": false,
|
|
||||||
"includeNullMetadata": true,
|
|
||||||
"instant": true,
|
|
||||||
"interval": "",
|
|
||||||
"legendFormat": "{{instance}}",
|
|
||||||
"range": false,
|
|
||||||
"refId": "dockcheck_images_analyzed",
|
|
||||||
"useBackend": false,
|
|
||||||
"datasource": {
|
|
||||||
"type": "prometheus",
|
|
||||||
"uid": "${DS_PROMETHEUS}"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"datasource": {
|
|
||||||
"type": "prometheus",
|
|
||||||
"uid": "${DS_PROMETHEUS}"
|
|
||||||
},
|
|
||||||
"disableTextWrap": false,
|
|
||||||
"editorMode": "code",
|
|
||||||
"exemplar": false,
|
|
||||||
"expr": "sum by(instance) (dockcheck_images_outdated)",
|
|
||||||
"format": "table",
|
|
||||||
"fullMetaSearch": false,
|
|
||||||
"hide": false,
|
|
||||||
"includeNullMetadata": true,
|
|
||||||
"instant": true,
|
|
||||||
"legendFormat": "{{instance}}",
|
|
||||||
"range": false,
|
|
||||||
"refId": "dockcheck_images_outdated",
|
|
||||||
"useBackend": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"datasource": {
|
|
||||||
"type": "prometheus",
|
|
||||||
"uid": "${DS_PROMETHEUS}"
|
|
||||||
},
|
|
||||||
"disableTextWrap": false,
|
|
||||||
"editorMode": "code",
|
|
||||||
"exemplar": false,
|
|
||||||
"expr": "sum by(instance) (dockcheck_images_latest)",
|
|
||||||
"format": "table",
|
|
||||||
"fullMetaSearch": false,
|
|
||||||
"hide": false,
|
|
||||||
"includeNullMetadata": true,
|
|
||||||
"instant": true,
|
|
||||||
"legendFormat": "{{instance}}",
|
|
||||||
"range": false,
|
|
||||||
"refId": "dockcheck_images_latest",
|
|
||||||
"useBackend": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"datasource": {
|
|
||||||
"type": "prometheus",
|
|
||||||
"uid": "${DS_PROMETHEUS}"
|
|
||||||
},
|
|
||||||
"editorMode": "code",
|
|
||||||
"exemplar": false,
|
|
||||||
"expr": "sum by(instance) (dockcheck_images_error)",
|
|
||||||
"format": "table",
|
|
||||||
"hide": false,
|
|
||||||
"instant": true,
|
|
||||||
"legendFormat": "{{instance}}",
|
|
||||||
"range": false,
|
|
||||||
"refId": "dockcheck_images_error"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"datasource": {
|
|
||||||
"type": "prometheus",
|
|
||||||
"uid": "${DS_PROMETHEUS}"
|
|
||||||
},
|
|
||||||
"editorMode": "code",
|
|
||||||
"exemplar": false,
|
|
||||||
"expr": "dockcheck_images_analyze_timestamp_seconds * 1000",
|
|
||||||
"format": "table",
|
|
||||||
"hide": false,
|
|
||||||
"instant": true,
|
|
||||||
"legendFormat": "{{instance}}",
|
|
||||||
"range": false,
|
|
||||||
"refId": "dockcheck_images_analyze_timestamp_seconds"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"datasource": {
|
|
||||||
"type": "prometheus",
|
|
||||||
"uid": "${DS_PROMETHEUS}"
|
|
||||||
},
|
|
||||||
"editorMode": "code",
|
|
||||||
"exemplar": false,
|
|
||||||
"expr": "time() - dockcheck_images_analyze_timestamp_seconds",
|
|
||||||
"format": "table",
|
|
||||||
"hide": false,
|
|
||||||
"instant": true,
|
|
||||||
"legendFormat": "{{instance}}",
|
|
||||||
"range": false,
|
|
||||||
"refId": "dockcheck_images_last_analyze"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"title": "Dockcheck Status",
|
|
||||||
"transformations": [
|
|
||||||
{
|
|
||||||
"id": "merge",
|
|
||||||
"options": {}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "organize",
|
|
||||||
"options": {
|
|
||||||
"excludeByName": {
|
|
||||||
"Time": true,
|
|
||||||
"__name__": true,
|
|
||||||
"job": true
|
|
||||||
},
|
|
||||||
"includeByName": {},
|
|
||||||
"indexByName": {
|
|
||||||
"Time": 0,
|
|
||||||
"Value #dockcheck_images_analyze_timestamp_seconds": 2,
|
|
||||||
"Value #dockcheck_images_analyzed": 4,
|
|
||||||
"Value #dockcheck_images_error": 7,
|
|
||||||
"Value #dockcheck_images_last_analyze": 3,
|
|
||||||
"Value #dockcheck_images_latest": 5,
|
|
||||||
"Value #dockcheck_images_outdated": 6,
|
|
||||||
"instance": 1,
|
|
||||||
"job": 8
|
|
||||||
},
|
|
||||||
"renameByName": {
|
|
||||||
"Value #A": "analyze_timestamp",
|
|
||||||
"Value #dockcheck_images_analyze_timestamp_seconds": "last_analyze_timestamp",
|
|
||||||
"Value #dockcheck_images_analyzed": "images_analyzed",
|
|
||||||
"Value #dockcheck_images_error": "images_error",
|
|
||||||
"Value #dockcheck_images_last_analyze": "last_analyze_since",
|
|
||||||
"Value #dockcheck_images_latest": "images_latest",
|
|
||||||
"Value #dockcheck_images_outdated": "images_outdated"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"type": "table"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"schemaVersion": 40,
|
|
||||||
"tags": [],
|
|
||||||
"templating": {
|
|
||||||
"list": []
|
|
||||||
},
|
|
||||||
"time": {
|
|
||||||
"from": "now-6h",
|
|
||||||
"to": "now"
|
|
||||||
},
|
|
||||||
"timepicker": {},
|
|
||||||
"timezone": "browser",
|
|
||||||
"title": "Dockcheck Status",
|
|
||||||
"uid": "feb4pv3kv1hxca",
|
|
||||||
"version": 17,
|
|
||||||
"weekStart": ""
|
|
||||||
}
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 50 KiB |
|
|
@ -1,28 +0,0 @@
|
||||||
prometheus_exporter() {
|
|
||||||
checkedImages=$(($1 + $2 + $3))
|
|
||||||
checkTimestamp=$(date +%s)
|
|
||||||
|
|
||||||
promFileContent=()
|
|
||||||
promFileContent+=("# HELP dockcheck_images_analyzed Docker images that have been analyzed")
|
|
||||||
promFileContent+=("# TYPE dockcheck_images_analyzed gauge")
|
|
||||||
promFileContent+=("dockcheck_images_analyzed $checkedImages")
|
|
||||||
|
|
||||||
promFileContent+=("# HELP dockcheck_images_outdated Docker images that are outdated")
|
|
||||||
promFileContent+=("# TYPE dockcheck_images_outdated gauge")
|
|
||||||
promFileContent+=("dockcheck_images_outdated ${#GotUpdates[@]}")
|
|
||||||
|
|
||||||
promFileContent+=("# HELP dockcheck_images_latest Docker images that are outdated")
|
|
||||||
promFileContent+=("# TYPE dockcheck_images_latest gauge")
|
|
||||||
promFileContent+=("dockcheck_images_latest ${#NoUpdates[@]}")
|
|
||||||
|
|
||||||
promFileContent+=("# HELP dockcheck_images_error Docker images with analysis errors")
|
|
||||||
promFileContent+=("# TYPE dockcheck_images_error gauge")
|
|
||||||
promFileContent+=("dockcheck_images_error ${#GotErrors[@]}")
|
|
||||||
|
|
||||||
promFileContent+=("# HELP dockcheck_images_analyze_timestamp_seconds Last dockercheck run time")
|
|
||||||
promFileContent+=("# TYPE dockcheck_images_analyze_timestamp_seconds gauge")
|
|
||||||
promFileContent+=("dockcheck_images_analyze_timestamp_seconds $checkTimestamp")
|
|
||||||
|
|
||||||
printf "%s\n" "${promFileContent[@]}" > "$CollectorTextFileDirectory/dockcheck_info.prom\$\$"
|
|
||||||
mv -f "$CollectorTextFileDirectory/dockcheck_info.prom\$\$" "$CollectorTextFileDirectory/dockcheck_info.prom"
|
|
||||||
}
|
|
||||||
|
|
@ -1,97 +0,0 @@
|
||||||
##### Custom user variables #####
|
|
||||||
## Copy this file to "dockcheck.config" to make it active
|
|
||||||
## Can be placed in ~/.config/ or alongside dockcheck.sh
|
|
||||||
##
|
|
||||||
## Uncomment and set your preferred configuration variables here
|
|
||||||
## This will not be replaced on updates
|
|
||||||
|
|
||||||
#AutoMode=true # Automatic updates, without interaction.
|
|
||||||
#AutoPrune=true # Auto-Prune dangling images after update.
|
|
||||||
#AutoSelfUpdate=true # Allow automatic self updates - caution as this will pull new code and autorun it.
|
|
||||||
#BackupForDays=7 # Enable backups of images and removes backups older than N days.
|
|
||||||
#BarWidth=50 # The character width of the progress bar
|
|
||||||
#CurlConnectTimeout=5 # Time to wait for curl to establish a connection before failing
|
|
||||||
#CurlRetryCount=3 # Max number of curl retries
|
|
||||||
#CurlRetryDelay=1 # Time between curl retries
|
|
||||||
#DaysOld="5" # Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
|
|
||||||
#DisplaySourcedFiles=false # Display what files are being sourced/used
|
|
||||||
#DontUpdate=true # No updates; only checking availability without interaction.
|
|
||||||
#DRunUp=true # Allow checking/updating images created by `docker run`, containers need to be recreated manually.
|
|
||||||
#Exclude="one,two" # Exclude containers, separated by comma.
|
|
||||||
#ForceRestartStacks=true # Force stop+start stack after update. Caution: restarts once for every updated container within stack.
|
|
||||||
#MaxAsync=10 # Set max asynchronous subprocesses, 1 default, 0 to disable.
|
|
||||||
#MonoMode=true # Monochrome mode, no printf colour codes and hides progress bar.
|
|
||||||
#Notify=true # Inform - send a preconfigured notification.
|
|
||||||
#OnlyLabel=true # Only update if label is set. See readme.
|
|
||||||
#OnlySpecific=true # Only compose up the specific container, not the whole compose. (useful for master-compose structure).
|
|
||||||
#PrintMarkdownURL=true # Prints custom releasenote urls as markdown
|
|
||||||
#PrintReleaseURL=true # Prints custom releasenote urls alongside each container with updates (requires urls.list)`
|
|
||||||
#SkipRecreate # Skip container recreation after pulling images.
|
|
||||||
#Stopped="-a" # Include stopped containers in the check. (Logic: docker ps -a).
|
|
||||||
#Timeout=10 # Set a timeout (in seconds) per container for registry checkups.
|
|
||||||
|
|
||||||
##### NOTIFY SETTINGS BELOW #####
|
|
||||||
##
|
|
||||||
## All commented values are examples only. Modify as needed.
|
|
||||||
##
|
|
||||||
## Uncomment the line below and specify the notification channels you wish to enable in a space separated string
|
|
||||||
# NOTIFY_CHANNELS="apprise bark discord DSM file generic gotify HA matrix ntfy pushbullet pushover slack smtp telegram"
|
|
||||||
#
|
|
||||||
## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze
|
|
||||||
# SNOOZE_SECONDS=86400
|
|
||||||
#
|
|
||||||
## Uncomment and set to true to disable notifications when dockcheck itself has updates.
|
|
||||||
# DISABLE_DOCKCHECK_NOTIFICATION=false
|
|
||||||
## Uncomment and set to true to disable notifications when notify scripts themselves have updates.
|
|
||||||
# DISABLE_NOTIFY_NOTIFICATION=false
|
|
||||||
#
|
|
||||||
## Apprise configuration variables. Set APPRISE_PAYLOAD to make a CLI call or set APPRISE_URL to make an API request instead.
|
|
||||||
# APPRISE_PAYLOAD='mailto://myemail:mypass@gmail.com
|
|
||||||
# mastodons://{token}@{host}
|
|
||||||
# pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b
|
|
||||||
# tgram://{bot_token}/{chat_id}/'
|
|
||||||
# APPRISE_URL="http://apprise.mydomain.tld:1234/notify/apprise"
|
|
||||||
#
|
|
||||||
# BARK_KEY="key-value"
|
|
||||||
#
|
|
||||||
# DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/<token string>"
|
|
||||||
#
|
|
||||||
# DSM_SENDMAILTO="me@mydomain.com"
|
|
||||||
# DSM_SUBJECTTAG="Email Subject Prefix"
|
|
||||||
#
|
|
||||||
# FILE_PATH="${ScriptWorkDir}/updates_available.txt"
|
|
||||||
#
|
|
||||||
# GOTIFY_DOMAIN="https://gotify.domain.tld"
|
|
||||||
# GOTIFY_TOKEN="token-value"
|
|
||||||
#
|
|
||||||
# HA_ENTITY="entity"
|
|
||||||
# HA_TOKEN="token"
|
|
||||||
# HA_URL="https://your.homeassistant.url"
|
|
||||||
#
|
|
||||||
# MATRIX_ACCESS_TOKEN="token-value"
|
|
||||||
# MATRIX_ROOM_ID="myroom"
|
|
||||||
# MATRIX_SERVER_URL="https://matrix.yourdomain.tld"
|
|
||||||
#
|
|
||||||
## https://ntfy.sh or your custom domain with https:// and no trailing /
|
|
||||||
# NTFY_DOMAIN="https://ntfy.sh"
|
|
||||||
# NTFY_TOPIC_NAME="YourUniqueTopicName"
|
|
||||||
## Auth method, set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":"
|
|
||||||
# NTFY_AUTH=""
|
|
||||||
#
|
|
||||||
# PUSHBULLET_URL="https://api.pushbullet.com/v2/pushes"
|
|
||||||
# PUSHBULLET_TOKEN="token-value"
|
|
||||||
#
|
|
||||||
# PUSHOVER_URL="https://api.pushover.net/1/messages.json"
|
|
||||||
# PUSHOVER_USER_KEY="userkey"
|
|
||||||
# PUSHOVER_TOKEN="token-value"
|
|
||||||
#
|
|
||||||
# SLACK_CHANNEL_ID=mychannel
|
|
||||||
# SLACK_ACCESS_TOKEN=xoxb-token-value
|
|
||||||
#
|
|
||||||
# SMTP_MAIL_FROM="me@mydomain.tld"
|
|
||||||
# SMTP_MAIL_TO="you@yourdomain.tld"
|
|
||||||
# SMTP_SUBJECT_TAG="dockcheck"
|
|
||||||
#
|
|
||||||
# TELEGRAM_CHAT_ID="mychatid"
|
|
||||||
# TELEGRAM_TOKEN="token-value"
|
|
||||||
# TELEGRAM_TOPIC_ID="0"
|
|
||||||
741
dockcheck.sh
741
dockcheck.sh
|
|
@ -1,104 +1,43 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
VERSION="v0.7.6"
|
VERSION="v0.5.0"
|
||||||
# ChangeNotes: Bugfixes and sanitation. Cleanup of default.config - migrate settings manually (optional).
|
### ChangeNotes: Rewritten notify logic - all templates adjusted, transfer your current settings to a new template! See README.
|
||||||
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"
|
||||||
|
|
||||||
set -uo pipefail
|
### Variables for self updating
|
||||||
shopt -s nullglob
|
|
||||||
shopt -s failglob
|
|
||||||
|
|
||||||
# Variables for self updating
|
|
||||||
ScriptArgs=( "$@" )
|
ScriptArgs=( "$@" )
|
||||||
ScriptPath="$(readlink -f "$0")"
|
ScriptPath="$(readlink -f "$0")"
|
||||||
ScriptWorkDir="$(dirname "$ScriptPath")"
|
ScriptWorkDir="$(dirname "$ScriptPath")"
|
||||||
|
|
||||||
# Source helper functions
|
### Check if there's a new release of the script:
|
||||||
source_if_exists_or_fail() {
|
LatestRelease="$(curl -s -r 0-50 $RawUrl | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
|
||||||
if [[ -s "$1" ]]; then
|
LatestChanges="$(curl -s -r 0-200 $RawUrl | sed -n "/ChangeNotes/s/### ChangeNotes: //p")"
|
||||||
source "$1"
|
|
||||||
[[ "${DisplaySourcedFiles:-false}" == true ]] && echo " * sourced config: ${1}"
|
|
||||||
return 0
|
|
||||||
else
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# User customizable defaults
|
### Help Function:
|
||||||
source_if_exists_or_fail "${HOME}/.config/dockcheck.config" || source_if_exists_or_fail "${ScriptWorkDir}/dockcheck.config"
|
|
||||||
|
|
||||||
# Help Function
|
|
||||||
Help() {
|
Help() {
|
||||||
echo "Syntax: dockcheck.sh [OPTION] [comma separated names to include]"
|
echo "Syntax: dockcheck.sh [OPTION] [part of name to filter]"
|
||||||
echo "Example: dockcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall"
|
echo "Example: dockcheck.sh -y -d 10 -e nextcloud,heimdall"
|
||||||
echo
|
echo
|
||||||
echo "Options:"
|
echo "Options:"
|
||||||
echo "-a|y Automatic updates, without interaction."
|
echo "-a|y Automatic updates, without interaction."
|
||||||
echo "-b N Enable image backups and sets number of days to keep from pruning."
|
|
||||||
echo "-B List currently backed up images, then exit."
|
|
||||||
echo "-c D Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory."
|
|
||||||
echo "-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower."
|
echo "-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower."
|
||||||
echo "-e X Exclude containers, separated by comma."
|
echo "-e X Exclude containers, separated by comma."
|
||||||
echo "-f Force stop+start stack after update. Caution: restarts once for every updated container within stack."
|
echo "-f Force stack restart after update. Caution: restarts once for every updated container within stack."
|
||||||
echo "-F Only compose up the specific container, not the whole compose stack (useful for master-compose structure)."
|
|
||||||
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 "-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 color codes."
|
||||||
echo "-m Monochrome mode, no printf colour codes and hides progress bar."
|
echo "-n No updates, only checking availability."
|
||||||
echo "-M Prints custom releasenote urls as markdown (requires template support)."
|
echo "-p Auto-Prune dangling images after update."
|
||||||
echo "-n No updates; only checking availability without interaction."
|
echo "-r Allow updating images for docker run, wont update the container."
|
||||||
echo "-p Auto-prune dangling images after update."
|
|
||||||
echo "-r Allow checking/updating images created by 'docker run', containers need to be recreated manually."
|
|
||||||
echo "-R Skip container recreation after pulling images."
|
|
||||||
echo "-s Include stopped containers in the check. (Logic: docker ps -a)."
|
echo "-s Include stopped containers in the check. (Logic: docker ps -a)."
|
||||||
echo "-t N Set a timeout (in seconds) per container for registry checkups, 10 is default."
|
echo "-t Set a timeout (in seconds) per container for registry checkups, 10 is default."
|
||||||
echo "-u Allow automatic self updates - caution as this will pull new code and autorun it."
|
|
||||||
echo "-v Prints current version."
|
echo "-v Prints current version."
|
||||||
echo "-x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested."
|
|
||||||
echo
|
echo
|
||||||
echo "Project source: $Github"
|
echo "Project source: $Github"
|
||||||
}
|
}
|
||||||
|
|
||||||
# Print current backups function
|
### Colors:
|
||||||
print_backups() {
|
|
||||||
printf "\n%b---%b Currently backed up images %b---%b\n\n" "$c_teal" "$c_blue" "$c_teal" "$c_reset"
|
|
||||||
docker images | sed -ne '/^REPOSITORY/p' -ne '/^dockcheck/p'
|
|
||||||
}
|
|
||||||
|
|
||||||
# Initialise variables
|
|
||||||
Timeout=${Timeout:-10}
|
|
||||||
MaxAsync=${MaxAsync:-1}
|
|
||||||
BarWidth=${BarWidth:-50}
|
|
||||||
AutoMode=${AutoMode:-false}
|
|
||||||
DontUpdate=${DontUpdate:-false}
|
|
||||||
AutoPrune=${AutoPrune:-false}
|
|
||||||
AutoSelfUpdate=${AutoSelfUpdate:-false}
|
|
||||||
OnlyLabel=${OnlyLabel:-false}
|
|
||||||
Notify=${Notify:-false}
|
|
||||||
ForceRestartStacks=${ForceRestartStacks:-false}
|
|
||||||
DRunUp=${DRunUp:-false}
|
|
||||||
MonoMode=${MonoMode:-false}
|
|
||||||
PrintReleaseURL=${PrintReleaseURL:-false}
|
|
||||||
PrintMarkdownURL=${PrintMarkdownURL:-false}
|
|
||||||
Stopped=${Stopped:-""}
|
|
||||||
CollectorTextFileDirectory=${CollectorTextFileDirectory:-}
|
|
||||||
Exclude=${Exclude:-}
|
|
||||||
DaysOld=${DaysOld:-}
|
|
||||||
BackupForDays=${BackupForDays:-}
|
|
||||||
OnlySpecific=${OnlySpecific:-false}
|
|
||||||
SpecificContainer=${SpecificContainer:-""}
|
|
||||||
SkipRecreate=${SkipRecreate:-false}
|
|
||||||
Excludes=()
|
|
||||||
GotUpdates=()
|
|
||||||
NoUpdates=()
|
|
||||||
GotErrors=()
|
|
||||||
SelectedUpdates=()
|
|
||||||
CurlArgs="--retry ${CurlRetryCount:=3} --retry-delay ${CurlRetryDelay:=1} --connect-timeout ${CurlConnectTimeout:=5} -sf"
|
|
||||||
regbin=""
|
|
||||||
jqbin=""
|
|
||||||
|
|
||||||
# Colours
|
|
||||||
c_red="\033[0;31m"
|
c_red="\033[0;31m"
|
||||||
c_green="\033[0;32m"
|
c_green="\033[0;32m"
|
||||||
c_yellow="\033[0;33m"
|
c_yellow="\033[0;33m"
|
||||||
|
|
@ -106,327 +45,163 @@ c_blue="\033[0;34m"
|
||||||
c_teal="\033[0;36m"
|
c_teal="\033[0;36m"
|
||||||
c_reset="\033[0m"
|
c_reset="\033[0m"
|
||||||
|
|
||||||
# Timestamps
|
Timeout=10
|
||||||
RunTimestamp=$(date +'%Y-%m-%d_%H%M')
|
Stopped=""
|
||||||
RunEpoch=$(date +'%s')
|
while getopts "aynpfrhlisvme:d:t:" options; do
|
||||||
|
|
||||||
while getopts "ayb:BfFhiIlmMnprsuvc:e:d:t:x:R" options; do
|
|
||||||
case "${options}" in
|
case "${options}" in
|
||||||
a|y) AutoMode=true ;;
|
a|y) AutoUp="yes" ;;
|
||||||
b) BackupForDays="${OPTARG}" ;;
|
n) AutoUp="no" ;;
|
||||||
B) print_backups; exit 0 ;;
|
r) DRunUp="yes" ;;
|
||||||
c) CollectorTextFileDirectory="${OPTARG}" ;;
|
p) AutoPrune="yes" ;;
|
||||||
d) DaysOld=${OPTARG} ;;
|
|
||||||
e) Exclude=${OPTARG} ;;
|
|
||||||
f) ForceRestartStacks=true ;;
|
|
||||||
F) OnlySpecific=true ;;
|
|
||||||
i) Notify=true ;;
|
|
||||||
I) PrintReleaseURL=true ;;
|
|
||||||
l) OnlyLabel=true ;;
|
l) OnlyLabel=true ;;
|
||||||
m) MonoMode=true ;;
|
f) ForceRestartStacks=true ;;
|
||||||
M) PrintMarkdownURL=true ;;
|
i) [ -s "$ScriptWorkDir"/notify.sh ] && { source "$ScriptWorkDir"/notify.sh ; Notify="yes" ; } ;;
|
||||||
n) DontUpdate=true; AutoMode=true;;
|
e) Exclude=${OPTARG} ;;
|
||||||
p) AutoPrune=true ;;
|
m) declare c_{red,green,yellow,blue,teal,reset}="" ;;
|
||||||
R) SkipRecreate=true ;;
|
|
||||||
r) DRunUp=true ;;
|
|
||||||
s) Stopped="-a" ;;
|
s) Stopped="-a" ;;
|
||||||
t) Timeout="${OPTARG}" ;;
|
t) Timeout="${OPTARG}" ;;
|
||||||
u) AutoSelfUpdate=true ;;
|
v) printf "%s\n" "$VERSION" ; exit 0 ;;
|
||||||
v) printf "%s\n" "$VERSION"; exit 0 ;;
|
d) DaysOld=${OPTARG}
|
||||||
x) MaxAsync=${OPTARG} ;;
|
if ! [[ $DaysOld =~ ^[0-9]+$ ]] ; then { printf "Days -d argument given (%s) is not a number.\n" "${DaysOld}" ; exit 2 ; } ; fi ;;
|
||||||
h|*) Help; exit 2 ;;
|
h|*) Help ; exit 2 ;;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
shift "$((OPTIND-1))"
|
shift "$((OPTIND-1))"
|
||||||
|
|
||||||
# Set $1 to a variable for name filtering later, rewriting if multiple
|
|
||||||
SearchName="${1:-}"
|
|
||||||
if [[ ! -z "$SearchName" ]]; then
|
|
||||||
SearchName="^(${SearchName//,/|})$"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check if there's a new release of the script
|
|
||||||
LatestSnippet="$(curl ${CurlArgs} -r 0-200 "$RawUrl" || printf "undefined")"
|
|
||||||
LatestRelease="$(echo "${LatestSnippet}" | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
|
|
||||||
LatestChanges="$(echo "${LatestSnippet}" | sed -n "/ChangeNotes/s/# ChangeNotes: //p")"
|
|
||||||
|
|
||||||
# Basic notify configuration check
|
|
||||||
if [[ "${Notify}" == true ]] && [[ ! -s "${ScriptWorkDir}/notify.sh" ]] && [[ -z "${NOTIFY_CHANNELS:-}" ]]; then
|
|
||||||
printf "Using v2 notifications with -i flag passed but no notify channels configured in dockcheck.config. This will result in no notifications being sent.\n"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Setting up options and sourcing functions
|
|
||||||
if [[ "$DontUpdate" == true ]]; then AutoMode=true; fi
|
|
||||||
if [[ "$MonoMode" == true ]]; then declare c_{red,green,yellow,blue,teal,reset}=""; fi
|
|
||||||
if [[ "$Notify" == true ]]; then
|
|
||||||
source_if_exists_or_fail "${ScriptWorkDir}/notify.sh" || source_if_exists_or_fail "${ScriptWorkDir}/notify_templates/notify_v2.sh" || Notify=false
|
|
||||||
fi
|
|
||||||
if [[ -n "$Exclude" ]]; then
|
|
||||||
IFS=',' read -ra Excludes <<< "$Exclude"
|
|
||||||
unset IFS
|
|
||||||
fi
|
|
||||||
if [[ -n "$DaysOld" ]]; then
|
|
||||||
if ! [[ $DaysOld =~ ^[0-9]+$ ]]; then
|
|
||||||
printf "Days -d argument given (%s) is not a number.\n" "$DaysOld"
|
|
||||||
exit 2
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
if [[ -n "$BackupForDays" ]]; then
|
|
||||||
if ! [[ $BackupForDays =~ ^[0-9]+$ ]]; then
|
|
||||||
printf "-b argument given (%s) is not a number.\n" "$BackupForDays"
|
|
||||||
exit 2
|
|
||||||
fi
|
|
||||||
[[ "$AutoPrune" == true ]] && printf "%bWARNING: When -b option is used, -p has no function.%b\n" "$c_yellow" "$c_reset"
|
|
||||||
fi
|
|
||||||
if [[ -n "$CollectorTextFileDirectory" ]]; then
|
|
||||||
if ! [[ -d $CollectorTextFileDirectory ]]; then
|
|
||||||
printf "The directory (%s) does not exist.\n" "$CollectorTextFileDirectory"
|
|
||||||
exit 2
|
|
||||||
else
|
|
||||||
source "${ScriptWorkDir}/addons/prometheus/prometheus_collector.sh"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
exec_if_exists() {
|
|
||||||
if [[ $(type -t $1) == function ]]; then "$@"; fi
|
|
||||||
}
|
|
||||||
|
|
||||||
exec_if_exists_or_fail() {
|
|
||||||
[[ $(type -t $1) == function ]] && "$@"
|
|
||||||
}
|
|
||||||
|
|
||||||
self_update_curl() {
|
self_update_curl() {
|
||||||
cp "$ScriptPath" "$ScriptPath".bak
|
cp "$ScriptPath" "$ScriptPath".bak
|
||||||
if command -v curl &>/dev/null; then
|
if [[ $(builtin type -P curl) ]]; then
|
||||||
curl ${CurlArgs} -L $RawUrl > "$ScriptPath"; chmod +x "$ScriptPath" || { printf "ERROR: Failed to curl updated Dockcheck.sh script. Skipping update.\n"; return 1; }
|
curl -L $RawUrl > "$ScriptPath" ; chmod +x "$ScriptPath"
|
||||||
printf "\n%b---%b starting over with the updated version %b---%b\n" "$c_yellow" "$c_teal" "$c_yellow" "$c_reset"
|
printf "\n%s\n" "--- starting over with the updated version ---"
|
||||||
exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
|
exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
|
||||||
exit 1 # Exit the old instance
|
exit 1 # exit the old instance
|
||||||
elif command -v wget &>/dev/null; then
|
elif [[ $(builtin type -P wget) ]]; then
|
||||||
wget --waitretry=1 --timeout=15 -t 10 $RawUrl -O "$ScriptPath"; chmod +x "$ScriptPath"
|
wget $RawUrl -O "$ScriptPath" ; chmod +x "$ScriptPath"
|
||||||
printf "\n%b---%b starting over with the updated version %b---%b\n" "$c_yellow" "$c_teal" "$c_yellow" "$c_reset"
|
printf "\n%s\n" "--- starting over with the updated version ---"
|
||||||
exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
|
exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
|
||||||
exit 0 # exit the old instance
|
exit 1 # exit the old instance
|
||||||
else
|
else
|
||||||
printf "\n%bcurl/wget not available %b- download the update manually: %b%s %b\n" "$c_red" "$c_reset" "$c_teal" "$Github" "$c_reset"
|
printf "curl/wget not available - download the update manually: %s \n" "$Github"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
self_update() {
|
self_update() {
|
||||||
cd "$ScriptWorkDir" || { printf "%bPath error,%b skipping update.\n" "$c_red" "$c_reset"; return; }
|
cd "$ScriptWorkDir" || { printf "Path error, skipping update.\n" ; return ; }
|
||||||
if command -v git &>/dev/null && [[ "$(git ls-remote --get-url 2>/dev/null)" =~ .*"mag37/dockcheck".* ]]; then
|
if [[ $(builtin type -P git) ]] && [[ "$(git ls-remote --get-url 2>/dev/null)" =~ .*"mag37/dockcheck".* ]] ; then
|
||||||
printf "\n%s\n" "Pulling the latest version."
|
printf "\n%s\n" "Pulling the latest version."
|
||||||
git pull --force || { printf "%bGit error,%b manually pull/clone.\n" "$c_red" "$c_reset"; return; }
|
git pull --force || { printf "Git error, manually pull/clone.\n" ; return ; }
|
||||||
printf "\n%s\n" "--- starting over with the updated version ---"
|
printf "\n%s\n" "--- starting over with the updated version ---"
|
||||||
cd - || { printf "%bPath error.%b\n" "$c_red" "$c_reset"; return; }
|
cd - || { printf "Path error.\n" ; return ; }
|
||||||
exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
|
exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
|
||||||
exit 0 # exit the old instance
|
exit 1 # exit the old instance
|
||||||
else
|
else
|
||||||
cd - || { printf "%bPath error.%b\n" "$c_red" "$c_reset"; return; }
|
cd - || { printf "Path error.\n" ; return ; }
|
||||||
self_update_curl
|
self_update_curl
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
### Choose from list -function:
|
||||||
choosecontainers() {
|
choosecontainers() {
|
||||||
while [[ -z "${ChoiceClean:-}" ]]; do
|
while [[ -z "$ChoiceClean" ]]; do
|
||||||
read -r -p "Enter number(s) separated by comma, [a] for all - [q] to quit: " Choice
|
read -r -p "Enter number(s) separated by comma, [a] for all - [q] to quit: " Choice
|
||||||
if [[ "$Choice" =~ [qQnN] ]]; then
|
if [[ "$Choice" =~ [qQnN] ]] ; then
|
||||||
[[ -n "${BackupForDays:-}" ]] && remove_backups
|
|
||||||
exit 0
|
exit 0
|
||||||
elif [[ "$Choice" =~ [aAyY] ]]; then
|
elif [[ "$Choice" =~ [aAyY] ]] ; then
|
||||||
SelectedUpdates=( "${GotUpdates[@]}" )
|
SelectedUpdates=( "${GotUpdates[@]}" )
|
||||||
ChoiceClean=${Choice//[,.:;]/ }
|
ChoiceClean=${Choice//[,.:;]/ }
|
||||||
else
|
else
|
||||||
ChoiceClean=${Choice//[,.:;]/ }
|
ChoiceClean=${Choice//[,.:;]/ }
|
||||||
for CC in $ChoiceClean; do
|
for CC in $ChoiceClean ; do
|
||||||
CC=$((10#$CC)) # Base 10 interpretation to strip leading zeroes
|
if [[ "$CC" -lt 1 || "$CC" -gt $UpdCount ]] ; then # reset choice if out of bounds
|
||||||
if [[ "$CC" -lt 1 || "$CC" -gt $UpdCount ]]; then # Reset choice if out of bounds
|
echo "Number not in list: $CC" ; unset ChoiceClean ; break 1
|
||||||
echo "Number not in list: $CC"; unset ChoiceClean; break 1
|
|
||||||
else
|
else
|
||||||
SelectedUpdates+=( "${GotUpdates[$CC-1]}" )
|
SelectedUpdates+=( "${GotUpdates[$CC-1]}" )
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
|
printf "\nUpdating containers:\n"
|
||||||
|
printf "%s\n" "${SelectedUpdates[@]}"
|
||||||
|
printf "\n"
|
||||||
}
|
}
|
||||||
|
|
||||||
datecheck() {
|
datecheck() {
|
||||||
ImageDate="$1"
|
ImageDate=$($regbin -v error image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1 )
|
||||||
DaysMax="$2"
|
ImageAge=$(( ( $(date +%s) - $(date -d "$ImageDate" +%s) )/86400 ))
|
||||||
ImageEpoch=$(date -d "$ImageDate" +%s 2>/dev/null) || ImageEpoch=$(date -f "%Y-%m-%d" -j "$ImageDate" +%s)
|
if [ "$ImageAge" -gt "$DaysOld" ] ; then
|
||||||
ImageAge=$(( ( RunEpoch - ImageEpoch )/86400 ))
|
|
||||||
if [[ "$ImageAge" -gt "$DaysMax" ]]; then
|
|
||||||
return 0
|
return 0
|
||||||
else
|
else
|
||||||
return 1
|
return 1
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
remove_backups() {
|
|
||||||
IFS=$'\n'
|
|
||||||
CleanupCount=0
|
|
||||||
for backup_img in $(docker images --format "{{.Repository}} {{.Tag}}" | sed -n '/^dockcheck/p'); do
|
|
||||||
repo_name=${backup_img% *}
|
|
||||||
backup_tag=${backup_img#* }
|
|
||||||
backup_date=${backup_tag%%_*}
|
|
||||||
# UNTAGGING HERE
|
|
||||||
if datecheck "$backup_date" "$BackupForDays"; then
|
|
||||||
[[ "$CleanupCount" == 0 ]] && printf "\n%bRemoving backed up images older then %s days.%b\n" "$c_blue" "$BackupForDays" "$c_reset"
|
|
||||||
docker rmi "${repo_name}:${backup_tag}" && ((CleanupCount+=1))
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
unset IFS
|
|
||||||
if [[ "$CleanupCount" == 0 ]]; then
|
|
||||||
printf "\nNo backup images to remove.\n"
|
|
||||||
else
|
|
||||||
[[ "$CleanupCount" -gt 1 ]] && b_phrase="backups" || b_phrase="backup"
|
|
||||||
printf "\n%b%s%b %s removed.%b\n" "$c_green" "$CleanupCount" "$c_teal" "$b_phrase" "$c_reset"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
progress_bar() {
|
progress_bar() {
|
||||||
QueCurrent="$1"
|
QueCurrent="$1"
|
||||||
QueTotal="$2"
|
QueTotal="$2"
|
||||||
BarWidth=${BarWidth:-50}
|
|
||||||
((Percent=100*QueCurrent/QueTotal))
|
((Percent=100*QueCurrent/QueTotal))
|
||||||
((Complete=BarWidth*Percent/100))
|
((Complete=50*Percent/100)) # change first number for width (50)
|
||||||
((Left=BarWidth-Complete)) || true # to not throw error when result is 0
|
((Left=50-Complete)) # change first number for width (50)
|
||||||
BarComplete=$(printf "%${Complete}s" | tr " " "#")
|
BarComplete=$(printf "%${Complete}s" | tr " " "#")
|
||||||
BarLeft=$(printf "%${Left}s" | tr " " "-")
|
BarLeft=$(printf "%${Left}s" | tr " " "-")
|
||||||
if [[ "$QueTotal" != "$QueCurrent" ]]; then
|
[[ "$QueTotal" == "$QueCurrent" ]] || printf "\r[%s%s] %s/%s " "$BarComplete" "$BarLeft" "$QueCurrent" "$QueTotal"
|
||||||
printf "\r[%s%s] %s/%s " "$BarComplete" "$BarLeft" "$QueCurrent" "$QueTotal"
|
[[ "$QueTotal" == "$QueCurrent" ]] && printf "\r[%b%s%b] %s/%s \n" "$c_teal" "$BarComplete" "$c_reset" "$QueCurrent" "$QueTotal"
|
||||||
else
|
|
||||||
printf "\r[%b%s%b] %s/%s \n" "$c_teal" "$BarComplete" "$c_reset" "$QueCurrent" "$QueTotal"
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Function to add user-provided urls to releasenotes
|
### Function to add user-provided urls to releasenotes
|
||||||
releasenotes() {
|
releasenotes() {
|
||||||
unset Updates
|
for update in ${GotUpdates[@]}; do
|
||||||
for update in "${GotUpdates[@]}"; do
|
|
||||||
found=false
|
found=false
|
||||||
while read -r container url; do
|
while read -r container url; do
|
||||||
if [[ "$update" == "$container" ]] && [[ "$PrintMarkdownURL" == true ]]; then Updates+=("- [$update]($url)"); found=true;
|
[[ $update == $container ]] && Updates+=("$update -> $url") && found=true
|
||||||
elif [[ "$update" == "$container" ]]; then Updates+=("$update -> $url"); found=true;
|
done < "$ScriptWorkDir"/urls.list
|
||||||
fi
|
[[ $found == false ]] && Updates+=("$update -> url missing") || continue
|
||||||
done < "${ScriptWorkDir}/urls.list"
|
|
||||||
if [[ "$found" == false ]] && [[ "$PrintMarkdownURL" == true ]]; then Updates+=("- $update -> url missing");
|
|
||||||
elif [[ "$found" == false ]]; then Updates+=("$update -> url missing");
|
|
||||||
else continue;
|
|
||||||
fi
|
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
# Static binary downloader for dependencies
|
### Version check & initiate self update
|
||||||
binary_downloader() {
|
if [[ "$VERSION" != "$LatestRelease" ]] ; then
|
||||||
BinaryName="$1"
|
printf "New version available! %b%s%b ⇒ %b%s%b \n Change Notes: %s \n" "$c_yellow" "$VERSION" "$c_reset" "$c_green" "$LatestRelease" "$c_reset" "$LatestChanges"
|
||||||
BinaryUrl="$2"
|
if [[ -z "$AutoUp" ]] ; then
|
||||||
case "$(uname -m)" in
|
read -r -p "Would you like to update? y/[n]: " SelfUpdate
|
||||||
x86_64|amd64) architecture="amd64" ;;
|
[[ "$SelfUpdate" =~ [yY] ]] && self_update
|
||||||
arm64|aarch64) architecture="arm64";;
|
|
||||||
*) printf "\n%bArchitecture not supported, exiting.%b\n" "$c_red" "$c_reset"; exit 1;;
|
|
||||||
esac
|
|
||||||
GetUrl="${BinaryUrl/TEMP/"$architecture"}"
|
|
||||||
if command -v curl &>/dev/null; then curl ${CurlArgs} -L "$GetUrl" > "$ScriptWorkDir/$BinaryName" || { printf "ERROR: Failed to curl binary dependency. Rerun the script to retry.\n"; exit 1; }
|
|
||||||
elif command -v wget &>/dev/null; then wget --waitretry=1 --timeout=15 -t 10 "$GetUrl" -O "$ScriptWorkDir/$BinaryName";
|
|
||||||
else printf "\n%bcurl/wget not available - get %s manually from the repo link, exiting.%b" "$c_red" "$BinaryName" "$c_reset"; exit 1;
|
|
||||||
fi
|
fi
|
||||||
[[ -f "$ScriptWorkDir/$BinaryName" ]] && chmod +x "$ScriptWorkDir/$BinaryName"
|
|
||||||
}
|
|
||||||
|
|
||||||
distro_checker() {
|
|
||||||
isRoot=false
|
|
||||||
[[ ${EUID:-} == 0 ]] && isRoot=true
|
|
||||||
if [[ -f /etc/alpine-release ]] ; then
|
|
||||||
[[ "$isRoot" == true ]] && PkgInstaller="apk add" || PkgInstaller="doas apk add"
|
|
||||||
elif [[ -f /etc/arch-release ]]; then
|
|
||||||
[[ "$isRoot" == true ]] && PkgInstaller="pacman -S" || PkgInstaller="sudo pacman -S"
|
|
||||||
elif [[ -f /etc/debian_version ]]; then
|
|
||||||
[[ "$isRoot" == true ]] && PkgInstaller="apt-get install" || PkgInstaller="sudo apt-get install"
|
|
||||||
elif [[ -f /etc/redhat-release ]]; then
|
|
||||||
[[ "$isRoot" == true ]] && PkgInstaller="dnf install" || PkgInstaller="sudo dnf install"
|
|
||||||
elif [[ -f /etc/SuSE-release ]]; then
|
|
||||||
[[ "$isRoot" == true ]] && PkgInstaller="zypper install" || PkgInstaller="sudo zypper install"
|
|
||||||
elif [[ $(uname -s) == "Darwin" ]]; then PkgInstaller="brew install"
|
|
||||||
else PkgInstaller="ERROR"; printf "\n%bNo distribution could be determined%b, falling back to static binary.\n" "$c_yellow" "$c_reset"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# Dependency check + installer function
|
|
||||||
dependency_check() {
|
|
||||||
AppName="$1"
|
|
||||||
AppVar="$2"
|
|
||||||
AppUrl="$3"
|
|
||||||
if command -v "$AppName" &>/dev/null; then export "$AppVar"="$AppName";
|
|
||||||
elif [[ -f "$ScriptWorkDir/$AppName" ]]; then export "$AppVar"="$ScriptWorkDir/$AppName";
|
|
||||||
else
|
|
||||||
printf "\nRequired dependency %b'%s'%b missing, do you want to install it?\n" "$c_teal" "$AppName" "$c_reset"
|
|
||||||
read -r -p "y: With packagemanager (sudo). / s: Download static binary. y/s/[n] " GetBin
|
|
||||||
GetBin=${GetBin:-no} # set default to no if nothing is given
|
|
||||||
if [[ "$GetBin" =~ [yYsS] ]]; then
|
|
||||||
[[ "$GetBin" =~ [yY] ]] && distro_checker
|
|
||||||
if [[ -n "${PkgInstaller:-}" && "${PkgInstaller:-}" != "ERROR" ]]; then
|
|
||||||
[[ $(uname -s) == "Darwin" && "$AppName" == "regctl" ]] && AppName="regclient"
|
|
||||||
if $PkgInstaller "$AppName"; then
|
|
||||||
AppName="$1"
|
|
||||||
export "$AppVar"="$AppName"
|
|
||||||
printf "\n%b%b installed.%b\n" "$c_green" "$AppName" "$c_reset"
|
|
||||||
else
|
|
||||||
PkgInstaller="ERROR"
|
|
||||||
printf "\n%bPackagemanager install failed%b, falling back to static binary.\n" "$c_yellow" "$c_reset"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
if [[ "$GetBin" =~ [sS] ]] || [[ "$PkgInstaller" == "ERROR" ]]; then
|
|
||||||
binary_downloader "$AppName" "$AppUrl"
|
|
||||||
[[ -f "$ScriptWorkDir/$AppName" ]] && { export "$AppVar"="$ScriptWorkDir/$1" && printf "\n%b%s downloaded.%b\n" "$c_green" "$AppName" "$c_reset"; }
|
|
||||||
fi
|
|
||||||
else printf "\n%bDependency missing, exiting.%b\n" "$c_red" "$c_reset"; exit 1;
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
# Final check if binary is correct
|
|
||||||
[[ "$1" == "jq" ]] && VerFlag="--version"
|
|
||||||
[[ "$1" == "regctl" ]] && VerFlag="version"
|
|
||||||
${!AppVar} "$VerFlag" &> /dev/null || { printf "%s\n" "$AppName is not working - try to remove it and re-download it, exiting."; exit 1; }
|
|
||||||
}
|
|
||||||
|
|
||||||
dependency_check "regctl" "regbin" "https://github.com/regclient/regclient/releases/latest/download/regctl-linux-TEMP"
|
|
||||||
dependency_check "jq" "jqbin" "https://github.com/jqlang/jq/releases/latest/download/jq-linux-TEMP"
|
|
||||||
|
|
||||||
# Numbered List function - pads with zero
|
|
||||||
list_options() {
|
|
||||||
local total="${#Updates[@]}"
|
|
||||||
[[ ${#total} < 2 ]] && local pads=2 || local pads="${#total}"
|
|
||||||
local num=1
|
|
||||||
for update in "${Updates[@]}"; do
|
|
||||||
printf "%0*d - %s\n" "$pads" "$num" "$update"
|
|
||||||
((num++))
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
# Version check & initiate self update
|
|
||||||
if [[ "$LatestSnippet" != "undefined" ]]; then
|
|
||||||
if [[ "$VERSION" != "$LatestRelease" ]]; then
|
|
||||||
printf "New version available! %b%s%b ⇒ %b%s%b \n Change Notes: %s \n" "$c_yellow" "$VERSION" "$c_reset" "$c_green" "$LatestRelease" "$c_reset" "$LatestChanges"
|
|
||||||
if [[ "$AutoMode" == false ]]; then
|
|
||||||
read -r -p "Would you like to update? y/[n]: " SelfUpdate
|
|
||||||
[[ "$SelfUpdate" =~ [yY] ]] && self_update
|
|
||||||
elif [[ "$AutoMode" == true ]] && [[ "$AutoSelfUpdate" == true ]]; then self_update;
|
|
||||||
else
|
|
||||||
[[ "$Notify" == true ]] && { exec_if_exists_or_fail dockcheck_notification "$VERSION" "$LatestRelease" "$LatestChanges" || printf "Could not source notification function.\n"; }
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
printf "ERROR: Failed to curl latest Dockcheck.sh release version.\n"
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Version check for notify templates
|
### Set $1 to a variable for name filtering later.
|
||||||
[[ "$Notify" == true ]] && [[ ! -s "${ScriptWorkDir}/notify.sh" ]] && { exec_if_exists_or_fail notify_update_notification || printf "Could not source notify notification function.\n"; }
|
SearchName="$1"
|
||||||
|
### Create array of excludes
|
||||||
|
IFS=',' read -r -a Excludes <<< "$Exclude" ; unset IFS
|
||||||
|
|
||||||
# Check docker compose binary
|
### Check if required binary exists in PATH or directory:
|
||||||
docker info &>/dev/null || { printf "\n%bYour current user does not have permissions to the docker socket - may require root / docker group. Exiting.%b\n" "$c_red" "$c_reset"; exit 1; }
|
if [[ $(builtin type -P "regctl") ]]; then regbin="regctl" ;
|
||||||
if docker compose version &>/dev/null; then DockerBin="docker compose" ;
|
elif [[ -f "$ScriptWorkDir/regctl" ]]; then regbin="$ScriptWorkDir/regctl" ;
|
||||||
elif docker-compose -v &>/dev/null; then DockerBin="docker-compose" ;
|
else
|
||||||
elif docker -v &>/dev/null; then
|
read -r -p "Required dependency 'regctl' missing, do you want it downloaded? y/[n] " GetDep
|
||||||
|
if [[ "$GetDep" =~ [yY] ]] ; then
|
||||||
|
### Check arch:
|
||||||
|
case "$(uname --machine)" in
|
||||||
|
x86_64|amd64) architecture="amd64" ;;
|
||||||
|
arm64|aarch64) architecture="arm64";;
|
||||||
|
*) echo "Architecture not supported, exiting." ; exit 1;;
|
||||||
|
esac
|
||||||
|
RegUrl="https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture"
|
||||||
|
if [[ $(builtin type -P curl) ]]; then curl -L $RegUrl > "$ScriptWorkDir/regctl" ; chmod +x "$ScriptWorkDir/regctl" ; regbin="$ScriptWorkDir/regctl" ;
|
||||||
|
elif [[ $(builtin type -P wget) ]]; then wget $RegUrl -O "$ScriptWorkDir/regctl" ; chmod +x "$ScriptWorkDir/regctl" ; regbin="$ScriptWorkDir/regctl" ;
|
||||||
|
else
|
||||||
|
printf "%s\n" "curl/wget not available - get regctl manually from the repo link, quitting."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
printf "%s\n" "Dependency missing, quitting."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
### final check if binary is correct
|
||||||
|
$regbin version &> /dev/null || { printf "%s\n" "regctl is not working - try to remove it and re-download it, exiting."; exit 1; }
|
||||||
|
|
||||||
|
### Check docker compose binary:
|
||||||
|
if docker compose version &> /dev/null ; then DockerBin="docker compose" ;
|
||||||
|
elif docker-compose -v &> /dev/null; then DockerBin="docker-compose" ;
|
||||||
|
elif docker -v &> /dev/null; then
|
||||||
printf "%s\n" "No docker compose binary available, using plain docker (Not recommended!)"
|
printf "%s\n" "No docker compose binary available, using plain docker (Not recommended!)"
|
||||||
printf "%s\n" "'docker run' will ONLY update images, not the container itself."
|
printf "%s\n" "'docker run' will ONLY update images, not the container itself."
|
||||||
else
|
else
|
||||||
|
|
@ -434,21 +209,30 @@ else
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Listing typed exclusions
|
### Numbered List -function:
|
||||||
if [[ -n ${Excludes[*]:-} ]]; then
|
options() {
|
||||||
|
num=1
|
||||||
|
for i in "${GotUpdates[@]}"; do
|
||||||
|
echo "$num) $i"
|
||||||
|
((num++))
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
### Listing typed exclusions:
|
||||||
|
if [[ -n ${Excludes[*]} ]] ; then
|
||||||
printf "\n%bExcluding these names:%b\n" "$c_blue" "$c_reset"
|
printf "\n%bExcluding these names:%b\n" "$c_blue" "$c_reset"
|
||||||
printf "%s\n" "${Excludes[@]}"
|
printf "%s\n" "${Excludes[@]}"
|
||||||
printf "\n"
|
printf "\n"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Variables for progress_bar function
|
# Variables for progress_bar function
|
||||||
ContCount=$(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}' | wc -l)
|
DocCount=$(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}' | wc -l)
|
||||||
RegCheckQue=0
|
RegCheckQue=0
|
||||||
|
|
||||||
# Testing and setting timeout binary
|
### Testing and setting timeout binary
|
||||||
t_out=$(command -v timeout || echo "")
|
t_out=$(type -P "timeout")
|
||||||
if [[ $t_out ]]; then
|
if [[ $t_out ]]; then
|
||||||
t_out=$(realpath "$t_out" 2>/dev/null || readlink -f "$t_out")
|
t_out=$(realpath $t_out 2>/dev/null || readlink -f $t_out)
|
||||||
if [[ $t_out =~ "busybox" ]]; then
|
if [[ $t_out =~ "busybox" ]]; then
|
||||||
t_out="timeout ${Timeout}"
|
t_out="timeout ${Timeout}"
|
||||||
else t_out="timeout --foreground ${Timeout}"
|
else t_out="timeout --foreground ${Timeout}"
|
||||||
|
|
@ -456,158 +240,81 @@ if [[ $t_out ]]; then
|
||||||
else t_out=""
|
else t_out=""
|
||||||
fi
|
fi
|
||||||
|
|
||||||
check_image() {
|
### Check the image-hash of every running container VS the registry
|
||||||
i="$1"
|
for i in $(docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}') ; do
|
||||||
local Excludes=($Excludes_string)
|
((RegCheckQue+=1))
|
||||||
for e in "${Excludes[@]}"; do
|
progress_bar "$RegCheckQue" "$DocCount"
|
||||||
if [[ "$i" == "$e" ]]; then
|
### Looping every item over the list of excluded names and skipping:
|
||||||
printf "%s\n" "Skip $i"
|
for e in "${Excludes[@]}" ; do [[ "$i" == "$e" ]] && continue 2 ; done
|
||||||
return
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Skipping non-compose containers unless option is set
|
|
||||||
ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}')
|
|
||||||
ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
|
|
||||||
[[ "$ContPath" == "null" ]] && ContPath=""
|
|
||||||
if [[ -z "$ContPath" ]] && [[ "$DRunUp" == false ]]; then
|
|
||||||
printf "%s\n" "NoUpdates !$i - not checked, no compose file"
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
# Checking if Label Only -option is set, and if container got the label
|
|
||||||
ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
|
|
||||||
[[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel=""
|
|
||||||
[[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "Skip $i"; return; } }
|
|
||||||
|
|
||||||
local NoUpdates GotUpdates GotErrors
|
|
||||||
ImageId=$(docker inspect "$i" --format='{{.Image}}')
|
|
||||||
RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
|
RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
|
||||||
LocalHash=$(docker image inspect "$ImageId" --format '{{.RepoDigests}}')
|
LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
|
||||||
|
# Checking for errors while setting the variable:
|
||||||
# Checking for errors while setting the variable
|
if RegHash=$(${t_out} $regbin -v error image digest --list "$RepoUrl" 2>&1) ; then
|
||||||
if RegHash=$($t_out "$regbin" -v error image digest --list "$RepoUrl" 2>&1); then
|
if [[ "$LocalHash" = *"$RegHash"* ]] ; then
|
||||||
if [[ "$LocalHash" == *"$RegHash"* ]]; then
|
NoUpdates+=("$i")
|
||||||
printf "%s\n" "NoUpdates $i"
|
|
||||||
else
|
else
|
||||||
if [[ -n "${DaysOld:-}" ]] && ! datecheck $("$regbin" -v error image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1) "$DaysOld" ; then
|
if [[ -n "$DaysOld" ]] && ! datecheck ; then
|
||||||
printf "%s\n" "NoUpdates +$i ${ImageAge}d"
|
NoUpdates+=("+$i ${ImageAge}d")
|
||||||
else
|
else
|
||||||
printf "%s\n" "GotUpdates $i"
|
GotUpdates+=("$i")
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
printf "%s\n" "GotErrors $i - ${RegHash}" # Reghash contains an error code here
|
# Here the RegHash is the result of an error code.
|
||||||
|
GotErrors+=("$i - ${RegHash}")
|
||||||
fi
|
fi
|
||||||
}
|
done
|
||||||
|
|
||||||
# Make required functions and variables available to subprocesses
|
### Sort arrays alphabetically
|
||||||
export -f check_image datecheck
|
|
||||||
export Excludes_string="${Excludes[*]:-}" # Can only export scalar variables
|
|
||||||
export t_out regbin RepoUrl DaysOld DRunUp jqbin OnlyLabel RunTimestamp RunEpoch
|
|
||||||
|
|
||||||
# Check for POSIX xargs with -P option, fallback without async
|
|
||||||
if (echo "test" | xargs -P 2 >/dev/null 2>&1) && [[ "$MaxAsync" != 0 ]]; then
|
|
||||||
XargsAsync="-P $MaxAsync"
|
|
||||||
else
|
|
||||||
XargsAsync=""
|
|
||||||
[[ "$MaxAsync" != 0 ]] && printf "%bMissing POSIX xargs, consider installing 'findutils' for asynchronous lookups.%b\n" "$c_yellow" "$c_reset"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Asynchronously check the image-hash of every running container VS the registry
|
|
||||||
while read -r line; do
|
|
||||||
((RegCheckQue+=1))
|
|
||||||
if [[ "$MonoMode" == false ]]; then progress_bar "$RegCheckQue" "$ContCount"; fi
|
|
||||||
|
|
||||||
Got=${line%% *} # Extracts the first word (NoUpdates, GotUpdates, GotErrors)
|
|
||||||
item=${line#* }
|
|
||||||
|
|
||||||
case "$Got" in
|
|
||||||
NoUpdates) NoUpdates+=("$item") ;;
|
|
||||||
GotUpdates) GotUpdates+=("$item") ;;
|
|
||||||
GotErrors) GotErrors+=("$item") ;;
|
|
||||||
Skip) ;;
|
|
||||||
*) echo "Error! Unexpected output from subprocess: ${line}" ;;
|
|
||||||
esac
|
|
||||||
done < <( \
|
|
||||||
docker ps $Stopped --filter "name=$SearchName" --format '{{.Names}}' | \
|
|
||||||
xargs $XargsAsync -I {} bash -c 'check_image "{}"' \
|
|
||||||
)
|
|
||||||
|
|
||||||
[[ "$OnlyLabel" == true ]] && printf "\n%bLabel option active:%b Only checking containers with labels set.\n" "$c_blue" "$c_reset"
|
|
||||||
|
|
||||||
# Sort arrays alphabetically
|
|
||||||
IFS=$'\n'
|
IFS=$'\n'
|
||||||
NoUpdates=($(sort <<<"${NoUpdates[*]:-}"))
|
NoUpdates=($(sort <<<"${NoUpdates[*]}"))
|
||||||
GotUpdates=($(sort <<<"${GotUpdates[*]:-}"))
|
GotUpdates=($(sort <<<"${GotUpdates[*]}"))
|
||||||
unset IFS
|
unset IFS
|
||||||
|
|
||||||
# Run the prometheus exporter function
|
### Define how many updates are available
|
||||||
if [[ -n "${CollectorTextFileDirectory:-}" ]]; then
|
|
||||||
exec_if_exists_or_fail prometheus_exporter ${#NoUpdates[@]} ${#GotUpdates[@]} ${#GotErrors[@]} || printf "%s\n" "Could not source prometheus exporter function."
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Define how many updates are available
|
|
||||||
UpdCount="${#GotUpdates[@]}"
|
UpdCount="${#GotUpdates[@]}"
|
||||||
|
|
||||||
# List what containers got updates or not
|
### List what containers got updates or not
|
||||||
if [[ -n ${NoUpdates[*]:-} ]]; then
|
if [[ -n ${NoUpdates[*]} ]] ; then
|
||||||
printf "\n%bContainers on latest version:%b\n" "$c_green" "$c_reset"
|
printf "\n%bContainers on latest version:%b\n" "$c_green" "$c_reset"
|
||||||
printf "%s\n" "${NoUpdates[@]}"
|
printf "%s\n" "${NoUpdates[@]}"
|
||||||
fi
|
fi
|
||||||
if [[ -n ${GotErrors[*]:-} ]]; then
|
if [[ -n ${GotErrors[*]} ]] ; then
|
||||||
printf "\n%bContainers with errors, won't get updated:%b\n" "$c_red" "$c_reset"
|
printf "\n%bContainers with errors, wont get updated:%b\n" "$c_red" "$c_reset"
|
||||||
printf "%s\n" "${GotErrors[@]}"
|
printf "%s\n" "${GotErrors[@]}"
|
||||||
printf "%binfo:%b 'unauthorized' often means not found in a public registry.\n" "$c_blue" "$c_reset"
|
printf "%binfo:%b 'unauthorized' often means not found in a public registry.\n" "$c_blue" "$c_reset"
|
||||||
fi
|
fi
|
||||||
if [[ -n ${GotUpdates[*]:-} ]]; then
|
if [[ -n ${GotUpdates[*]} ]] ; then
|
||||||
printf "\n%bContainers with updates available:%b\n" "$c_yellow" "$c_reset"
|
printf "\n%bContainers with updates available:%b\n" "$c_yellow" "$c_reset"
|
||||||
if [[ -s "$ScriptWorkDir/urls.list" ]] && [[ "$PrintReleaseURL" == true ]]; then releasenotes; else Updates=("${GotUpdates[@]}"); fi
|
[[ -z "$AutoUp" ]] && options || printf "%s\n" "${GotUpdates[@]}"
|
||||||
[[ "$AutoMode" == false ]] && list_options || printf "%s\n" "${Updates[@]}"
|
[[ -n "$Notify" ]] && { [[ $(type -t send_notification) == function ]] && send_notification "${GotUpdates[@]}" || printf "Could 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
|
||||||
if [[ -n "${GotUpdates:-}" ]]; then
|
if [ -n "$GotUpdates" ] ; then
|
||||||
if [[ "$AutoMode" == false ]]; then
|
if [ -z "$AutoUp" ] ; then
|
||||||
printf "\n%bChoose what containers to update.%b\n" "$c_teal" "$c_reset"
|
printf "\n%bChoose what containers to update.%b\n" "$c_teal" "$c_reset"
|
||||||
choosecontainers
|
choosecontainers
|
||||||
else
|
else
|
||||||
SelectedUpdates=( "${GotUpdates[@]}" )
|
SelectedUpdates=( "${GotUpdates[@]}" )
|
||||||
fi
|
fi
|
||||||
if [[ "$DontUpdate" == false ]]; then
|
if [ "$AutoUp" == "${AutoUp#[Nn]}" ] ; then
|
||||||
printf "\n%bUpdating container(s):%b\n" "$c_blue" "$c_reset"
|
|
||||||
printf "%s\n" "${SelectedUpdates[@]}"
|
|
||||||
|
|
||||||
NumberofUpdates="${#SelectedUpdates[@]}"
|
NumberofUpdates="${#SelectedUpdates[@]}"
|
||||||
|
|
||||||
CurrentQue=0
|
CurrentQue=0
|
||||||
for i in "${SelectedUpdates[@]}"; do
|
for i in "${SelectedUpdates[@]}"
|
||||||
|
do
|
||||||
((CurrentQue+=1))
|
((CurrentQue+=1))
|
||||||
printf "\n%bNow updating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
|
unset CompleteConfs
|
||||||
ContConfig=$(docker inspect "$i" --format '{{json .}}')
|
ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir" }}')
|
||||||
ContImage=$($jqbin -r '."Config"."Image"' <<< "$ContConfig")
|
ContConfigFile=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.config_files" }}')
|
||||||
ImageId=$($jqbin -r '."Image"' <<< "$ContConfig")
|
ContName=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.service" }}')
|
||||||
ContPath=$($jqbin -r '."Config"."Labels"."com.docker.compose.project.working_dir"' <<< "$ContConfig")
|
ContEnv=$(docker inspect "$i" --format '{{index .Config.Labels "com.docker.compose.project.environment_file" }}')
|
||||||
[[ "$ContPath" == "null" ]] && ContPath=""
|
ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
|
||||||
|
ContUpdateLabel=$(docker inspect "$i" --format '{{ index .Config.Labels "mag37.dockcheck.update" }}')
|
||||||
# Add new backup tag prior to pulling if option is set
|
ContRestartStack=$(docker inspect "$i" --format '{{ index .Config.Labels "mag37.dockcheck.restart-stack" }}')
|
||||||
if [[ -n "${BackupForDays:-}" ]]; then
|
### Checking if compose-values are empty - hence started with docker run:
|
||||||
ImageConfig=$(docker image inspect "$ImageId" --format '{{ json . }}')
|
if [ -z "$ContPath" ] ; then
|
||||||
ContRepoDigests=$($jqbin -r '.RepoDigests[0]' <<< "$ImageConfig")
|
if [ "$DRunUp" == "yes" ] ; then
|
||||||
[[ "$ContRepoDigests" == "null" ]] && ContRepoDigests=""
|
|
||||||
ContRepo=${ContImage%:*}
|
|
||||||
ContApp=${ContRepo#*/}
|
|
||||||
[[ "$ContImage" =~ ":" ]] && ContTag=${ContImage#*:} || ContTag="latest"
|
|
||||||
BackupName="dockcheck/${ContApp}:${RunTimestamp}_${ContTag}"
|
|
||||||
docker tag "$ImageId" "$BackupName"
|
|
||||||
printf "%b%s backed up as %s%b\n" "$c_teal" "$i" "$BackupName" "$c_reset"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Checking if compose-values are empty - hence started with docker run
|
|
||||||
if [[ -z "$ContPath" ]]; then
|
|
||||||
if [[ "$DRunUp" == true ]]; then
|
|
||||||
docker pull "$ContImage"
|
docker pull "$ContImage"
|
||||||
printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters"
|
printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters"
|
||||||
else
|
else
|
||||||
|
|
@ -615,91 +322,35 @@ if [[ -n "${GotUpdates:-}" ]]; then
|
||||||
fi
|
fi
|
||||||
continue
|
continue
|
||||||
fi
|
fi
|
||||||
|
### cd to the compose-file directory to account for people who use relative volumes, eg - ${PWD}/data:data
|
||||||
if docker pull "$ContImage"; then
|
cd "$ContPath" || { echo "Path error - skipping $i" ; continue ; }
|
||||||
# Removal of the <none>-tag image left behind from backup
|
## Reformatting path + multi compose
|
||||||
if [[ ! -z "${ContRepoDigests:-}" ]] && [[ -n "${BackupForDays:-}" ]]; then docker rmi "$ContRepoDigests"; fi
|
if [[ $ContConfigFile = '/'* ]] ; then
|
||||||
|
CompleteConfs=$(for conf in ${ContConfigFile//,/ } ; do printf -- "-f %s " "$conf"; done)
|
||||||
else
|
else
|
||||||
printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1
|
CompleteConfs=$(for conf in ${ContConfigFile//,/ } ; do printf -- "-f %s/%s " "$ContPath" "$conf"; done)
|
||||||
|
fi
|
||||||
|
printf "\n%bNow updating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
|
||||||
|
### Checking if Label Only -option is set, and if container got the label
|
||||||
|
[[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping." ; continue ; } }
|
||||||
|
docker pull "$ContImage"
|
||||||
|
### Check if the container got an environment file set and reformat it
|
||||||
|
if [ -n "$ContEnv" ]; then ContEnvs=$(for env in ${ContEnv//,/ } ; do printf -- "--env-file %s " "$env"; done) ; fi
|
||||||
|
### Check if the whole stack should be restarted
|
||||||
|
if [[ "$ContRestartStack" == true ]] || [[ "$ForceRestartStacks" == true ]] ; then
|
||||||
|
$DockerBin ${CompleteConfs} stop ; $DockerBin ${CompleteConfs} ${ContEnvs} up -d
|
||||||
|
else
|
||||||
|
$DockerBin ${CompleteConfs} ${ContEnvs} up -d ${ContName}
|
||||||
fi
|
fi
|
||||||
|
|
||||||
done
|
done
|
||||||
printf "\n%bDone pulling updates.%b\n" "$c_green" "$c_reset"
|
printf "\n%bAll done!%b\n" "$c_green" "$c_reset"
|
||||||
|
if [[ -z "$AutoPrune" ]] && [[ -z "$AutoUp" ]]; then read -r -p "Would you like to prune dangling images? y/[n]: " AutoPrune ; fi
|
||||||
if [[ "$SkipRecreate" == true ]]; then
|
[[ "$AutoPrune" =~ [yY] ]] && docker image prune -f
|
||||||
printf "%bSkipping container recreation due to -R.%b\n" "$c_yellow" "$c_reset"
|
|
||||||
else
|
|
||||||
printf "%bRecreating updated containers.%b\n" "$c_blue" "$c_reset"
|
|
||||||
CurrentQue=0
|
|
||||||
for i in "${SelectedUpdates[@]}"; do
|
|
||||||
((CurrentQue+=1))
|
|
||||||
unset CompleteConfs
|
|
||||||
# Extract labels and metadata
|
|
||||||
ContConfig=$(docker inspect "$i" --format '{{json .}}')
|
|
||||||
ContLabels=$($jqbin -r '."Config"."Labels"' <<< "$ContConfig")
|
|
||||||
ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
|
|
||||||
[[ "$ContPath" == "null" ]] && ContPath=""
|
|
||||||
ContConfigFile=$($jqbin -r '."com.docker.compose.project.config_files"' <<< "$ContLabels")
|
|
||||||
[[ "$ContConfigFile" == "null" ]] && ContConfigFile=""
|
|
||||||
ContName=$($jqbin -r '."com.docker.compose.service"' <<< "$ContLabels")
|
|
||||||
[[ "$ContName" == "null" ]] && ContName=""
|
|
||||||
ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
|
|
||||||
[[ "$ContEnv" == "null" ]] && ContEnv=""
|
|
||||||
ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
|
|
||||||
[[ "$ContRestartStack" == "null" ]] && ContRestartStack=""
|
|
||||||
ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels")
|
|
||||||
[[ "$ContOnlySpecific" == "null" ]] && ContRestartStack=""
|
|
||||||
ContStateRunning=$($jqbin -r '."State"."Running"' <<< "$ContConfig")
|
|
||||||
[[ "$ContStateRunning" == "null" ]] && ContStateRunning=""
|
|
||||||
|
|
||||||
if [[ "$ContStateRunning" == "true" ]]; then
|
|
||||||
printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
|
|
||||||
else
|
|
||||||
printf "\n%bSkipping recreation of %b%s%b as it's not running.%b\n" "$c_yellow" "$c_blue" "$i" "$c_yellow" "$c_reset"
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Checking if compose-values are empty - hence started with docker run
|
|
||||||
[[ -z "$ContPath" ]] && { echo "Not a compose container, skipping."; continue; }
|
|
||||||
|
|
||||||
# cd to the compose-file directory to account for people who use relative volumes
|
|
||||||
cd "$ContPath" || { printf "\n%bPath error - skipping%b %s" "$c_red" "$c_reset" "$i"; continue; }
|
|
||||||
# Reformatting path + multi compose
|
|
||||||
if [[ $ContConfigFile == '/'* ]]; then
|
|
||||||
CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s " "$conf"; done)
|
|
||||||
else
|
|
||||||
CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s/%s " "$ContPath" "$conf"; done)
|
|
||||||
fi
|
|
||||||
# Check if the container got an environment file set and reformat it
|
|
||||||
ContEnvs=""
|
|
||||||
if [[ -n "$ContEnv" ]]; then ContEnvs=$(for env in ${ContEnv//,/ }; do printf -- "--env-file %s " "$env"; done); fi
|
|
||||||
# Set variable when compose up should only target the specific container, not the stack
|
|
||||||
if [[ $OnlySpecific == true ]] || [[ $ContOnlySpecific == true ]]; then SpecificContainer="$ContName"; fi
|
|
||||||
|
|
||||||
# Check if the whole stack should be restarted
|
|
||||||
if [[ "$ContRestartStack" == true ]] || [[ "$ForceRestartStacks" == true ]]; then
|
|
||||||
${DockerBin} ${CompleteConfs} stop; ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
|
|
||||||
else
|
|
||||||
${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
printf "\n%bAll updates done!%b\n" "$c_green" "$c_reset"
|
|
||||||
|
|
||||||
# Trigger pruning only when backup-function is not used
|
|
||||||
if [[ -z "${BackupForDays:-}" ]]; then
|
|
||||||
if [[ "$AutoPrune" == false ]] && [[ "$AutoMode" == false ]]; then printf "\n"; read -rep "Would you like to prune all dangling images? y/[n]: " AutoPrune; fi
|
|
||||||
if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\nAuto pruning.."; docker image prune -f; fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
else
|
else
|
||||||
printf "\nNo updates installed.\n"
|
printf "\nNo updates installed, exiting.\n"
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
printf "\nNo updates available.\n"
|
printf "\nNo updates available, exiting.\n"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Clean up old backup image tags if -b is used
|
|
||||||
[[ -n "${BackupForDays:-}" ]] && remove_backups
|
|
||||||
|
|
||||||
exit 0
|
exit 0
|
||||||
|
|
|
||||||
|
|
@ -38,15 +38,35 @@ You can also use the [caronc/apprise-api](https://github.com/caronc/apprise-api)
|
||||||
|
|
||||||
|
|
||||||
### Customize the **notify.sh** file.
|
### Customize the **notify.sh** file.
|
||||||
After you're done with the setup of the container and tried your notifications, you need to follow the configuration setup (explained in detail in the README).
|
After you're done with the setup of the container and tried your notifications, you can copy the `notify_apprise.sh` file to `notify.sh` and start editing it.
|
||||||
Briefly: Copy `default.config` to `dockcheck.config` then edit it to change the following, `APPRISE_URL` matching your environment:
|
|
||||||
|
|
||||||
|
Comment out/remove the bare metal apprise-command (starting with `apprise -vv -t...`).
|
||||||
|
Uncomment and edit the `AppriseURL` variable and *curl* line
|
||||||
|
It should look something like this when curling the API:
|
||||||
```bash
|
```bash
|
||||||
NOTIFY_CHANNELS="apprise"
|
send_notification() {
|
||||||
APPRISE_URL="http://apprise.mydomain.tld:1234/notify/apprise"
|
Updates=("$@")
|
||||||
|
UpdToString=$( printf "%s\n" "${Updates[@]}" )
|
||||||
|
FromHost=$(hostname)
|
||||||
|
|
||||||
|
printf "\nSending Apprise notification\n"
|
||||||
|
|
||||||
|
MessageTitle="$FromHost - updates available."
|
||||||
|
# Setting the MessageBody variable here.
|
||||||
|
read -d '\n' MessageBody << __EOF
|
||||||
|
Containers on $FromHost with updates available:
|
||||||
|
|
||||||
|
$UpdToString
|
||||||
|
|
||||||
|
__EOF
|
||||||
|
|
||||||
|
AppriseURL="http://IP.or.mydomain.tld:8000/notify/apprise"
|
||||||
|
curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
|
||||||
|
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
That's it!
|
That's all!
|
||||||
___
|
___
|
||||||
___
|
___
|
||||||
|
|
||||||
|
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 144 KiB |
|
|
@ -2,21 +2,12 @@
|
||||||
SearchName="$1"
|
SearchName="$1"
|
||||||
for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
|
for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
|
||||||
echo "------------ $i ------------"
|
echo "------------ $i ------------"
|
||||||
ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}')
|
ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir" }}')
|
||||||
ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
|
|
||||||
ContPath=$(jq -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
|
|
||||||
[ "$ContPath" == "null" ] && ContPath=""
|
|
||||||
[ -z "$ContPath" ] && { "$i has no compose labels - skipping" ; continue ; }
|
[ -z "$ContPath" ] && { "$i has no compose labels - skipping" ; continue ; }
|
||||||
ContConfigFile=$(jq -r '."com.docker.compose.project.config_files"' <<< "$ContLabels")
|
ContConfigFile=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.config_files" }}')
|
||||||
[ "$ContConfigFile" == "null" ] && ContConfigFile=""
|
ContName=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.service" }}')
|
||||||
ContName=$(jq -r '."com.docker.compose.service"' <<< "$ContLabels")
|
ContEnv=$(docker inspect "$i" --format '{{index .Config.Labels "com.docker.compose.project.environment_file" }}')
|
||||||
[ "$ContName" == "null" ] && ContName=""
|
ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
|
||||||
ContEnv=$(jq -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
|
|
||||||
[ "$ContEnv" == "null" ] && ContEnv=""
|
|
||||||
ContUpdateLabel=$(jq -r '."mag37.dockcheck.update"' <<< "$ContLabels")
|
|
||||||
[ "$ContUpdateLabel" == "null" ] && ContUpdateLabel=""
|
|
||||||
ContRestartStack=$(jq -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
|
|
||||||
[ "$ContRestartStack" == "null" ] && ContRestartStack=""
|
|
||||||
|
|
||||||
if [[ $ContConfigFile = '/'* ]] ; then
|
if [[ $ContConfigFile = '/'* ]] ; then
|
||||||
ComposeFile="$ContConfigFile"
|
ComposeFile="$ContConfigFile"
|
||||||
|
|
@ -29,8 +20,6 @@ for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
|
||||||
echo -e "Compose files:\t\t$ComposeFile"
|
echo -e "Compose files:\t\t$ComposeFile"
|
||||||
echo -e "Environment files:\t$ContEnv"
|
echo -e "Environment files:\t$ContEnv"
|
||||||
echo -e "Container image:\t$ContImage"
|
echo -e "Container image:\t$ContImage"
|
||||||
echo -e "Update label:\t$ContUpdateLabel"
|
|
||||||
echo -e "Restart Stack label:\t$ContRestartStack"
|
|
||||||
echo
|
echo
|
||||||
echo "Mounts:"
|
echo "Mounts:"
|
||||||
docker inspect -f '{{ range .Mounts }}{{ .Source }}:{{ .Destination }}{{ printf "\n" }}{{ end }}' "$i"
|
docker inspect -f '{{ range .Mounts }}{{ .Source }}:{{ .Destination }}{{ printf "\n" }}{{ end }}' "$i"
|
||||||
|
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 549 KiB After Width: | Height: | Size: 404 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 472 KiB |
|
|
@ -1,69 +1,52 @@
|
||||||
### 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.5"
|
# INFO: ssmtp is depcerated - consider to use msmtp instead.
|
||||||
# INFO: ssmtp is deprecated - consider to use msmtp instead.
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snipppet.
|
||||||
# mSMTP/sSMTP has to be installed and configured manually.
|
# mSMTP/sSMTP has to be installed and configured manually.
|
||||||
# The existing DSM Notification Email configuration will be used automatically.
|
# The existing DSM Notification Email configuration will be used automatically.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# Modify to your liking - changing SendMailTo and Subject and content.
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set DSM_SENDMAILTO and DSM_SUBJECTTAG in your dockcheck.config file.
|
|
||||||
|
|
||||||
MSMTP=$(which msmtp)
|
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, ssmtp or sendmail binary found in PATH: $PATH" ; exit 1
|
echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
trigger_DSM_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
DSM_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
FromHost=$(hostname)
|
||||||
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 SendMailTo below.
|
||||||
SendMailTo=${!DSMSendmailToVar:-$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')}
|
SendMailTo=$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
|
||||||
# e.g. DSM_SENDMAILTO="me@mydomain.com"
|
#SendMailTo="me@mydomain.com"
|
||||||
|
|
||||||
SubjectTag=${!DSMSubjectTagVar:-$(grep 'eventsubjectprefix' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')}
|
SubjectTag=$(grep 'eventsubjectprefix' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
|
||||||
# e.g. DSM_SUBJECTTAG="Email Subject Prefix"
|
|
||||||
SenderName=$(grep 'smtp_from_name' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')
|
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')
|
||||||
SenderMail=${SenderMail:-$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')}
|
SenderMail=${SenderMail:-$(grep 'eventmail1' $CfgFile | sed -n 's/.*"\([^"]*\)".*/\1/p')}
|
||||||
|
|
||||||
|
printf "\nSending email notification.\n"
|
||||||
|
|
||||||
|
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"
|
||||||
|
|
||||||
$MailPkg $SendMailTo << __EOF
|
$MailPkg $SendMailTo << __EOF
|
||||||
From: "$SenderName" <$SenderMail>
|
From: "$SenderName" <$SenderMail>
|
||||||
date:$(date -R)
|
date:$(date -R)
|
||||||
To: <$SendMailTo>
|
To: <$SendMailTo>
|
||||||
Subject: $SubjectTag $MessageTitle
|
Subject: $SubjectTag Updates available on $FromHost
|
||||||
Content-Type: text/plain; charset=UTF-8; format=flowed
|
Content-Type: text/plain; charset=UTF-8; format=flowed
|
||||||
Content-Transfer-Encoding: 7bit
|
Content-Transfer-Encoding: 7bit
|
||||||
|
|
||||||
$MessageBody
|
$MessageBody
|
||||||
From $SenderName
|
From $SenderName
|
||||||
__EOF
|
__EOF
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
|
|
||||||
# This ensures DSM's container manager will also see the update
|
|
||||||
/var/packages/ContainerManager/target/tool/image_upgradable_checker
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,44 +0,0 @@
|
||||||
### 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,51 +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_APPRISE_VERSION="v0.4"
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
# 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.
|
# Modify to fit your setup - if API, set AppriseURL to your Apprise ip/domain.
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set APPRISE_PAYLOAD in your dockcheck.config file.
|
|
||||||
# If API, set APPRISE_URL instead.
|
|
||||||
|
|
||||||
trigger_apprise_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
apprise_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
FromHost=$(hostname)
|
||||||
apprise_channel="apprise"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${apprise_channel^^}"
|
printf "\nSending Apprise notification\n"
|
||||||
|
|
||||||
ApprisePayloadVar="${UpperChannel}_PAYLOAD"
|
MessageTitle="$FromHost - updates available."
|
||||||
AppriseUrlVar="${UpperChannel}_URL"
|
# Setting the MessageBody variable here.
|
||||||
|
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
|
||||||
|
|
||||||
if [[ -z "${!ApprisePayloadVar:-}" ]] && [[ -z "${!AppriseUrlVar:-}" ]]; then
|
# Modify to fit your setup:
|
||||||
printf "The ${apprise_channel} notification channel is enabled, but required configuration variables are missing. Apprise notifications will not be sent.\n"
|
apprise -vv -t "$MessageTitle" -b "$MessageBody" \
|
||||||
|
mailto://myemail:mypass@gmail.com \
|
||||||
|
mastodons://{token}@{host} \
|
||||||
|
pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b \
|
||||||
|
tgram://{bot_token}/{chat_id}/
|
||||||
|
|
||||||
remove_channel apprise
|
### If you use the Apprise-API - Comment out the apprise command above.
|
||||||
return 0
|
### Uncomment the AppriseURL and the curl-line below:
|
||||||
fi
|
# AppriseURL="http://apprise.mydomain.tld:1234/notify/apprise"
|
||||||
|
# curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
|
||||||
|
|
||||||
if [[ -n "${!ApprisePayloadVar:-}" ]]; then
|
}
|
||||||
apprise -vv -t "$MessageTitle" -b "$MessageBody" \
|
|
||||||
${!ApprisePayloadVar}
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
# e.g. APPRISE_PAYLOAD='mailto://myemail:mypass@gmail.com
|
|
||||||
# mastodons://{token}@{host}
|
|
||||||
# pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b
|
|
||||||
# tgram://{bot_token}/{chat_id}/'
|
|
||||||
|
|
||||||
if [[ -n "${!AppriseUrlVar:-}" ]]; then
|
|
||||||
AppriseURL="${!AppriseUrlVar}"
|
|
||||||
curl -S -o /dev/null ${CurlArgs} -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL # e.g. APPRISE_URL=http://apprise.mydomain.tld:1234/notify/apprise
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# NOTIFY_BARK_VERSION="v1.0"
|
|
||||||
|
|
||||||
trigger_bark_notification() {
|
|
||||||
local channel="$1"
|
|
||||||
|
|
||||||
if [[ -z "$jqbin" ]]; then
|
|
||||||
for path in "$jqbin" "jq" "./jq" "../jq" "./jq-linux-TEMP" "../jq-linux-TEMP"; do
|
|
||||||
if command -v "$path" &>/dev/null; then jqbin="$path"; break; fi
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
[[ -z "$jqbin" ]] && { echo "Error: jq missing"; return 1; }
|
|
||||||
|
|
||||||
[[ -z "$BARK_KEY" ]] && { echo "Error: Key not set"; return 1; }
|
|
||||||
|
|
||||||
local sound="${BARK_SOUND:-hello}"
|
|
||||||
local group="${BARK_GROUP:-Dockcheck}"
|
|
||||||
local icon_url="${BARK_ICON_URL:-https://raw.githubusercontent.com/mag37/dockcheck/main/logo.png}"
|
|
||||||
|
|
||||||
|
|
||||||
local title="${MessageTitle%.}"
|
|
||||||
local newline=$'\n'
|
|
||||||
local formatted_body="## $title${newline}${newline}---${newline}${newline}$MessageBody"
|
|
||||||
|
|
||||||
local json_payload=$( "$jqbin" -n \
|
|
||||||
--arg title "$title" \
|
|
||||||
--arg body "$formatted_body" \
|
|
||||||
--arg group "$group" \
|
|
||||||
--arg sound "$sound" \
|
|
||||||
--arg icon "$icon_url" \
|
|
||||||
'{
|
|
||||||
"title": $title,
|
|
||||||
"markdown": $body,
|
|
||||||
"group": $group,
|
|
||||||
"sound": $sound,
|
|
||||||
"icon": $icon,
|
|
||||||
}' )
|
|
||||||
|
|
||||||
|
|
||||||
if curl -s -f -X POST "https://api.day.app/$BARK_KEY" \
|
|
||||||
-H "Content-Type: application/json; charset=utf-8" \
|
|
||||||
-d "$json_payload" > /dev/null 2>&1; then
|
|
||||||
echo "Bark notification sent successfully (Markdown): $title"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
@ -1,39 +1,25 @@
|
||||||
### 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.5"
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
# 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.
|
# Modify to fit your setup - set DiscordWebhookUrl
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set DISCORD_WEBHOOK_URL in your dockcheck.config file.
|
|
||||||
|
|
||||||
trigger_discord_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
discord_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
|
||||||
discord_channel="discord"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${discord_channel^^}"
|
echo "$UpdToString"
|
||||||
|
FromHost=$(hostname)
|
||||||
|
|
||||||
DiscordWebhookUrlVar="${UpperChannel}_WEBHOOK_URL"
|
# platform specific notification code would go here
|
||||||
|
printf "\nSending Discord notification\n"
|
||||||
|
|
||||||
if [[ -z "${!DiscordWebhookUrlVar:-}" ]]; then
|
# Setting the MessageBody variable here.
|
||||||
printf "The ${discord_channel} notification channel is enabled, but required configuration variables are missing. Discord notifications will not be sent.\n"
|
MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
|
||||||
|
|
||||||
remove_channel discord
|
# Modify to fit your setup:
|
||||||
return 0
|
DiscordWebhookUrl="PasteYourFullDiscordWebhookURL"
|
||||||
fi
|
|
||||||
|
|
||||||
DiscordWebhookUrl="${!DiscordWebhookUrlVar}" # e.g. DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/<token string>
|
MsgBody="{\"username\":\"$FromHost\",\"content\":\"$MessageBody\"}"
|
||||||
|
curl -sS -o /dev/null --fail -X POST -H "Content-Type: application/json" -d "$MsgBody" "$DiscordWebhookUrl"
|
||||||
|
|
||||||
JsonData=$( "$jqbin" -n \
|
|
||||||
--arg username "$FromHost" \
|
|
||||||
--arg body "$MessageBody" \
|
|
||||||
'{"username": $username, "content": $body}' )
|
|
||||||
|
|
||||||
curl -S -o /dev/null ${CurlArgs} -X POST -H "Content-Type: application/json" -d "$JsonData" "$DiscordWebhookUrl"
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
|
||||||
|
|
@ -1,22 +0,0 @@
|
||||||
### 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,9 +1,16 @@
|
||||||
### 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_GENERIC_VERSION="v0.2"
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
# generic sample, the "Hello World" of notification addons
|
# generic sample, the "Hello World" of notification addons
|
||||||
|
|
||||||
trigger_generic_notification() {
|
send_notification() {
|
||||||
printf "\n$MessageTitle\n"
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
printf "\n$MessageBody\n"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
}
|
|
||||||
|
FromHost=$(hostname)
|
||||||
|
|
||||||
|
# platform specific notification code would go here
|
||||||
|
printf "\n%bGeneric notification addon:%b" "$c_green" "$c_reset"
|
||||||
|
printf "\nThe following docker containers on %s need to be updated:\n" "$FromHost"
|
||||||
|
printf "$UpdToString"
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,48 +1,29 @@
|
||||||
### 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.5"
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
# 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.
|
# Modify to fit your setup - set GotifyUrl and GotifyToken.
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set GOTIFY_TOKEN and GOTIFY_DOMAIN in your dockcheck.config file.
|
|
||||||
|
|
||||||
trigger_gotify_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
gotify_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
FromHost=$(hostname)
|
||||||
gotify_channel="gotify"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${gotify_channel^^}"
|
# platform specific notification code would go here
|
||||||
|
printf "\nSending Gotify notification\n"
|
||||||
|
|
||||||
GotifyTokenVar="${UpperChannel}_TOKEN"
|
# Setting the MessageTitle and MessageBody variable here.
|
||||||
GotifyUrlVar="${UpperChannel}_DOMAIN"
|
MessageTitle="${FromHost} - updates available."
|
||||||
|
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
|
||||||
|
|
||||||
if [[ -z "${!GotifyTokenVar:-}" ]] || [[ -z "${!GotifyUrlVar:-}" ]]; then
|
# Modify to fit your setup:
|
||||||
printf "The ${gotify_channel} notification channel is enabled, but required configuration variables are missing. Gotify notifications will not be sent.\n"
|
GotifyToken="Your Gotify token here"
|
||||||
|
GotifyUrl="https://api.gotify/message?token=${GotifyToken}"
|
||||||
|
|
||||||
remove_channel gotify
|
curl \
|
||||||
return 0
|
-F "title=${MessageTitle}" \
|
||||||
fi
|
-F "message=${MessageBody}" \
|
||||||
|
-F "priority=5" \
|
||||||
|
-X POST "${GotifyUrl}" &> /dev/null
|
||||||
|
|
||||||
GotifyToken="${!GotifyTokenVar}" # e.g. GOTIFY_TOKEN=token-value
|
|
||||||
GotifyUrl="${!GotifyUrlVar}/message?token=${GotifyToken}" # e.g. GOTIFY_URL=https://gotify.domain.tld
|
|
||||||
|
|
||||||
if [[ "$PrintMarkdownURL" == true ]]; then
|
|
||||||
ContentType="text/markdown"
|
|
||||||
else
|
|
||||||
ContentType="text/plain"
|
|
||||||
fi
|
|
||||||
|
|
||||||
JsonData=$( "$jqbin" -n \
|
|
||||||
--arg body "$MessageBody" \
|
|
||||||
--arg title "$MessageTitle" \
|
|
||||||
--arg type "$ContentType" \
|
|
||||||
'{message: $body, title: $title, priority: 5, extras: {"client::display": {"contentType": $type}}}' )
|
|
||||||
|
|
||||||
curl -S -o /dev/null ${CurlArgs} --data "${JsonData}" -H 'Content-Type: application/json' -X POST "${GotifyUrl}" 1> /dev/null
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,40 +1,28 @@
|
||||||
### 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.5"
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
# 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.
|
# Modify to fit your setup - set MatrixServer, Room_id and AccessToken
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set MATRIX_ACCESS_TOKEN, MATRIX_ROOM_ID, and MATRIX_SERVER_URL in your dockcheck.config file.
|
|
||||||
|
|
||||||
trigger_matrix_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
matrix_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
FromHost=$(hostname)
|
||||||
matrix_channel="matrix"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${matrix_channel^^}"
|
# platform specific notification code would go here
|
||||||
|
printf "\nSending Matrix notification\n"
|
||||||
|
|
||||||
AccessTokenVar="${UpperChannel}_ACCESS_TOKEN"
|
# Setting the MessageBody variable here.
|
||||||
RoomIdVar="${UpperChannel}_ROOM_ID"
|
MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
|
||||||
MatrixServerVar="${UpperChannel}_SERVER_URL"
|
|
||||||
|
|
||||||
if [[ -z "${!AccessTokenVar:-}" ]] || [[ -z "${!RoomIdVar:-}" ]] || [[ -z "${!MatrixServerVar:-}" ]]; then
|
# Modify to fit your setup:
|
||||||
printf "The ${matrix_channel} notification channel is enabled, but required configuration variables are missing. Matrix notifications will not be sent.\n"
|
AccessToken="Your Matrix token here"
|
||||||
|
Room_id="Enter Room_id here"
|
||||||
|
MatrixServer="Enter Your HomeServer URL"
|
||||||
|
MsgBody="{\"msgtype\":\"m.text\",\"body\":\"$MessageBody\"}"
|
||||||
|
|
||||||
remove_channel matrix
|
# URL Example: https://matrix.org/_matrix/client/r0/rooms/!xxxxxx:example.com/send/m.room.message?access_token=xxxxxxxx
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
AccessToken="${!AccessTokenVar}" # e.g. MATRIX_ACCESS_TOKEN=token-value
|
curl -sS -o /dev/null --fail -X POST "$MatrixServer/_matrix/client/r0/rooms/$Room_id/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
|
||||||
RoomId="${!RoomIdVar}" # e.g. MATRIX_ROOM_ID=myroom
|
|
||||||
MatrixServer="${!MatrixServerVar}" # e.g. MATRIX_SERVER_URL=http://matrix.yourdomain.tld
|
|
||||||
MsgBody=$($jqbin -Rn --arg body "$MessageBody" '{msgtype:"m.text", body:$body}')
|
|
||||||
|
|
||||||
# URL Example: https://matrix.org/_matrix/client/r0/rooms/!xxxxxx:example.com/send/m.room.message?access_token=xxxxxxxx
|
|
||||||
curl -S -o /dev/null ${CurlArgs} -X POST "$MatrixServer/_matrix/client/r0/rooms/$RoomId/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
26
notify_templates/notify_ntfy-sh.sh
Normal file
26
notify_templates/notify_ntfy-sh.sh
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
||||||
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
|
# Setup app and subscription at https://ntfy.sh
|
||||||
|
# Use your unique Topic Name in the URL below.
|
||||||
|
|
||||||
|
send_notification() {
|
||||||
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
|
FromHost=$(hostname)
|
||||||
|
|
||||||
|
printf "\nSending ntfy.sh notification\n"
|
||||||
|
|
||||||
|
MessageTitle="$FromHost - updates available."
|
||||||
|
# Setting the MessageBody variable here.
|
||||||
|
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
|
||||||
|
|
||||||
|
# Modify to fit your setup:
|
||||||
|
NtfyUrl="ntfy.sh/YourUniqueTopicName"
|
||||||
|
|
||||||
|
curl -sS -o /dev/null --show-error --fail \
|
||||||
|
-H "Title: $MessageTitle" \
|
||||||
|
-d "$MessageBody" \
|
||||||
|
$NtfyUrl
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -1,56 +0,0 @@
|
||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
|
||||||
NOTIFY_NTFYSH_VERSION="v0.7"
|
|
||||||
#
|
|
||||||
# Setup app and subscription at https://ntfy.sh
|
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set NTFY_DOMAIN and NTFY_TOPIC_NAME in your dockcheck.config file.
|
|
||||||
|
|
||||||
trigger_ntfy_notification() {
|
|
||||||
if [[ -n "$1" ]]; then
|
|
||||||
ntfy_channel="$1"
|
|
||||||
else
|
|
||||||
ntfy_channel="ntfy"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${ntfy_channel^^}"
|
|
||||||
|
|
||||||
NtfyDomainVar="${UpperChannel}_DOMAIN"
|
|
||||||
NtfyTopicNameVar="${UpperChannel}_TOPIC_NAME"
|
|
||||||
NtfyAuthVar="${UpperChannel}_AUTH"
|
|
||||||
|
|
||||||
if [[ -z "${!NtfyDomainVar:-}" ]] || [[ -z "${!NtfyTopicNameVar:-}" ]]; then
|
|
||||||
printf "The ${ntfy_channel} notification channel is enabled, but required configuration variables are missing. Ntfy notifications will not be sent.\n"
|
|
||||||
|
|
||||||
remove_channel ntfy
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
NtfyUrl="${!NtfyDomainVar}/${!NtfyTopicNameVar}"
|
|
||||||
# e.g.
|
|
||||||
# NTFY_DOMAIN=ntfy.sh
|
|
||||||
# NTFY_TOPIC_NAME=YourUniqueTopicName
|
|
||||||
|
|
||||||
if [[ "$PrintMarkdownURL" == true ]]; then
|
|
||||||
ContentType="Markdown: yes"
|
|
||||||
else
|
|
||||||
ContentType="Markdown: no" #text/plain
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ -n "${!NtfyAuthVar:-}" ]]; then
|
|
||||||
NtfyAuth="-u ${!NtfyAuthVar}"
|
|
||||||
else
|
|
||||||
NtfyAuth=""
|
|
||||||
fi
|
|
||||||
|
|
||||||
curl -S -o /dev/null ${CurlArgs} \
|
|
||||||
-H "Title: $MessageTitle" \
|
|
||||||
-H "$ContentType" \
|
|
||||||
-d "$MessageBody" \
|
|
||||||
$NtfyAuth \
|
|
||||||
-L "$NtfyUrl"
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
@ -1,38 +1,27 @@
|
||||||
### 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.4"
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
# 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.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# Modify to fit your setup - set Url and Token.
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set PUSHBULLET_TOKEN and PUSHBULLET_URL in your dockcheck.config file.
|
|
||||||
|
|
||||||
trigger_pushbullet_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
pushbullet_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
FromHost=$(hostname)
|
||||||
pushbullet_channel="pushbullet"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${pushbullet_channel^^}"
|
# platform specific notification code would go here
|
||||||
|
printf "\nSending pushbullet notification\n"
|
||||||
|
|
||||||
PushUrlVar="${UpperChannel}_URL"
|
MessageTitle="$FromHost - updates available."
|
||||||
PushTokenVar="${UpperChannel}_TOKEN"
|
# Setting the MessageBody variable here.
|
||||||
|
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
|
||||||
|
|
||||||
if [[ -z "${!PushUrlVar:-}" ]] || [[ -z "${!PushTokenVar:-}" ]]; then
|
# Modify to fit your setup:
|
||||||
printf "The ${pushbullet_channel} notification channel is enabled, but required configuration variables are missing. Pushbullet notifications will not be sent.\n"
|
PushUrl="https://api.pushbullet.com/v2/pushes"
|
||||||
|
PushToken="Your Pushbullet token here"
|
||||||
|
|
||||||
remove_channel pushbullet
|
# Requires jq to process json data
|
||||||
return 0
|
jq -n --arg title "$MessageTitle" --arg body "$MessageBody" '{body: $body, title: $title, type: "note"}' | curl -sS -o /dev/null --show-error --fail -X POST -H "Access-Token: $PushToken" -H "Content-type: application/json" $PushUrl -d @-
|
||||||
fi
|
|
||||||
|
|
||||||
PushUrl="${!PushUrlVar}" # e.g. PUSHBULLET_URL=https://api.pushbullet.com/v2/pushes
|
|
||||||
PushToken="${!PushTokenVar}" # e.g. PUSHBULLET_TOKEN=token-value
|
|
||||||
|
|
||||||
# Requires jq to process json data
|
|
||||||
"$jqbin" -n --arg title "$MessageTitle" --arg body "$MessageBody" '{body: $body, title: $title, type: "note"}' | curl -S -o /dev/null ${CurlArgs} -X POST -H "Access-Token: $PushToken" -H "Content-type: application/json" $PushUrl -d @-
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,45 +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_PUSHOVER_VERSION="v0.4"
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
# 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.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# Modify to fit your setup - set Url and Token.
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set PUSHOVER_USER_KEY, PUSHOVER_TOKEN, and PUSHOVER_URL in your dockcheck.config file.
|
|
||||||
|
|
||||||
trigger_pushover_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
pushover_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
FromHost=$(hostname)
|
||||||
pushover_channel="pushover"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${pushover_channel^^}"
|
# platform specific notification code would go here
|
||||||
|
printf "\nSending pushover notification\n"
|
||||||
|
|
||||||
PushoverUrlVar="${UpperChannel}_URL"
|
MessageTitle="$FromHost - updates available."
|
||||||
PushoverUserKeyVar="${UpperChannel}_USER_KEY"
|
# Setting the MessageBody variable here.
|
||||||
PushoverTokenVar="${UpperChannel}_TOKEN"
|
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString"
|
||||||
|
|
||||||
if [[ -z "${!PushoverUrlVar:-}" ]] || [[ -z "${!PushoverUserKeyVar:-}" ]] || [[ -z "${!PushoverTokenVar:-}" ]]; then
|
# Modify to fit your setup:
|
||||||
printf "The ${pushover_channel} notification channel is enabled, but required configuration variables are missing. Pushover notifications will not be sent.\n"
|
PushoverUrl="https://api.pushover.net/1/messages.json"
|
||||||
|
PushoverUserKey="Your Pushover User Key Here"
|
||||||
|
PushoverToken="Your Pushover API Token Here"
|
||||||
|
|
||||||
remove_channel pushover
|
# Sending the notification via Pushover
|
||||||
return 0
|
curl -sS -o /dev/null --show-error --fail -X POST \
|
||||||
fi
|
-F "token=$PushoverToken" \
|
||||||
|
-F "user=$PushoverUserKey" \
|
||||||
PushoverUrl="${!PushoverUrlVar}" # e.g. PUSHOVER_URL=https://api.pushover.net/1/messages.json
|
-F "title=$MessageTitle" \
|
||||||
PushoverUserKey="${!PushoverUserKeyVar}" # e.g. PUSHOVER_USER_KEY=userkey
|
-F "message=$MessageBody" \
|
||||||
PushoverToken="${!PushoverTokenVar}" # e.g. PUSHOVER_TOKEN=token-value
|
$PushoverUrl
|
||||||
|
}
|
||||||
# Sending the notification via Pushover
|
|
||||||
curl -S -o /dev/null ${CurlArgs} -X POST \
|
|
||||||
-F "token=$PushoverToken" \
|
|
||||||
-F "user=$PushoverUserKey" \
|
|
||||||
-F "title=$MessageTitle" \
|
|
||||||
-F "message=$MessageBody" \
|
|
||||||
$PushoverUrl
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
|
||||||
|
|
@ -1,40 +0,0 @@
|
||||||
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
|
|
||||||
NOTIFY_SLACK_VERSION="v0.4"
|
|
||||||
#
|
|
||||||
# Setup app and token at https://api.slack.com/tutorials/tracks/posting-messages-with-curl
|
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set SLACK_ACCESS_TOKEN, and SLACK_CHANNEL_ID in your dockcheck.config file.
|
|
||||||
|
|
||||||
trigger_slack_notification() {
|
|
||||||
if [[ -n "$1" ]]; then
|
|
||||||
slack_channel="$1"
|
|
||||||
else
|
|
||||||
slack_channel="slack"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${slack_channel^^}"
|
|
||||||
|
|
||||||
AccessTokenVar="${UpperChannel}_ACCESS_TOKEN"
|
|
||||||
ChannelIDVar="${UpperChannel}_CHANNEL_ID"
|
|
||||||
|
|
||||||
if [[ -z "${!AccessTokenVar:-}" ]] || [[ -z "${!ChannelIDVar:-}" ]]; then
|
|
||||||
printf "The ${slack_channel} notification channel is enabled, but required configuration variables are missing. Slack notifications will not be sent.\n"
|
|
||||||
|
|
||||||
remove_channel slack
|
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
AccessToken="${!AccessTokenVar}" # e.g. SLACK_ACCESS_TOKEN=some-token
|
|
||||||
ChannelID="${!ChannelIDVar}" # e.g. CHANNEL_ID=mychannel
|
|
||||||
SlackUrl="https://slack.com/api/chat.postMessage"
|
|
||||||
|
|
||||||
curl -S -o /dev/null ${CurlArgs} \
|
|
||||||
-d "text=$MessageBody" -d "channel=$ChannelID" \
|
|
||||||
-H "Authorization: Bearer $AccessToken" \
|
|
||||||
-X POST $SlackUrl
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
@ -1,63 +1,44 @@
|
||||||
### 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.5"
|
|
||||||
# INFO: ssmtp is depcerated - consider to use msmtp instead.
|
# INFO: ssmtp is depcerated - consider to use msmtp instead.
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snipppet.
|
||||||
# mSMTP/sSMTP has to be installed and configured manually.
|
# mSMTP/sSMTP has to be installed and configured manually.
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
# Modify to fit your setup - changing SendMailFrom, SendMailTo, SubjectTag
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set SMTP_MAIL_FROM, SMTP_MAIL_TO, and SMTP_SUBJECT_TAG in your dockcheck.config file.
|
|
||||||
|
|
||||||
MSMTP=$(which msmtp)
|
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, ssmtp or sendmail binary found in PATH: $PATH" ; exit 1
|
echo "No msmtp or ssmtp binary found in PATH: $PATH" ; exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
trigger_smtp_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
smtp_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
FromHost=$(hostname)
|
||||||
smtp_channel="smtp"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${smtp_channel^^}"
|
# User variables:
|
||||||
|
SendMailFrom="me@mydomain.tld"
|
||||||
|
SendMailTo="me@mydomain.tld"
|
||||||
|
SubjectTag="dockcheck"
|
||||||
|
|
||||||
SendMailFromVar="${UpperChannel}_MAIL_FROM"
|
printf "\nSending email notification.\n"
|
||||||
SendMailToVar="${UpperChannel}_MAIL_TO"
|
|
||||||
SubjectTagVar="${UpperChannel}_SUBJECT_TAG"
|
|
||||||
|
|
||||||
if [[ -z "${!SendMailFromVar:-}" ]] || [[ -z "${!SendMailToVar:-}" ]] || [[ -z "${!SubjectTagVar:-}" ]]; then
|
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n\n$UpdToString"
|
||||||
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>
|
||||||
date:$(date -R)
|
date:$(date -R)
|
||||||
To: <$SendMailTo>
|
To: <$SendMailTo>
|
||||||
Subject: [$SubjectTag] $MessageTitle $FromHost
|
Subject: [$SubjectTag] Updates available on $FromHost
|
||||||
Content-Type: text/plain; charset=UTF-8; format=flowed
|
Content-Type: text/plain; charset=UTF-8; format=flowed
|
||||||
Content-Transfer-Encoding: 7bit
|
Content-Transfer-Encoding: 7bit
|
||||||
|
|
||||||
$MessageBody
|
$MessageBody
|
||||||
|
|
||||||
__EOF
|
__EOF
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,52 +1,27 @@
|
||||||
### 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.5"
|
|
||||||
#
|
#
|
||||||
|
# Copy/rename this file to notify.sh to enable the notification snippet.
|
||||||
# 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.
|
# Modify to fit your setup - set TelegramChatId and TelegramToken.
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script.
|
|
||||||
# Do not modify this file directly within the "notify_templates" subdirectory. Set TELEGRAM_CHAT_ID and TELEGRAM_TOKEN in your dockcheck.config file.
|
|
||||||
|
|
||||||
trigger_telegram_notification() {
|
send_notification() {
|
||||||
if [[ -n "$1" ]]; then
|
[ -s "$ScriptWorkDir"/urls.list ] && releasenotes || Updates=("$@")
|
||||||
telegram_channel="$1"
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
||||||
else
|
FromHost=$(hostname)
|
||||||
telegram_channel="telegram"
|
|
||||||
fi
|
|
||||||
|
|
||||||
UpperChannel="${telegram_channel^^}"
|
# platform specific notification code would go here
|
||||||
|
printf "\nSending Telegram notification\n"
|
||||||
|
|
||||||
TelegramTokenVar="${UpperChannel}_TOKEN"
|
# Setting the MessageBody variable here.
|
||||||
TelegramChatIdVar="${UpperChannel}_CHAT_ID"
|
MessageBody="🐋 Containers on $FromHost with updates available: \n$UpdToString"
|
||||||
TelegramTopicIdVar="${UpperChannel}_TOPIC_ID"
|
|
||||||
|
|
||||||
if [[ -z "${!TelegramChatIdVar:-}" ]] || [[ -z "${!TelegramTokenVar:-}" ]]; then
|
# Modify to fit your setup:
|
||||||
printf "The ${telegram_channel} notification channel is enabled, but required configuration variables are missing. Telegram notifications will not be sent.\n"
|
TelegramToken="Your Telegram token here"
|
||||||
|
TelegramChatId="Your Telegram ChatId here"
|
||||||
|
TelegramUrl="https://api.telegram.org/bot$TelegramToken"
|
||||||
|
TelegramTopicID=12345678 ## Set to 0 if not using specific topic within chat
|
||||||
|
TelegramData="{\"chat_id\":\"$TelegramChatId\",\"text\":\"$MessageBody\",\"message_thread_id\":\"$TelegramTopicID\",\"disable_notification\": false}"
|
||||||
|
|
||||||
remove_channel telegram
|
curl -sS -o /dev/null --fail -X POST "$TelegramUrl/sendMessage" -H 'Content-Type: application/json' -d "$TelegramData"
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ "$PrintMarkdownURL" == true ]]; then
|
|
||||||
ParseMode="Markdown"
|
|
||||||
else
|
|
||||||
ParseMode="HTML"
|
|
||||||
fi
|
|
||||||
|
|
||||||
TelegramToken="${!TelegramTokenVar}" # e.g. TELEGRAM_TOKEN=token-value
|
|
||||||
TelegramChatId="${!TelegramChatIdVar}" # e.g. TELEGRAM_CHAT_ID=mychatid
|
|
||||||
TelegramUrl="https://api.telegram.org/bot$TelegramToken"
|
|
||||||
TelegramTopicID=${!TelegramTopicIdVar:="0"}
|
|
||||||
|
|
||||||
JsonData=$( "$jqbin" -n \
|
|
||||||
--arg chatid "$TelegramChatId" \
|
|
||||||
--arg text "$MessageBody" \
|
|
||||||
--arg thread "$TelegramTopicID" \
|
|
||||||
--arg parse_mode "$ParseMode" \
|
|
||||||
'{"chat_id": $chatid, "text": $text, "message_thread_id": $thread, "disable_notification": false, "parse_mode": $parse_mode, "disable_web_page_preview": true}' )
|
|
||||||
|
|
||||||
curl -S -o /dev/null ${CurlArgs} -X POST "$TelegramUrl/sendMessage" -H 'Content-Type: application/json' -d "$JsonData"
|
|
||||||
|
|
||||||
if [[ $? -gt 0 ]]; then
|
|
||||||
NotifyError=true
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,406 +0,0 @@
|
||||||
NOTIFY_V2_VERSION="v0.7"
|
|
||||||
#
|
|
||||||
# If migrating from an older notify template, remove your existing notify.sh file.
|
|
||||||
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
|
|
||||||
# If you instead wish make your own modifications, make a copy in the same directory as the main dockcheck.sh script and rename to notify.sh.
|
|
||||||
# Enable and configure all required notification variables in your dockcheck.config file, e.g.:
|
|
||||||
# NOTIFY_CHANNELS=apprise gotify slack
|
|
||||||
# SLACK_TOKEN=xoxb-some-token-value
|
|
||||||
# GOTIFY_TOKEN=some.token
|
|
||||||
|
|
||||||
# Number of seconds to snooze identical update notifications based on local image name
|
|
||||||
# or dockcheck.sh/notify.sh template file updates.
|
|
||||||
# Actual snooze will be 60 seconds less to avoid the chance of missed notifications due to minor scheduling or script run time issues.
|
|
||||||
snooze="${SNOOZE_SECONDS:-}"
|
|
||||||
SnoozeFile="${ScriptWorkDir}/snooze.list"
|
|
||||||
[[ ! -f "${SnoozeFile}" ]] && touch "${SnoozeFile}"
|
|
||||||
|
|
||||||
enabled_notify_channels=( ${NOTIFY_CHANNELS:-} )
|
|
||||||
|
|
||||||
# Global output string variable for modification by functions
|
|
||||||
UpdToString=""
|
|
||||||
FormattedOutput=""
|
|
||||||
|
|
||||||
get_channel_template() {
|
|
||||||
local UpperChannel="${1^^}"
|
|
||||||
local TemplateVar="${UpperChannel}_TEMPLATE"
|
|
||||||
if [[ -n "${!TemplateVar:-}" ]]; then
|
|
||||||
printf "${!TemplateVar}"
|
|
||||||
else
|
|
||||||
printf "$1"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
declare -A unique_templates
|
|
||||||
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
|
||||||
template=$(get_channel_template "${channel}")
|
|
||||||
unique_templates["${template}"]=1
|
|
||||||
done
|
|
||||||
|
|
||||||
enabled_notify_templates=( "${!unique_templates[@]}" )
|
|
||||||
|
|
||||||
FromHost="$(cat /etc/hostname 2>/dev/null)" || FromHost="$(hostname 2>/dev/null)" || FromHost="UNKNOWN"
|
|
||||||
|
|
||||||
CurrentEpochTime=$(date +"%Y-%m-%dT%H:%M:%S")
|
|
||||||
CurrentEpochSeconds=$(date +%s)
|
|
||||||
|
|
||||||
NotifyError=false
|
|
||||||
|
|
||||||
for template in "${enabled_notify_templates[@]}"; do
|
|
||||||
source_if_exists_or_fail "${ScriptWorkDir}/notify_${template}.sh" || \
|
|
||||||
source_if_exists_or_fail "${ScriptWorkDir}/notify_templates/notify_${template}.sh" || \
|
|
||||||
printf "The notification channel template ${template} is enabled, but notify_${template}.sh was not found. Check the ${ScriptWorkDir} directory or the notify_templates subdirectory.\n"
|
|
||||||
done
|
|
||||||
|
|
||||||
skip_snooze() {
|
|
||||||
local UpperChannel="${1^^}"
|
|
||||||
local SkipSnoozeVar="${UpperChannel}_SKIPSNOOZE"
|
|
||||||
if [[ "${!SkipSnoozeVar:-}" == "true" ]]; then
|
|
||||||
printf "true"
|
|
||||||
else
|
|
||||||
printf "false"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
allow_empty() {
|
|
||||||
local UpperChannel="${1^^}"
|
|
||||||
local AllowEmptyVar="${UpperChannel}_ALLOWEMPTY"
|
|
||||||
if [[ "${!AllowEmptyVar:-}" == "true" ]]; then
|
|
||||||
printf "true"
|
|
||||||
else
|
|
||||||
printf "false"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
containers_only() {
|
|
||||||
local UpperChannel="${1^^}"
|
|
||||||
local ContainersOnlyVar="${UpperChannel}_CONTAINERSONLY"
|
|
||||||
if [[ "${!ContainersOnlyVar:-}" == "true" ]]; then
|
|
||||||
printf "true"
|
|
||||||
else
|
|
||||||
printf "false"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
output_format() {
|
|
||||||
local UpperChannel="${1^^}"
|
|
||||||
local OutputFormatVar="${UpperChannel}_OUTPUT"
|
|
||||||
if [[ -z "${!OutputFormatVar:-}" ]]; then
|
|
||||||
printf "text"
|
|
||||||
else
|
|
||||||
printf "${!OutputFormatVar:-}"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
remove_channel() {
|
|
||||||
local temp_array=()
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
|
||||||
local channel_template=$(get_channel_template "${channel}")
|
|
||||||
[[ "${channel_template}" != "$1" ]] && temp_array+=("${channel}")
|
|
||||||
done
|
|
||||||
enabled_notify_channels=( "${temp_array[@]}" )
|
|
||||||
}
|
|
||||||
|
|
||||||
is_snoozed() {
|
|
||||||
if [[ -n "${snooze}" ]] && [[ -f "${SnoozeFile}" ]]; then
|
|
||||||
local found=$(grep -w "$1" "${SnoozeFile}" || printf "")
|
|
||||||
if [[ -n "${found}" ]]; then
|
|
||||||
read -a arr <<< "${found}"
|
|
||||||
CheckEpochSeconds=$(( $(date -d "${arr[1]}" +%s 2>/dev/null) + ${snooze} - 60 )) || CheckEpochSeconds=$(( $(date -f "%Y-%m-%d" -j "${arr[1]}" +%s) + ${snooze} - 60 ))
|
|
||||||
if [[ "${CurrentEpochSeconds}" -le "${CheckEpochSeconds}" ]]; then
|
|
||||||
printf "true"
|
|
||||||
else
|
|
||||||
printf "false"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
printf "false"
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
printf "false"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
unsnoozed_count() {
|
|
||||||
unset Unsnoozed
|
|
||||||
Unsnoozed=()
|
|
||||||
|
|
||||||
for element in "$@"
|
|
||||||
do
|
|
||||||
read -a item <<< "${element}"
|
|
||||||
if [[ $(is_snoozed "${item[0]}") == "false" ]]; then
|
|
||||||
Unsnoozed+=("${element}")
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
printf "${#Unsnoozed[@]}"
|
|
||||||
}
|
|
||||||
|
|
||||||
update_snooze() {
|
|
||||||
for arg in "$@"
|
|
||||||
do
|
|
||||||
read -a entry <<< "${arg}"
|
|
||||||
found=$(grep -w "${entry[0]}" "${SnoozeFile}" || printf "")
|
|
||||||
|
|
||||||
if [[ -n "${found}" ]]; then
|
|
||||||
sed -e "s/${entry[0]}.*/${entry[0]} ${CurrentEpochTime}/" "${SnoozeFile}" > "${SnoozeFile}.new"
|
|
||||||
mv "${SnoozeFile}.new" "${SnoozeFile}"
|
|
||||||
else
|
|
||||||
printf "${entry[0]} ${CurrentEpochTime}\n" >> "${SnoozeFile}"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup_snooze() {
|
|
||||||
unset NotifyEntries
|
|
||||||
NotifyEntries=()
|
|
||||||
switch=""
|
|
||||||
|
|
||||||
for arg in "$@"
|
|
||||||
do
|
|
||||||
read -a entry <<< "${arg}"
|
|
||||||
NotifyEntries+=("${entry[0]}")
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ ! "${NotifyEntries[@]}" == *".sh"* ]]; then
|
|
||||||
switch="-v"
|
|
||||||
fi
|
|
||||||
|
|
||||||
while read -r entry datestamp; do
|
|
||||||
if [[ ! "${NotifyEntries[@]}" == *"$entry"* ]]; then
|
|
||||||
sed -e "/${entry}/d" "${SnoozeFile}" > "${SnoozeFile}.new"
|
|
||||||
mv "${SnoozeFile}.new" "${SnoozeFile}"
|
|
||||||
fi
|
|
||||||
done <<< "$(grep ${switch} '\.sh ' ${SnoozeFile})"
|
|
||||||
}
|
|
||||||
|
|
||||||
format_output() {
|
|
||||||
local UpdateType="$1"
|
|
||||||
local OutputFormat="$2"
|
|
||||||
local FormattedTextTemplate="$3"
|
|
||||||
local tempcsv=""
|
|
||||||
|
|
||||||
if [[ ! "${UpdateType}" == "dockcheck_update" ]]; then
|
|
||||||
tempcsv="${UpdToString// -> /,}"
|
|
||||||
tempcsv="${tempcsv//.sh /.sh,}"
|
|
||||||
else
|
|
||||||
tempcsv="${UpdToString}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [[ "${OutputFormat}" == "csv" ]]; then
|
|
||||||
if [[ -z "${UpdToString}" ]]; then
|
|
||||||
FormattedOutput="None"
|
|
||||||
else
|
|
||||||
FormattedOutput="${tempcsv}"
|
|
||||||
fi
|
|
||||||
elif [[ "${OutputFormat}" == "json" ]]; then
|
|
||||||
if [[ -z "${UpdToString}" ]]; then
|
|
||||||
FormattedOutput='{"updates": []}'
|
|
||||||
else
|
|
||||||
if [[ "${UpdateType}" == "container_update" ]]; then
|
|
||||||
# container updates case
|
|
||||||
FormattedOutput=$(jq --compact-output --null-input --arg updates "${tempcsv}" '($updates | split("\\n")) | map(split(",")) | {"updates": map({"container_name": .[0], "release_notes": .[1]})} | del(..|nulls)')
|
|
||||||
elif [[ "${UpdateType}" == "notify_update" ]]; then
|
|
||||||
# script updates case
|
|
||||||
FormattedOutput=$(jq --compact-output --null-input --arg updates "${tempcsv}" '($updates | split("\\n")) | map(split(",")) | {"updates": map({"script_name": .[0], "installed_version": .[1], "latest_version": .[2]})}')
|
|
||||||
elif [[ "${UpdateType}" == "dockcheck_update" ]]; then
|
|
||||||
# dockcheck update case
|
|
||||||
FormattedOutput=$(jq --compact-output --null-input --arg updates "${tempcsv}" '($updates | split("\\n")) | map(split(",")) | {"updates": map({"script_name": .[0], "installed_version": .[1], "latest_version": .[2], "release_notes": (.[3:] | join(","))})}')
|
|
||||||
else
|
|
||||||
FormattedOutput="Invalid input"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
if [[ -z "${UpdToString}" ]]; then
|
|
||||||
FormattedOutput="None"
|
|
||||||
else
|
|
||||||
if [[ "${UpdateType}" == "container_update" ]]; then
|
|
||||||
FormattedOutput="${FormattedTextTemplate/<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() {
|
|
||||||
[[ -s "$ScriptWorkDir"/urls.list ]] && releasenotes || Updates=("$@")
|
|
||||||
|
|
||||||
[[ -n "${snooze}" ]] && cleanup_snooze "${Updates[@]}"
|
|
||||||
|
|
||||||
UnsnoozedContainers=$(unsnoozed_count "${Updates[@]}")
|
|
||||||
NotifyError=false
|
|
||||||
Notified="false"
|
|
||||||
|
|
||||||
# To be added in the MessageBody if "-d X" was used
|
|
||||||
# Trailing space is left intentionally for clean output
|
|
||||||
[[ -n "$DaysOld" ]] && msgdaysold="with images ${DaysOld}+ days old " || msgdaysold=""
|
|
||||||
MessageTitle="$FromHost - updates ${msgdaysold}available."
|
|
||||||
|
|
||||||
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
|
||||||
UpdToString="${UpdToString%, }"
|
|
||||||
UpdToString=${UpdToString%\\n}
|
|
||||||
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
|
||||||
local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedContainers}" "container")
|
|
||||||
if [[ "${SkipNotification}" == "false" ]]; then
|
|
||||||
local template=$(get_channel_template "${channel}")
|
|
||||||
|
|
||||||
# Formats UpdToString variable per channel settings
|
|
||||||
format_output "container_update" "$(output_format "${channel}")" "🐋 Containers on $FromHost with updates available:\n<insert_text_cu>\n"
|
|
||||||
|
|
||||||
# Setting the MessageBody variable here.
|
|
||||||
printf -v MessageBody "${FormattedOutput}"
|
|
||||||
|
|
||||||
printf "\nSending ${channel} notification"
|
|
||||||
exec_if_exists_or_fail trigger_${template}_notification "${channel}" || \
|
|
||||||
printf "\nAttempted to send notification to channel ${channel}, but the function was not found. Make sure notify_${template}.sh is available in the ${ScriptWorkDir} directory or notify_templates subdirectory."
|
|
||||||
Notified="true"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ "${Notified}" == "true" ]]; then
|
|
||||||
[[ -n "${snooze}" ]] && [[ -n "${UpdToString}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${Updates[@]}"
|
|
||||||
printf "\n"
|
|
||||||
fi
|
|
||||||
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
### Set DISABLE_DOCKCHECK_NOTIFICATION=false in dockcheck.config
|
|
||||||
### to not send notifications when dockcheck itself has updates.
|
|
||||||
dockcheck_notification() {
|
|
||||||
if [[ ! "${DISABLE_DOCKCHECK_NOTIFICATION:-}" == "true" ]]; then
|
|
||||||
UnsnoozedDockcheck=$(unsnoozed_count "dockcheck\.sh")
|
|
||||||
NotifyError=false
|
|
||||||
Notified=false
|
|
||||||
|
|
||||||
MessageTitle="$FromHost - New version of dockcheck available."
|
|
||||||
UpdToString="dockcheck.sh,$1,$2,\"$3\""
|
|
||||||
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
|
||||||
local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedDockcheck}" "dockcheck")
|
|
||||||
if [[ "${SkipNotification}" == "false" ]]; then
|
|
||||||
local template=$(get_channel_template "${channel}")
|
|
||||||
|
|
||||||
# Formats UpdToString variable per channel settings
|
|
||||||
format_output "dockcheck_update" "$(output_format "${channel}")" "Installed version: <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
|
|
||||||
|
|
||||||
if [[ "${Notified}" == "true" ]]; then
|
|
||||||
[[ -n "${snooze}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "dockcheck.sh"
|
|
||||||
printf "\n"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
### Set DISABLE_NOTIFY_NOTIFICATION=false in dockcheck.config
|
|
||||||
### to not send notifications when notify scripts themselves have updates.
|
|
||||||
notify_update_notification() {
|
|
||||||
if [[ ! "${DISABLE_NOTIFY_NOTIFICATION:-}" == "true" ]]; then
|
|
||||||
NotifyError=false
|
|
||||||
NotifyUpdates=()
|
|
||||||
Notified=false
|
|
||||||
|
|
||||||
UpdateChannels=( "${enabled_notify_templates[@]}" "v2" )
|
|
||||||
|
|
||||||
for NotifyScript in "${UpdateChannels[@]}"; do
|
|
||||||
UpperChannel="${NotifyScript^^}"
|
|
||||||
VersionVar="NOTIFY_${UpperChannel}_VERSION"
|
|
||||||
if [[ -n "${!VersionVar:-}" ]]; then
|
|
||||||
RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_${NotifyScript}.sh"
|
|
||||||
LatestNotifySnippet="$(curl ${CurlArgs} -r 0-150 "$RawNotifyUrl" || printf "undefined")"
|
|
||||||
if [[ ! "${LatestNotifySnippet}" == "undefined" ]]; then
|
|
||||||
LatestNotifyRelease="$(echo "$LatestNotifySnippet" | sed -n "/${VersionVar}/s/${VersionVar}=//p" | tr -d '"')"
|
|
||||||
|
|
||||||
if [[ "${!VersionVar}" != "${LatestNotifyRelease}" ]] ; then
|
|
||||||
NotifyUpdates+=("${NotifyScript}.sh ${!VersionVar} -> ${LatestNotifyRelease}")
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
UpdatesPlusDockcheck=("${NotifyUpdates[@]}")
|
|
||||||
UpdatesPlusDockcheck+=("dockcheck.sh")
|
|
||||||
[[ -n "${snooze}" ]] && cleanup_snooze "${UpdatesPlusDockcheck[@]}"
|
|
||||||
|
|
||||||
UnsnoozedTemplates=$(unsnoozed_count "${NotifyUpdates[@]}")
|
|
||||||
|
|
||||||
MessageTitle="$FromHost - New version of notify templates available."
|
|
||||||
|
|
||||||
UpdToString=$( printf '%s\\n' "${NotifyUpdates[@]}" )
|
|
||||||
UpdToString="${UpdToString%, }"
|
|
||||||
UpdToString=${UpdToString%\\n}
|
|
||||||
|
|
||||||
for channel in "${enabled_notify_channels[@]}"; do
|
|
||||||
local SkipNotification=$(skip_notification "${channel}" "${UnsnoozedTemplates}" "notify")
|
|
||||||
|
|
||||||
if [[ "${SkipNotification}" == "false" ]]; then
|
|
||||||
local template=$(get_channel_template "${channel}")
|
|
||||||
|
|
||||||
# Formats UpdToString variable per channel settings
|
|
||||||
format_output "notify_update" "$(output_format "${channel}")" "Notify templates on $FromHost with updates available:\n<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
|
|
||||||
|
|
||||||
if [[ "${Notified}" == "true" ]]; then
|
|
||||||
[[ -n "${snooze}" ]] && [[ -n "${UpdToString}" ]] && [[ "${NotifyError}" == "false" ]] && update_snooze "${NotifyUpdates[@]}"
|
|
||||||
printf "\n"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
@ -1,105 +1,34 @@
|
||||||
# Additions are welcome! Append your list to the git-repo, use generic names and sensible urls.
|
|
||||||
# Modify, add and (if necessary) remove to fit your needs.
|
|
||||||
# This is a list of container names and releasenote urls, separated by space.
|
# This is a list of container names and releasenote urls, separated by space.
|
||||||
|
# Modify, add and (if necessary) remove to fit your needs.
|
||||||
|
# Additions are welcome! Append your list to the git-repo, use generic names and sensible urls.
|
||||||
|
|
||||||
actual_server https://actualbudget.org/blog
|
|
||||||
adguardhome https://github.com/AdguardTeam/AdGuardHome/releases
|
|
||||||
apprise-api https://github.com/linuxserver/docker-apprise-api/releases
|
apprise-api https://github.com/linuxserver/docker-apprise-api/releases
|
||||||
audiobookshelf https://github.com/advplyr/audiobookshelf/releases
|
homer https://github.com/bastienwirtz/homer/releases
|
||||||
authentik_server https://github.com/goauthentik/authentik/releases
|
nginx https://github.com/docker-library/official-images/blob/master/library/nginx
|
||||||
authentik_worker https://github.com/goauthentik/authentik/releases
|
vaultwarden-server https://github.com/dani-garcia/vaultwarden/releases
|
||||||
barassistant https://github.com/karlomikus/bar-assistant//releases
|
actual_server https://actualbudget.org/blog
|
||||||
barassistant_api https://github.com/karlomikus/bar-assistant/releases
|
gotify https://github.com/gotify/server/releases
|
||||||
bazarr https://github.com/morpheus65535/bazarr/releases
|
traefik https://github.com/traefik/traefik/releases
|
||||||
bazarr-ls https://github.com/linuxserver/docker-bazarr/releases
|
|
||||||
beszel https://github.com/henrygd/beszel/releases
|
|
||||||
booklore https://github.com/booklore-app/BookLore/releases
|
|
||||||
bookstack https://github.com/BookStackApp/BookStack/releases
|
|
||||||
bruceforce-vaultwarden-backup https://github.com/Bruceforce/vaultwarden-backup/blob/main/CHANGELOG.md
|
|
||||||
caddy https://github.com/caddyserver/caddy/releases
|
caddy https://github.com/caddyserver/caddy/releases
|
||||||
|
|
||||||
calibre https://github.com/linuxserver/docker-calibre/releases
|
calibre https://github.com/linuxserver/docker-calibre/releases
|
||||||
calibre-web https://github.com/linuxserver/docker-calibre-web/releases
|
calibre-web https://github.com/linuxserver/docker-calibre-web/releases
|
||||||
cleanuperr https://github.com/flmorg/cleanuperr/releases
|
readarr https://github.com/Readarr/Readarr/releases
|
||||||
collabora https://github.com/CollaboraOnline/online/releases
|
audiobookshelf https://github.com/advplyr/audiobookshelf/releases
|
||||||
cross-seed https://github.com/cross-seed/cross-seed/releases
|
|
||||||
crowdsec https://github.com/crowdsecurity/crowdsec/releases
|
|
||||||
cup https://github.com/sergi0g/cup/releases
|
|
||||||
databasus https://github.com/databasus/databasus/releases
|
|
||||||
dockge https://github.com/louislam/dockge/releases
|
|
||||||
dozzle https://github.com/amir20/dozzle/releases
|
|
||||||
esphome https://github.com/esphome/esphome/releases
|
|
||||||
feishin https://github.com/jeffvli/feishin/releases
|
|
||||||
flatnotes https://github.com/dullage/flatnotes/releases
|
|
||||||
forgejo https://codeberg.org/forgejo/forgejo/releases
|
|
||||||
fressrss https://github.com/FreshRSS/FreshRSS/releases
|
|
||||||
frigate https://github.com/blakeblackshear/frigate/releases
|
|
||||||
gerbil https://github.com/fosrl/gerbil/releases
|
|
||||||
glances https://github.com/nicolargo/glances/releases
|
|
||||||
gluetun https://github.com/qdm12/gluetun/releases
|
gluetun https://github.com/qdm12/gluetun/releases
|
||||||
go2rtc https://github.com/AlexxIT/go2rtc/releases
|
bazarr https://github.com/morpheus65535/bazarr/releases
|
||||||
godoxy https://github.com/yusing/godoxy/releases
|
bazarr-ls https://github.com/linuxserver/docker-bazarr/releases
|
||||||
gotify https://github.com/gotify/server/releases
|
|
||||||
hbbr https://github.com/rustdesk/rustdesk-server/releases
|
|
||||||
hbbs https://github.com/rustdesk/rustdesk-server/releases
|
|
||||||
homarr https://github.com/homarr-labs/homarr/releases
|
|
||||||
home-assistant https://github.com/home-assistant/core/releases/
|
|
||||||
homepage https://github.com/gethomepage/homepage/releases
|
|
||||||
homer https://github.com/bastienwirtz/homer/releases
|
|
||||||
immich_machine_learning https://github.com/immich-app/immich/releases
|
|
||||||
immich_postgres https://github.com/tensorchord/VectorChord/releases
|
|
||||||
immich_redis https://github.com/valkey-io/valkey/releases
|
|
||||||
immich_server https://github.com/immich-app/immich/releases
|
|
||||||
jellyfin https://github.com/jellyfin/jellyfin/releases
|
|
||||||
jellyseerr https://github.com/Fallenbagel/jellyseerr/releases
|
|
||||||
jellystat https://github.com/CyferShepard/Jellystat/releases
|
|
||||||
karakeep https://github.com/karakeep-app/karakeep/releases
|
|
||||||
librespeed https://github.com/librespeed/speedtest/releases
|
|
||||||
lidarr https://github.com/Lidarr/Lidarr/releases/
|
|
||||||
lidarr-ls https://github.com/linuxserver/docker-lidarr/releases
|
|
||||||
lubelogger https://github.com/hargata/lubelog/releases
|
|
||||||
mattermost https://github.com/mattermost/mattermost/releases
|
|
||||||
mealie https://github.com/mealie-recipes/mealie/releases
|
|
||||||
meilisearch https://github.com/meilisearch/meilisearch/releases
|
|
||||||
monica https://github.com/monicahq/monica/releases
|
|
||||||
mqtt https://github.com/eclipse/mosquitto/tags
|
|
||||||
navidrome https://github.com/navidrome/navidrome/releases
|
|
||||||
newt https://github.com/fosrl/newt/releases
|
|
||||||
nextcloud-aio-mastercontainer https://github.com/nextcloud/all-in-one/releases
|
|
||||||
nginx https://github.com/docker-library/official-images/blob/master/library/nginx
|
|
||||||
opencloud https://github.com/opencloud-eu/opencloud/releases
|
|
||||||
outline https://github.com/outline/outline/releases
|
|
||||||
owncast https://github.com/owncast/owncast/releases
|
|
||||||
pangolin https://github.com/fosrl/pangolin/releases
|
|
||||||
prowlarr https://github.com/Prowlarr/Prowlarr/releases
|
prowlarr https://github.com/Prowlarr/Prowlarr/releases
|
||||||
prowlarr-ls https://github.com/linuxserver/docker-prowlarr/releases
|
prowlarr-ls https://github.com/linuxserver/docker-prowlarr/releases
|
||||||
qbittorrent https://www.qbittorrent.org/news
|
|
||||||
qbittorrent-nox https://www.qbittorrent.org/news
|
|
||||||
radarr https://github.com/Radarr/Radarr/releases/
|
|
||||||
radarr-ls https://github.com/linuxserver/docker-radarr/releases
|
|
||||||
readarr https://github.com/Readarr/Readarr/releases
|
|
||||||
readeck https://codeberg.org/readeck/readeck/releases
|
|
||||||
recyclarr https://github.com/recyclarr/recyclarr/releases
|
recyclarr https://github.com/recyclarr/recyclarr/releases
|
||||||
roundcubemail https://github.com/roundcube/roundcubemail/releases
|
|
||||||
sabnzbd https://github.com/linuxserver/docker-sabnzbd/releases
|
sabnzbd https://github.com/linuxserver/docker-sabnzbd/releases
|
||||||
scanopy https://github.com/scanopy/scanopy/releases
|
sonarr https://github.com/linuxserver/docker-sonarr/releases
|
||||||
scrutiny https://github.com/AnalogJ/scrutiny/releases
|
radarr https://github.com/linuxserver/docker-radarr/releases
|
||||||
sftpgo https://github.com/drakkan/sftpgo/releases
|
lidarr https://github.com/linuxserver/docker-lidarr/releases
|
||||||
slskd https://github.com/slskd/slskd/releases
|
jellyseerr https://github.com/Fallenbagel/jellyseerr/releases
|
||||||
snappymail https://github.com/the-djmaze/snappymail/releases
|
jellyfin https://github.com/jellyfin/jellyfin/releases
|
||||||
stirling-pdf https://github.com/Stirling-Tools/Stirling-PDF/releases
|
|
||||||
sonarr https://github.com/Sonarr/Sonarr/releases/
|
home-assistant https://github.com/home-assistant/docker/releases
|
||||||
sonarr-ls https://github.com/linuxserver/docker-sonarr/releases
|
|
||||||
synapse https://github.com/element-hq/synapse/releases
|
|
||||||
syncthing https://github.com/syncthing/syncthing/releases
|
|
||||||
tailscale https://github.com/tailscale/tailscale/releases
|
|
||||||
tautulli https://github.com/Tautulli/Tautulli/releases
|
|
||||||
thelounge https://github.com/thelounge/thelounge/releases
|
|
||||||
traefik https://github.com/traefik/traefik/releases
|
|
||||||
uptime-kuma https://github.com/louislam/uptime-kuma/releases
|
|
||||||
vaultwarden-server https://github.com/dani-garcia/vaultwarden/releases
|
|
||||||
vikunja https://github.com/go-vikunja/vikunja/releases
|
|
||||||
wallos https://github.com/ellite/Wallos/releases
|
|
||||||
watchtower https://github.com/beatkind/watchtower/releases
|
|
||||||
wopiserver https://github.com/cs3org/wopiserver/releases
|
|
||||||
wud https://github.com/getwud/wud/releases
|
|
||||||
zigbee2mqtt https://github.com/Koenkk/zigbee2mqtt/releases
|
zigbee2mqtt https://github.com/Koenkk/zigbee2mqtt/releases
|
||||||
|
mqtt https://github.com/eclipse/mosquitto/tags
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue