diff --git a/README.md b/README.md index d1785d2..d637d65 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,16 @@ docker build -t git-puller . After this is done successfully, you can check out the new image in your local image store with `docker images`. +## Configuration + +Essentially, this image can be configured over environment variables. + +- **`PULL_LOCATION`**: used to set the container-internal folder which is getting pulled frequently (you should mount one into this direction) - defaults to `/to-pull` +- **`PULL_INTERVAL`**: the interval between pulls in seconds (minimum is 5, default is 60) +- **`PULLER_UID`**: the uid of the user that executes the `git pull` command (defaults to 1000) +- **`GIT_OUTPUT`**: if set to 0, the `git pull` stdout will be hidden from docker logs (redirected to /dev/null ;) (if not set, everything is visible in the docker logs) + + ## Useful links Similar projects: