MySource Matrix Resources

Main Content

Upgrading MySource Matrix from v3.10.3 to v3.10.4

Introduction

This guide will help you upgrade an existing MySource Matrix version 3.10.3 installation to version 3.10.4.

This upgrade requires you to have access to:

  • update the MySource Matrix source code
  • upgrade MySource Matrix configuration files

This guide assumes that your MySource Matrix installation is located at /home/websites/mysource_matrix. Please change any commands to the appropriate location if your installation is located elsewhere.

If your system contains the commercial or premium modules, please contact Squiz for updated versions of the modules before proceeding with the upgrade.

The modules must be upgraded at the same time as the core system.

Backup

Before starting any upgrade, always backup your MySource Matrix installation. See the MySource Matrix backup management guide for information on how to backup your MySource Matrix system.

Getting the New Source Code

The first thing you need to do is update the MySource Matrix source code. You can find out how to download the latest stable version of MySource Matrix on the installation page.

Once you have downloaded the source code, you need replace the existing code with the newer version. This will not reset any configuration options or remove any content from your system.

These steps assume MySource Matrix is installed at /home/websites/mysource_matrix and that a tar.gz archive with the new source code exists within /home/websites
$ cd /home/websites
$ mv mysource_matrix mysource_matrix_3-10-3
$ tar -xzvf new_source.tar.gz
$ cd mysource_matrix
$ cp -r /home/websites/mysource_matrix_3-10-3/data .

Clear Stale Files from Filesystem

There have been code updates to the File asset to ensure that old versions of files do not persist within the filesystem. A script has been added to remove old versions of File assets.

First, run the following command from the root of your MySource Matrix installation:

$ php scripts/system_integrity_clean_old_files.php .

This script will notify you of any files that are no longer referenced by File assets within the system, and can be safely deleted. If there are files that can be deleted, you should delete them by running the following script:

$ php scripts/system_integrity_clean_old_files.php . --delete-orphans

Full System Upgrade

To complete the upgrade, the system's installation scripts should be run to ensure the asset types and language translations are up to date.

$ php install/step_02.php /home/websites/mysource_matrix
$ php install/step_03.php /home/websites/mysource_matrix
$ php install/compile_locale.php /home/websites/mysource_matrix

Reparse Your Designs

Once you have completed the upgrade scripts, login to your Administration Interface, locate any Design asset containing a Menu or Constant Button design area, and manually reparse it. Code changes were made to some design areas in this upgrade and reparsing ensures that your designs use the latest, most efficient code.

Clear Your MySource Matrix Cache

If you are using the User Group Restrictions feature in your MySource Matrix system, it is strongly recommended at this point that your MySource Matrix cache is cleared via the Cache Manager.

Review and Change Cron Run Script

The Cron Run script ([SYSTEM ROOT]/core/cron.run.php) has been changed to better handle systems such as Solaris, which previously had issues with determining the location of its MySource Matrix installation.

The Cron Run script now accepts the root of the installation as a parameter, and it is strongly recommended (and required on systems such as Solaris) that you use it inside your Crontab file. For example, for a Cron set to run every 15 minutes, the line in Crontab should read like this:

*/15 * * * * /path/to/matrix/core/cron/run.php /path/to/matrix

Or on systems such as Solaris that do not support the "*/15" format for specifying "every 15 minutes" and require the minutes to be specified explicitly:

0,15,30,45 * * * * /path/to/matrix/core/cron/run.php /path/to/matrix

Upgrade Complete

Your upgrade to MySource Matrix version 3.10.4 should now be complete.