.. _index:

.. include:: ./../README.rst

Users Guide

-----------

**Installation:**

.. toctree::

   :maxdepth: 1

   installation

   installation_iis

   setup

**Usage**

.. toctree::

   :maxdepth: 1

   usage/general

   usage/git_support

   usage/performance

   usage/locking

   usage/statistics

   usage/backup

   usage/subrepos

   usage/debugging

   usage/troubleshooting

**Develop**

.. toctree::

   :maxdepth: 1

   contributing

   changelog

.. _installation:

``Kallithea`` is written entirely in Python. Before posting any issues make

sure, your not missing any system libraries and using right version of

libraries required by Kallithea. There's also restriction in terms of mercurial

clients. Minimal version of hg client known working fine with Kallithea is

**1.6**. If you're using older client, please upgrade.

Installing Kallithea from PyPI (aka "Cheeseshop")

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

Kallithea requires python version 2.6 or higher.

The easiest way to install ``kallithea`` is to run::

    easy_install kallithea

Or::

    pip install kallithea

If you prefer to install Kallithea manually simply grab latest release from

http://pypi.python.org/pypi/Kallithea, decompress the archive and run::

Step by step Installation for Windows

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

Kallithea step-by-step install Guide for Windows

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

+ All Windows Updates until 24-may-2012

.. note::

   This installation is for 32bit systems, for 64bit windows you might need

   to download proper 64bit versions of the different packages(Windows Installer, Win32py extensions)

   plus some extra tweaks.

   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

Step1 - Install Visual Studio 2008 Express

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