In this post, I will introduce how to set up a personal Wiki system with the following features,<\/p>\n
I provide a ready-to-use Docker image.<\/p>\n
sudo docker run \\\n-v ${PWD}:\/home\/wiki_repo \\\n-p 4567:4567 \\\n-e GITHUB_CLIENT_ID=xxx \\\n-e GITHUB_CLIENT_SECRET=xxx \\\n-e AUTH_EMAIL=fighternan@gmail.com \\\n--name wiki \\\nfighternan\/auth_wiki:latest<\/code><\/pre>\nThere are three environment varibles you should set. GITHUB_CLIENT_ID <\/code> and GITHUB_CLIENT_SECRET<\/code> are available once you set your Github OAuth App. See here<\/a> for official tutorial. AUTH_EMAIL<\/code> specifies the user who can edit the pages. Other users can only view the pages.<\/p>\nIf you want to build your customized image. See my repo here<\/a> and develop your images.<\/p>\nDetails<\/h2>\nGollum<\/h3>\n
Gollum is a wiki using git as the back end storage mechanism and written mostly in Ruby. It is the wiki system used by the GitHub web hosting system. Gollum pages may be written in a variety of formats such as Markdown. See here<\/a> for installation tutorial.<\/p>\nGithub Wiki<\/h3>\n
For every Github repository, you can create a Wiki, which is separate from your main project. You can clone it, look at it, edit pages and structure, and push your changes back up. For example, I have a wiki repo here<\/a>.<\/p>\ngit clone https:\/\/github.com\/FighterNan\/FighterNan.github.io.wiki.git<\/code><\/pre>\nSet up Your Wiki Service<\/h3>\n
Once you clone the Wiki repo and install Gollum, people can view and edit your pages through a Web GUI.<\/p>\n
cd FighterNan.github.io.wiki && gollum<\/code><\/pre>\nThe system can be run without networks. Once you have Internet available, you can back them up though git push<\/code>.<\/p>\nAuthentication<\/h3>\n
You may want to share your Wiki but do not want others to edit the pages. omnigollum<\/a> provides the authentication packages. Use the configuration below.<\/p>\nGollum::Page.send :remove_const, :FORMAT_NAMES if defined? Gollum::Page::FORMAT_NAMES\n\n## Omni Auth\nrequire 'omnigollum'\nrequire 'omniauth\/strategies\/github'\n\nwiki_options = {\n :live_preview => false,\n :allow_uploads => true,\n :per_page_uploads => true,\n :allow_editing => true,\n :css => true,\n :js => true,\n :mathjax => true,\n :h1_title => true\n}\nPrecious::App.set(:wiki_options, wiki_options)\n\noptions = {\n # OmniAuth::Builder block is passed as a proc\n :providers => Proc.new do\n # Found https:\/\/github.com\/settings\/var\/www\/htmllications\/\n provider :github, 'Client ID', 'Client Secret'\n end,\n :dummy_auth => false,\n # If you want to make pages private:\n #:protected_routes => ['\/private*'],\n\n # Specify committer name as just the user name\n :author_format => Proc.new { |user| user.name },\n # Specify committer e-mail as just the user e-mail\n :author_email => Proc.new { |user| user.email },\n\n # Authorized users\n :authorized_users => [\"your_email@example.com\"],\n}\n## :omnigollum options *must* be set before the Omnigollum extension is registered\nPrecious::App.set(:omnigollum, options)\nPrecious::App.register Omnigollum::Sinatra<\/code><\/pre>\nRun your application again by gollumn --config auth.rb<\/code>. The original script and post are available here<\/a>.<\/p>\nGithub OAuth App<\/h3>\n
You can achieve authentication through Github OAuth App without passing the password to the Wiki System. Follow the tutorial here<\/a> and create your OAuth Apps.<\/p>\nReady-to-Use Docker Image<\/h3>\n
Environment Issues are annoying and you do not want to configure them again from your MAC laptop to another Centos or Ubuntu server. You may also want to be lazy and configure things by one command.<\/p>\n