Requirements

Please note that the requirements on this page are for Squiz Matrix version 5.5 only. For requirements related to previous versions, use the links below:

If you are installing Squiz Matrix on your own server, please take note of all requirements on this page.

Web Browser Support

The Squiz Matrix Admin and Edit Mode editing interfaces support the following desktop web browsers and browser versions:

Mozilla FirefoxInternet ExplorerMicrosoft EdgeSafariGoogle Chrome
Firefox Logo
Mozilla Firefox for Windows 8.1 & 10 and Mac
Latest Extended Support Release
Internet Explorer Logo
Internet Explorer 11 for Windows 8.1 & 10.

Microsoft Edge for Windows 10, Latest Stable Release
Safari Logo
Safari for Mac (latest 3 macOS versions), Latest Stable Release
Google Chrome Logo
Google Chrome for Windows 8.1, & 10 and Mac, Latest Stable Release

    Squiz Matrix only supports out of the box (native) installations and configurations of desktop web browsers and browser versions. For example, Squiz Matrix does not support Internet Explorer 'emulation' configurations where later versions are configured to act like older versions e.g. IE11 is told (via local and/or server-side controls) to act like IE7.

    Some features and tools of the edit interfaces in Squiz Matrix rely on native browser features to function. Therefore, some features as outlined in this manual may not be supported for all of the web browsers listed above.

    JavaScript

    Squiz Matrix requires JavaScript to be enabled in your web browser. JavaScript is enabled by default in most browsers so as long as you have not turned it off, you should be fine.

    Cookies

    Squiz Matrix makes use of browser cookies to identify authenticated users. Your web browser must have cookies enabled in order to access the editing and administration interfaces of Squiz Matrix.

    Operating System

    Squiz Matrix requires a UNIX-like operating system for the webserver. The following operating system is endorsed and recommended for use with Squiz Matrix:

    While this operating system is recommended and officially supported by Squiz, Squiz Matrix can be run on any operating system that supports the software packages and requirements outlined on this page.

    You can verify the program requirements of a Squiz Matrix installation against your server configuration using the system's check_requirements.php script. This script is located in the /install directory of your system and will notify you of any third-party applications, PHP extensions and/or PEAR packages that are required for your installation.

    PHP

    Depending on what version of Squiz Matrix you are running, a different range of PHP versions will be supported.

    Matrix versionPHP support
    5.5.0.0 - 5.5.2.35.4, 5.6, 7.1
    5.5.3.x5.4, 5.6, 7.1, 7.3
    5.5.4.0 +7.3

    The following PHP extensions are required:

    • xsl
    • pdo_pgsql or oci8
    • curl
    • gd
    • mbstring
    • pspell
    • soap
    • SimpleXML
    • ldap
    • json
    • intl

    Suhosin Configuration

    When using the Suhosin patch on your PHP installation, you will need to adjust the default configuration settings, as follows:

    • the suhosin.session.encrypt setting must be disabled.
    • the suhosin.request.max_varname_length setting should be set to 200.
    • and the suhosin.post.max_name_length setting should be set to 200.

    OPCache

    OPCache can be optionally enabled with Matrix, however, Matrix requires opcache.revalidate_freq to be set to 0.

    Squiz recommends using OPCache v7.3.7 or newer as Matrix will trigger PHP Bug #78106 on older versions.

      Web Server

      Squiz Matrix is officially supported on the Nginx web server. For more information on installing Nginx, please refer to the Beginner's Guide. It is strongly recommended to also use the OpenResty bundle, which includes many popular and useful Nginx plug-ins.

      Squiz Matrix can potentially also be run on any other web server that supports and is compatible with software's PHP and other server requirements.

      If you are using Apache 2 as your web server, it must be compiled with the Apache MPM prefork module or PHP will not work correctly. For more information on Apache 2 support, please read the PHP compatibility guide.

      Please note that Apache is not compatible with Squiz Matrix version 5.5.6.0 and up. Nginx is the recommended and preferred web server to use.

      Database

      Squiz Matrix uses a database as its primary data store and supports the PostgreSQL open-source database and.

      Squiz Matrix supports PostgreSQL versions:

      • 9.2
      • 9.3
      • 9.4
      • 9.6
      • 10.1

      Squiz Matrix supports UTF-8 character encoding only.

      In-Memory Cache

      Squiz Matrix supports both Memcached and Redis caching systems. The following table outlines which caching system is recommended for each cache mechanism.

      Cache ManagerRedis
      Session HandlingMemcached
      Asset LockingRedis
      Deja VuRedis

      Please note that Memcached requires the Memcache PECL module (version 2.0.0) and Redis requires the Redis PECL module (version 2.2.5).

      Third-party Tools

      Squiz Matrix requires a selection of third-party tools to support extended functionality.

      Where possible, third-party tools are included with Matrix.

      Some tools require separate installation and must be referenced from the External Tools Configuration screen to function.

      The following versions have been tested and are minimum requirements for the following functionality:

      HTML Tidy

      HTML Tidy for Linux is required to clean HTML content for the Classic WYSIWYG editor and provide accessibility checking.

      This tool is not applicable if you are using the Edit+ Editor.

      Anti-virus

      Virus checking of file uploads requires the clamdscan client.

      Microsoft Word Conversion

      Convert Word to HTML 1.01 is required to import Microsoft Word documents into Squiz Matrix as structured page navigation. This is a Windows executable which must be configured to upload to a Squiz Matrix system directory for use with the "Word Import  Tool Converter" and "Structured  File Import Tool".

      File Keyword Indexing

      File keyword indexing support for PDF and MS Word documents require Apache Tika version 1.8 and Java version 6 or later installed on the server.

      Image Metadata Extraction

      Image metadata extraction support for Image assets requires ExifTool version 9.90.

      REST JavaScript Processing

      The REST Resource JavaScript asset allows you to use either SpiderMonkey, Rhino or V8 JavaScript engines for processing response body content. These modules must be correctly installed and configured if they have been selected for use on this asset.

      Squiz Matrix Operating System Support Statement

      Each minor release of Squiz Matrix is supported on the major version of the Operating System (OS) it was originally released on until either the OS vendor ceases support for the OS or 36 months elapse since that Minor release of Squiz Matrix was released.

      For most OSs', security and maintenance fix updates are only provided for the latest minor version of that OS, so users will need to update their OS installation to the latest minor version of the OS to continue receiving security and maintenance fixes for the entirety of the supported period.

      Squiz Matrix updates may also require packages additional to those provided by the OS and these will be indicated in the release notes for each version of Squiz Matrix.

      For example, Squiz Matrix 5.3 was released in November 2015 and is fully supported until November 2018. At release, it was tested and certified on Red Hat Enterprise Linux version 6, which is supported by Red Hat until November 30, 2020.

      This means users could have built a server with Squiz Matrix 5.3 and Red Hat Enterprise Linux 6 in November 2016, and retain that server as a fully supported configuration simply by applying OS package and Squiz Matrix updates until November 2018.

      Definitions for what constitutes Squiz Matrix Major, Minor,  Micro, and Patch releases as well as other information about the Squiz Matrix release schedule is available on the Release Information page.

      The Latest

      Releases

      Date Version
      22 Apr 20205.5.6.3
      19 Mar 20205.5.6.2
      28 Feb 20205.5.6.1
      14 Feb 20205.5.6.0
      19 Dec 20195.5.5.1
      02 Dec 20195.5.5.0
      17 Oct 20195.5.4.2
      15 Oct 20195.5.4.1

      Let Us Know What You Think

      Let us know if you spot any errors or if you have any ideas on how we can improve the Matrix Community Website.

      Contact Squiz for Demo

      Let us show you the true power of Squiz Matrix by giving you a personalised demonstration.