diff --git a/README.md b/README.md index 0944727..a671a97 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,26 @@ A nginx-powered container hosting a hugo-built blog regularly pulled off git. ## Run +There are multiple options to get your Hugo blog into blogker: +- by specifying a git URL where it gets pulled from regularly +- by passing in the required files via a bind or volume mount + ### Auto-Pull Git If you store your blog data in a git repository, run the container with env `REPO_URL` set to a Git repo: `docker run -e REPO_URL=https://git.maride.cc/maride/sec.maride.cc.git -p 80:80 -d blogker` -The repository will be pulled and built every 10 minutes. +#### Pull frequency + +The repository will be pulled and built every 10 minutes by default. + +Other values can be specified by the `BUILDFREQ` environment variable. +For example, if you want to have the blog updated every minute: + +`docker run -e REPO_URL=https://... -e BUILDFREQ=1 -p 80:80 -d blogker` + +Lowering this value may risk running into rate limits on some git servers. #### SSH URLs