Home

What is it?

Smeagol is a customizable 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.
• Easy navigation with built-in menu support.
• Language specific syntax highlighting through Pygments

Can I See It In Action?

You're looking at it. This very site is run on Smeagol on a small Rackspace VPS.

If you want to add documentation, head over to the Smeagol Wiki on GitHub and make your changes. Your changes will appear on this site on the next update.

Here's a short list of some other Smeagol sites:

• http://www.sector5d.org
• http://qntm.net
• http://melomel.info
• http://grapevine-project.info
• http://help.challengepost.com

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-preview

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

Usage

See the following resources for details on usage and configuration:

• Wiki Settings
• Templates
• Command Line Interface
• Miscellaneous

License and Copyrights

Smeagol is distributed under the terms of the BSD-2-Clause license.

• Copyright 2012 Rubyworks
• Copyright 2009 Ben Johnson

Please see LICENSE.txt file in the distribution for license details.