MySource Matrix Resources

MySource Matrix has been superseded by Squiz Matrix. This site will remain available for archival purposes only; it is not intended as a current source of Matrix information. For all the latest on Matrix, including documentation and release information, visit the Squiz Matrix site.

Content Tools

Main Content

Upgrading MySource Matrix from v3.26.1 to v3.26.2

Introduction

This guide will help you upgrade an existing MySource Matrix version 3.26.1 installation to version 3.26.2.

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 Squiz Supported Version (SSV) 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.

Obtain Funnelback OEM binaries (SSV only)

Clients under the SSV licence may obtain the Funnelback OEM binaries for use with the MySource Matrix Funnelback integration. Please contact Squiz to obtain these binaries before undertaking this upgrade.

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.

Disable Rollback

At this point, you need to ensure that rollback is disabled before continuing. For help with disabling rollback, see the MySource Matrix rollback management guide.

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

Full System Upgrade

Now, 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/compile_locale.php /home/websites/mysource_matrix
$ php install/step_03.php /home/websites/mysource_matrix
$ php install/compile_locale.php /home/websites/mysource_matrix

Funnelback Search integration

The following steps are required to install the Funnelback OEM binaries for the integration with MySource Matrix.

A Java Runtime Environment is included in the distribution as Funnelback has dependencies on Java code. This particular runtime version has been tested against Funnelback code, so substituting other existing runtimes is not advised.

All commands must be run as the root user at the command line (prompt denoted by the hash '#' character).

All supported OS distributions
(Create directory to house Funnelback OEM binaries)

mkdir /opt
tar -zxf funnelback.tar.gz -C /opt
mv /opt/funnelback /opt/funnelback-oem
(Set permissions and fix symbolic links)
chown -R root.root /opt/funnelback-oem

Debian distributions
(Modify Funnelback config to point to correct 'sort' binary)

sed -i 's!sort=/bin/sort!sort=/usr/bin/sort!' /opt/funnelback-oem/conf/executables.cfg

Cron Setup for Funnelback Search indexing

The Funnelback Search indexer will need to be configured to run on a schedule to update the index with new and modified content.

In order to enable indexing, a line will need to be added to the crontab of the apache user to do so. Please run the following command, assuming "apache" is the name of your apache user: 

crontab -u apache -e

Please add the following line to the crontab. This will reindex every configured Collection at 2am each day: 

00 02 * * * php /home/websites/mysource_matrix/packages/funnelback/scripts/funnelback_reindex.php /home/websites/mysource_matrix

This line can be configured to index individual Collections by Collection ID. This can be done at different times of day or week, although Collections may not be configured individually to run concurrently due to a lock file acquired when running the script.

The Collection ID is configured in the Funnelback Manager within MySource Matrix. So for example, a Collection named "Product_Site" could be re-indexed as such: 

php /home/websites/mysource_matrix/packages/funnelback/scripts/funnelback_reindex.php /home/websites/mysource_matrix Product_Site

Re-enable Rollback

If you needed to disable rollback at the beginning of this upgrade, you may now re-enable it. For help with enabling rollback, see the MySource Matrix rollback management guide.

Upgrade Complete

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