Tree @1.1.0 (Download .tar.gz)
klaus: a simple, easy-to-set-up Git web viewer that Just Works™.
(If it doesn't Just Work for you, please file a bug.)
- Super easy to set up -- no configuration required
- Supports Python 2 and Python 3
- Syntax highlighting
- Git Smart HTTP support
- Code navigation using Exuberant ctags
Demo: | http://klausdemo.lophus.org |
---|---|
Mailing list: | http://groups.google.com/group/klaus-users |
On PyPI: | http://pypi.python.org/pypi/klaus/ |
Wiki: | https://github.com/jonashaag/klaus/wiki |
License: | ISC (BSD) |
Contributing
Please do it!
I'm equally happy with bug reports/feature ideas and code contributions. If you have any questions/issues, I'm happy to help!
For starters, here are a few ideas what to work on. :-)
Usage
See also: Klaus wiki
Using the klaus script
NOTE: This is intended for testing/low-traffic local installations only! The klaus script uses wsgiref internally which doesn't scale at all (in fact it's single-threaded and non-asynchronous).
To run klaus using the default options:
klaus [repo1 [repo2 ...]]
For more options, see:
klaus --help
Using a real server
The klaus module contains a make_app function which returns a WSGI app.
An example WSGI helper script is provided with klaus (see klaus/contrib/wsgi.py), configuration being read from environment variables. Use it like this (uWSGI example):
uwsgi -w klaus.contrib.wsgi \ --env KLAUS_SITE_NAME="Klaus Demo" \ --env KLAUS_REPOS="/path/to/repo1 /path/to/repo2 ..." \ ...
Gunicorn example:
gunicorn --env KLAUS_SITE_NAME="Klaus Demo" \ --env KLAUS_REPOS="/path/to/repo1 /path/to/repo2 ..." \ klaus.contrib.wsgi
See also deployment section in the wiki.
Commit History @1.1.0
- Version 1.1.0 Jonas Haag 5 years ago
- Merge pull request #175 from jelmer/mdwn Jonas Haag (commit: GitHub) 5 years ago
- Add ".mdwn" as a markdown extension. Jelmer Vernooij 5 years ago
- Merge pull request #173 from jelmer/cloneurl Jonas Haag (commit: GitHub) 5 years ago
- Merge pull request #174 from jelmer/indexpage Jonas Haag (commit: GitHub) 5 years ago
- Link to index page rather than history page. Jelmer Vernooij 5 years ago
- Support the gitweb .git/cloneurl file and 'gitweb.url' settings as ways to find out clone url. Jelmer Vernooij 5 years ago
- Some minor fixes Jonas Haag 5 years ago
- Add an 'index' page that displays a bit of history and possibly README.md. Jelmer Vernooij 5 years ago
- Merge pull request #171 from jimmyppi/wsgi_env Jonas Haag (commit: GitHub) 5 years ago