background preloader

Github Gollum (Ruby)

Facebook Twitter

Peterkeen/sites. Simple Git-backed Microsites. A few days ago I built a new tool I'm calling Sites.

Simple Git-backed Microsites

It builds on top of git-backed wikis powered by GitHub's Gollum system and lets me build and deploy microsites in the amount of time it takes me to create a CNAME. Something that I've wanted for a very long time is a way to stand up new websites with little more than a CNAME and a few clicks. I've gone through a few rounds of trying to make that happen but nothing ever stuck. Furthest progressed was a Rails app exclusively hosting Comfortable Mexican Sofa, a simple CMS engine. I never ended up putting any sites on it, though. GitHub's Pages are of course one of the best answers, but I'm sticking to my self-hosting, built-at-home guns. A Short Code Tour The code is split up into four distinct parts: viewer is a Sinatra app that presents wiki content as web pages.

Demo Time Here's what the manager app presents when you just go to sites.bugsplat.info: If you click on one of those links, you'll get the familiar Gollum interface: Installation. Absolutely No Machete Juggling » Personal Wiki using GitHub and Gollum on OS X. I’ve been strug­gling for a while to get a good per­sonal wiki so­lu­tion going.

Absolutely No Machete Juggling » Personal Wiki using GitHub and Gollum on OS X

I have a bunch of re­quire­ments that have made this quite dif­fi­cult: Access and edit wiki from browserRun in OS X (Laptop) and Linux (Work­sta­tion)Syn­chro­nized across all ma­chinesCan use offline I tried using Tid­dly­Wiki with DropBox as the cloud-based sync mech­a­nism, but I use Google Chrome as my browser, which has a lot of trouble with the Java plugin that does the saving. There are command line ar­gu­ments for Chrome that fix this, but that’s weirdly dif­fi­cult to deal with on OS X. So my final so­lu­tion, subject to im­prove­ment, is to use Gollum. There are a number of steps to getting this set up, so I’ve decided to doc­u­ment them here, both for the benefit of anyone else who wants to do this, as well as for myself if I have to set it up on another machine. In any case, get a Git repo set up on either GitHub or Bit­Bucket. Now, clone your per­sonal wiki some­where handy.

God that’s hideous. Gollum/gollum. Gollum on Ubuntu/Linux Mint. Gollum is the wiki engine that is developed and deployed by GitHub.

Gollum on Ubuntu/Linux Mint

The codes are hosted at It supports many syntaxes, including Markdown, ReStructuredText, Textile, MediaWiki, etc. To install: On Linux Mint 13 “Maya” (based on Ubuntu 12.04 “Precise Pangolin”), first get Ruby and RubyGems: Then install Gollum via RubyGems: An alternative to install Gollum is to build from source (taking version 2.5.0 as example): To use it, simply create a Git repository: Now point the browser to and you have a fully functional Wiki site up and running. One downside thus far is that Gollum doesn’t support multiple repositories and multiple users. One might want to run Gollum as a service/daemon with Upstart. Then I made a script called ~/.init/gollum.conf (create the directory ~/.init if it doesn’t exist, and replace USERNAME with your username below): Ask initctl to reload configurations: Happy writing wikis!

Like this: Like Loading... Git-backed wikis, Gollum, and simple installation experiences. The Zen of Wiki with Gollum - I am alberto.