diff --git a/README.md b/README.md
index c3bb07c..418b50b 100644
--- a/README.md
+++ b/README.md
@@ -13,54 +13,54 @@
CLI tool to automate docker image updates or notifying when updates are available.
-selective updates, exclude containers, custom labels, notification plugins, prune when done etc.
+selective updates, include/exclude containers, image backups, custom labels, notification plugins, prune when done etc.
-:whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks but for actual pulls - read more
+:whale: Docker Hub pull limit :chart_with_downwards_trend: not an issue for checks only for actual pulls - read more
For Podman - see the fork sudo-kraken/podcheck!
___
+
## Changelog
-- **v0.7.1**:
- - Added support for multiple notifications using the same template
- - Added support for notification output format
- - Added support for file output
- - Added optional configuration variables per channel to (replace `` with any channel name):
- - `_TEMPLATE` : Specify a template
- - `_SKIPSNOOZE` : Skip snooze
- - `_CONTAINERSONLY` : Only notify for docker container related updates
- - `_ALLOWEMPTY` : Always send notifications, even when empty
- - `_OUTPUT` : Define output format
-- **v0.7.0**:
- - Bugfix: snooze dockcheck.sh-self-notification and some config clarification.
- - Added authentication support to Ntfy.sh.
- - Added suport for sendmail in the SMTP-template.
-- **v0.6.9**:
- - Bugfix: label logic didn't skip recreation (skipped pulling).
- - Added comma separated search filtering so you can selectively search exactly which containers to check/update.
- - eg: `dockcheck.sh -yp homer,dozzle`
-- **v0.6.8**:
- - Bugfix: Unbound variable in notify_v2.sh
- - New option: "DisplaySourcedFiles" *config* added to list what files get sourced
-- **v0.6.7**: Snooze feature, curl, and consolidation
- - Added snooze feature to delay notifications
- - Added configurable default curl arguments
- - Consolidated and standardized notify template update notifications
- - Added curl error handling
+- **v0.7.6**:
+ - New:
+ - Added Bark notify-template.
+ - Fixes:
+ - Sanitized message for Matrix notification.
+ - Fixed hostname fallback for notifications.
+ - Clenaed up README.md some.
+ - Sorted and clarified `default.config` - migrate your settings manually (optional).
+- **v0.7.5**:
+ - Added new option **BackupForDays**; `-b N` and `-B`:
+ - Backup an image before pulling a new version for easy rollback in case of breakage.
+ - Removes backed up images older than *N* days.
+ - List currently backed up images with `-B`.
+ - Fixes:
+ - Bugfix for `-s` *Stopped* to not recreate stopped containers after update.
+- **v0.7.4**:
+ - Added new option `-R`:
+ - Will skip container recreation after pulling images.
+ - Allows for more control and possible pipeline integration.
+ - Fixes:
+ - Bugfix for *value too great* error due to leading zeroes - solved with base10 conversion.
+ - Clean up of some legacy readme sections.
+
___
-
-
+
## `dockcheck.sh`
-```
+
+```shell
$ ./dockcheck.sh -h
Syntax: dockcheck.sh [OPTION] [comma separated names to include]
Example: dockcheck.sh -y -x 10 -d 10 -e nextcloud,heimdall
Options:
-a|y Automatic updates, without interaction.
+-b N Enable image backups and sets number of days to keep from pruning.
+-B List currently backed up images, then exit.
-c D Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory.
-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
-e X Exclude containers, separated by comma.
@@ -69,12 +69,13 @@ Options:
-h Print this Help.
-i Inform - send a preconfigured notification.
-I Prints custom releasenote urls alongside each container with updates in CLI output (requires urls.list).
--l Only update if label is set. See readme.
+-l Only include containers with label set. See readme.
-m Monochrome mode, no printf colour codes and hides progress bar.
-M Prints custom releasenote urls as markdown (requires template support).
-n No updates, only checking availability.
-p Auto-Prune dangling images after update.
--r Allow checking for updates/updating images for docker run containers. Won't update the container.
+-r Allow checking/updating images created by `docker run`, containers need to be recreated manually.
+-R Skip container recreation after pulling images.
-s Include stopped containers in the check. (Logic: docker ps -a).
-t N Set a timeout (in seconds) per container for registry checkups, 10 is default.
-u Allow automatic self updates - caution as this will pull new code and autorun it.
@@ -82,41 +83,47 @@ Options:
-x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested.
```
-### Basic example:
-```
+### Basic example
+
+```shell
$ ./dockcheck.sh
-. . .
+[##################################################] 5/5
+
Containers on latest version:
glances
homer
Containers with updates available:
-1) adguardhome
-2) syncthing
-3) whoogle-search
+01) adguardhome
+02) syncthing
+03) whoogle-search
Choose what containers to update:
-Enter number(s) separated by comma, [a] for all - [q] to quit:
+Enter number(s) separated by comma, [a] for all - [q] to quit: 1,2
```
+
Then it proceeds to run `pull` and `up -d` on every container with updates.
After the updates are complete, you'll get prompted if you'd like to prune dangling images.
___
## Dependencies
-- Running docker (duh) and compose, either standalone or plugin. (see [Podman fork](https://github.com/sudo-kraken/podcheck)
+
+- Running docker (duh) and compose, either standalone or plugin. (see [Podman fork](https://github.com/sudo-kraken/podcheck))
- Bash shell or compatible shell of at least v4.3
- POSIX `xargs`, usually default but can be installed with the `findutils` package - to enable async.
- [jq](https://github.com/jqlang/jq)
- User will be prompted to install with package manager or download static binary.
- [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))
- User will be prompted to download `regctl` if not in `PATH` or `PWD`.
- - regctl requires `amd64/arm64` - see [workaround](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
+ - regctl requires `amd64/arm64` - see [workaround](#workaround-for-non-amd64--arm64) if other architecture is used.
## Install Instructions
+
Download the script to a directory in **PATH**, I'd suggest using `~/.local/bin` as that's usually in **PATH**.
For OSX/macOS preferably use `/usr/local/bin`.
-```sh
+
+```shell
# basic example with curl:
curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o ~/.local/bin/dockcheck.sh
chmod +x ~/.local/bin/dockcheck.sh
@@ -127,29 +134,36 @@ wget -O ~/.local/bin/dockcheck.sh "https://raw.githubusercontent.com/mag37/dockc
# OSX or macOS version with curl:
curl -L https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh -o /usr/local/bin/dockcheck.sh && chmod +x /usr/local/bin/dockcheck.sh
```
+
Then call the script anywhere with just `dockcheck.sh`.
Add preferred `notify.sh`-template to the same directory - this will not be touched by the scripts self-update function.
## Configuration
+
To modify settings and have them persist through updates - copy the `default.config` to `dockcheck.config` alongside the script or in `~/.config/`.
Alternatively create an alias where specific flags and values are set.
Example `alias dc=dockcheck.sh -p -x 10 -t 3`.
## Notifications
+
Triggered with the `-i` flag. Will send a list of containers with updates available and a notification when `dockcheck.sh` itself has an update.
`notify_templates/notify_v2.sh` is the default notification wrapper, if `notify.sh` is present and configured, it will override.
Example of a cron scheduled job running non-interactive at 10'oclock excluding 1 container and sending notifications:
`0 10 * * * /home/user123/.local/bin/dockcheck.sh -nix 10 -e excluded_container1`
-#### Installation and configuration:
+#### Installation and configuration
+
Set up a directory structure as below.
-You only need the `notify_templates/notify_v2.sh` file and any notification templates you wish to enable, but there is no harm in having all of them present.
-```
+You only need the `notify_templates/notify_v2.sh` file and any notification templates
+you wish to enable, but there is no harm in having all of them present.
+
+```shell
.
├── notify_templates/
│ ├── notify_DSM.sh
│ ├── notify_apprise.sh
+│ ├── notify_bark.sh
│ ├── notify_discord.sh
│ ├── notify_generic.sh
│ ├── notify_gotify.sh
@@ -166,14 +180,15 @@ You only need the `notify_templates/notify_v2.sh` file and any notification temp
├── dockcheck.sh
└── urls.list # optional
```
+
- Uncomment and set the `NOTIFY_CHANNELS=""` environment variable in `dockcheck.config` to a space separated string of your desired notification channels to enable.
- Uncomment and set the environment variables related to the enabled notification channels. Eg. `GOTIFY_DOMAIN=""` + `GOTIFY_TOKEN=""`.
It's recommended to only do configuration with variables within `dockcheck.config` and not modify `notify_templates/notify_X.sh` directly. If you wish to customize the notify templates yourself, you may copy them to your project root directory alongside the main `dockcheck.sh` (where they're also ignored by git).
Customizing `notify_v2.sh` is handled the same as customizing the templates, but it must be renamed to `notify.sh` within the `dockcheck.sh` root directory.
+#### Snooze feature
-#### Snooze feature:
Configure to receive scheduled notifications only if they're new since the last notification - within a set time frame.
**Example:** *Dockcheck is scheduled to run every hour. You will receive an update notification within an hour of availability.*
@@ -187,31 +202,35 @@ If an update becomes available for an item that is not snoozed, notifications wi
The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to account for minor scheduling or run time issues.
+#### Current notify templates
-#### Current notify templates:
-- Synology [DSM](https://www.synology.com/en-global/dsm)
-- Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP))
- Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications)
- both native [caronc/apprise](https://github.com/caronc/apprise) and the standalone [linuxserver/docker-apprise-api](https://github.com/linuxserver/docker-apprise-api)
- Read the [QuickStart](extras/apprise_quickstart.md)
-- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications.
+- [Bark](https://bark.day.app/) - iOS Push notifications.
+- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks.
+- [DSM](https://www.synology.com/en-global/dsm) - Synology.
- [Gotify](https://gotify.net/) - a simple server for sending and receiving messages.
- [Home Assistant](https://www.home-assistant.io/integrations/notify/) - Connection to the notify [integrations](https://www.home-assistant.io/integrations/#notifications).
-- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
-- [Telegram](https://telegram.org/) - Telegram chat API.
- [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication.
+- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications.
+- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features.
- [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops)
-- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks.
- [Slack](https://api.slack.com/tutorials/tracks/posting-messages-with-curl) - Slack curl api
+- SMTP Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP))
+- [Telegram](https://telegram.org/) - Telegram chat API.
Further additions are welcome - suggestions or PRs!
Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).
-#### Notification channel configuration:
+#### Notification channel configuration
+
All required environment variables for each notification channel are provided in the default.config file as comments and must be uncommented and modified for your requirements.
For advanced users, additional functionality is available via custom configurations and environment variables.
Use cases - all configured in `dockcheck.config`:
-(replace `` with the upper case name of the of the channel as listed in `NOTIFY_CHANNELS` variable, eg `TELEGRAM_SKIPSNOOZE`)
+(replace `` with the upper case name of the of the channel as listed in
+`NOTIFY_CHANNELS` variable, eg `TELEGRAM_SKIPSNOOZE`)
+
- To bypass the snooze feature, even when enabled, add the variable `_SKIPSNOOZE` and set it to `true`.
- To configure the channel to only send container update notifications, add the variable `_CONTAINERSONLY` and set it to `true`.
- To send notifications even when there are no updates available, add the variable `_ALLOWEMPTY` and set it to `true`.
@@ -223,7 +242,8 @@ Use cases - all configured in `dockcheck.config`:
- Add all other environment variables required for the chosen template to function with `` in upper case as the prefix rather than the template name.
- For example, if `` is `mynotification` and the template configured is `slack`, you would need to set `MYNOTIFICATION_CHANNEL_ID` and `MYNOTIFICATION_ACCESS_TOKEN`.
-### Release notes addon
+#### Release notes addon
+
There's a function to use a lookup-file to add release note URL's to the notification message.
Copy the notify_templates/`urls.list` file to the script directory, it will be used automatically if it's there.
Modify it as necessary, the names of interest in the left column needs to match your container names.
@@ -231,31 +251,57 @@ To also list the URL's in the CLI output (choose containers list) use the `-I` o
For Markdown formatting also add the `-M` option. (**this requires the template to be compatible - see gotify for example**)
The output of the notification will look something like this:
-```
+
+```shell
Containers on hostname with updates available:
apprise-api -> https://github.com/linuxserver/docker-apprise-api/releases
homer -> https://github.com/bastienwirtz/homer/releases
nginx -> https://github.com/docker-library/official-images/blob/master/library/nginx
...
```
+
The `urls.list` file is just an example and I'd gladly see that people contribute back when they add their preferred URLs to their lists.
## Asyncronous update checks with **xargs**; `-x N` option. (default=1)
+
Pass `-x N` where N is number of subprocesses allowed, experiment in your environment to find a suitable max!
-Change the default value by editing the `MaxAsync=N` variable in `dockcheck.sh`. To disable the subprocess function set `MaxAsync=0`.
+Change the default value by editing the `MaxAsync=N` variable in `dockcheck.config`. To disable the subprocess function set `MaxAsync=0`.
+## Image Backups; `-b N` to backup previous images as custom (retagged) images for easy rollback
-## Extra plugins and tools:
+When the option `BackupForDays` is set **dockcheck** will store the image being updated as a backup, retagged with a different name and removed due to age configured (*BackupForDays*) in a future run.
+Let's say we're updating `b4bz/homer:latest` - then before replacing the current image
+it will be retagged with the name `dockcheck/homer:2025-10-26_1132_latest`
+
+- `dockcheck` as repo name to not interfere with others.
+- `homer` is the image.
+- `2025-10-26_1132` is the time when running the script.
+- `latest` is the tag of the image.
+
+Then if an update breaks, you could restore the image by stopping the container, delete the new image, eg. `docker rmi b4bz/homer:latest`, then retag the backup as latest `docker tag dockcheck/homer:_latest b4bz/homer:latest`.
+After that, start the container again (now with the backup image active) and it will be updated as usual next time you run dockcheck or other updates.
+
+The backed up images will be removed if they're older than *BackupForDays* value (passed as `-b N` or set in the `dockcheck.config` with `BackupForDays=N`) and then pruned.
+If configured for eg. 7 days, force earlier cleaning by just passing a lower number of days, eg. `-b 2` to clean everything older than 2 days.
+Backed up images will not be removed if neither `-b` flag nor `BackupForDays` config variable is set.
+
+Use the capital option `-B` to list currently backed up images. Or list all images with `docker images`.
+To manually remove any backed up images, do `docker rmi dockcheck/homer:2025-10-26_1132_latest`.
+
+## Extra plugins and tools
### Using dockcheck.sh with the Synology DSM
+
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
```
@@ -263,35 +309,44 @@ See the [README.md](./addons/prometheus/README.md) for more detailed information
Contributed by [tdralle](https://github.com/tdralle).
### Zabbix config to monitor docker image updates
+
If you already use Zabbix - this config will show numbers of available docker image updates on host.
Example: *2 Docker Image updates on host-xyz*
See project: [thetorminal/zabbix-docker-image-updates](https://github.com/thetorminal/zabbix-docker-image-updates)
### Serve REST API to list all available updates
+
A custom python script to serve a REST API to get pulled into other monitoring tools like [homepage](https://github.com/gethomepage/homepage).
See [discussion here](https://github.com/mag37/dockcheck/discussions/146).
### Wrapper Script for Unraid's User Scripts
+
A custom bash wrapper script to allow the usage of dockcheck as a Unraid User Script plugin.
See [discussion here](https://github.com/mag37/dockcheck/discussions/145).
## Labels
+
Optionally add labels to compose-files. Currently these are the usable labels:
-```
+
+```yaml
labels:
mag37.dockcheck.update: true
mag37.dockcheck.only-specific-container: true
mag37.dockcheck.restart-stack: true
```
-- `mag37.dockcheck.update: true` will when used with the `-l` option only update containers with this label and skip the rest. Will still list updates as usual.
+
+- `mag37.dockcheck.update: true` will when used with the `-l` option only check and update containers with this label set and skip the rest.
- `mag37.dockcheck.only-specific-container: true` works instead of the `-F` option, specifying the updated container when doing compose up, like `docker compose up -d homer`.
- `mag37.dockcheck.restart-stack: true` works instead of the `-f` option, forcing stop+restart on the whole compose-stack (Caution: Will restart on every updated container within stack).
+Adding or modifying labels in compose-files requires a restart of the container to take effect.
+
## Workaround for non **amd64** / **arm64**
+
`regctl` provides binaries for amd64/arm64, to use on other architecture you could try this workaround.
Run regctl in a container wrapped in a shell script. Copied from [regclient/docs/install.md](https://github.com/regclient/regclient/blob/main/docs/install.md):
-```sh
+```shell
cat >regctl <Unauthenticated users: 10 pulls/hour
>Authenticated users with a free account: 100 pulls/hour
@@ -316,8 +373,11 @@ This is not an issue for registry checks. But if you have a large stack and pull
You could use/modify the login-wrapper function in the example below to automate the login prior to running `dockcheck.sh`.
### Function to auth with docker hub before running
-**Example** - Change names, paths, and remove cat+password flag if you rather get prompted:
-```sh
+
+**Example** - Change names, paths, and remove cat+password flag if you rather get
+prompted:
+
+```shell
function dchk {
cat ~/pwd.txt | docker login --username YourUser --password-stdin
~/dockcheck.sh "$@"
@@ -325,31 +385,41 @@ function dchk {
```
## `-r flag` disclaimer and warning
+
**Wont auto-update the containers, only their images. (compose is recommended)**
-`docker run` dont support using new images just by restarting a container.
+`docker run` doesn't support using new images just by restarting a container.
Containers need to be manually stopped, removed and created again to run on the new image.
Using the `-r` option together with eg. `-i` and `-n` to just check for updates and send notifications and not update is safe though!
## Known issues
+
- No detailed error feedback (just skip + list what's skipped).
- Not respecting `--profile` options when re-creating the container.
- Not working well with containers created by **Portainer**.
- **Watchtower** might cause issues due to retagging images when checking for updates (and thereby pulling new images).
## Debugging
+
If you hit issues, you could check the output of the `extras/errorCheck.sh` script for clues.
Another option is to run the main script with debugging in a subshell `bash -x dockcheck.sh` - if there's a particular container/image that's causing issues you can filter for just that through `bash -x dockcheck.sh nginx`.
## License
+
dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
## Sponsorlist
-- [avegy](https://github.com/avegy)
-- [eichhorn](https://github.com/eichhorn)
-- [stepdg](https://github.com/stepdg)
-- [acer2220](https://github.com/acer2220)
-- [shgew](https://github.com/shgew)
+:small_orange_diamond: [avegy](https://github.com/avegy)
+:small_orange_diamond: [eichhorn](https://github.com/eichhorn)
+:small_orange_diamond: [stepdg](https://github.com/stepdg)
+:small_orange_diamond: [acer2220](https://github.com/acer2220)
+:small_orange_diamond: [shgew](https://github.com/shgew)
+:small_orange_diamond: [jonas3456](https://github.com/jonas3456)
+:small_orange_diamond: [4ndreasH](https://github.com/4ndreasH)
+:small_orange_diamond: [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.
+## The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in retrospect
diff --git a/default.config b/default.config
index d5d21aa..f9076a2 100644
--- a/default.config
+++ b/default.config
@@ -1,38 +1,41 @@
-### Custom user variables
+##### Custom user variables #####
## Copy this file to "dockcheck.config" to make it active
## Can be placed in ~/.config/ or alongside dockcheck.sh
##
## Uncomment and set your preferred configuration variables here
## This will not be replaced on updates
-#Timeout=10 # Set a timeout (in seconds) per container for registry checkups.
-#MaxAsync=10 # Set max asynchronous subprocesses, 1 default, 0 to disable.
-#BarWidth=50 # The character width of the progress bar
-#AutoMode=true # Automatic updates, without interaction.
-#DontUpdate=true # No updates; only checking availability without interaction.
-#AutoPrune=true # Auto-Prune dangling images after update.
-#AutoSelfUpdate=true # Allow automatic self updates - caution as this will pull new code and autorun it.
-#Notify=true # Inform - send a preconfigured notification.
-#Exclude="one,two" # Exclude containers, separated by comma.
-#DaysOld="5" # Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
-#Stopped="-a" # Include stopped containers in the check. (Logic: docker ps -a).
-#OnlyLabel=true # Only update if label is set. See readme.
+#AutoMode=true # Automatic updates, without interaction.
+#AutoPrune=true # Auto-Prune dangling images after update.
+#AutoSelfUpdate=true # Allow automatic self updates - caution as this will pull new code and autorun it.
+#BackupForDays=7 # Enable backups of images and removes backups older than N days.
+#BarWidth=50 # The character width of the progress bar
+#CurlConnectTimeout=5 # Time to wait for curl to establish a connection before failing
+#CurlRetryCount=3 # Max number of curl retries
+#CurlRetryDelay=1 # Time between curl retries
+#DaysOld="5" # Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
+#DisplaySourcedFiles=false # Display what files are being sourced/used
+#DontUpdate=true # No updates; only checking availability without interaction.
+#DRunUp=true # Allow checking/updating images created by `docker run`, containers need to be recreated manually.
+#Exclude="one,two" # Exclude containers, separated by comma.
#ForceRestartStacks=true # Force stop+start stack after update. Caution: restarts once for every updated container within stack.
-#DRunUp=true # Allow updating images for docker run, wont update the container.
-#MonoMode=true # Monochrome mode, no printf colour codes and hides progress bar.
-#PrintReleaseURL=true # Prints custom releasenote urls alongside each container with updates (requires urls.list)`
-#PrintMarkdownURL=true # Prints custom releasenote urls as markdown
-#OnlySpecific=true # Only compose up the specific container, not the whole compose. (useful for master-compose structure).
-#CurlRetryDelay=1 # Time between curl retries
-#CurlRetryCount=3 # Max number of curl retries
-#CurlConnectTimeout=5 # Time to wait for curl to establish a connection before failing
-#DisplaySourcedFiles=false # Display what files are being sourced/used
+#MaxAsync=10 # Set max asynchronous subprocesses, 1 default, 0 to disable.
+#MonoMode=true # Monochrome mode, no printf colour codes and hides progress bar.
+#Notify=true # Inform - send a preconfigured notification.
+#OnlyLabel=true # Only update if label is set. See readme.
+#OnlySpecific=true # Only compose up the specific container, not the whole compose. (useful for master-compose structure).
+#PrintMarkdownURL=true # Prints custom releasenote urls as markdown
+#PrintReleaseURL=true # Prints custom releasenote urls alongside each container with updates (requires urls.list)`
+#SkipRecreate # Skip container recreation after pulling images.
+#Stopped="-a" # Include stopped containers in the check. (Logic: docker ps -a).
+#Timeout=10 # Set a timeout (in seconds) per container for registry checkups.
-### Notify settings
+##### NOTIFY SETTINGS BELOW #####
+##
## All commented values are examples only. Modify as needed.
##
## Uncomment the line below and specify the notification channels you wish to enable in a space separated string
-# NOTIFY_CHANNELS="apprise discord DSM file generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram file"
+# NOTIFY_CHANNELS="apprise bark discord DSM file generic gotify HA matrix ntfy pushbullet pushover slack smtp telegram"
#
## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze
# SNOOZE_SECONDS=86400
@@ -49,11 +52,15 @@
# tgram://{bot_token}/{chat_id}/'
# APPRISE_URL="http://apprise.mydomain.tld:1234/notify/apprise"
#
+# BARK_KEY="key-value"
+#
# DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/"
#
# DSM_SENDMAILTO="me@mydomain.com"
# DSM_SUBJECTTAG="Email Subject Prefix"
#
+# FILE_PATH="${ScriptWorkDir}/updates_available.txt"
+#
# GOTIFY_DOMAIN="https://gotify.domain.tld"
# GOTIFY_TOKEN="token-value"
#
@@ -68,7 +75,8 @@
## https://ntfy.sh or your custom domain with https:// and no trailing /
# NTFY_DOMAIN="https://ntfy.sh"
# NTFY_TOPIC_NAME="YourUniqueTopicName"
-# NTFY_AUTH="" # set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":"
+## Auth method, set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":"
+# NTFY_AUTH=""
#
# PUSHBULLET_URL="https://api.pushbullet.com/v2/pushes"
# PUSHBULLET_TOKEN="token-value"
@@ -87,6 +95,3 @@
# TELEGRAM_CHAT_ID="mychatid"
# TELEGRAM_TOKEN="token-value"
# TELEGRAM_TOPIC_ID="0"
-#
-# FILE_PATH="${ScriptWorkDir}/updates_available.txt"
-
diff --git a/dockcheck.sh b/dockcheck.sh
index d46f4da..24e7c62 100755
--- a/dockcheck.sh
+++ b/dockcheck.sh
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
-VERSION="v0.7.1"
-# ChangeNotes: Add support for multiple notifications of the same type, output formatting, and file output
+VERSION="v0.7.6"
+# ChangeNotes: Bugfixes and sanitation. Cleanup of default.config - migrate settings manually (optional).
Github="https://github.com/mag37/dockcheck"
RawUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh"
@@ -34,7 +34,9 @@ Help() {
echo
echo "Options:"
echo "-a|y Automatic updates, without interaction."
- echo "-c Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory."
+ echo "-b N Enable image backups and sets number of days to keep from pruning."
+ echo "-B List currently backed up images, then exit."
+ echo "-c D Exports metrics as prom file for the prometheus node_exporter. Provide the collector textfile directory."
echo "-d N Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower."
echo "-e X Exclude containers, separated by comma."
echo "-f Force stop+start stack after update. Caution: restarts once for every updated container within stack."
@@ -42,14 +44,15 @@ Help() {
echo "-h Print this Help."
echo "-i Inform - send a preconfigured notification."
echo "-I Prints custom releasenote urls alongside each container with updates in CLI output (requires urls.list)."
- echo "-l Only update if label is set. See readme."
+ echo "-l Only include containers with label set. See readme."
echo "-m Monochrome mode, no printf colour codes and hides progress bar."
echo "-M Prints custom releasenote urls as markdown (requires template support)."
echo "-n No updates; only checking availability without interaction."
echo "-p Auto-prune dangling images after update."
- echo "-r Allow checking for updates/updating images for docker run containers. Won't update the container."
+ echo "-r Allow checking/updating images created by 'docker run', containers need to be recreated manually."
+ echo "-R Skip container recreation after pulling images."
echo "-s Include stopped containers in the check. (Logic: docker ps -a)."
- echo "-t Set a timeout (in seconds) per container for registry checkups, 10 is default."
+ echo "-t N Set a timeout (in seconds) per container for registry checkups, 10 is default."
echo "-u Allow automatic self updates - caution as this will pull new code and autorun it."
echo "-v Prints current version."
echo "-x N Set max asynchronous subprocesses, 1 default, 0 to disable, 32+ tested."
@@ -57,6 +60,12 @@ Help() {
echo "Project source: $Github"
}
+# Print current backups function
+print_backups() {
+ printf "\n%b---%b Currently backed up images %b---%b\n\n" "$c_teal" "$c_blue" "$c_teal" "$c_reset"
+ docker images | sed -ne '/^REPOSITORY/p' -ne '/^dockcheck/p'
+}
+
# Initialise variables
Timeout=${Timeout:-10}
MaxAsync=${MaxAsync:-1}
@@ -76,8 +85,10 @@ Stopped=${Stopped:-""}
CollectorTextFileDirectory=${CollectorTextFileDirectory:-}
Exclude=${Exclude:-}
DaysOld=${DaysOld:-}
+BackupForDays=${BackupForDays:-}
OnlySpecific=${OnlySpecific:-false}
SpecificContainer=${SpecificContainer:-""}
+SkipRecreate=${SkipRecreate:-false}
Excludes=()
GotUpdates=()
NoUpdates=()
@@ -95,9 +106,15 @@ c_blue="\033[0;34m"
c_teal="\033[0;36m"
c_reset="\033[0m"
-while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:" options; do
+# Timestamps
+RunTimestamp=$(date +'%Y-%m-%d_%H%M')
+RunEpoch=$(date +'%s')
+
+while getopts "ayb:BfFhiIlmMnprsuvc:e:d:t:x:R" options; do
case "${options}" in
a|y) AutoMode=true ;;
+ b) BackupForDays="${OPTARG}" ;;
+ B) print_backups; exit 0 ;;
c) CollectorTextFileDirectory="${OPTARG}" ;;
d) DaysOld=${OPTARG} ;;
e) Exclude=${OPTARG} ;;
@@ -110,6 +127,7 @@ while getopts "ayfFhiIlmMnprsuvc:e:d:t:x:" options; do
M) PrintMarkdownURL=true ;;
n) DontUpdate=true; AutoMode=true;;
p) AutoPrune=true ;;
+ R) SkipRecreate=true ;;
r) DRunUp=true ;;
s) Stopped="-a" ;;
t) Timeout="${OPTARG}" ;;
@@ -153,6 +171,13 @@ if [[ -n "$DaysOld" ]]; then
exit 2
fi
fi
+if [[ -n "$BackupForDays" ]]; then
+ if ! [[ $BackupForDays =~ ^[0-9]+$ ]]; then
+ printf "-b argument given (%s) is not a number.\n" "$BackupForDays"
+ exit 2
+ fi
+ [[ "$AutoPrune" == true ]] && printf "%bWARNING: When -b option is used, -p has no function.%b\n" "$c_yellow" "$c_reset"
+fi
if [[ -n "$CollectorTextFileDirectory" ]]; then
if ! [[ -d $CollectorTextFileDirectory ]]; then
printf "The directory (%s) does not exist.\n" "$CollectorTextFileDirectory"
@@ -193,11 +218,11 @@ self_update() {
printf "\n%s\n" "Pulling the latest version."
git pull --force || { printf "%bGit error,%b manually pull/clone.\n" "$c_red" "$c_reset"; return; }
printf "\n%s\n" "--- starting over with the updated version ---"
- cd - || { printf "%bPath error.%b\n" "$c_red"; return; }
+ cd - || { printf "%bPath error.%b\n" "$c_red" "$c_reset"; return; }
exec "$ScriptPath" "${ScriptArgs[@]}" # run the new script with old arguments
exit 0 # exit the old instance
else
- cd - || { printf "%bPath error.%b\n" "$c_red"; return; }
+ cd - || { printf "%bPath error.%b\n" "$c_red" "$c_reset"; return; }
self_update_curl
fi
}
@@ -206,6 +231,7 @@ choosecontainers() {
while [[ -z "${ChoiceClean:-}" ]]; do
read -r -p "Enter number(s) separated by comma, [a] for all - [q] to quit: " Choice
if [[ "$Choice" =~ [qQnN] ]]; then
+ [[ -n "${BackupForDays:-}" ]] && remove_backups
exit 0
elif [[ "$Choice" =~ [aAyY] ]]; then
SelectedUpdates=( "${GotUpdates[@]}" )
@@ -213,6 +239,7 @@ choosecontainers() {
else
ChoiceClean=${Choice//[,.:;]/ }
for CC in $ChoiceClean; do
+ CC=$((10#$CC)) # Base 10 interpretation to strip leading zeroes
if [[ "$CC" -lt 1 || "$CC" -gt $UpdCount ]]; then # Reset choice if out of bounds
echo "Number not in list: $CC"; unset ChoiceClean; break 1
else
@@ -224,16 +251,39 @@ choosecontainers() {
}
datecheck() {
- ImageDate=$("$regbin" -v error image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1)
+ ImageDate="$1"
+ DaysMax="$2"
ImageEpoch=$(date -d "$ImageDate" +%s 2>/dev/null) || ImageEpoch=$(date -f "%Y-%m-%d" -j "$ImageDate" +%s)
- ImageAge=$(( ( $(date +%s) - ImageEpoch )/86400 ))
- if [[ "$ImageAge" -gt "$DaysOld" ]]; then
+ ImageAge=$(( ( RunEpoch - ImageEpoch )/86400 ))
+ if [[ "$ImageAge" -gt "$DaysMax" ]]; then
return 0
else
return 1
fi
}
+remove_backups() {
+ IFS=$'\n'
+ CleanupCount=0
+ for backup_img in $(docker images --format "{{.Repository}} {{.Tag}}" | sed -n '/^dockcheck/p'); do
+ repo_name=${backup_img% *}
+ backup_tag=${backup_img#* }
+ backup_date=${backup_tag%%_*}
+ # UNTAGGING HERE
+ if datecheck "$backup_date" "$BackupForDays"; then
+ [[ "$CleanupCount" == 0 ]] && printf "\n%bRemoving backed up images older then %s days.%b\n" "$c_blue" "$BackupForDays" "$c_reset"
+ docker rmi "${repo_name}:${backup_tag}" && ((CleanupCount+=1))
+ fi
+ done
+ unset IFS
+ if [[ "$CleanupCount" == 0 ]]; then
+ printf "\nNo backup images to remove.\n"
+ else
+ [[ "$CleanupCount" -gt 1 ]] && b_phrase="backups" || b_phrase="backup"
+ printf "\n%b%s%b %s removed.%b\n" "$c_green" "$CleanupCount" "$c_teal" "$b_phrase" "$c_reset"
+ fi
+}
+
progress_bar() {
QueCurrent="$1"
QueTotal="$2"
@@ -342,18 +392,19 @@ dependency_check() {
dependency_check "regctl" "regbin" "https://github.com/regclient/regclient/releases/latest/download/regctl-linux-TEMP"
dependency_check "jq" "jqbin" "https://github.com/jqlang/jq/releases/latest/download/jq-linux-TEMP"
-# Numbered List function
-# if urls.list exists add release note url per line
+# Numbered List function - pads with zero
list_options() {
- num=1
+ local total="${#Updates[@]}"
+ [[ ${#total} < 2 ]] && local pads=2 || local pads="${#total}"
+ local num=1
for update in "${Updates[@]}"; do
- echo "$num) $update"
+ printf "%0*d - %s\n" "$pads" "$num" "$update"
((num++))
done
}
# Version check & initiate self update
-if [[ "$LatestRelease" != "undefined" ]]; then
+if [[ "$LatestSnippet" != "undefined" ]]; then
if [[ "$VERSION" != "$LatestRelease" ]]; then
printf "New version available! %b%s%b ⇒ %b%s%b \n Change Notes: %s \n" "$c_yellow" "$VERSION" "$c_reset" "$c_green" "$LatestRelease" "$c_reset" "$LatestChanges"
if [[ "$AutoMode" == false ]]; then
@@ -423,6 +474,10 @@ check_image() {
printf "%s\n" "NoUpdates !$i - not checked, no compose file"
return
fi
+ # Checking if Label Only -option is set, and if container got the label
+ ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
+ [[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel=""
+ [[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "Skip $i"; return; } }
local NoUpdates GotUpdates GotErrors
ImageId=$(docker inspect "$i" --format='{{.Image}}')
@@ -434,7 +489,7 @@ check_image() {
if [[ "$LocalHash" == *"$RegHash"* ]]; then
printf "%s\n" "NoUpdates $i"
else
- if [[ -n "${DaysOld:-}" ]] && ! datecheck; then
+ if [[ -n "${DaysOld:-}" ]] && ! datecheck $("$regbin" -v error image inspect "$RepoUrl" --format='{{.Created}}' | cut -d" " -f1) "$DaysOld" ; then
printf "%s\n" "NoUpdates +$i ${ImageAge}d"
else
printf "%s\n" "GotUpdates $i"
@@ -448,7 +503,7 @@ check_image() {
# Make required functions and variables available to subprocesses
export -f check_image datecheck
export Excludes_string="${Excludes[*]:-}" # Can only export scalar variables
-export t_out regbin RepoUrl DaysOld DRunUp jqbin
+export t_out regbin RepoUrl DaysOld DRunUp jqbin OnlyLabel RunTimestamp RunEpoch
# Check for POSIX xargs with -P option, fallback without async
if (echo "test" | xargs -P 2 >/dev/null 2>&1) && [[ "$MaxAsync" != 0 ]]; then
@@ -478,6 +533,8 @@ done < <( \
xargs $XargsAsync -I {} bash -c 'check_image "{}"' \
)
+[[ "$OnlyLabel" == true ]] && printf "\n%bLabel option active:%b Only checking containers with labels set.\n" "$c_blue" "$c_reset"
+
# Sort arrays alphabetically
IFS=$'\n'
NoUpdates=($(sort <<<"${NoUpdates[*]:-}"))
@@ -529,14 +586,24 @@ if [[ -n "${GotUpdates:-}" ]]; then
for i in "${SelectedUpdates[@]}"; do
((CurrentQue+=1))
printf "\n%bNow updating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
- ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}')
- ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
- ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
+ ContConfig=$(docker inspect "$i" --format '{{json .}}')
+ ContImage=$($jqbin -r '."Config"."Image"' <<< "$ContConfig")
+ ImageId=$($jqbin -r '."Image"' <<< "$ContConfig")
+ ContPath=$($jqbin -r '."Config"."Labels"."com.docker.compose.project.working_dir"' <<< "$ContConfig")
[[ "$ContPath" == "null" ]] && ContPath=""
- ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
- [[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel=""
- # Checking if Label Only -option is set, and if container got the label
- [[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping."; continue; } }
+
+ # Add new backup tag prior to pulling if option is set
+ if [[ -n "${BackupForDays:-}" ]]; then
+ ImageConfig=$(docker image inspect "$ImageId" --format '{{ json . }}')
+ ContRepoDigests=$($jqbin -r '.RepoDigests[0]' <<< "$ImageConfig")
+ [[ "$ContRepoDigests" == "null" ]] && ContRepoDigests=""
+ ContRepo=${ContImage%:*}
+ ContApp=${ContRepo#*/}
+ [[ "$ContImage" =~ ":" ]] && ContTag=${ContImage#*:} || ContTag="latest"
+ BackupName="dockcheck/${ContApp}:${RunTimestamp}_${ContTag}"
+ docker tag "$ImageId" "$BackupName"
+ printf "%b%s backed up as %s%b\n" "$c_teal" "$i" "$BackupName" "$c_reset"
+ fi
# Checking if compose-values are empty - hence started with docker run
if [[ -z "$ContPath" ]]; then
@@ -549,67 +616,90 @@ if [[ -n "${GotUpdates:-}" ]]; then
continue
fi
- docker pull "$ContImage" || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
- done
- printf "\n%bDone pulling updates. %bRecreating updated containers.%b\n" "$c_green" "$c_blue" "$c_reset"
-
- CurrentQue=0
- for i in "${SelectedUpdates[@]}"; do
- ((CurrentQue+=1))
- unset CompleteConfs
- # Extract labels and metadata
- ContLabels=$(docker inspect "$i" --format '{{json .Config.Labels}}')
- ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
- ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
- [[ "$ContPath" == "null" ]] && ContPath=""
- ContConfigFile=$($jqbin -r '."com.docker.compose.project.config_files"' <<< "$ContLabels")
- [[ "$ContConfigFile" == "null" ]] && ContConfigFile=""
- ContName=$($jqbin -r '."com.docker.compose.service"' <<< "$ContLabels")
- [[ "$ContName" == "null" ]] && ContName=""
- ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
- [[ "$ContEnv" == "null" ]] && ContEnv=""
- ContUpdateLabel=$($jqbin -r '."mag37.dockcheck.update"' <<< "$ContLabels")
- [[ "$ContUpdateLabel" == "null" ]] && ContUpdateLabel=""
- ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
- [[ "$ContRestartStack" == "null" ]] && ContRestartStack=""
- ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels")
- [[ "$ContOnlySpecific" == "null" ]] && ContRestartStack=""
-
- printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
- # Checking if compose-values are empty - hence started with docker run
- [[ -z "$ContPath" ]] && { echo "Not a compose container, skipping."; continue; }
- # Checking if Label Only -option is set, and if container got the label
- [[ "$OnlyLabel" == true ]] && { [[ "$ContUpdateLabel" != true ]] && { echo "No update label, skipping."; continue; } }
-
- # cd to the compose-file directory to account for people who use relative volumes
- cd "$ContPath" || { printf "\n%bPath error - skipping%b %s" "$c_red" "$c_reset" "$i"; continue; }
- ## Reformatting path + multi compose
- if [[ $ContConfigFile == '/'* ]]; then
- CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s " "$conf"; done)
+ if docker pull "$ContImage"; then
+ # Removal of the -tag image left behind from backup
+ if [[ ! -z "${ContRepoDigests:-}" ]] && [[ -n "${BackupForDays:-}" ]]; then docker rmi "$ContRepoDigests"; fi
else
- CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s/%s " "$ContPath" "$conf"; done)
+ printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1
fi
- # Check if the container got an environment file set and reformat it
- ContEnvs=""
- if [[ -n "$ContEnv" ]]; then ContEnvs=$(for env in ${ContEnv//,/ }; do printf -- "--env-file %s " "$env"; done); fi
- # Set variable when compose up should only target the specific container, not the stack
- if [[ $OnlySpecific == true ]] || [[ $ContOnlySpecific == true ]]; then SpecificContainer="$ContName"; fi
- # Check if the whole stack should be restarted
- if [[ "$ContRestartStack" == true ]] || [[ "$ForceRestartStacks" == true ]]; then
- ${DockerBin} ${CompleteConfs} stop; ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
- else
- ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
- fi
done
- if [[ "$AutoPrune" == false ]] && [[ "$AutoMode" == false ]]; then printf "\n"; read -rep "Would you like to prune dangling images? y/[n]: " AutoPrune; fi
- if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\nAuto pruning.."; docker image prune -f; fi
- printf "\n%bAll done!%b\n" "$c_green" "$c_reset"
+ printf "\n%bDone pulling updates.%b\n" "$c_green" "$c_reset"
+
+ if [[ "$SkipRecreate" == true ]]; then
+ printf "%bSkipping container recreation due to -R.%b\n" "$c_yellow" "$c_reset"
+ else
+ printf "%bRecreating updated containers.%b\n" "$c_blue" "$c_reset"
+ CurrentQue=0
+ for i in "${SelectedUpdates[@]}"; do
+ ((CurrentQue+=1))
+ unset CompleteConfs
+ # Extract labels and metadata
+ ContConfig=$(docker inspect "$i" --format '{{json .}}')
+ ContLabels=$($jqbin -r '."Config"."Labels"' <<< "$ContConfig")
+ ContPath=$($jqbin -r '."com.docker.compose.project.working_dir"' <<< "$ContLabels")
+ [[ "$ContPath" == "null" ]] && ContPath=""
+ ContConfigFile=$($jqbin -r '."com.docker.compose.project.config_files"' <<< "$ContLabels")
+ [[ "$ContConfigFile" == "null" ]] && ContConfigFile=""
+ ContName=$($jqbin -r '."com.docker.compose.service"' <<< "$ContLabels")
+ [[ "$ContName" == "null" ]] && ContName=""
+ ContEnv=$($jqbin -r '."com.docker.compose.project.environment_file"' <<< "$ContLabels")
+ [[ "$ContEnv" == "null" ]] && ContEnv=""
+ ContRestartStack=$($jqbin -r '."mag37.dockcheck.restart-stack"' <<< "$ContLabels")
+ [[ "$ContRestartStack" == "null" ]] && ContRestartStack=""
+ ContOnlySpecific=$($jqbin -r '."mag37.dockcheck.only-specific-container"' <<< "$ContLabels")
+ [[ "$ContOnlySpecific" == "null" ]] && ContRestartStack=""
+ ContStateRunning=$($jqbin -r '."State"."Running"' <<< "$ContConfig")
+ [[ "$ContStateRunning" == "null" ]] && ContStateRunning=""
+
+ if [[ "$ContStateRunning" == "true" ]]; then
+ printf "\n%bNow recreating (%s/%s): %b%s%b\n" "$c_teal" "$CurrentQue" "$NumberofUpdates" "$c_blue" "$i" "$c_reset"
+ else
+ printf "\n%bSkipping recreation of %b%s%b as it's not running.%b\n" "$c_yellow" "$c_blue" "$i" "$c_yellow" "$c_reset"
+ continue
+ fi
+
+ # Checking if compose-values are empty - hence started with docker run
+ [[ -z "$ContPath" ]] && { echo "Not a compose container, skipping."; continue; }
+
+ # cd to the compose-file directory to account for people who use relative volumes
+ cd "$ContPath" || { printf "\n%bPath error - skipping%b %s" "$c_red" "$c_reset" "$i"; continue; }
+ # Reformatting path + multi compose
+ if [[ $ContConfigFile == '/'* ]]; then
+ CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s " "$conf"; done)
+ else
+ CompleteConfs=$(for conf in ${ContConfigFile//,/ }; do printf -- "-f %s/%s " "$ContPath" "$conf"; done)
+ fi
+ # Check if the container got an environment file set and reformat it
+ ContEnvs=""
+ if [[ -n "$ContEnv" ]]; then ContEnvs=$(for env in ${ContEnv//,/ }; do printf -- "--env-file %s " "$env"; done); fi
+ # Set variable when compose up should only target the specific container, not the stack
+ if [[ $OnlySpecific == true ]] || [[ $ContOnlySpecific == true ]]; then SpecificContainer="$ContName"; fi
+
+ # Check if the whole stack should be restarted
+ if [[ "$ContRestartStack" == true ]] || [[ "$ForceRestartStacks" == true ]]; then
+ ${DockerBin} ${CompleteConfs} stop; ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
+ else
+ ${DockerBin} ${CompleteConfs} ${ContEnvs} up -d ${SpecificContainer} || { printf "\n%bDocker error, exiting!%b\n" "$c_red" "$c_reset" ; exit 1; }
+ fi
+ done
+ fi
+ printf "\n%bAll updates done!%b\n" "$c_green" "$c_reset"
+
+ # Trigger pruning only when backup-function is not used
+ if [[ -z "${BackupForDays:-}" ]]; then
+ if [[ "$AutoPrune" == false ]] && [[ "$AutoMode" == false ]]; then printf "\n"; read -rep "Would you like to prune all dangling images? y/[n]: " AutoPrune; fi
+ if [[ "$AutoPrune" == true ]] || [[ "$AutoPrune" =~ [yY] ]]; then printf "\nAuto pruning.."; docker image prune -f; fi
+ fi
+
else
- printf "\nNo updates installed, exiting.\n"
+ printf "\nNo updates installed.\n"
fi
else
- printf "\nNo updates available, exiting.\n"
+ printf "\nNo updates available.\n"
fi
+# Clean up old backup image tags if -b is used
+[[ -n "${BackupForDays:-}" ]] && remove_backups
+
exit 0
diff --git a/extras/apprise_quickstart.md b/extras/apprise_quickstart.md
index 2d1ddd6..c526492 100644
--- a/extras/apprise_quickstart.md
+++ b/extras/apprise_quickstart.md
@@ -38,35 +38,15 @@ You can also use the [caronc/apprise-api](https://github.com/caronc/apprise-api)
### Customize the **notify.sh** file.
-After you're done with the setup of the container and tried your notifications, you can copy the `notify_apprise.sh` file to `notify.sh` and start editing it.
+After you're done with the setup of the container and tried your notifications, you need to follow the configuration setup (explained in detail in the README).
+Briefly: Copy `default.config` to `dockcheck.config` then edit it to change the following, `APPRISE_URL` matching your environment:
-Comment out/remove the bare metal apprise-command (starting with `apprise -vv -t...`).
-Uncomment and edit the `AppriseURL` variable and *curl* line
-It should look something like this when curling the API:
```bash
-send_notification() {
-Updates=("$@")
-UpdToString=$( printf "%s\n" "${Updates[@]}" )
-FromHost=$(hostname)
-
-printf "\nSending Apprise notification\n"
-
-MessageTitle="$FromHost - updates available."
-# Setting the MessageBody variable here.
-read -d '\n' MessageBody << __EOF
-Containers on $FromHost with updates available:
-
-$UpdToString
-
-__EOF
-
-AppriseURL="http://IP.or.mydomain.tld:8000/notify/apprise"
-curl -X POST -F "title=$MessageTitle" -F "body=$MessageBody" -F "tags=all" $AppriseURL
-
-}
+NOTIFY_CHANNELS="apprise"
+APPRISE_URL="http://apprise.mydomain.tld:1234/notify/apprise"
```
-That's all!
+That's it!
___
___
diff --git a/notify_templates/notify_bark.sh b/notify_templates/notify_bark.sh
new file mode 100644
index 0000000..c720cf2
--- /dev/null
+++ b/notify_templates/notify_bark.sh
@@ -0,0 +1,46 @@
+#!/bin/bash
+
+# NOTIFY_BARK_VERSION="v1.0"
+
+trigger_bark_notification() {
+ local channel="$1"
+
+ if [[ -z "$jqbin" ]]; then
+ for path in "$jqbin" "jq" "./jq" "../jq" "./jq-linux-TEMP" "../jq-linux-TEMP"; do
+ if command -v "$path" &>/dev/null; then jqbin="$path"; break; fi
+ done
+ fi
+ [[ -z "$jqbin" ]] && { echo "Error: jq missing"; return 1; }
+
+ [[ -z "$BARK_KEY" ]] && { echo "Error: Key not set"; return 1; }
+
+ local sound="${BARK_SOUND:-hello}"
+ local group="${BARK_GROUP:-Dockcheck}"
+ local icon_url="${BARK_ICON_URL:-https://raw.githubusercontent.com/mag37/dockcheck/main/logo.png}"
+
+
+ local title="${MessageTitle%.}"
+ local newline=$'\n'
+ local formatted_body="## $title${newline}${newline}---${newline}${newline}$MessageBody"
+
+ local json_payload=$( "$jqbin" -n \
+ --arg title "$title" \
+ --arg body "$formatted_body" \
+ --arg group "$group" \
+ --arg sound "$sound" \
+ --arg icon "$icon_url" \
+ '{
+ "title": $title,
+ "markdown": $body,
+ "group": $group,
+ "sound": $sound,
+ "icon": $icon,
+ }' )
+
+
+ if curl -s -f -X POST "https://api.day.app/$BARK_KEY" \
+ -H "Content-Type: application/json; charset=utf-8" \
+ -d "$json_payload" > /dev/null 2>&1; then
+ echo "Bark notification sent successfully (Markdown): $title"
+ fi
+}
\ No newline at end of file
diff --git a/notify_templates/notify_matrix.sh b/notify_templates/notify_matrix.sh
index efdf37d..fbdb332 100644
--- a/notify_templates/notify_matrix.sh
+++ b/notify_templates/notify_matrix.sh
@@ -1,5 +1,5 @@
### DISCLAIMER: This is a third party addition to dockcheck - best effort testing.
-NOTIFY_MATRIX_VERSION="v0.4"
+NOTIFY_MATRIX_VERSION="v0.5"
#
# Required receiving services must already be set up.
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
@@ -29,7 +29,7 @@ trigger_matrix_notification() {
AccessToken="${!AccessTokenVar}" # e.g. MATRIX_ACCESS_TOKEN=token-value
RoomId="${!RoomIdVar}" # e.g. MATRIX_ROOM_ID=myroom
MatrixServer="${!MatrixServerVar}" # e.g. MATRIX_SERVER_URL=http://matrix.yourdomain.tld
- MsgBody="{\"msgtype\":\"m.text\",\"body\":\"$MessageBody\"}"
+ MsgBody=$($jqbin -Rn --arg body "$MessageBody" '{msgtype:"m.text", body:$body}')
# URL Example: https://matrix.org/_matrix/client/r0/rooms/!xxxxxx:example.com/send/m.room.message?access_token=xxxxxxxx
curl -S -o /dev/null ${CurlArgs} -X POST "$MatrixServer/_matrix/client/r0/rooms/$RoomId/send/m.room.message?access_token=$AccessToken" -H 'Content-Type: application/json' -d "$MsgBody"
@@ -37,4 +37,4 @@ trigger_matrix_notification() {
if [[ $? -gt 0 ]]; then
NotifyError=true
fi
-}
\ No newline at end of file
+}
diff --git a/notify_templates/notify_v2.sh b/notify_templates/notify_v2.sh
index 5ff088f..a44870a 100644
--- a/notify_templates/notify_v2.sh
+++ b/notify_templates/notify_v2.sh
@@ -1,4 +1,4 @@
-NOTIFY_V2_VERSION="v0.6"
+NOTIFY_V2_VERSION="v0.7"
#
# If migrating from an older notify template, remove your existing notify.sh file.
# Leave (or place) this file in the "notify_templates" subdirectory within the same directory as the main dockcheck.sh script.
@@ -40,7 +40,7 @@ done
enabled_notify_templates=( "${!unique_templates[@]}" )
-FromHost=$(cat /etc/hostname)
+FromHost="$(cat /etc/hostname 2>/dev/null)" || FromHost="$(hostname 2>/dev/null)" || FromHost="UNKNOWN"
CurrentEpochTime=$(date +"%Y-%m-%dT%H:%M:%S")
CurrentEpochSeconds=$(date +%s)
diff --git a/notify_templates/urls.list b/notify_templates/urls.list
index 2b31c3b..e69838a 100644
--- a/notify_templates/urls.list
+++ b/notify_templates/urls.list
@@ -3,31 +3,47 @@
# This is a list of container names and releasenote urls, separated by space.
actual_server https://actualbudget.org/blog
+adguardhome https://github.com/AdguardTeam/AdGuardHome/releases
apprise-api https://github.com/linuxserver/docker-apprise-api/releases
audiobookshelf https://github.com/advplyr/audiobookshelf/releases
+authentik_server https://github.com/goauthentik/authentik/releases
+authentik_worker https://github.com/goauthentik/authentik/releases
+barassistant https://github.com/karlomikus/bar-assistant//releases
+barassistant_api https://github.com/karlomikus/bar-assistant/releases
bazarr https://github.com/morpheus65535/bazarr/releases
bazarr-ls https://github.com/linuxserver/docker-bazarr/releases
beszel https://github.com/henrygd/beszel/releases
+booklore https://github.com/booklore-app/BookLore/releases
bookstack https://github.com/BookStackApp/BookStack/releases
bruceforce-vaultwarden-backup https://github.com/Bruceforce/vaultwarden-backup/blob/main/CHANGELOG.md
caddy https://github.com/caddyserver/caddy/releases
calibre https://github.com/linuxserver/docker-calibre/releases
calibre-web https://github.com/linuxserver/docker-calibre-web/releases
cleanuperr https://github.com/flmorg/cleanuperr/releases
+collabora https://github.com/CollaboraOnline/online/releases
cross-seed https://github.com/cross-seed/cross-seed/releases
+crowdsec https://github.com/crowdsecurity/crowdsec/releases
cup https://github.com/sergi0g/cup/releases
+databasus https://github.com/databasus/databasus/releases
dockge https://github.com/louislam/dockge/releases
dozzle https://github.com/amir20/dozzle/releases
+esphome https://github.com/esphome/esphome/releases
+feishin https://github.com/jeffvli/feishin/releases
flatnotes https://github.com/dullage/flatnotes/releases
forgejo https://codeberg.org/forgejo/forgejo/releases
fressrss https://github.com/FreshRSS/FreshRSS/releases
+frigate https://github.com/blakeblackshear/frigate/releases
+gerbil https://github.com/fosrl/gerbil/releases
+glances https://github.com/nicolargo/glances/releases
gluetun https://github.com/qdm12/gluetun/releases
go2rtc https://github.com/AlexxIT/go2rtc/releases
+godoxy https://github.com/yusing/godoxy/releases
gotify https://github.com/gotify/server/releases
hbbr https://github.com/rustdesk/rustdesk-server/releases
hbbs https://github.com/rustdesk/rustdesk-server/releases
homarr https://github.com/homarr-labs/homarr/releases
home-assistant https://github.com/home-assistant/core/releases/
+homepage https://github.com/gethomepage/homepage/releases
homer https://github.com/bastienwirtz/homer/releases
immich_machine_learning https://github.com/immich-app/immich/releases
immich_postgres https://github.com/tensorchord/VectorChord/releases
@@ -36,6 +52,7 @@ immich_server https://github.com/immich-app/immich/releases
jellyfin https://github.com/jellyfin/jellyfin/releases
jellyseerr https://github.com/Fallenbagel/jellyseerr/releases
jellystat https://github.com/CyferShepard/Jellystat/releases
+karakeep https://github.com/karakeep-app/karakeep/releases
librespeed https://github.com/librespeed/speedtest/releases
lidarr https://github.com/Lidarr/Lidarr/releases/
lidarr-ls https://github.com/linuxserver/docker-lidarr/releases
@@ -45,9 +62,14 @@ mealie https://github.com/mealie-recipes/mealie/releases
meilisearch https://github.com/meilisearch/meilisearch/releases
monica https://github.com/monicahq/monica/releases
mqtt https://github.com/eclipse/mosquitto/tags
+navidrome https://github.com/navidrome/navidrome/releases
+newt https://github.com/fosrl/newt/releases
nextcloud-aio-mastercontainer https://github.com/nextcloud/all-in-one/releases
nginx https://github.com/docker-library/official-images/blob/master/library/nginx
+opencloud https://github.com/opencloud-eu/opencloud/releases
+outline https://github.com/outline/outline/releases
owncast https://github.com/owncast/owncast/releases
+pangolin https://github.com/fosrl/pangolin/releases
prowlarr https://github.com/Prowlarr/Prowlarr/releases
prowlarr-ls https://github.com/linuxserver/docker-prowlarr/releases
qbittorrent https://www.qbittorrent.org/news
@@ -59,17 +81,25 @@ readeck https://codeberg.org/readeck/readeck/releases
recyclarr https://github.com/recyclarr/recyclarr/releases
roundcubemail https://github.com/roundcube/roundcubemail/releases
sabnzbd https://github.com/linuxserver/docker-sabnzbd/releases
+scanopy https://github.com/scanopy/scanopy/releases
scrutiny https://github.com/AnalogJ/scrutiny/releases
sftpgo https://github.com/drakkan/sftpgo/releases
slskd https://github.com/slskd/slskd/releases
snappymail https://github.com/the-djmaze/snappymail/releases
+stirling-pdf https://github.com/Stirling-Tools/Stirling-PDF/releases
sonarr https://github.com/Sonarr/Sonarr/releases/
sonarr-ls https://github.com/linuxserver/docker-sonarr/releases
+synapse https://github.com/element-hq/synapse/releases
syncthing https://github.com/syncthing/syncthing/releases
+tailscale https://github.com/tailscale/tailscale/releases
tautulli https://github.com/Tautulli/Tautulli/releases
thelounge https://github.com/thelounge/thelounge/releases
traefik https://github.com/traefik/traefik/releases
+uptime-kuma https://github.com/louislam/uptime-kuma/releases
vaultwarden-server https://github.com/dani-garcia/vaultwarden/releases
+vikunja https://github.com/go-vikunja/vikunja/releases
+wallos https://github.com/ellite/Wallos/releases
watchtower https://github.com/beatkind/watchtower/releases
+wopiserver https://github.com/cs3org/wopiserver/releases
wud https://github.com/getwud/wud/releases
zigbee2mqtt https://github.com/Koenkk/zigbee2mqtt/releases