Kallithea 0.6.3

Kallithea is a fast and powerful management tool for Mercurial and Git with a built in push/pull server, full text search and code-review.

About

Kallithea is a fast and powerful management tool for Mercurial and Git with a built-in push/pull server, full text search and code-review. It works on HTTP/HTTPS and SSH, has a built-in permission/authentication system with the ability to authenticate via LDAP or ActiveDirectory. Kallithea also provides simple API so it’s easy to integrate with existing external systems.

Kallithea is similar in some respects to GitHub or Bitbucket, however Kallithea can be run as standalone hosted application on your own server. It is open-source and focuses more on providing a customised, self-administered interface for Mercurial and Git repositories. Kallithea works on Unix-like systems and Windows.

Kallithea was forked from RhodeCode in July 2014 and has been heavily modified.

Installation

Kallithea requires Python 3 and it is recommended to install it in a virtualenv. Official releases of Kallithea can be installed with:

pip install kallithea

The development repository is kept very stable and used in production by the developers – you can do the same.

Please visit https://docs.kallithea-scm.org/en/latest/installation.html for more details.

There is also an experimental Puppet module for installing and setting up Kallithea. Currently, only basic functionality is provided, but it is still enough to get up and running quickly, especially for people without Python background. See https://docs.kallithea-scm.org/en/latest/installation_puppet.html for further information.

Source code

The latest sources can be obtained from https://kallithea-scm.org/repos/kallithea.

Kallithea features

• Has its own middleware to handle Mercurial and Git protocol requests. Each request is authenticated and logged together with IP address.

• Built for speed and performance. You can make multiple pulls/pushes simultaneously. Proven to work with thousands of repositories and users.

• Supports HTTP/HTTPS with LDAP, AD, or proxy-pass authentication.

• Supports SSH access with server-side public key management.

• Full permissions (private/read/write/admin) together with IP restrictions for each repository, additional explicit forking, repositories group and repository creation permissions.

• User groups for easier permission management.

• Repository groups let you group repos and manage them easier. They come with permission delegation features, so you can delegate groups management.

• Users can fork other users repos, and compare them at any time.

• Built-in versioned paste functionality (Gist) for sharing code snippets.

• Integrates easily with other systems, with custom created mappers you can connect it to almost any issue tracker, and with a JSON-RPC API you can make much more.

• Built-in commit API lets you add, edit and commit files right from Kallithea web interface using simple editor or upload binary files using simple form.

• Powerful pull request driven review system with inline commenting, changeset statuses, and notification system.

• Importing and syncing repositories from remote locations for Git, Mercurial and Subversion.

• Mako templates let you customize the look and feel of the application.

• Beautiful diffs, annotations and source code browsing all colored by pygments. Raw diffs are made in Git-diff format for both VCS systems, including Git binary-patches.

• Mercurial and Git DAG graphs and Flot-powered graphs with zooming and statistics to track activity for repositories.

• Admin interface with user/permission management. Admin activity journal logs pulls, pushes, forks, registrations and other actions made by all users.

• Server side forks. It is possible to fork a project and modify it freely without breaking the main repository.

• reST and Markdown README support for repositories.

• Full text search powered by Whoosh on the source files, commit messages, and file names. Built-in indexing daemons, with optional incremental index build (no external search servers required all in one application).

• Setup project descriptions/tags and info inside built in DB for easy, non-filesystem operations.

• Intelligent cache with invalidation after push or project change, provides high performance and always up to date data.

• RSS/Atom feeds, Gravatar support, downloadable sources as zip/tar/gz.

• Optional async tasks for speed and performance using Celery.

• Backup scripts can do backup of whole app and send it over scp to desired location.

• Based on TurboGears2, SQLAlchemy, Whoosh, Bootstrap, and other open source libraries.

• Uses PostgreSQL, SQLite, or MariaDB/MySQL databases.

License

Kallithea is released under the GPLv3 license. Kallithea is a Software Freedom Conservancy project and thus controlled by a non-profit organization. No commercial entity can take ownership of the project and change the direction.

Kallithea started out as an effort to make sure the existing GPLv3 codebase would stay available under a legal license. Kallithea thus has to stay GPLv3 compatible … but we are also happy it is GPLv3 and happy to keep it that way. A different license (such as AGPL) could perhaps help attract a different community with a different mix of Free Software people and companies but we are happy with the current focus.

Community

Kallithea is maintained by its users who contribute the fixes they would like to see.

Get in touch with the rest of the community:

• Join the mailing list users and developers – see http://lists.sfconservancy.org/mailman/listinfo/kallithea-general.

• Use IRC and join #kallithea on FreeNode (irc.freenode.net) or use http://webchat.freenode.net/?channels=kallithea.

• Follow Kallithea on Twitter, @KallitheaSCM.

• Please report issues on the mailing list. An archive of the old issue tracker is available at: https://kallithea-scm.org/bitbucket-archive/issues/index.html

  Note

  Please try to read the documentation before posting any issues, especially the troubleshooting section

Online documentation

Online documentation for the current version of Kallithea is available at https://docs.kallithea-scm.org/en/stable/. Documentation for the current development version can be found on https://docs.kallithea-scm.org/en/default/.

You can also build the documentation locally: go to docs/ and run:

make html

Note

You need to have Sphinx installed to build the documentation. If you don’t have Sphinx installed you can install it via the command: pip install sphinx .

Migrating from RhodeCode

Kallithea 0.3.2 and earlier supports migrating from an existing RhodeCode installation. To migrate, install Kallithea 0.3.2 and follow the instructions in the 0.3.2 README to perform a one-time conversion of the database from RhodeCode to Kallithea, before upgrading to this version of Kallithea.