dockcheck/README.md

102 lines
3.1 KiB
Markdown
Raw Normal View History

2023-01-18 10:47:52 +00:00
# dockcheck
2023-01-31 13:52:30 +00:00
### A script checking updates for docker images **without the need of pulling** - then optionally auto-update chosen containers.
With the help of [`regctl`](https://github.com/regclient/regclient). This is just a concept for inspiration, use with care.
2023-01-18 12:46:00 +00:00
___
2023-01-18 12:44:39 +00:00
2023-01-18 12:45:15 +00:00
## Dependencies:
2023-01-18 12:46:00 +00:00
Running docker (duh) and compose, either standalone or plugin.
2023-01-31 13:55:00 +00:00
`regctl` by [regclient](https://github.com/regclient/regclient) (will ask to download `regctl` if not in `PATH` or `PWD`)
2023-01-18 12:46:00 +00:00
___
2023-01-18 12:45:30 +00:00
## `dockcheck.sh`
2023-01-18 20:07:52 +00:00
```bash
$ ./dockcheck.sh -h
Syntax: dockcheck.sh [OPTION] [part of name to filter]
Example: dockcheck.sh -a ng
Options:
-h Print this Help.
-a|y Automatic updates, without interaction.
-n No updates, only checking availability.
```
2023-01-22 12:44:48 +00:00
2023-01-31 09:48:54 +00:00
![](https://github.com/mag37/dockcheck/blob/main/example.gif)
2023-01-19 11:20:02 +00:00
Basic example:
```bash
$ ./dockcheck.sh
2023-01-18 20:07:52 +00:00
. . .
Containers on latest version:
glances
homer
Containers with updates available:
0) ALL
1) adguardhome
2) syncthing
3) whoogle-search
Do you want to update? y/[n] y
What containers do you like to update?
Enter number(s) separated by comma: 1,3
2023-01-18 20:12:00 +00:00
```
2023-01-19 11:20:02 +00:00
Then it proceedes to run `pull` and `up -d` on every container with updates.
2023-01-19 11:21:05 +00:00
And with `-n` *No updates* and `gl` for `*gl*` filtering:
```bash
$ ./dockcheck.sh -n gl
. . .
Containers with updates available:
whoogle-search
Containers on latest version:
glances
No updates installed, exiting
```
2023-01-18 20:07:52 +00:00
### :beetle: Squashed Bugs:
- ~~No options for running without updates or auto update.~~
- ~~No filter to check only specific containers.~~
- ~~Faulty registry checkups stopped the updates completely.~~
- ~~No clear checks to skip containers producing errors.~~
- ~~Multi-digest images didn't correctly check with registry, giving false positives on updates.~~
- ~~Not working with filenames other than `docker-compose.yml`~~
- ~~Lists are not alphabetically sorted (due to stacks and other parameters)~~
- ~~Old `docker-compose` binary-check sometimes returned false error~~
- ~~Stacks gets updated as whole, even if only one service is chosen.~~
### :hammer: Known issues
- ~~No granular choice of what to update (except initial name filter).~~
- No detailed error feedback (just skip + list what's skipped) .
2023-01-30 13:21:57 +00:00
## `dockcheck_docker-run_ver.sh`
### Wont auto-update the containers, only their images. (compose is recommended)
Alternative version for people who use `docker run` and no composes.
`docker run` dont support using new images just by restarting a container.
Containers need to be stopped, removed and created again to run on the new image.
2023-01-19 11:24:34 +00:00
## `dupc_function.sh`
2023-01-19 11:28:15 +00:00
Function to quickly check for updates on a single contianer or list of containers by name. **Without the need of pulling**.
2023-01-18 20:03:42 +00:00
Preferably placed in `.bashrc` or similar.
Example:
2023-01-19 09:03:43 +00:00
```
2023-01-19 11:24:34 +00:00
$ dupc ng
2023-01-19 09:03:26 +00:00
Updates available for local_nginx.
nginx_reverse is already latest.
Updates available for paperless-ng.
2023-01-18 20:03:42 +00:00
```
2023-02-01 19:55:20 +00:00
## Also check out a spinoff brother-project [Palleri/dockcheck-web](https://github.com/Palleri/dockcheck-web) for a WebUI-front!
---
## Special Thanks:
:bison: [t0rnis](https://github.com/t0rnis)
:leopard: [Palleri](https://github.com/Palleri)