Mirrored_Repos/dockcheck
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
mag37 2023-02-15 13:14:05 +01:00
parent 607ead565c
commit 791933ffaa
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,12 +1,11 @@
# dockcheck # dockcheck
### A script checking updates for docker images **without pulling** - then selectively auto-update some/all containers. ### A script checking updates for docker images **without pulling** - then selectively auto-update some/all containers.
With the help of [`regctl`](https://github.com/regclient/regclient). This is just a concept for inspiration, use with care.
___ ___
## Dependencies: ## Dependencies:
Running docker (duh) and compose, either standalone or plugin. Running docker (duh) and compose, either standalone or plugin.
`regctl` by [regclient](https://github.com/regclient/regclient) (will ask to download `regctl` if not in `PATH` or `PWD`) [`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`
___ ___
@ -22,6 +21,7 @@ Options:
-h Print this Help. -h Print this Help.
-a|y Automatic updates, without interaction. -a|y Automatic updates, without interaction.
-n No updates, only checking availability. -n No updates, only checking availability.
-p Auto-Prune dangling images after update.
-r Allow updating images for docker run, wont update the container. -r Allow updating images for docker run, wont update the container.
``` ```
@ -34,17 +34,17 @@ glances
homer homer
Containers with updates available: Containers with updates available:
0) ALL
1) adguardhome 1) adguardhome
2) syncthing 2) syncthing
3) whoogle-search 3) whoogle-search
Choose what containers to update: Choose what containers to update:
Enter number(s) separated by comma, [q] to quit: 1,3 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. 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` :warning: disclaimer and warning: ### `-r flag` :warning: disclaimer and warning:
**Wont auto-update the containers, only their images. (compose is recommended)** **Wont auto-update the containers, only their images. (compose is recommended)**
@ -65,6 +65,7 @@ Containers need to be manually stopped, removed and created again to run on the
- ~~Path broken occationally (from inspect) - probably due to old docker-compose binary.~~ - ~~Path broken occationally (from inspect) - probably due to old docker-compose binary.~~
- ~~Script breaks if one of the chosen containers are a `docker run` container.~~ - ~~Script breaks if one of the chosen containers are a `docker run` container.~~
- ~~Using relative paths for volumes eg. `${PWD}/data:data` will create the volumes where you stand.~~ - ~~Using relative paths for volumes eg. `${PWD}/data:data` will create the volumes where you stand.~~
- ~~Having no curl/wget leads to corrupt `regctl` without alerting.~~
### :hammer: Known issues ### :hammer: Known issues
- ~~No granular choice of what to update (except initial name filter).~~ - ~~No granular choice of what to update (except initial name filter).~~
@ -80,6 +81,9 @@ Updates available for local_nginx.
nginx_reverse is already latest. nginx_reverse is already latest.
Updates available for paperless-ng. Updates available for paperless-ng.
``` ```
# License
dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license.
## Also check out a spinoff brother-project [Palleri/dockcheck-web](https://github.com/Palleri/dockcheck-web) for a WebUI-front! ## Also check out a spinoff brother-project [Palleri/dockcheck-web](https://github.com/Palleri/dockcheck-web) for a WebUI-front!
--- ---