https://kallithea-scm.org/repos/kallithea.

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

https://bitbucket.org/conservancy/kallithea.

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

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

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

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

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.

   python setup.py install

then you will find this location at

``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``.

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

Alternatively, if you would like to convert the database for good, you can use

a helper script provided by Kallithea. This script will operate directly on the

database, using the database string you can find in your ``production.ini`` (or

``development.ini``) file. For example, if using SQLite::

.. _models:

========================

========================

.. automodule:: kallithea.model

   :members:

.. automodule:: kallithea.model.comment

.. _index:

Kallithea Documentation

**Readme**

.. toctree::

   :maxdepth: 1

   usage/general

   usage/vcs_support

   usage/locking

   usage/statistics

.. toctree::

   :maxdepth: 1

   usage/email

   usage/performance

   usage/backup

   usage/debugging

   usage/troubleshooting

.. toctree::

   :maxdepth: 1

   contributing

   changelog

    pip install --user kallithea

You can now proceed to :ref:`setup`.

Upgrading Kallithea from Python Package Index (PyPI)

.. note::

   It is strongly recommended that you **always** perform a database and

   configuration backup before doing an upgrade.

   These directions will use '{version}' to note that this is the version of

.. _installation_iis:

Installing Kallithea on Microsoft Internet Information Services (IIS)

=====================================================================

The following is documented using IIS 7/8 terminology. There should be nothing

preventing you from applying this on IIS 6 well.

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

The following will assume that your Kallithea is at ``c:\inetpub\kallithea`` and

will be served from the root of its own website. The changes to serve it in its

own virtual folder will be noted where appropriate.

................

Make sure that there is a unique application pool for the Kallithea application

with an identity that has read access to the Kallithea distribution.

The application pool does not need to be able to run any managed code. If you

.. note::

    The application pool can be the same as an existing application pool as long

    as the requirements to Kallithea are enabled by the existing application

    pool.

.............

The ISAPI handler can be generated using::

    paster install-iis my.ini --root=/

.. _installation_win:

Installation and upgrade on Windows (7/Server 2008 R2 and newer)

================================================================

First time install

::::::::::::::::::

Scripts folder, which is likely not on your path. To correct this,

open a CMD and type::

  SETX PATH "%PATH%;[your-python-path]\Scripts" /M

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

Create a Kallithea folder structure.

This is only an example to install Kallithea. Of course, you can

change it. However, this guide will follow the proposed structure, so

.. note:: This will take some time. Please wait patiently until it is fully

          complete. Some warnings will appear. Don't worry, they are

          normal.

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

Mercurial being a python package, it was installed automatically when doing "pip install kallithea".

You need to install git manually if you want Kallithea to be able to host git repositories.

.. _installation_win_old:

Installation and upgrade on Windows (XP/Vista/Server 2003/Server 2008)

======================================================================

::::::::::::::::::

Target OS: Windows XP SP3 32bit English (Clean installation)

+ All Windows Updates until 24-may-2012

.. note::

   These extra steps haven been marked as "64bit".

   Tested on Windows Server 2008 R2 SP1, 9-feb-2013.

   If you run into any 64bit related problems, please check these pages:

   - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/

   - http://bugs.python.org/issue7511

Optional: You can also install MinGW, but VS2008 installation is easier.

Download "Visual C++ 2008 Express Edition with SP1" from:

http://download.microsoft.com/download/E/8/E/E8EEB394-7F42-4963-A2D8-29559B738298/VS2008ExpressWithSP1ENUX1504728.iso

   64bit: You also need to copy and rename a .bat file to make the Visual C++ compiler work.

   I am not sure why this is not necessary for 32bit.

   Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat

Install Python 2.x.y (x = 6 or 7) x86 version (32bit). DO NOT USE A 3.x version.

Download Python 2.x.y from:

http://www.python.org/download/

Choose "Windows Installer" (32bit version) not "Windows X86-64

be needed in the next step. In this case, it is "2.7".

.. note::

   64bit: Just download and install the 64bit version of python.

Download pywin32 from:

http://sourceforge.net/projects/pywin32/files/

- Click on "pywin32" folder

- Click on the first folder (in this case, Build 217, maybe newer when you try)

  .. note::

     64bit: Download and install the 64bit version.

     At the time of writing you can find this at:

     http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download

Add Python BIN folder to the path

You have to add the Python folder to the path, you can do it manually

(editing "PATH" environment variable) or using Windows Support Tools

that came preinstalled in Vista/7 and can be installed in Windows XP.

    SETX PATH "%PATH%;[your-python-path]" /M

  Please substitute [your-python-path] with your Python installation path.

  Typically: C:\\Python27

Create a Kallithea folder structure

This is only a example to install Kallithea, you can of course change

it. However, this guide will follow the proposed structure, so please

later adapt the paths if you change them. My recommendation is to use

  C:\Kallithea

  C:\Kallithea\Bin

  C:\Kallithea\Env

  C:\Kallithea\Repos

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

Install Virtual Env for Python

Navigate to: http://www.virtualenv.org/en/latest/index.html#installation

Right click on "virtualenv.py" file and choose "Save link as...".

 python virtualenv.py C:\Kallithea\Env

(--no-site-packages is now the default behaviour of virtualenv, no need

to include it)

Finally, install Kallithea

Close previously opened command prompt/s, and open a Visual Studio 2008

Command Prompt (**IMPORTANT!!**). To do so, go to Start Menu, and then open

"Microsoft Visual C++ 2008 Express Edition" -> "Visual Studio Tools" ->

(long step, please wait until fully complete)

Some warnings will appear, don't worry as they are normal.

steps taken from http://packages.python.org/Kallithea/setup.html

You have to use the same Visual Studio 2008 command prompt as Step7, so

if you closed it reopen it following the same commands (including the

whatever you want)

If you make some mistake and the script does not end, don't worry, start

it again.

In the previous command prompt, being in the C:\\Kallithea\\Bin folder,

just type::

 paster serve production.ini

.. _overview:

=====================

=====================

Some overview and some details that can help understanding the options when

installing Kallithea.

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

**Kallithea** is written entirely in Python_ and requires Python version

2.6 or higher. Python 3.x is currently not supported.

Given a Python installation, there are different ways of providing the

  "container" where each Kallithea instance can get its own dedicated and

  self-contained virtual environment.

We recommend using virtualenv for installing Kallithea.

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

Kallithea must be installed on a server. Kallithea is installed in a Python

environment so it can use packages that are installed there and make itself

available for other packages.

  directory with Python files and everything else that is needed.

  (``pip install kallithea`` from a source tree will do pretty much the same

  but build the Kallithea package itself locally instead of downloading it.)

----------

Kallithea is (primarily) a WSGI_ application that must be run from a web

server that expose WSGI as HTTP.

- Kallithea uses the Paste_ tool for some admin tasks. Paste provides ``paste

.. note::

   If you enable proxy pass-through authentication, make sure your server is

   only accessible through the proxy. Otherwise, any client would be able to

   forge the authentication header and could effectively become authenticated

   using any account of their liking.

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

Kallithea provides a simple integration with issue trackers. It's possible

to define a regular expression that will fetch an issue id stored in a commit

messages and replace that with a URL to the issue. To enable this simply

uncomment the following variables in the ini file::

*Note:* The WebError_ package does not respect ``smtp_port`` and assumes the

standard SMTP port (25). If you have a remote SMTP server with a different port,

you could set up a local forwarding SMTP server on port 25.

References

----------

- `Error Middleware (Pylons documentation) <http://pylons-webframework.readthedocs.org/en/latest/debugging.html#error-middleware>`_

- `ErrorHandler (Pylons modules documentation) <http://pylons-webframework.readthedocs.org/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_

.. _WebError: https://pypi.python.org/pypi/WebError

Example usage of such fields would be to define company-specific information

into repositories, e.g., defining a ``repo_manager`` key that would give info

about a manager of each repository.  There's no limit for adding custom fields.

Newly created fields are accessible via the API.

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

In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea

to turn certain meta-tags, detected in repository and repository group

descriptions, into colored tags. Currently recognised tags are::

.. _performance:

================================

================================

When serving a large amount of big repositories, Kallithea can start

performing slower than expected. Because of the demanding nature of handling large

amounts of data from version control systems, here are some tips on how to get

the best performance.

.. _troubleshooting:

===============

Troubleshooting

===============

:Q: **Missing static files?**

:A: Make sure either to set the ``static_files = true`` in the .ini file or