Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ptruman committed Sep 9, 2020
1 parent 1c29d16 commit a4f49c9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ It *assumes* that you are using the standard Docker Hub Registry for your images
<b>Volumes</b>

* /var/run/docker.sock:/var/run/docker.sock:ro
* /tmp/cwatch.txt:/var/log/cwatch *(optional)*

* /tmp/cwatch.txt:/var/log/cwatch (optional)
* /etc/localtime:/etc/localtime:ro (optional *but* ensures correct timestamps)
* /etc/timezone:/etc/timezone:ro (optional *but* ensures correct timestamps)
* /etc/msmtprc:/etc/msmtprc:re (optional, if you have a functional msmtprc already)
<b>Environment</b>

* DEBUG - Can be set to 1 for verbose output. Defaults to *0*
Expand All @@ -44,6 +46,14 @@ It also writes logs to /var/log/cwatch - so you can mount that as a bind mount (

Every 1am, CWATCH will run and check each container for a newer Docker Registry image, and advise if one is available.

# Label Based Checking
CWATCH can read the following <b>labels</b> from running *containers* to INCLUDE or EXCLUDE their images from checking, although for this to work you <b>must</b> specify the environment variable BEHAVIOUR to be *INCLUDE* or *EXCLUDE* for them to be useful.
* CWATCH.INCLUDE - set to TRUE on a container you want to check the image for
* CWATCH.EXCLUDE - set to TRUE on a container you want to *not* check the image for

This means you do not need to set *every* Container with the labels, just the ones you want to explicitly include, or exclude.
The default BEHAVIOUR is ALL which will check ALL containers.

# Notes

* msmtp support is coming shortly (to send emails)
Expand Down
1 change: 1 addition & 0 deletions cwatch.sh
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,7 @@ EndTime=`date +%s`
TotalTime=`expr $EndTime - $StartTime`
OutDate=`date`
SendOutput S "CWATCH >> Finished. Took $TotalTime seconds. ($OutDate)"
echo "CWATCH >> Finished. Took $TotalTime seconds. ($OutDate)" >> $TMPFile

# Send email
if [ "$CWATCH_ENABLE_EMAIL" = 1 ]; then
Expand Down

0 comments on commit a4f49c9

Please sign in to comment.