Updating your LORIS - aces/Loris GitHub Wiki

The Release notes for each version of LORIS contain Upgrade steps for existing projects.
This page contains more information about this process, including for Imaging projects.

We recommend upgrading to the most recent LORIS release.

The LORIS team provides support (on a best-effort basis via the Loris-dev mailing list) for the last 2 releases of LORIS (including minor releases), and does not support pre-release development branches.

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

Update your LORIS in a few steps:

Important If you are upgrading over multiple versions, first upgrade to each minor release increment before upgrading to the next major release.

Consult the Release notes for the Upgrade Process specific to each release. Back up your database and code customizations before beginning. The typical steps are:

  • Update your dependencies
  • Apply the Release Patch to the database
  • Run any upgrade scripts provided
  • Update or merge custom code to work with the new release, if necessary
  • Update data to match type/column modifications, if necessary

Upgrade tips

  • Clear both your Browser cache and cached templates rm -f /var/www/loris/smarty/templates_c/* - note _c (i.e. do not clear smarty/templates/)
  • Ensure your admin user has all available permissions:
INSERT IGNORE INTO `user_perm_rel` (userID, permID) SELECT DISTINCT 1, permID FROM permissions;
  • Good to note: Pull requests tagged with Caveat for Existing Projects mean that there may be changes to your data after upgrading.
  • 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 and carefully review the Loris-MRI release notes for changes to the imaging pipeline scripts, config files and tables, and follow all recommended steps for Existing Projects. We recommend testing your pipelines after upgrading.

Troubleshooting

In the latest release, Loris needs to upgrade the PHP version. If you have an old PHP version installed, you need to upgrade to the higher PHP version. (example: PHP 7.3 to PHP 7.4 in Ubuntu) In order to ensure that this new PHP version is installed correctly, you need to do the following steps:

  1. sudo apt-get install -y php7.4 php7.4-mysql php7.4-xml php7.4-json php7.4-mbstring php7.4-gd php-ast
  2. sudo apt-get install -y libapache2-mod-php7.4
  3. sudo a2dismod php7.3
  4. sudo a2enmod php7.4
  5. sudo service apache2 restart
  6. run "/var/www/loris/htdocs$ echo "" >> test.php " Using test.php to check the current PHP version in your browser.
  7. make clean
  8. make
  9. mkdir smarty/template_c/ and set permission for this new folder (770 or 777).