Managing Asset version history

You can make limited configuration changes to default settings, and upgrade or remove the extension.

Adjusting default settings

You need server administrator access to make the changes suggested in this section.

You can make limited configuration changes to the default settings in the <matrix_root>/data/private/conf/asset_version_history/config.php file.

Option Description Default Values

enabled

Provides a way to enable or disable the extension without completely removing it from the system. Set the value to false to stop version history data from being collected.

When set to false the Version History screen remains available to view version history data stored up to the point at which the extension was disabled.

true

true

false

pagination_limit

Sets a limit on how many versions are available to view on the Version History screen.

500

0+ (must be an integer)

null (no limit)

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.

Removing the package

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. Open a terminal and navigate into the target Matrix system directory. For example: cd /var/www/squiz_matrix/

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

  4. 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
  5. To remove all asset version history data, drop the sq_ast_vers_history table from your database.

  6. Delete the configuration directory located at <matrix_root>/data/private/conf/asset_version_history.

© 2015-2020 Squiz Pty Ltd