search

blastehh / vuepress-docker

https://hub.docker.com/r/blasteh/vuepress
MIT License
13 stars 5 forks source link
docker vuepress

readme

Vuepress-docker

Simple build of vuepress using Alpine Linux on Docker.

The image has 2 folders, 1 for input files, 1 for output files. Mount these folders to use the image:

Input folder: /root/src

Output folder: /root/html

When the build runs, it will take contents of the input folder, generate the site, and then place them in the output folder. This image regenerates the files every 23 hours unless you use the hook option. Webhook is supplied by Hookdoo

Environment variables

USE_HOOK - The web hook is enabled as long as this is present.

GITHUB_REPO - Remove "https://" from the url; e.g. use GITHUB_REPO=github.com/blastehh/vuepress-docker.git instead of GITHUB_REPO=https://github.com/blastehh/vuepress-docker.git

GITHUB_TOKEN - Needed to access private repos, otherwise will try to access a public repo.

GITHUB_PUSH_REPO - URL of repo to push to once build finishes, e.g. github.com/blastehh/mypage.git

GITHUB_PUSH_TOKEN - Set the token for pushing to Github if different from GITHUB_TOKEN

PLUGINS - A space delimited list of vuepress plugins to install; e.g. PLUGINS="@vuepress/plugin-back-to-top @vuepress/plugin-pwa"

Example docker command

This will automatically regenerate the source files every 23 hours.

docker run --name vuepress -v /host/vuepress/files/:/root/src/:rw -v /host/vuepress/output/:/root/html/:rw -d blasteh/vuepress

Github example:

This will pull from the repo before generating the files.

docker run --name vuepress -v /host/vuepress/files/:/root/src/:rw -v /host/vuepress/output/:/root/html/:rw -d -e GITHUB_REPO=github.com/blastehh/vuepress-docker.git blasteh/vuepress

Github example with a Personal access token:

This will pull from a private repo before generating the files.

docker run --name vuepress -v /host/vuepress/files/:/root/src/:rw -v /host/vuepress/output/:/root/html/:rw -d -e GITHUB_REPO=github.com/blastehh/vuepress-docker.git -e GITHUB_TOKEN=TOKENHERE blasteh/vuepress

Github with hooks example:

This will listen for a webhook, and then pull from a private repo before generating the files. Trigger the hook via http://<container address>:9000/hooks/vuepress-webhook

docker run --name vuepress -v /host/vuepress/files/:/root/src/:rw -v /host/vuepress/output/:/root/html/:rw -d -p 9000:9000 -e USE_HOOK=1 -e GITHUB_REPO=github.com/blastehh/vuepress-docker.git -e GITHUB_TOKEN=TOKENHERE blasteh/vuepress