Managing Content API

You can manage versions of this extension by upgrading or uninstalling the package.

Upgrading the package

Before you upgrade any package, you must delete older package versions installed on your Matrix system.

You should check the Release Notes for the package prior to upgrading to make sure there are no compatibility issues with the Matrix version you are using.

Follow these steps to upgrade a package to a newer version:

  1. Verify there are no compatibility issues between the upgrade package and Matrix version you are using.

  2. Open a terminal and navigate into the target Matrix system directory. For example: cd /var/www/squiz_matrix

  3. Delete any previous installation of the package. For example: rm -rf packages/package_directory_name

  4. Download the updated package archive to a file system location accessible to your Matrix system. For example, /path/to/package.tgz.

  5. Install the package by extracting the archive into your squiz_matrix/packages directory.

    cd /var/www/squiz_matrix
    tar -xvf /path/to/package.tgz
  6. Run the installation steps in order.

    sudo -u apache php install/step_02.php $PWD
    sudo -u apache php install/step_03.php $PWD --package=[package_name] (1)
1 [package_name] - Specify the name of the Matrix extension package. The name is the same as the installation package name, excluding any version information.

Uninstalling

To uninstall this extension, you need to have both Matrix system administrator and command line access to your Matrix instance.
  1. Log in to Matrix as a system administrator and access admin mode.

  2. Move all JSON Web Token assets in your Matrix instance to the Trash.

  3. Purge any trashed JSON Web Token assets from the Trash.

  4. As a server administrator, edit the feature flags configuration file:

    /var/www/squiz_matrix/data/private/conf/feature_flags.inc
  5. Set the SQ_FEATURE_API_ENABLED option to false:

    define('SQ_FEATURE_API_ENABLED', false);
  6. Open a terminal and navigate into the target Matrix system directory. For example: cd /var/www/squiz_matrix/

  7. Remove the package directory from the Matrix system. For example: rm -rf packages/package_directory_name

  8. Run Step 2 and Step 3 scripts to finalize the package removal process.

    sudo -u apache php install/step_02.php $PWD
    sudo -u apache php install/step_03.php $PWD

© 2015- Squiz Pty Ltd