Update Scenarios for Linux Servers

A Note About Guidance Packages

For a smooth update, the major and minor version numbers of the updated Acrolinx Core Platform and your existing guidance package should be the same. For example: A guidance package with the version number 2019.05.x is compatible with server versions 2019.05.x.

If you’re unsure whether your current guidance package is compatible with your updated Core Platform version, contact your Acrolinx project consultant.

Update to a New Core Platform Version

The following steps are based on using a supported standard stack.

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

  1. Make sure that 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.
    For more information about the files to copy to a new installation, see the installation update checklist.
  2. Stop all servers from the existing installation.

    $ cd <EXISTING_INSTALL_DIR>/server/bin/
    $ ./run.all stop
  3. Use GNU tar to unpack the Core Platform package. The filename has the following structure: AcrolinxServerV<VERSION_NUMBER>B<BUILD_NUMBER>.posix.tgz

    Don’t unpack the new Core Platform package into the existing installation directory.

    $ cd <INSTALL_ROOT>
    $ <GNU_TAR_COMMAND> -xvzf <FILE_NAME>.tgz

    This creates a new directory, which we refer to as <INSTALL_DIR>.

  4. (Optional) 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 updates. Unless you’ve explicitly disabled the configuration directory, you can proceed to the next step.

  5. Run the Core Platform installation script. This creates an installer.parameters file.

    $ cd <INSTALL_DIR>
    $ bash ./installer.sh
     Need More Language Servers?

    You can use the -lscount option to change the number of language servers installed:

    OptionDescription
    -lscount

    This option specifies the total number of language servers to install. It persistently overrides the LSCOUNT parameter in the installation parameters file.

    Example
    $ cd /home/acrolinx/acrolinx/
    $ bash ./installer.sh -lscount 4

    Note

    You can't use -lscount together with the -i or -u options.
  6. When prompted, make sure that the installation parameters in the terminal are exactly what you want to use.

    The installation script automatically determines the IP address of the computer. If your computer has more than one network interface, the installer picks the address of the first network interface. It’s strongly recommended that you replace the IP address with a symbolic name.

    If you have an existing configuration directory, make sure that either ACROLINX_CONFIGURATION_ROOT or CONFIG_COPY_FROM points to the existing configuration directory.

     Need to Change the Installation Parameters?

    If you need to change the installation parameters, follow these steps:

    1. Enter No in the terminal to exit the installation script.

    2. Open the installer parameters file at the following location: <INSTALL_DIR>/installer.parameters

    3. Update the relevant installation parameters.
    4. Run the installation script again.


      You can rerun the installer script anytime if you need to change the installation parameters again. The installer script overwrites all installation files in the server/bin directory. Before you run the installer script on an existing installation, back up any files in the server/bin directory that you’ve changed.

  7. Check the installer.log file in the <INSTALL_DIR>. Make sure the files and configurations that you copied in previous steps were correctly loaded. You should see something like "Installation is complete".
  8. (Optional) If you want the Core Platform to start automatically when you reboot your system, install init scripts. This option doesn't persist when you update your Core Platform.
  9. If you’ve received a new guidance package:

    1. Unzip the guidance package into the new Core Platform directory.

      $ cd <INSTALL_DIR>
      $ <UNZIP_COMMAND> <FILE_NAME>.zip
    2. Install the guidance package with the prepling option. This option corrects any paths that might only work on Windows installations.

      $ cd <INSTALL_DIR>
      $ bash ./installer.sh -prepling

Update Your Core Platform - 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 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 the legacy Acrolinx Reuse feature.
    Back up and restore your reuse files. You can find them under <INSTALL_DIR>/data/reuse/.

Update Your Guidance Package

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. 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 Update Your Core Platform - Special Cases above 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. Install the new guidance package files.
  4. Check the log files for errors or warnings.