Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A simple, Git-powered wiki with a sweet API and local frontend.
JavaScript Ruby CSS Other

Merge pull request #1062 from mortonfox/patch-1

Fix github-markup link in readme.
latest commit caa1a55e7a
@bartkamphorst bartkamphorst authored

README.md

gollum -- A git-based Wiki

Gem Version Build Status Dependency Status

DESCRIPTION

Gollum is a simple wiki system built on top of Git. A Gollum Wiki is simply a git repository (either bare or regular) of a specific nature:

  • A Gollum repository's contents are human-editable, unless the repository is bare. Pages are unique text files which may be organized into directories any way you choose. Other content can also be included, for example images, PDFs and headers/footers for your pages.
  • Gollum pages:
    • May be written in a variety of markups.
    • Can be edited with your favourite system editor or IDE (changes will be visible after committing) or with the built-in web interface.
    • Can be displayed in all versions (commits).

Gollum can be launched either as a webserver (with the web interface) or in "console mode", where you can use a predefined API to query and manipulate the repository. For more information, see the Running and Configuration sections.

For more information on Gollum's capabilities and pitfalls:

  1. Syntax/capability overview for pages.
  2. Known limitations.
  3. Security overview.

SYSTEM REQUIREMENTS

Operating System Ruby Adapters Supported
Unix/Linux-like Ruby 1.9.3+ all except RJGit yes
Unix/Linux-like JRuby (1.9.3+ compatible) RJGit yes
Windows Ruby 1.9.3+ all except RJGit no
Windows JRuby (1.9.3+ compatible) RJGit almost1

Notes:

  1. There are still some bugs and this setup is not ready for production yet. You can track the progress at #1044.

INSTALLATION

Varies depending on operating system, package manager and Ruby installation. Generally, you should first install Ruby and then Gollum.

  1. Ruby is best installed either via RVM or a package manager of choice.
  2. Gollum is best installed via RubyGems:
    [sudo] gem install gollum

Installation examples for individual systems can be seen here.

Notes:

  • Whichever Ruby implementation you're using, Gollum ships with the appropriate default git adapter. So the above installation procedure is common for both MRI and JRuby.
  • If you're installing from source:
    • Optionally uninstall any previous versions of Gollum:
      [sudo] gem uninstall -aIx gollum
    • Install Bundler.
    • Navigate to the cloned source of Gollum.
    • Install dependencies:
      [sudo] bundle install
    • Build:
      rake build
    • And install:
      [sudo] gem install --no-ri --no-rdoc pkg/gollum*.gem

Markups

Gollum presently ships with support for the following markups:

Since all markups are rendered by the github-markup gem, you can easily add support for other markups by additional installation:

  • AsciiDoc -- [sudo] gem install asciidoctor
  • Creole -- [sudo] gem install creole
  • GitHub Flavored Markdown -- [sudo] gem install github-markdown
  • MediaWiki -- [sudo] gem install wikicloth
  • Org -- [sudo] gem install org-ruby
  • Pod -- requires Perl >= 5.10 (the perl command must be available on your command line)
    • Lower versions should install Pod::Simple from CPAN.
  • ReStructuredText -- requires python >= 2 (the python2 command must be available on your command line)
    • Note that Gollum will also need you to install docutils for your Python 2. Installation procedure can, again, vary depending on operating system and package manager.
  • Textile -- [sudo] gem install RedCloth

By default, Gollum ships with the kramdown gem to render Markdown. However, you can use any Markdown renderer supported by github-markup. The thing to remember is that the first installed renderer from the list will be used. So, for example, redcarpet will NOT be used if github/markdown is installed.

RUNNING

Simply:

  1. Navigate to your git repository (wiki) via the command line.
  2. Run: gollum.
  3. Open http://localhost:4567 in your browser.

If you wish to run from source, simply:

  1. Navigate to your git repository (wiki) via the command line.
  2. Run: bundle exec bin/gollum
  3. Open http://localhost:4567 in your browser.

This will start up a web server (WEBrick) running Gollum with a web interface, where you can view and edit your wiki.

Rack

Gollum can also be ran with any rack-compatible web server. More on that over here.

Docker

Gollum can also be ran via Docker. More on that over here.

Service

Gollum can also be ran as a service. More on that over here.

CONFIGURATION

Gollum comes with the following command line options:

Option Arguments Description
--host [HOST] Specify the hostname or IP address to listen on. Default: 0.0.0.0.1
--port [PORT] Specify the port to bind Gollum with. Default: 4567.
--gollum-path [PATH] Specify path to the Gollum git repository. Default: current working directory.
--config [CONFIG] Path to the configuration file.
--ref [REF] Specify the git branch to serve. Default: master.
--bare none Tell Gollum that the git repository should be treated as bare. This is only necessary when using the default grit adapter.
--base-path [PATH] Specify the leading portion of all page URLs. Default: /. For example, if set to wiki, all pages will be accessible under http://localhost:4567/wiki/ by default.
--page-file-dir [PATH] Specify the subdirectory for all pages. If set, Gollum will only serve pages from this directory. Default: repository root.
--css none Tell Gollum to inject custom CSS into each page. Uses custom.css from repository root.2,4
--js none Tell Gollum to inject custom JS into each page. Uses custom.js from repository root.2,4
--no-edit none Disables the feature of editing pages.
--live-preview none Enables the live preview feature in page editor.
--no-live-preview none Disables the live preview feature in page editor.
--allow-uploads [MODE] Enables file uploads. If set to dir, Gollum will store all uploads in the /uploads/ directory. If set to page, Gollum will store each upload at the same location as the page that is currently being edited.3
--template-dir [PATH] Specify custom mustache template directory.
--show-all none Tell Gollum to also show files in the file view. By default, only valid pages are shown.
--collapse-tree none Tell Gollum to collapse the file tree, when the file view is opened. By default, the tree is expanded.
--mathjax none Enables MathJax (renders mathematical equations). By default, uses the TeX-AMS-MML_HTMLorMML config with the autoload-all extension.4
--mathjax-config [PATH] Specify path for custom MathJax config. By default, uses mathjax.config.js from repository root.
--h1-title none Tell Gollum to use the first <h1> as page title.
--adapter [ADAPTER] Tell Gollum to use a specific git adapter. Default: grit.5
--user-icons [MODE] Tell Gollum to use specific user icons. Can be set to gravatar, identicon or none. Default: none.
--irb none Tell Gollum to launch in console mode, with this API being available.
--help none Display the list of options no the command line.
--version none Display the current version of Gollum.

Notes:

  1. The 0.0.0.0 IP address allows remote access. Should you wish for Gollum to turn into a personal Wiki, use 127.0.0.1.
  2. When --css or --js is used, respective files must be committed to your git repository or you will get a 302 redirect to the create a page.
  3. Files can be uploaded simply by dragging and dropping them onto the editor's text area (this is, however exclusive to the default editor, not the live preview editor).
  4. Read the relevant Security note before using these.
  5. Before using --adapter, you should probably read this first.

Config file

When --config option is used, certain inner parts of Gollum can be customized. This is used throughout our wiki for certain user-level alterations, among which customizing supported markups will probably stand out.

All of the mentioned alterations work both for Gollum's config file (config.rb) and Rack's config file (config.ru).

HOW TO CONTRIBUTE

  1. Fork and clone Gollum.
  2. Create a thoughtfully named topic branch to contain your changes.
  3. If you haven't installed dependencies yet, navigate to your clone and execute:
    [sudo] bundle install
  4. Hack away.
  5. Add your own tests and make sure they're all still passing.
  6. If some of your changes deserve a mention on Gollum's home page, edit the README accordingly.
  7. If necessary, rebase your commits into logical chunks, without errors.
  8. Push the branch to your fork on GitHub.
  9. Create a pull request for Gollum.

Notes:

  • Do not change Gollum's version numbers, we will do that on our own.

Running tests

  1. Install Bundler.
  2. Navigate to the cloned source of Gollum.
  3. Install dependencies:
    [sudo] bundle install
  4. Run the tests:
    bundle exec rake test

Working with test repositories

An example of how to add a test file to the bare repository lotr.git.

mkdir tmp
cd tmp
git clone ../lotr.git/
git log
echo "test" > test.md
git add .
git commit -am "Add test"
git push ../lotr.git/ master

RELEASING

Gollum uses Semantic Versioning.

x.y.z

For z releases:

rake bump
rake release

For x.y releases:

# First update VERSION in lib/gollum.rb and then:
rake gemspec
rake release
Something went wrong with that request. Please try again.