CKAN Documentation 2.1.5 documentation » Upgrading CKAN »

Upgrading a source install


Before upgrading CKAN you should check the compatibility of any custom themes or extensions you’re using, check the changelog, and backup your database. See Upgrading CKAN.

The process for upgrading a source install is the same, no matter what type of CKAN release you’re upgrading to:

  1. Activate your virtualenv and switch to the ckan source directory, e.g.:

    . /usr/lib/ckan/default/bin/activate
    cd /usr/lib/ckan/default/src/ckan
  2. Checkout the new CKAN version from git, for example:

    git fetch
    git checkout release-v2.0

    If you have any CKAN extensions installed from source, you may need to checkout newer versions of the extensions at this point as well. Refer to the documentation for each extension.

  3. Update CKAN’s dependencies:

    pip install --upgrade -r pip-requirements.txt
  4. Register any new or updated plugins:

    python develop
  5. If you are upgrading to a new major release you need to update your Solr schema symlink.

    When Setting up Solr you created a symlink /etc/solr/conf/schema.xml linking to a CKAN Solr schema file such as /usr/lib/ckan/default/src/ckan/ckan/config/solr/schema-2.0.xml. This symlink should be updated to point to the latest schema file in /usr/lib/ckan/default/src/ckan/ckan/config/solr/, if it doesn’t already.

    For example, to update the symlink:

    sudo rm /etc/solr/conf/schema.xml
    sudo ln -s /usr/lib/ckan/default/src/ckan/ckan/config/solr/schema-2.0.xml /etc/solr/conf/schema.xml

    You will need to restart Jetty for the changes to take effect:

    sudo service jetty restart
  6. If you are upgrading to a new major release update your CKAN database’s schema using the db upgrade command.


    To avoid problems during the database upgrade, comment out any plugins that you have enabled in your ini file. You can uncomment them again when the upgrade finishes.

    For example:

    paster db upgrade --config=/etc/ckan/default/development.ini

    See db: Manage databases for details of the db upgrade command.

  7. Rebuild your search index by running the ckan search-index rebuild command:

    paster search-index rebuild -r --config=/etc/ckan/default/development.ini

    See search-index: Rebuild search index for details of the ckan search-index rebuild command.

  8. Finally, restart your web server. For example if you have deployed CKAN using the Apache web server on Ubuntu linux, run this command:

    sudo service apache2 reload
  9. You’re done!

You should now be able to visit your CKAN website in your web browser and see that it’s running the new version of CKAN.