MySource Matrix Resources

Content Tools

Main Content

MySource Matrix Upgrade Guide

Introduction

This guide will help you upgrade the MySource Matrix Content Management System (CMS) using the command line.

A minor upgrade is the most common procedure - that is, an upgrade from MySource Matrix 3.x.y to 3.x.z - for example 3.16.0 to 3.16.1. At the top of this page you can find the standard instructions for upgrading between minor versions, followed by specific instructions for any particular upgrade that requires them.

For upgrade instructions between major versions of MySource Matrix, please see the Major Version Upgrade Guides.

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.

Minor Version Upgrades (for versions up to 3.18.0)

Minor version upgrades are usually quick and easy as they do not add new functionality or change the database schema.

The following are standard instructions to upgrade a MySource Matrix system from 3.x.y to 3.x.z. Please note that for some minor version upgrades, further steps are required to complete the upgrade - these steps are detailed in the specific instructions for each minor version, given below. You should follow the specific instructions for a minor upgrade if there is one, otherwise use the standard ones:

Standard Minor Release Upgrade Instructions

New Steps Required for 3.18.x to 3.18.y upgrades

The steps provided below are required if upgrading an existing "3.18.x" installation to a newer "3.18.y" release. These steps are the equivalent of the "Getting the New Source Code" section for all 3.18 releases.

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-18-x
$ tar -xzvf new_source.tar.gz
$ cd mysource_matrix
$ cp -r /home/websites/mysource_matrix_3-18-x/data .
$ cp -r /home/websites/mysource_matrix_3-18-x/core/lib/DAL/Oven core/lib/DAL
$ cp -r /home/websites/mysource_matrix_3-18-x/core/lib/DAL/QueryStore core/lib/DAL

Please then follow any minor version upgrade instructions relevant to your new "3.18.y" system. Links to these instructions are provided in the next section.

If there are no further instructions for your new "3.18.y" system, please proceed with the Standard Minor Release Upgrade Instructions.

Specific Minor Version Upgrade Guides

Some minor version upgrades require further steps to complete the upgrade. Often this will be due to changes to the database schema for performance reasons. Please follow the steps in the appropriate guide closely to ensure your system is correctly upgraded.

The following minor version upgrade guides are available:

Version 3.18.x
Version 3.16.x
Version 3.14.x
Version 3.12.x
Version 3.10.x
Version 3.8.x
Version 3.6.x

Major Version Upgrades

A major version upgrade is an upgrade from MySource Matrix 3.x to 3.y. These upgrades may require additional upgrade scripts to be run as well as database queries or configuration file changes. They are often more complex than minor version upgrades and require downtime for a system.

Major version upgrades require you to delete all previous rollback data from your system. Rollback data is incompatible between major versions.

Ensure that you have a current backup of your existing system and rollback data before upgrading.

The following major version upgrade guides are available: