Docker - Hugo site generator used in CI/CD.
MIT License
This is used in my blog automation.
git clone https://github.com/J-Siu/docker_hugo.git
cd docker_hugo
docker build -t jsiu/hugo .
Host | Inside Container | Mapping Required | Default | Usage |
---|---|---|---|---|
${TZ} | ${MY_TZ} | no | n/a | time zone |
${WWW_VOL} | /www | yes | n/a | Base dir/volume Hugo publish to |
${MY_GIT_DIR} | ${MY_GIT_DIR} | no | /hugo | Git clone/pull destination. |
${MY_GIT_URL} | ${MY_GIT_URL} | yes | n/a | Git will clone/pull from this URL. |
${MY_GIT_SUB} | ${MY_GIT_SUB} | no | n/a | If defined(not empty), pull git sub-module |
${MY_GIT_SUB_REMOTE} | ${MY_GIT_SUB_REMOTE} | no | n/a | If defined(not empty), pull git sub-module with --remote
|
${MY_HUG_DIR} | ${MY_HUG_DIR} | no | n/a | Relative path to ${MY_GIT_DIR}, default empty. |
${MY_PUB_DIR} | ${MY_PUB_DIR} | no | n/a | Override publish directory. Hugo default public or defined in site config(publishDir ). |
${MY_THM_DIR} | ${MY_THM_DIR} | no | /theme | Hugo theme clone/pull destination. |
${MY_THM_URL} | ${MY_THM_URL} | no | n/a | Hugo theme repo url. |
Clone/pull of ${MY_GIT_URL}
flow:
${MY_GIT_DIR}/.git
exist, do git pull, exit(1) if failed.${MY_GIT_DIR}
exist
${MY_GIT_DIR}
does not exist, do git clone, exit(1) if failed.If ${MY_THM_URL}
is defined:
${MY_GIT_URL}
--destination
will be added to hugo command${MY_THM_DIR}
and ${MY_THM_URL}
will not use theme automatically. Please see examples below.All arguments will past to
hugo
instart.sh
. See last example below.
docker run --rm --name hugo \
-v ${WWW_VOL}:/www \
-e P_TZ=America/New_York \
-e MY_GIT_URL=${MY_GIT_URL} \
jsiu/hugo
Fresh git clone each run, publish to /www/johnsiu.com
at the end.
docker run --rm --name hugo \
-v CADDY_WWW:/www \
-e P_TZ=America/New_York \
-e MY_GIT_URL=https://github.com/J-Siu/johnsiu.com.git \
-e MY_GIT_SUB=true \
-e MY_PUB_DIR=/www/johnsiu.com \
jsiu/hugo
Clone if needed, else pull.
docker run --rm --name hugo \
-v CADDY_WWW:/www \
-e P_TZ=America/New_York \
-e MY_GIT_URL=https://github.com/J-Siu/johnsiu.com.git \
-e MY_GIT_SUB=true \
-e MY_GIT_DIR=/www/johnsiu.com \
jsiu/hugo
docker run --rm --name hugo \
-v CADDY_WWW:/www \
-e P_TZ=America/New_York \
-e MY_GIT_URL=https://github.com/J-Siu/johnsiu.com.git \
-e MY_GIT_SUB=true \
-e MY_GIT_DIR=/www/git/johnsiu.com \
-e MY_PUB_DIR=/www/site/johnsiu.com \
jsiu/hugo
Pass --cleanDestinationDir
to hugo command.
docker run --rm --name hugo \
-v CADDY_WWW:/www \
-e P_TZ=America/New_York \
-e MY_GIT_URL=https://github.com/J-Siu/johnsiu.com.git \
-e MY_GIT_SUB=true \
-e MY_GIT_DIR=/www/git/johnsiu.com \
-e MY_PUB_DIR=/www/site/johnsiu.com \
jsiu/hugo --cleanDestinationDir
Replacing theme and hugo command.
docker run --rm --name hugo \
-v CADDY_WWW:/www \
-e P_TZ=America/New_York \
-e MY_GIT_URL=https://github.com/J-Siu/johnsiu.com.git \
-e MY_GIT_DIR=/www/git/johnsiu.com \
-e MY_PUB_DIR=/www/site/johnsiu.com \
-e MY_THM_URL=https://github.com/J-Siu/hugo-theme-sk3.git \
jsiu/hugo --theme theme --themesDir /
docker run --rm --name hugo \
-v CADDY_WWW:/www \
-e P_TZ=America/New_York \
-e MY_GIT_URL=https://github.com/J-Siu/johnsiu.com.git \
-e MY_GIT_DIR=/www/git/johnsiu.com \
-e MY_PUB_DIR=/www/site/johnsiu.com \
-e MY_THM_DIR=/www/themes/sk3 \
-e MY_THM_URL=https://github.com/J-Siu/hugo-theme-sk3.git \
jsiu/hugo --theme sk3 --themesDir /www/themes
Get README.md
from image:
docker run --rm jsiu/hugo cat /README.md > README.md
${MY_GIT_DIR}
, ${MY_GIT_PUB}
.MY_GIT_SUB_REMOTE
optionThe MIT License
Copyright (c) 2024
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.