Mercurial > kallithea
view docs/upgrade.rst @ 6001:23057179017f
docs: add information about extra dependencies we now need
We have always needed some development packages, but never said
that explicitly. Now that bcrypt also requires libffi-dev, we
should mention that.
author | Andrew Shadura <andrew@shadura.me> |
---|---|
date | Tue, 12 Jul 2016 23:31:02 +0200 |
parents | 8075ec3d0233 |
children | 0b6d2ca7175f |
line wrap: on
line source
.. _upgrade: =================== Upgrading Kallithea =================== This describes the process for upgrading Kallithea, independently of the Kallithea installation method. 1. Stop the Kallithea web application ------------------------------------- This step depends entirely on the web server software used to serve Kallithea, but in any case, Kallithea should not be running during the upgrade. .. note:: If you're using Celery, make sure you stop all instances during the upgrade. 2. Create a backup of both database and configuration ----------------------------------------------------- You are of course strongly recommended to make backups regularly, but it is *especially* important to make a full database and configuration backup before performing a Kallithea upgrade. Back up your configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ Make a copy of your Kallithea configuration (``.ini``) file. If you are using :ref:`rcextensions <customization>`, you should also make a copy of the entire ``rcextensions`` directory. Back up your database ^^^^^^^^^^^^^^^^^^^^^ If using SQLite, simply make a copy of the Kallithea database (``.db``) file. If using PostgreSQL, please consult the documentation for the ``pg_dump`` utility. If using MySQL, please consult the documentation for the ``mysqldump`` utility. Look for ``sqlalchemy.db1.url`` in your configuration file to determine database type, settings, location, etc. 3. Activate the Kallithea virtual environment (if any) ------------------------------------------------------ Verify that you are using the Python 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. 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, it is as simple as:: cd my-kallithea-clone hg pull -u pip install -e . 5. Upgrade your configuration ----------------------------- Run the following command to upgrade your configuration (``.ini``) file:: paster make-config Kallithea my.ini This will display any changes made by the new version of Kallithea to your current configuration, and attempt an automatic merge. It is recommended that you check the contents after the merge. .. note:: Please always make sure your ``.ini`` files are up to date. Errors can often be caused by missing parameters added in new versions. 6. Upgrade your 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. .. note:: The DB schema upgrade library has some limitations and can sometimes fail if you try to upgrade from older major releases. In such a case simply run upgrades sequentially, e.g., upgrading from 0.1.X to 0.3.X should be done like this: 0.1.X. > 0.2.X > 0.3.X. You can always specify what version of Kallithea you want to install e.g. using pip: ``pip install Kallithea==0.2`` 7. Rebuild the Whoosh full-text index ------------------------------------- It is recommended that you rebuild the Whoosh index after upgrading since new Whoosh versions can introduce incompatible index changes. 8. Start the Kallithea web application -------------------------------------- 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