/dockcheck

A script checking updates for docker images without pulling - then selectively auto-update some/all containers.

Primary LanguageShellGNU General Public License v3.0GPL-3.0

No AI! bash GPLv3 release Buy me a Coffee LiberaPay Github Sponsor

A script checking updates for docker images without pulling
Then selectively auto-update containers.

With features like excluding specific containers, filter by name, auto-prune dangling images and more.

🔔 Recent changes

  • v0.3.1: Addded option -m , monochrome mode - no printf color codes.
  • v0.3.0: Added option -d N, age (days) new images have to be before being pulled and updated.
  • v0.2.6: regctl check / download logic changed. Now using the scripts directory as primary location.
  • v0.2.5: Added a new option -s to include stopped containers in the check for updates.
  • v0.2.4: Fixed a bug with the Exclude-logic to only exclude exact matches. Added a counter.
  • v0.2.3: Added a self updating function (curl/git) and a ugly changenote-message for updates.
  • v0.2.2: Fixed breaking errors with multi-compose, odd breakage and working dir error.
  • v0.2.1: Added option to exclude a list of containers.
  • v0.2.1: Added multi-compose support (eg. override).
  • v0.2.0: Fixed error with container:tag definition.
  • v0.1.9: Fixed custom env-support.

Dependencies

Running docker (duh) and compose, either standalone or plugin.
regclient/regctl (Licensed under Apache-2.0 License)
User will be prompted to download regctl if not in PATH or PWD

dockcheck.sh

$ ./dockcheck.sh -h
 Syntax:     dockcheck.sh [OPTION] [part of name to filter] 
 Example:    dockcheck.sh -y -d 10 -e nextcloud,heimdall
 
 Options:
 -h     Print this Help.
 -a|y   Automatic updates, without interaction.
 -n     No updates, only checking availability.
 -e X   Exclude containers, separated by comma.
 -d N   Only update to new images that are N+ days old. Lists too recent with +prefix. 2xSlower.
 -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).

Basic example:

$ ./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.

⚠️ -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.

🔨 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.

dc_brief.sh

Just a brief, slimmed down version of the script to only print what containers got updates, no updates or errors.

License

dockcheck is created and released under the GNU GPL v3.0 license.

Check out a spinoff project: Palleri/DCW for a WebUI-front with exporters and notifications.

Special Thanks