noccy/fresh
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

Update 'Usage'

Chris 2022-03-10 01:52:49 +00:00
parent bdff4afbc7
commit 931ad51642
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Usage.md

@ -1 +1,17 @@
Welcome to the Wiki.
## Basic usage
Using Fresh is as simple as falling off a log. Just run it while in a directory that contains a `docker-compose.yml` file, and Fresh will go and check for updates to any registries you have authenticated against. This means it currently can't be used to check images from dockerhub, but it works great for private registries.
### Slack/Mattermost Webhooks
Fresh can invoke a Slack-compatible webhook to notify before anything is actually updated. To do this, use the `--slack` flag followed by the webhook URL
### Script hooks
You can specify a script to run after an update by using the `--after` flag.
## Scheduled run
### Using cron
### Using Systemd