sudo apt-get install build-essential git libffi-dev python3-dev

For Fedora and RHEL-derivatives, the following command will ensure that a

reasonable set of dependencies is installed::

    sudo yum install gcc git libffi-devel python3-devel

.. _installation-source:

Installation from repository source

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

To install Kallithea in a virtualenv using the stable branch of the development

repository, use the following commands in your bash shell::

        hg clone https://kallithea-scm.org/repos/kallithea -u stable

        cd kallithea

        python3 -m venv ../kallithea-venv

        . ../kallithea-venv/bin/activate

        pip install --upgrade pip setuptools

        pip install --upgrade -e .

        python3 setup.py compile_catalog   # for translation of the UI

.. _installation-virtualenv:

Installing a released version in a virtualenv

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

It is highly recommended to use a separate virtualenv for installing Kallithea.

This way, all libraries required by Kallithea will be installed separately from your

main Python installation and other applications and things will be less

problematic when upgrading the system or Kallithea.

An additional benefit of virtualenv is that it doesn't require root privileges.

- Assuming you have installed virtualenv, create a new virtual environment

  for example, in `/srv/kallithea/venv`, using the venv command::

    python3 -m venv /srv/kallithea/venv

- Activate the virtualenv in your current shell session and make sure the

  basic requirements are up-to-date by running the following commands in your

  bash shell::

    . /srv/kallithea/venv/bin/activate

    pip install --upgrade pip setuptools

  filesystem. For example::

    mkdir /srv/kallithea

- Go into the created directory and run this command to install Kallithea::

    pip install --upgrade kallithea

.. note:: Some dependencies are optional. If you need them, install them in

   the virtualenv too::

     pip install --upgrade kallithea python-ldap python-pam psycopg2

   This might require installation of development packages using your

   distribution's package manager.

  Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea,

  extract it and install from source by running::

    pip install --upgrade .

- This will install Kallithea together with all other required

  Python libraries into the activated virtualenv.

.. _installation-without-virtualenv:

Installing a released version without virtualenv

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

For installation without virtualenv, 'just' use::

    pip install kallithea

Note that this method requires root privileges and will install packages

globally without using the system's package manager.

To install as a regular user in ``~/.local``, you can use::

    pip install --user kallithea

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

.. _overview:

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

Installation overview

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

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

installing Kallithea.

1. **Prepare environment and external dependencies.**

    Kallithea needs:

    * A filesystem where the Mercurial and Git repositories can be stored.

    * A database where meta data can be stored.

    * A Python environment where the Kallithea application and its dependencies

      can be installed.

    * A web server that can host the Kallithea web application using the WSGI

      API.

2. **Install Kallithea software.**

    This makes the ``kallithea-cli`` command line tool available.

    Use ``kallithea-cli config-create`` to create a ``.ini`` file with database

    connection info, mail server information, configuration for the specified

    web server, etc.

    Use ``kallithea-cli db-create`` with the ``.ini`` file to create the

    database schema and insert the most basic information: the location of the

    repository store and an initial local admin user.

6. **Configure the web server.**

    The web server must invoke the WSGI entrypoint for the Kallithea software

    using the ``.ini`` file (and thus the database). This makes the web

    application available so the local admin user can log in and tweak the

    configuration further.

7. **Configure users.**

    The initial admin user can create additional local users, or configure how

    users can be created and authenticated from other user directories.

See the subsequent sections, the separate OS-specific instructions, and

:ref:`setup` for details on these steps.

Python environment

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

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

3.6 or higher.

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

environment for running Python applications. Each of them pretty much

corresponds to a ``site-packages`` directory somewhere where packages can be

installed.

account it sets up for you.

The ``db-create`` values can also be given on the command line.

Example::

    kallithea-cli db-create -c my.ini --user=nn --password=secret --email=nn@example.com --repos=/srv/repos

The ``db-create`` command will create all needed tables and an

admin account. When choosing a root path you can either use a new

empty location, or a location which already contains existing

repositories. If you choose a location which contains existing

repositories Kallithea will add all of the repositories at the chosen

location to its database.  (Note: make sure you specify the correct

path to the root).

.. note:: It is also possible to use an existing database. For example,

          when using PostgreSQL without granting general createdb privileges to

          the PostgreSQL kallithea user, set ``sqlalchemy.url =

          postgresql://kallithea:password@localhost/kallithea`` and create the

          database like::

              sudo -u postgres createdb 'kallithea' --owner 'kallithea'

              kallithea-cli db-create -c my.ini --reuse

Running

^^^^^^^

You are now ready to use Kallithea. To run it using a gearbox web server,

simply execute::

    gearbox serve -c my.ini

- This command runs the Kallithea server. The web app should be available at

  http://127.0.0.1:5000. The IP address and port is configurable via the

  configuration file created in the previous step.

- Log in to Kallithea using the admin account created when running ``db-create``.

- The default permissions on each repository is read, and the owner is admin.

  Remember to update these if needed.

- In the admin panel you can toggle LDAP, anonymous, and permissions

  settings, as well as edit more advanced options on users and

  repositories.

Internationalization (i18n support)

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

The Kallithea web interface is automatically displayed in the user's preferred

language, as indicated by the browser. Thus, different users may see the