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

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

.. _Python: http://www.python.org/

.. _Sphinx: http://sphinx.pocoo.org/

.. _Mercurial: http://mercurial.selenic.com/

.. _Bitbucket: http://bitbucket.org/

.. _GitHub: http://github.com/

.. _Subversion: http://subversion.tigris.org/

.. _Git: http://git-scm.com/

.. _Celery: http://celeryproject.org/

.. _Software Freedom Conservancy: http://sfconservancy.org/

.. _Puppet module: https://forge.puppetlabs.com/rauch/kallithea