Skip to content
Dockerized docs, powered by VuePress
Shell JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
.gitignore
Dockerfile.docs
README.md
docker-compose.yml
docs.conf
hl.js
htpasswd.sh
screenshot.png

README.md

dockerized-docs

Dockerized docs, powered by VuePress

Usage

You may set the ports in docker-compose.yml, default is 3627

And then build the image

docker-compose build

Next, write docs in the docs subdirectory.

Finally,

docker-compose up -d

Restrict Access

To enable basic http auth, you should edit docs/security.txt

For example, to allow user username to access with password pa$$word, and user username1 to access with password pa$$word!, the docs/security.txt should be

username pa$$word
username1 pa$$word!

PLEASE MAKE SURE THERE IS A BLANK LINE AT THE END.

NO SPACE-ish CHARACTER IS ALLOWED IN EITHER USERNAME OR PASSWORD. AND : IS NOT ALLOWED IN USERNAME.

Another way

Or, you can generate a .htpasswd by yourself, and place it in docs

Note

If docs/security.txt and docs/.htpasswd are both missing, there will be no restriction.

(which means you could remove docs/security.txt and docs/.htpasswd to disable access restrict).

screenshot

screenshot

You can’t perform that action at this time.