May 19, 2014
Posted by on
Suppose you have a vanilla Debian/Ubuntu/Mint machine and you want to use Gollum – wiki system, built on top of Git and used internally by Gihub wiki pages. Here are the necessary steps:
- Install required components from OS repositories:
sudo apt-get install ruby ruby-dev libz-dev libicu-dev build-essential
Install Gollum from gems repository:
sudo gem install gollum
Create test git repository and run Gollum on it:
Check: you should see messages like this:
[2014-05-19 18:58:02] INFO WEBrick 1.3.1
[2014-05-19 18:58:02] INFO ruby 1.9.3 (2012-04-20) [x86_64-linux]
== Sinatra/1.4.5 has taken the stage on 4567 for development with backup from WEBrick
[2014-05-19 18:58:02] INFO WEBrick::HTTPServer#start: pid=27319 port=4567
that means: Gollum is up and running on port 4567.
Now you can launch you favourite browser, enter addresss http://localhost:4567 and start editing wiki pages:
Whenever you save a page, Gollum commits it to git repository. Optionally you can add a message to commit.
It is worth noting, that Gollum supports many important markup languages: AsciiDoc, Creole, Markdown, MediaWiki, Org-mode, Pod, RDoc, reStructuredText, Textile.
When wiki pages are ready to be presented to the world, you push them to github wiki pages. Instructions on pushing to a remote repository are found here.