Installation from repository source

To install Kallithea in a virtualenv using the stable branch of the development repository, follow the instructions below:

hg clone https://kallithea-scm.org/repos/kallithea -u stable
cd kallithea
virtualenv ../kallithea-venv
source ../kallithea-venv/bin/activate
pip install --upgrade pip "setuptools<34"
pip install -e .
python2 setup.py compile_catalog   # for translation of the UI

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

To upgrade, simply update the repository with hg pull -u and restart the server.

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 virtualenv command:

  virtualenv /srv/kallithea/venv
  

• Activate the virtualenv in your current shell session and make sure the basic requirements are up-to-date by running:

  source /srv/kallithea/venv/bin/activate
  pip install --upgrade pip "setuptools<34"
  

pip install psycopg2
pip install python-ldap

• Make a folder for Kallithea data files, and configuration somewhere on the filesystem. For example:

  mkdir /srv/kallithea
  

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

  pip install kallithea
  

  Alternatively, download a .tar.gz from http://pypi.python.org/pypi/Kallithea, extract it and run:

  pip install .
  

• This will install Kallithea together with pylons and all other required python libraries into the activated virtualenv.

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

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

Upgrading Kallithea from Python Package Index (PyPI)

If using a SQLite database, stop the Kallithea process/daemon/service, and then make a copy of the database file:

service kallithea stop
cp kallithea.db kallithea.db.{version}

Back up your configuration file:

cp my.ini my.ini.{version}

Ensure that you are using the Python virtual environment that you originally installed Kallithea in by running:

pip freeze

This will list all packages installed in the current environment. If Kallithea isn't listed, activate the correct virtual environment:

source /srv/kallithea/venv/bin/activate

Once you have verified the environment you can upgrade Kallithea with:

pip install --upgrade kallithea

Then run the following command from the installation directory:

paster make-config Kallithea my.ini

This will display any changes made by the new version of Kallithea to your current configuration. It will try to perform an automerge. It is recommended that you recheck the content after the automerge.

It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh version could introduce some incompatible index changes. Please read the changelog to see if there were any changes to whoosh.

The final step is to upgrade the database. To do this simply run:

paster upgrade-db my.ini

This will upgrade the schema and update some of the defaults in the database, and will always recheck the settings of the application, if there are no new options that need to be set.

You may find it helpful to clear out your log file so that new errors are readily apparent:

echo > kallithea.log

Once that is complete, you may now start your upgraded Kallithea Instance:

service kallithea start

Or:

paster serve /srv/kallithea/my.ini