Gateway Upgrade Process

Detailed Steps for Gateway Upgrade

1. Preparation

Windows

Step 1: Download the New Gateway Version

Download the latest gateway version from the DvSum Data Catalog Gateway Windows Installer.

Step 2: Uninstall the Current Gateway Service

Before installing the new gateway, uninstall the existing version to prevent conflicts. Use the following command to uninstall the service:

.\dvsum_gateway_setup.bat uninstall

Step 3: Verify Uninstallation

Ensure the service is no longer running:

.\dvsum_gateway_setup.bat status

Note: Keep a backup of the previous version for safety.

Linux

Step 1: Download the New Gateway Version

Download the latest gateway version from the DvSum Data Catalog Gateway Linux Installer.

Step 2: Uninstall the Current Gateway Service

To uninstall the service on Linux, run the following command:

./dvsum_gateway_setup.sh uninstall

Step 3: Backup the Previous Version

Move the current gateway folder to create a backup:

mv dvsum_gateway/ dvsum_gateway_1.2.3/

2. Configuration

Windows

Step 1: Set up a New Folder for the Latest Gateway

Create a new folder for the latest gateway files.

Step 2: Extract the Gateway Files

Extract the downloaded .zip file to the new folder. Avoid using the Downloads folder.

Step 3: Migrate Configuration and SSL Files

Copy the following configuration files from the old gateway folder to the new one:

• configuration.properties
• ssl_config.properties

Special case: when migrating from before v1.3.0 to v1.3.0 or later, then you must manually add this property (to any available port):
python.service.port=8184

In order to view the saved data from previous chats, you must copy the folder data_analysis from the old install to the new one.

If you are using a CA-signed certificate, also transfer the relevant certificate or keystore files:

cp dvsum_gateway_1.2.3/my_domain.jks dvsum_gateway_1.2.4/my_domain.jks

 

Linux

Step 1: Set up a New Folder for the Latest Gateway

Create a new folder for the latest gateway installation:

mkdir dvsum_gateway

Step 2: Extract the Gateway Files

Extract the .tar.gz file into the newly created folder:

tar -xzf dvsum_gateway_latest.tar.gz -C dvsum_gateway/

Step 3: Migrate Configuration and SSL Files

Copy the following configuration files from the old gateway folder to the new one:

• configuration.properties
• ssl_config.properties

Special case: when migrating from before v1.3.0 to v1.3.0 or later, then you must manually add this property (to any available port):
python.service.port=8184

In order to view the saved data from previous chats, you must copy the folder data_analysis from the old install to the new one.

If you are using a CA-signed certificate, also transfer the relevant certificate or keystore files:

cp dvsum_gateway_1.2.3/my_domain.jks dvsum_gateway_1.2.4/my_domain.jks

3. Installation

Windows

After setting up the new gateway and transferring the necessary files, install the gateway:

.\dvsum_gateway_setup.bat --ssl-option=4 --non-interactive

Next, start the gateway:

1. Open PowerShell in Administrator mode.
2. Navigate to the gateway folder:

cd c:\dvsum_gateway

3. Run the install command:

.\dvsum_gateway_setup.bat install

Linux

To complete the installation and start the gateway on Linux:

./dvsum_gateway_setup.sh --ssl-option=4 --non-interactive

---

Notes on Certificate Handling

For self-signed certificates, if you don’t need to retain previous settings, you can follow the general installation steps in the Gateway Installation article.

For CA-signed certificates, it’s recommended to reuse the same keystore to avoid reconfiguring the private key and related settings. Simply copy the keystore from the previous installation to the new gateway folder to maintain secure communication.

---

Final Remarks

• Ensure that configuration.properties and ssl_config.properties are correctly migrated.
• Keeping a backup of the previous version is recommended to avoid potential issues with SSL configurations or other settings.
• For CA-signed certificates, reusing the existing keystore simplifies the process, avoiding the need to track down the private key.