Introduction

Upgrading an Openclerk instance is currently a manual process but fairly straightforward once you have done it a couple of times. The basic format is:

• Update config.php and set jobs_enabled to false
• Update config.php and add new sections as changed in inc/config.php.sample since the last version
• Execute svn update to update to the latest version
• Execute the new database commands in inc\database.sql on the database server
• Re-enable jobs_enabled to true
• Check the admin status page to make sure that no jobs are failing with errors, fix configuration as necessary

Details

Update config.php

First, edit your config.php and set jobs_enabled to false. This is necessary so that your database does not become inconsistent and jobs are not run while you are upgrading.

Secondly, do a diff on inc/config.php.sample to see what new configuration options have been added, and add these to your config.php. For example, changes from 0.16 to 0.17 in config.php.sample.

Execute svn update

If you have checked out Openclerk through http://openclerk.googlecode.com/svn/trunk/ then you can just execute a svn update to get the latest code.

If you are running through a tag, execute a svn switch http://openclerk.googlecode.com/svn/tags/0.17.

Execute new database commands

Execute the commands in inc/database.sql for the new version into your MySQL database. For example, database commands upgrading from 0.16 to 0.17.

Re-enable jobs and check for issues

Edit your config.php and set jobs_enabled back to true.

Check the System Status page once jobs are running again to ensure that there are no major errors. Also check the output of the batch_run.php script to see there are no major issues.

If there are any problems, resolve them as necessary (could be through source code changes, changes to your config.php, changes to your database, etc).

Finally, edit your config.php and set openclerk_version to the latest version number.