maride/blogker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Enhance README

Browse Source
This commit is contained in:
maride 2023-08-31 19:09:17 +02:00
parent 30fe61c9c0
commit c5cd522a22
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -4,13 +4,26 @@ A nginx-powered container hosting a hugo-built blog regularly pulled off git.
## Run ## 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 ### 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: 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` `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 #### SSH URLs