138 lines
6.2 KiB
Markdown
138 lines
6.2 KiB
Markdown
<p align="center">
|
|
<img src="extras/dockcheck_logo_by_booYah187.png" width="160" title="dockcheck">
|
|
</p>
|
|
<p align="center">
|
|
<img src="https://img.shields.io/badge/coded%20by%20Human-100%25-yellow?style=flat-square" alt="No AI!">
|
|
<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>
|
|
<img src="https://img.shields.io/github/v/tag/mag37/dockcheck?style=flat-square&label=release" alt="release">
|
|
<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://github.com/sponsors/mag37"><img src="https://img.shields.io/badge/-Sponsor-grey?style=flat-square&logo=github" alt="Github Sponsor"></a>
|
|
</p>
|
|
|
|
<h3 align="center">A script checking updates for docker images <b>without pulling</b><br>Then selectively auto-update containers.</h3>
|
|
<h2 align="center">Now with a simple Apprise integration!</h2>
|
|
<h4 align="center">With features like excluding specific containers, filter by name, auto-prune dangling images and more.</h4>
|
|
|
|
|
|
### :bell: Changelog
|
|
- **v0.3.3**: Added Apprise template and the option `-i` inform - to send notifications.
|
|
- **v0.3.2**: Added a notify function to wrap a notify-script, currently DSM/Ssmtp + template script.
|
|
- **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.
|
|
___
|
|
|
|
## Dependencies
|
|
- Running docker (duh) and compose, either standalone or plugin.
|
|
- [`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](#workaround-for-non-amd64--arm64) if other architecture is used.
|
|
___
|
|
|
|
|
|
|
|
|
|
## `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.
|
|
-h Print this Help.
|
|
-i Inform - send a preconfigured notification.
|
|
-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)
|
|
```
|
|
|
|
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.
|
|
|
|
### :loudspeaker: Notifications
|
|
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:
|
|
- Synology [DSM](https://www.synology.com/en-global/dsm)
|
|
- Email with [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)
|
|
|
|
Further additions are welcome - suggestions or PR!
|
|
<sub><sup>Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2).</sup></sub>
|
|
|
|
|
|
### :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.
|
|
|
|
### :hammer: 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.
|
|
|
|
### :roller_coaster: 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
|
|
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`).
|
|
|
|
|
|
## `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](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
|
|
|
|
## The [story](https://mag37.org/posts/project_dockcheck/) behind it. 1 year in the mirror.
|
|
|
|
___
|
|
|
|
### Check out a spinoff project: [Palleri/DCW](https://github.com/Palleri/DCW) for a WebUI-front with exporters and notifications.
|
|
|
|
## Special Thanks
|
|
- :bison: [t0rnis](https://github.com/t0rnis)
|
|
- :leopard: [Palleri](https://github.com/Palleri)
|