nanzhoumails/auth_wiki repository overview

⁠Auth-Gollum-Wiki-Image

A ready-to-use docker image for Github-Synchronized, Markdown-based, and Auth-Enabled Wiki System.

A live demo is available here⁠.
More details can be found in this post⁠.
Dockerfile can be found here⁠.

⁠Run

Create your Github wiki, clone it to some local directory. For example,

git clone https://github.com/FighterNan/FighterNan.github.io.wiki.git

Run the service on the root of your Wiki repo.

cd FighterNan.github.io.wiki
sudo docker run \
-v ${PWD}:/home/wiki_repo \
-p 4567:4567 \
-e GITHUB_CLIENT_ID=xxx \
-e GITHUB_CLIENT_SECRET=xxx \
-e [email protected] \
--name wiki \
nanzhoumails/auth_wiki:latest

There are three environment variables you should set. GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET are available once you set your Github OAuth App. See here⁠ for official tutorial. AUTH_EMAIL specifies the user who can edit the pages. Other users can only view the pages.

⁠Reference

gollum⁠

omnigollum⁠