Updating your LORIS

We recommend upgrading to the most recent LORIS release.

See additional notes at bottom for Imaging projects

If you are a developer used to working on the development branch, note that the master branch reflects the last stable release.

We do not support the unstable pre-release development branch. e.g. 17.1-dev is the next development branch after the 17.0.* release

Update your LORIS in a few steps:

• Download the new release codebase. Be careful of overwriting any custom code modifications that you may have added - you'll want to merge these with the code updates.
• Run composer install --no-dev and then composer dump-autoload to update dependencies and re-generate the autoload.php file
• Apply the MySQL release-upgrade patch found in the SQL/Release_patches directory. Carefully note modifications to data columns and data type definitions
• Check your project/ directory for code that may be overriding the main Loris codebase - these files may need updating to work with the release codebase. Note that as of 16.0 release, custom module support has changed
• Review all Release Notes for every release since your last version, including minor releases -- especially those in the section specifically for Existing Projects. Follow carefully the recommended steps for existing projects
• Important: Upgrading to LORIS 17.0 (fall 2016) will require a one-line change to all PHP Quickform instruments, as HTML Quickform is replace by LorisForm. No other code, configurations, templates, tables or data will be affected or require adjustment

Upgrade tips

• Ensure your admin user has all available permissions:

INSERT IGNORE INTO `user_perm_rel` (userID, permID) SELECT DISTINCT 1, permID FROM permissions;

• If old template code continues to be sourced, clear your smarty/templates_c directory where templates are cached (NB: clear smarty/templates_c/ but do not clear smarty/templates/)
• Good to note: Pull requests tagged with Caveat for Existing Projects
• It may help to update tables to utf8 character set:

    ALTER TABLE users CONVERT TO CHARACTER SET utf8;

Imaging projects

Update your Loris-MRI code to the latest Loris-MRI release (to accompany your Loris release) carefully note changes to the imaging pipeline scripts, config files and tables, and follow all recommended steps in the Release notes for Existing Projects. Ensure you have also updated to the most recent version of the dicom-archive-tools repo. Loris-MRI Pull requests marked Caveat for Existing Projects mean that there may be changes to your data after upgrading.