Home

What is it?

Smeagol is a read-only server for hosting GitHub Gollum wikis.

Why should I care?

If you host a project at GitHub then Smeagol allows you to mirror your project's wiki on your own server and domain. Smeagol is easy to setup and provides some great benefits:

• Host on your own domain name.
• Collaborate with others on content for your project's web site.
• Create your own look and feel with Mustache templates.
• Provide historical documentation for users using tag-based versioning.
• Easy maintenance with automatic updating.
• Speedy page delivering with page caching.
• Language specific syntax highlighting through Pygments

Installation

Installing Smeagol is a cinch. Simply use RubyGems and you'll be ready to go in one line:

$ [sudo] gem install smeagol

Change directories to your wiki repository and run the smeagol command:

$ cd /path/to/repo.wiki
$ smeagol

Navigate to http://localhost:4567 to view your wiki running on Smeagol!