Setup

Documentation
Setup
API
Change log
Downloads

Setting up the DQM

Starting the DQM

Prerequisites

The DQM is a web based application hosted on a local server or cloud. 
There a two deployment options:


Docker container


Java WAR file

The minimum requirements for the server or cloud instance hosting the application are as follows:
CPU: 2 core
RAM: 4GB
HDD: A minimum of 10GB of free space

Note: When hosting application from WAR file, Java 8 is required (openJDK8)

Deploying/updating the DQM using WAR file

Download the latest version of WAR from https://litech.app/downloads/
To run WAR application, use command:

java -XX:TieredStopAtLevel=1 -Dspring.jmx.enabled=false -Xmx3g -Dserver.port=8090 -jar LiTech_DQM_2022.1.war

-Xmx3g – Specifies the amount of memory that can be used by Java – in this case 3GB
-Dserver.port=8090 – Defining DQM’s machine port

It is recommended to run the Java file as a service.
Java application as a service on Ubuntu
Java application as a service on Windows

Deploying the DQM using docker image

For hosting your application on your cloud instance, make sure you have a connection to docker hub 

  1. Docker pull LiTech tester image:
docker pull litech/tester:2022.1

Note: the version might be updated since this documentation was made. Please check https://hub.docker.com/repository/docker/litech/tester 

  1. Run DQM container:

Note: “-e JAVA_OPTIONS=’-Xmx3g’” is optional. It is recommended to specify maximum heap size (3GB recommended)

docker run -d
-v {local_path}/logs:/usr/app/logs        
-v {local_path}/database:/usr/app/database
-v {local_path}/drivers:/usr/app/drivers
-v {local_path}/keys:/usr/app/keys                    
-p 8090:8090 
-e –server.port=8090 
-e JAVA_OPTIONS=’-Xmx3g’
{image_id}

-v {local_path}/logs:/usr/app/logs
Mapping of logs folder for DQM user and SQL log files. Needed for persisting logs.

-v {local_path}/database:/usr/app/database
Mapping of database folder for local database files. Needed for persisting local database.

-v {local_path}/drivers:/usr/app/drivers  
Mapping of drivers folder for JDBC driver files. Needed for persisting JDBC drivers uploaded to DQM.

-v {local_path}/keys:/usr/app/keys  
Mapping of keys folder for certificates. Needed for persisting all certificates uploaded to DQM.

-p 8090:8090
Mapping of DQM port 8090 to machine port 8090

-e –server.port=8090
Defining DQM machine port (By default container port will be 8090, this wont be needed)

{image_id}
Image id for “litech/tester” image. You can also directly use image name “litech/tester:2022.1”

  1. Validate that DQM container is running:
docker ps
  1. If the container is now up and running, you have successfully started the DQM

Updating from older image

Easiest way to keep container updated is just killing old container and running new one with new version

docker run {run_parameters} litech/tester:{version}
  1. Pull the new docker image
docker pull litech/tester:2022.1
  1. Kill the older docker container (data is kept because you have already mapped your volumes).
docker kill {container_id}

Note: You can get container id with “docker container ps –all”

  1. (Optional) Remove the old container.  You might want to keep it as a backup if the newer version has some unexpected errors.
docker rm {container_id}
  1. Run the new pulled container. See chapter Deploying the DQM using docker image

Configuration

Logging in for the first time

The DQM is available from your machine address with specified port:
http://localhost:8090

Please use Chrome web browser to access the DQM.

Use default credentials to log in for the first time:

Username: admin
Password: admin
  1. Log in using provided credentials (you will be redirected to the License page. See chapter Setting up license)
  2. After logging in, change admin password in Settings -> Users:
This image has an empty alt attribute; its file name is ouA3lsbtYdFRY2uo9riwKRHqhtowVZmG9MImrL553M9c1FIZPGKgg-MCEl0c6UmC2jBQ45oUvMIttJYlEq4df1OGROlw8ueS34r2KKRqJA55Qu3gmnSyyif3wzH2A9KVWs5UTsJ2
  1. Click “Save changes”

Setting up license

  1. Navigate to Settings -> License
  2. Insert your license key and click “Save license”
  3. Your license information should now be displayed and can be accessed by navigating to Settings -> License

Adding JDBC drivers

  1. Navigate to Settings -> Drivers
  2. Press the “Add new driver” button
  3. Choose driver type and select the driver’s JDBC JAR file to be used
  1. Click “Add new driver” button
  2. Click “Initialize drivers” button 
  3. DQM will restart and initialize added drivers
  4. Check that added driver status is OK

If the status check fails then please check that the correct driver file is uploaded.

  1. New connections can now be added using the selected driver.