Skip to main content
Version: 2.8

Upgrading Conversion Service

This page describes how to upgrade Conversion Service to a recent version.

Note

You must repeat this procedure for all Conversion Service servers in your deployment. See Deployment use cases.

Before you begin​

  • Obtain a deployment package with the recent version of Conversion Service from the Document.One team
  • Upload the deployment package to the server where the current version of Conversion Service is installed
  • Backup the current version of your Conversion Service installation. For details about how to do this, see Backing up Document.One.
important

If your database or file system configuration has changed, we recommend that you perform a fresh installation of Conversion Service instead of upgrade.

For information about how to install Conversion Service, see Installing Conversion Service.

To upgrade Conversion Service​

  1. Shut down the current Conversion Service installation (if it is running).

    • Run ./tribefire-console-stop.sh from /runtime/host/bin - if Conversion Service was started from the command line with ./tribefire-console-start.sh.
    • Run /etc/init.d/service_name stop- if Conversion Service was started as a Linux service.

  2. Unzip your new archive into the root directory of the current installation (the directory containing conversion-deployment-package).

  1. Run ll to list directories and files in the root folder. The updated conversion-deployment-package contains the following files and folders:

    Installation package files and foldersDescription
    additional-libraries/Created during first installation; it hosts database drivers
    conversion-deployment-package/Your new Conversion Service package.
    conversion-resources/Resources created by the previous Conversion Service instance. It is Will be overwritten when you run the new package.
    installation-settings.yamlThe installation settings created during the first installation. You need to update this file if the new release introduces configuration changes.
    license/The license file created during the first installation.
    logs/Log files from the previous Conversion Service instance. It will be overwritten when you run the new package.
    temp/Temporary data from the previous Conversion Service instance. It will be overwritten when you run the new package.

  2. If the release notes of your new package mention any configuration changes, adapt the installation-settings.yaml file accordingly.

    Tip

    To create a new installation file based on the latest template, run cp conversion-deployment-package/example-installation-settings.yaml installation-settings.yaml, and then re-enter configuration data into the new file.

  3. Go to the directory where you unzipped the package and open conversion-deployment-package.

    Note

    When you install the updates in the directory with the previous installation, all temporary data (logs, elastic search data, temporary files) are overwritten when you launch the new runtime.

  4. Open the terminal, and run the installation script: ./install.sh.

    If your installation settings file is not in the default location, adapt the paths and/or names accordingly. For example:

    install.sh --settings /path/to/installation-settings.yaml --environment /path/to/environment.sh-

    Conversion Service is to be installed in the directory specified in the configuration file.

  5. To start the service, enter /runtime/host/bin in the installation directory, then run ./tribefire-console-start.sh. Alternatively, you can start the server as a Linux service.

    After startup, Conversion Service is to be available in your browser under the host and port you configured (for example http://localhost:8080).

  6. (Recommended) Run a number of health checks to make sure everything is running smoothly.

Troubleshooting note

If the upgrade failed, quote the full version of the package (including the -p suffix if it's in your package name) to the support team.

Where to go from here

When you have upgraded the Conversion Service, you can do the same for D1. See Updating ADx for details.