Updated readme

This commit is contained in:
Chris 2022-03-10 02:32:47 +01:00
parent 0cf2380b7e
commit 66abd9d3c5

View File

@ -5,17 +5,20 @@ returning
## Building ## Building
Build using NoccyLabs Pharlite. Build using NoccyLabs Pharlite:
$ tools/pharlite
## Installing
Download the latest version (or build it yourself) and move it into `/usr/bin`.
## Usage ## Usage
To check for updates, pull updated images and recreate any containers defined in the To check for updates, pull updated images and recreate any containers defined in the
`docker-compose.yml` in the current directory: `docker-compose.yml` in the current directory:
``` $ fresh.phar
$ fresh.phar
```
For all available options, use the `--help` flag. For all available options, use the `--help` flag.
@ -25,15 +28,15 @@ For all available options, use the `--help` flag.
`--check` flag. `--check` flag.
- Only checks authenticated registries for new versions. But if you are using - Only checks authenticated registries for new versions. But if you are using
this you probably aren't using DockerHub anyway. this you probably aren't using DockerHub anyway.
- ~Using the `-q` or `--quiet` flags doesn't mute the output from `docker-compose`.~
- ~Using `--check` still updates the state, need a `--no-state` flag or so to ~
~prevent updating the state.~
## FAQ ## FAQ
- **How does Fresh remember the last seen hash?** The container hashes are stored - **How does Fresh remember the last seen hash?** The container hashes are stored
in the same directory as the `docker-compose.yml` file in a file named `fresh.yml`. in the same directory as the `docker-compose.yml` file in a file named `fresh.yml`.
Remove this file to force trigger an update. Remove this file to force trigger an update.
- **What are these hashes?** Fresh grabs the manifest for the image from the registry
and proceeds to hash a concatenation of all the various build layer hashes. This
should mean if the image is new but the layers are the same nothing will be updated.
## Changes ## Changes