1
Fork 0

Add more details to readme

This commit is contained in:
Jake Howard 2020-10-05 21:42:30 +01:00
parent 959921bf5f
commit 2d3bc78beb
Signed by: jake
GPG key ID: 57AFB45680EDD477

View file

@ -1,2 +1,19 @@
# compose-updater
Simple command to enable updating docker-compose based applications
![CI](https://github.com/RealOrangeOne/compose-updater/workflows/CI/badge.svg)
Simple command to enable updating docker-compose based applications.
If newer containers are available than those running, pull the new containers, and cycle the containers. Supports specifying multiple containers using globs, and multiple globs if necessary.
## Features
- Only cycle application if containers were updated (unless `--force-cycle` specified)
- Don't try and update stopped containers (unless `--force-pull` specified)
## _"How does it work?"_
- List images
- If there are images, pull (`docker-compose pull`)
- List images again
- If images list is different, cycle container (`docker-compose down && docker-compose up -d`)