CLI tool to automate docker image updates. No pre-pull, selective, notify, prune.
--env-file
logic to work with multiple env-files.-f
option (force restart stack).dockcheck.sh
$ ./dockcheck.sh -h
Syntax: dockcheck.sh [OPTION] [part of name to filter]
Example: dockcheck.sh -y -d 10 -e nextcloud,heimdall
Options:"
-a|y Automatic updates, without interaction.
-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.
-f Force stack restart after update. Caution: restarts once for every updated container within stack.
-h Print this Help.
-i Inform - send a preconfigured notification.
-l Only update if label is set. See readme.
-m Monochrome mode, no printf color codes.
-n No updates, only checking availability.
-p Auto-Prune dangling images after update.
-r Allow updating images for docker run, wont update the container.
-s Include stopped containers in the check. (Logic: docker ps -a).
-v Prints current version.
$ ./dockcheck.sh
. . .
Containers on latest version:
glances
homer
Containers with updates available:
1) adguardhome
2) syncthing
3) whoogle-search
Choose what containers to update:
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.
After the updates are complete, you'll get prompted if you'd like to prune dangling images.
regctl
if not in PATH
or PWD
.amd64/arm64
- see workaround if other architecture is used.Download the script to a directory in PATH, I'd suggest using ~/.local/bin
as that's usually in PATH.
# 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
# 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
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.
Trigger with the -i
flag.
Run it scheduled with -ni
to only get notified when there's updates available!
Use a notify_X.sh
template file, copy it to notify.sh
, modify it to your needs!
Current templates:
Further additions are welcome - suggestions or PR!
Initiated and first contributed by yoyoma2.
Optionally add labels to compose-files. Currently these are the usable labels:
labels:
mag37.dockcheck.restart-stack: true
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.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.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:
cat >regctl <<EOF
#!/bin/sh
opts=""
case "\$*" in
"registry login"*) opts="-t";;
esac
docker container run \$opts -i --rm --net host \\
-u "\$(id -u):\$(id -g)" -e HOME -v \$HOME:\$HOME \\
-v /etc/docker/certs.d:/etc/docker/certs.d:ro \\
ghcr.io/regclient/regctl:latest "\$@"
EOF
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
).
Example - Change names, paths, and remove cat+password flag if you rather get prompted:
function dchk {
cat ~/pwd.txt | docker login --username YourUser --password-stdin
~/dockcheck.sh "$@"
}
--profile
options when re-creating the container.-r flag
disclaimer and warningWont 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.
dockcheck is created and released under the GNU GPL v3.0 license.