1. Ōlelo Wiki
    1. Features
    2. Quick start
    3. Installation from source
    4. Deployment
    5. Configuration
    6. Dependencies
    7. Authors
    8. License

1 Ōlelo Wiki

Ōlelo is a wiki that stores pages in a Git repository, supports many markup styles and has an extensible, hackable architecture! If you want to see a demo installation go to http://www.gitwiki.org/.

1.1 Features

Ōlelo implements a plugin system. A lot of the features are implemented as plugins and can be activated or deactivated as you wish.

Core features:

Features, implemented by plugins:

1.2 Quick start

The best way to install Ōlelo is via 'gem'.

$ gem install olelo

Go to a git repository via command line and start the Ōlelo webserver.

$ olelo

Point your web browser at http://localhost:8080/.

1.3 Installation from source

Installation from source is especially useful if you want to do development or use the newest features.

Clone the git repository:

git clone git://github.com/minad/olelo.git

Now change to the Ōlelo source directory and use Bundler to install the dependencies.

$ cd olelo
$ bundle install

Start the Ōlelo webserver from the Ōlelo source directory.

$ bin/olelo

1.4 Deployment

For production purposes, I recommend that you deploy the wiki with Unicorn. You should use the rackup configuration from the Ōlelo source or gem directory.

$ unicorn path-to/config.ru

1.5 Configuration

For deployment you might want to tweak some settings. Ōlelo reads the files config/config.yml.default and config/config.yml in that order. So just copy the default configuration config/config.yml.default to config/config.yml and make your modifications. If you installed Ōlelo as gem this is not a good idea since you don't want to fiddle in the gem directory. For this purpose exists the environment variable OLELO_CONFIG which can point to the configuration file that you want to use.

export OLELO_CONFIG=/home/olelo/olelo_config.yml

You can also use the OLELO_CONFIG environment variable if you want to run multiple Ōlelo instances with different configurations.

1.6 Dependencies

If you use Bundler or installed Ōlelo as gem you don't really have to care about the dependencies. The standard installation provides the core dependencies and a good selection of optional dependencies.

Core dependencies:

Some dependencies are optional, for example depending on the markup you want to use.

1.7 Authors

Git-Wiki was originally developed by Simon Rozet. The development of Ōlelo to its current state was done by Daniel Mendler and contributors. The current code base doesn't have much in common with the original Git-Wiki proof-of-concept.


1.8 License

Ōlelo is released under the MIT license.