README.rst

klaus

a simple Git web viewer that Just Works™. (beta quality)

Demo at http://klausdemo.lophus.org

Requirements

• Python 2.7
• Jinja2
• Pygments
• dulwich (>= 0.7.1)
• Nano (shipped as submodule, do a git submodule update --init to fetch)

Installation

The same procedure as every year, James.

virtualenv your-env
source your-env/bin/activate

pip install jinja2
pip install pygments
pip install dulwich

git clone https://github.com/jonashaag/klaus
cd klaus
git submodule update --init

Usage

Using the quickstart.py script

tools/quickstart --help
tools/quickstart.py <host> <port> /path/to/repo1 [../path/to/repo2 [...]]

Example:

tools/quickstart.py 127.0.0.1 8080 ../klaus ../nano ../bjoern

This will make klaus serve the klaus, nano and bjoern repos at 127.0.0.1:8080 using Python's built-in wsgiref server (or, if installed, the bjoern server).

Using a real server

The klaus.py module contains a WSGI application object. The repo list is read from the KLAUS_REPOS environment variable (space-separated paths).

UWSGI example:

uwsgi ... -m klaus --env KLAUS_REPOS="/path/to/repo1 /path/to/repo2 ..." ...