Gateway Installation

Avatar
DvSum Support
Follow

In this Article

Overview

This document outlines the steps for installing the DvSum Gateway for use with Data Intelligence Platform. It provides detailed instructions for both Windows and Linux systems, including configuration and installation procedures.

Note: Gateway, Connector, SAWS (Stand-Alone Web Service) and webservice are used interchangeably referring to the DvSum Edge Gateway.

Download Links

Prerequisites (all platforms)

  • Minimum Memory: 8 GB (16 GB recommended)
  • Minimum Disk Space: 10 GB (20 GB recommended)
  • CPU Cores: 2 (4 recommended)

  • Python Requirement: For Windows: Python 3.9 or later does not need to be pre-installed. The Gateway installer automatically detects and installs Python if it is not available on the system.

    For Linux: Python 3.9 or later should be installed on the system.

  • Linux Requirements:
    • systemd support
    • x86_64 architecture
  • Windows Requirements:
    • Windows Server 2012 or later
# Confirm Architecture 
lscpu
# Expected output includes:
# Architecture: x86_64

Network Configuration

If the DvSum Gateway is installed on a server with restricted outside access to specific URLs, you'll need to whitelist the following addresses on the network. This will enable the DvSum Gateway to communicate with the DvSum SaaS application and ensure the service functions properly and securely connects to the necessary resources on the network. Please configure the network settings accordingly to allow for this communication.

URLs that must be whitelisted for outbound access on port 443

  • https://apis.dvsum.ai

  • wss://3k7tif2dyi.execute-api.us-west-2.amazonaws.com/prod

  • https://dvsum-app-data-prod.s3.amazonaws.com

Ports that must be open for inbound access from end-user computers

  • Default: 8183
  • Common alternative: 443

Testing network configuration

The installer includes an option to test the network configuration.

  • Linux:
    ./dvsum_gateway_setup.sh --check-network
  • Windows:
    .\dvsum_gateway_setup.bat --check-network

Define a Gateway

You must define a gateway in the DvSum GUI defining the details that you will use when you install the gateway. Navigate to Administration → Account Settings → Gateway.

Click on "Add" Button as shown in the image below. Provide the Web Service name, Host Name and Port (default 8183) and save it.

This defines a Gateway with a unique communication key by which the gateway communicates with the DvSum web application. 
Keep track of the communication key; it will be required later during the installation.

Windows Installation

Download the installer

Use the link provided above, or the installer can also be downloaded directly through the Download button available in the GUI. 
Note: Once the installer is downloaded, extract it and move it to the desired folder.

Launch PowerShell

Navigate to Start, look for Windows PowerShell, then right-click and select "Run as Administrator."

Navigate in PowerShell to the gateway folder

# In this example, the gateway was unzipped in c:\dvsum_gateway
cd c:\dvsum_gateway
dir

Non-interactive Installation

The non-interactive mode proceeds automatically without the need for manual input during the process. Instead, you enter all relevant information into the two properties files before running the installation.

Edit configuration.properties

  • Set the value for API Key 
    Note: The API key refers to the Configuration Key displayed in the Gateway tab of the platform.
  • Confirm the value for Port
  • Confirm the value for Python Port

  • Review all other properties — in most cases, no updates are needed.

- dvsum.apiKey (copy from app.dvsum.com -> Account -> Gateway -> copy communication key of your gateway)

- dvsum.port (default value: 8183)

- dvsum.pythonServicePort (default value: 8185)

Edit ssl_config.properties

The properties that you need to set in this file depend on the SSL option that you select when running the script.

Generate a new certificate (SSL Option 1): complete sections 1 and 2.
Add certificates to an existing keystore (SSL Option 2): complete sections 2 and 3.
Create a new keystore with your certificate (SSL Option 3): complete sections 2 and 3.
Use an existing keystore with certificate and private key (SSL Option 4): complete all sections.

SSL Option 1: Launch the installer

Use the following command to execute the gateway setup script and proceed with the installation and configuration of the DvSum Gateway automatically, without requiring any user interaction.

# In this example, Generate a cert (SSL Option 1) is selected.
.\dvsum_gateway_setup.bat --ssl-option=1 --non-interactive


PS C:\Users\Administrator\Desktop\KB> .\dvsum_gateway_setup.bat --ssl-option=1 --non-interactive

Running setup prerequisites...
--------------------------------

Checking network connectivity to DvSum application ...
-------------------------------------------------------

Network Reachability Report
====================================

Status: success
Timestamp: 2026-03-12 16:31:20

API: REACHABLE
API Key: VALID
WebSocket: REACHABLE
S3: REACHABLE

Network check successful
All DvSum endpoints are reachable

-------------------------------------------------------
Existing gateway.dvsum.ai.p12 deleted.
Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF-8
Generating 2,048 bit RSA key pair and self-signed certificate (SHA384withRSA) with a validity of 3,650 days
        for: CN=gateway.dvsum.ai
Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF-8
Existing gateway.dvsum.ai.jks deleted.
Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF-8
Importing keystore gateway.dvsum.ai.p12 to gateway.dvsum.ai.jks...
Entry for alias dvsum-gateway-cert successfully imported.
Import command completed:  1 entries successfully imported, 0 entries failed or cancelled

Warning:
The JKS keystore uses a proprietary format. It is recommended to migrate to PKCS12 which is an industry standard format using "keytool -importkeystore -srckeystore gateway.dvsum.ai.jks -destkeystore gateway.dvsum.ai.jks -deststoretype pkcs12".
Configuration has been updated with the latest values.
The updated configuration file is: ssl_config.properties

Setting up DvSum Gateway services...
------------------------------------

Installing DvSum-Gateway service...
DvSum-Gateway service installed successfully.
DvSum-Gateway service started successfully.
DvSum-Gateway service is running.

Installing DvSum-Gateway-Monitor service...
DvSum-Gateway-Monitor service installed successfully.
DvSum-Gateway-Monitor service started successfully.
DvSum-Gateway-Monitor service is running.
Installing DvSum-Gateway-Python service...
Service "DvSum-Gateway-Python" installed successfully!
Set parameter "AppDirectory" for service "DvSum-Gateway-Python".
Set parameter "Start" for service "DvSum-Gateway-Python".
Set parameter "AppStdout" for service "DvSum-Gateway-Python".
Set parameter "AppStderr" for service "DvSum-Gateway-Python".
Set parameter "Description" for service "DvSum-Gateway-Python".
DvSum-Gateway-Python service installed successfully.
Starting DvSum-Gateway-Python service...
DvSum-Gateway-Python: START: The operation completed successfully.
DvSum-Gateway-Python service started successfully.
Instance metadata saved to C:\Users\Administrator\Desktop\KB\.dvsum-instance

------------------------------------------------------------
[OK] DvSum Gateway Installation and Configuration Complete
------------------------------------------------------------
Great news The setup process has finished successfully.

Here's what we've accomplished:
1. SSL has been configured for secure communication
2. DvSum Gateway services have been installed
3. All necessary services have been started

Next steps:
. Verify that the Gateway is accessible at: https://<your-domain>:<port>
. Check the logs at ./logs/SAWS.log for any important messages
. Refer to the DvSum documentation for post-installation tasks

If you encounter any issues or have questions, please contact
DvSum support at support@dvsum.com

Thank you for choosing DvSum Gateway

SSL option 2: Keystore Configuration

These settings define how the Java keystore is configured for SSL support.

 

# 2. Keystore Configuration
# ----------------------------------------
# Settings for the Java keystore that will hold the SSL certificates
dvsum.keystorePath=      # Path to the keystore file. If left blank, a default keystore will be created.
dvsum.keystorePass=      # Use a strong password.
dvsum.keyStoreType=      # Typically left blank. Defaults to JKS if not specified.
dvsum.alias=dvsum-gateway-cert   # Default alias used by the installer.

SSL Option 3 – Generate CSR and Private Key

Before running the installer, generate a private key and CSR.

Ensure OpenSSL is installed and available in your system PATH before running these commands.

openssl genrsa -out server.key 2048
openssl req -new -key server.key -out server.csr

Submit the generated server.csr file to your Certificate Authority (CA) to obtain a signed certificate.

After receiving the signed certificate, update the following properties in ssl_config.properties:

dvsum.serverCertPath=
dvsum.privateKeyPath=
dvsum.rootCertPath=          (optional)
dvsum.intermediateCertPath=  (optional)

 

Validate the Gateway

Follow these steps to verify if the installation succeeded.
1. Verify that the Gateway is accessible at:
  https://<your-domain>:<port>
  
2. Check the logs at:
  .\logs\SAWS.log

Interactive Installation

In an interactive installation, the installer will prompt you for all options and all properties that you need to provide.

Launch the installer

Use the following command to access the gateway setup file and proceed with installing and configuring the DvSum Gateway.

.\dvsum_gateway_setup.bat

The help command displays all the necessary commands required to operate with the gateway.

# Display detailed help
.\dvsum_gateway_setup.bat help

The API key and the Port Name are required; these must match the properties you used when defining the gateway above.

SSL Configuration Option

Four different options will be offered for SSL configuration. You will choose one of these options. All four options are explained below.

Generate a new certificate

Choice: 1

If you do not have an SSL certificate already, choose this option. This is the most common option for new users.

It will prompt you for all details needed to generate a certificate. Then it will generate a self-signed certificate that you can use immediately, as well as a certificate signing request (CSR) that you can use to obtain a CA-signed certificate later.

Add certificates to an existing keystore

Choice: 2

Use this option when you have a DvSum keystore from a previous installation and you have an updated certificate that you want to use.

You will be prompted for the keystore location and password as well as the certificate location.

How to Use Your CA-Signed Certificate:

1. A CSR file is utilized to obtain a CA-signed certificate from a Certificate Authority, such as GoDaddy or Digicert.
2. Once obtained, you will receive a folder containing the certificate, which includes four files as illustrated.


3. Copy these files and place them in the DvSum folder.
4. Once copied, open PowerShell and select option 2. 
5. Provide the path to the keystore (obtained in step 1).

After successful execution, the results can be observed by browsing to the gateway.

Create a new keystore with your certificate

Choice: 3

Use this option if you have a certificate and private key. The script will create a new keystore and save your certificate in the keystore.

Choice: 4

Use this option if you already have a keystore fully configured with the appropriate SSL certificate. The script will update the DvSum gateway to use this keystore.

All the information of the keystore is displayed, and the user is asked if it's the correct keystore; the configuration is completed accordingly.

Uninstall the Gateway

Use the following command to uninstall the gateway:

# Uninstall the gateway
.\dvsum_gateway_setup.bat uninstall

Note: After uninstalling the previous gateway, proceed with the new dvsum_gateway_setup.bat file in order to install the latest gateway.

Linux Installation

You can download the Gateway installer directly to your Linux server.

Download the installer

Run the following command:

curl -LOJ "https://apis.dvsum.ai/admin/account/saws/download-gateway?env=linux&app=dc"

What this command does:

  • -L → Follows redirects

  • -O → Saves the file using the original filename

  • -J → Uses the filename provided by the server

This command automatically resolves the correct installer version and saves it in the current directory. Manual filename extraction is not required.

Note: On SELinux-based distributions (such as Oracle Linux), install the application in the /opt directory or run the setup with sudo privileges.

Download to Desktop First (Optional)

If direct download to the Linux server is not permitted due to firewall or network restrictions:

  1. Run the same curl command on your desktop machine.

  2. Upload the downloaded .tar.gz file to the Linux server using SCP or another secure file transfer method.

Unzip the installer

# Create a directory for the Gateway
mkdir -p /home/my_user/dvsum_gateway

# Move the downloaded file to the Gateway directory
mv DvSum_*.tar.gz /home/my_user/dvsum_gateway/

# Navigate to the Gateway directory
cd /home/my_user/dvsum_gateway

# Extract the installer
tar -xvzf DvSum_*.tar.gz

Python Runtime

Before running the installation, make sure Python 3.9 or later is installed on the system.

Verify the installed Python version:

python3 --version

Expected output:

Python 3.9 or later

If Python is not installed, install it using the following steps.

  1. Navigate to the gateway folder:

cd <gateway-folder>

  1. Run the following commands to install Python and required packages:

sudo apt update
sudo apt install python3 python3-venv python3-pip -y

  1. If the Python virtual environment already exists, remove it and upgrade pip:

rm -rf python_service/venv
python3 -m pip install --upgrade pip

After completing these steps, proceed with the normal installation of the gateway services.

 

Non-interactive Installation

The non-interactive mode reads all relevant information from two properties files during the installation. This is the most common installation method.

Edit configuration.properties

  • Set the value for api.Key

  • Confirm the value for port

  • Confirm the value for python.service.port

  • Review all other properties — in most cases, no updates are needed.

  • dvsum.apiKey

  • dvsum.port

  • dvsum.pythonServicePort

Edit ssl_config.properties

The properties that you need to set in this file depend on the SSL option selected when running the script.

  • Generate a new certificate (SSL Option 1): complete sections 1 and 2.

  • Add certificates to an existing keystore (SSL Option 2): complete sections 2 and 3.

  • Create a new keystore with your certificate (SSL Option 3): complete sections  2 and 3.

  • Use an existing keystore with certificate and private key (SSL Option 4): complete all sections.

Comments on option 2: Keystore Configuration

These settings define how the Java keystore is configured for SSL support.

# 2. Keystore Configuration
# ----------------------------------------
# Settings for the Java keystore that will hold the SSL certificates
dvsum.keystorePath= # Path to the keystore file. If left blank, a default keystore will be created.
dvsum.keystorePass= # Use a strong password.
dvsum.keyStoreType= # Typically left blank. Defaults to JKS if not specified.
dvsum.alias=dvsum-gateway-cert  # Default alias used by the installer.

Comments on SSL Option 3 – Generate CSR and Private Key

Before running the installer, generate a private key and CSR:

openssl genrsa -out server.key 2048
openssl req -new -key server.key -out server.csr

Submit the generated server.csr to your Certificate Authority (CA) to obtain a signed certificate.

After receiving the signed certificate, update the following properties in ssl_config.properties:

dvsum.serverCertPath=
dvsum.privateKeyPath=
dvsum.rootCertPath=        (optional)
dvsum.intermediateCertPath= (optional)

Launch the installer

Use the following command to execute the gateway setup script and proceed with the installation and configuration of the DvSum Gateway automatically, without requiring any user interaction.

# In this example, Generate a cert (SSL Option 1) is selected.
./dvsum_gateway_setup.sh --ssl-option=1 --non-interactive

Validate the Gateway

Follow these steps to verify if the installation succeeded.
1. Verify that the Gateway is accessible at:
  https://<your-domain>:<port>
 
2. Check the logs at:
  ./logs/SAWS.log

Interactive Installation

In an interactive installation, the installer will prompt you for all options and all properties that you need to provide.

Launch the installer

Use the following command to access the gateway setup file and proceed with installing and configuring the DvSum Gateway.

./dvsum_gateway_setup.sh

Appendix

Using Port 443

Most customers prefer to open the standard port for https, 443, rather than opening port 8183. The simplest way to achieve this is to simply redirect traffic from port 443 to port 8183.

Ubuntu example

# Add the iptables rule.
sudo iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-port 8183

# Install iptables-persistent if not already present.
sudo apt-get update
sudo apt-get install iptables-persistent

# Save the current iptables rules
# and ensure they start on reboot.
sudo netfilter-persistent save
sudo systemctl enable netfilter-persistent

Monitor Gateway Health

After installing the gateway, administrators can monitor gateway performance, alarms, logs, and notifications from the Gateway monitoring interface.

See Gateway Monitoring for details.

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk