This will list all packages installed in the current environment. If

Kallithea isn't listed, activate the correct virtual environment.

See the appropriate installation page for details.

4. Install new version of Kallithea

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

Please refer to the instructions for the installation method you

originally used to install Kallithea.

If you originally installed using pip, it is as simple as::

    pip install --upgrade kallithea

If you originally installed from version control, assuming you did not make

private changes (in which case you should adapt the instructions accordingly)::

    cd my-kallithea-clone

    hg parent   # make a note of the original revision

    hg pull

    hg update

    hg parent   # make a note of the new revision

    pip install --upgrade -e .

.. _upgrade_config:

5. Upgrade your configuration

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

Run the following command to create a new configuration (``.ini``) file::

    kallithea-cli config-create new.ini

Then compare it with your old config file and see what changed.

.. note::

    Please always make sure your ``.ini`` files are up to date. Errors

    can often be caused by missing parameters added in new versions.

.. _upgrade_db:

6. Upgrade your database

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

.. note::

Kallithea configuration files created before the introduction of Alembic

(i.e. predating Kallithea 0.4) need to be updated for use with Alembic.

Without this, Alembic will fail with an error like this::

    FAILED: No config file 'my.ini' found, or file has no '[alembic]' section

.. note::

    If you followed this upgrade guide correctly, you will have created a

    new configuration file in section :ref:`Upgrading your configuration

    <upgrade_config>`. When calling Alembic, make

    sure to use this new config file. In this case, you should not get any

    errors and the below manual steps should not be needed.

If Alembic complains specifically about a missing ``alembic.ini``, it is

likely because you did not specify a config file using the ``-c`` option.

On the other hand, if the mentioned config file actually exists, you

need to append the following lines to it::

    [alembic]

    script_location = kallithea:alembic

Your config file should now work with Alembic.

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

It is possible that an upgrade involves changes to the Git hooks installed by

Kallithea. As these hooks are created inside the repositories on the server

filesystem, they are not updated automatically when upgrading Kallithea itself.

To update the hooks of your Git repositories:

* Go to *Admin > Settings > Remap and Rescan*

* Select the checkbox *Install Git hooks*

* Click the button *Rescan repositories*

.. note::

    Kallithea does not use hooks on Mercurial repositories. This step is thus

    not necessary if you only have Mercurial repositories.

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

It is recommended that you rebuild the Whoosh index after upgrading since

new Whoosh versions can introduce incompatible index changes.

This step once again depends entirely on the web server software used to

serve Kallithea.

Before starting the new version of Kallithea, you may find it helpful to

clear out your log file so that new errors are readily apparent.

.. note::

    If you're using Celery, make sure you restart all instances of it after

    upgrade.

.. _virtualenv: http://pypi.python.org/pypi/virtualenv