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

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.

- Don't install as root - install as a dedicated user like ``kallithea``.

  If necessary, create the top directory for the virtualenv (like

  ``/srv/kallithea/venv``) as root and assign ownership to the user.

- Create a new virtual environment, for example in ``/srv/kallithea/venv``,

  specifying the right Python binary::

    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

  is by default in a ``data`` directory next to the ``.ini`` file. This will

  have to be writable by the running Kallithea service.

- A database. The ``.ini`` file specifies which database to use. The database

  will be a separate service and live elsewhere in the filesystem if using

  PostgreSQL or MariaDB/MySQL. If using SQLite, it will by default live next to

  the ``.ini`` file, as ``kallithea.db``.

- A location for the repositories that are hosted by this Kallithea instance.

  This will have to be writable by the running Kallithea service. The path to

  this location will be configured in the database.

For simple setups, it is fine to just use something like a ``kallithea`` user

with home in ``/home/kallithea`` and place everything there.

For experiments, it might be convenient to run everything as yourself and work

inside a clone of Kallithea, with the ``.ini`` and SQLite database in the root

of the clone, and a virtualenv in ``venv``.

Python environment

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

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