dockcheck/README.md
mag37 4f8d6289c2
Update README.md
added donation buttons
added logo by [booYah187](https://github.com/booYah187)
2023-03-04 09:56:16 +01:00

4.2 KiB

bash GPLv3 release Buy me a Coffee LiberaPay Github Sponsor

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

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

⚠️ URGENT!

The 2.0 change had a breaking error - compose-recreation might have included previous containers compose-file. If you've had odd errors, you can use the errorCheck.sh script to list current running container configs in a readable way. Look especially for Compose files listed in wrong places.
Recreate the suspicious container(s) manually with docker compose down && docker compose up -d.

📌 Recent changes:

  • 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.
  • v0.1.8: Added option to prune dangling images.

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 -a -e nextcloud,heimdall

Options:
-h     Print this Help.
-a|y   Automatic updates, without interaction.
-n     No updates, only checking availability.
-p     Auto-Prune dangling images after update.
-e     Exclude containers, separated by comma.
-r     Allow updating images for docker run, wont update the container.

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.

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 brother-project:

Palleri/dockcheck-web for a WebUI-front!

Special Thanks: