with a built-in push/pull server, full text search and code-review.

It works on http/https and 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 donationware and focuses more on providing a customised,

self-administered interface for Mercurial_ and Git_  repositories.

Kallithea works on Unix-like systems and Windows, and is powered by the vcs_ library

created by Łukasz Balcerzak and Marcin Kuźmiński to uniformly handle multiple

version control systems.

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

Installation

------------

Official releases of Kallithea can be installed via::

    pip install kallithea

The development repository is kept very stable and used in production by the

developers - you can do the same.

more details.

Source code

-----------

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

The issue tracker and a repository mirror can be found at Bitbucket_ on

https://bitbucket.org/conservancy/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, LDAP, AD, proxy-pass authentication.

- 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.

**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**.

- Issues can be reported at `issue tracker <https://bitbucket.org/conservancy/kallithea/issues>`_.

   .. 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://pythonhosted.org/Kallithea/.

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

   make html

(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``)

Converting from RhodeCode

-------------------------

Currently, you have two options for working with an existing RhodeCode database:

 - keep the database unconverted (intended for testing and evaluation)

 - convert the database in a one-time step

Maintaining Interoperability

~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Interoperability with RhodeCode 2.2.X installations is provided so you don't

have to immediately commit to switching to Kallithea. This option will most

likely go away once the two projects have diverged significantly.