Update Scenarios for Linux Servers

The major version numbers of the updated Acrolinx Core Platform and the existing guidance package must be compatible.

For example: A guidance package with the version number 4.x is compatible with server versions 4.x.

In some circumstances, it’s possible to use a guidance package with an earlier version number than the server, but it is recommended that you update to the same major version as the server. If you’re unsure if your current guidance package is compatible with your updated server, contact your Acrolinx project consultant.

To install a new version of the Acrolinx Core Platform, follow these steps:

  1. Make sure your database administrator has made native backups of your existing terminology database, your reporting, and Analytics databases. The update automatically migrates your data but it’s a good idea to keep regular backups in case you’ll need a fallback.
  2. Stop all servers from the previous installation.
  3. Install the new Acrolinx Core Platform software version to a new directory.
  4. If you’ve disabled the configuration directory, add any changes to the new installation.

    The configuration directory is enabled by default when you install the Acrolinx Core Platform and is unaffected by server updates. Unless you’ve explicitly disabled the configuration directory, you can proceed to the next step.

    For more information about the files to copy to a new installation, see the installation update checklist.

  5. Check the log files to ensure that the files and configurations that you copied in previous steps were correctly loaded.
  6. If you’ve also received a new guidance package, update your guidance package.

Updating Your Guidance Package - Happy Path

The Acrolinx linguistic team can provide updates to your guidance package in response to the changing requirements of your organization.

In most cases, updating your guidance package is simple. You uninstall the previous version, then install the new guidance package version. There are some situations that make it more complicated. You’ll need to manually back up and restore some files if you use a H2 database for your terminology, use Acrolinx Reuse, or if you’ve modified configuration files directly in your installation directory. Read the section Updating Your Guidance Package - Special Cases below for more details.

To update your guidance package in the majority of cases, follow these steps:

  1. Make sure your database administrator has made native backups of your existing terminology database, your reporting, and Analytics databases. The update automatically migrates your data but it’s a good idea to keep regular backups in case you’ll need a fallback.
  2. Stop all servers, and back up both your entire install directory and your configuration directory.
    The default location of your configuration directory is:

    <USER_HOME>/.config/Acrolinx/ServerConfiguration<VERSION_NUMBER>/

    Again, this step is just a precaution and you hopefully won't need to use these backups. But skip it at your own risk!

  3. Remove the old guidance package files.
  4. Install the new guidance package files.
  5. Check the log files for errors or warnings.

Updating Your Guidance Package - Special Cases

If you use a H2 database for your terminology, use Acrolinx Reuse, or if you’ve modified configuration files directly in your installation directory, you’ll need to manually back up and restore some files in your installation directory.

  • You use a H2 database for your terminology.
    Back up and restore your terminology database. You can find it under <INSTALL_DIR>/db/terminology

    Using a H2 database for your terminology is not recommended or supported.

  • You’ve modified configuration files directly in your installation directory.
    Back up and restore the files that you’ve modified.

    Where possible, it's best to modify configuration files in the configuration directory to avoid this process.

  • You use Acrolinx Reuse.
    Back up and restore your reuse files. You can find them under <INSTALL_DIR>/data/reuse