QMetry and Reports Installation on Linux - 3 Tier
This guide describes how to install QMetry Database, QMetry application and QMetry Reporting in a 3-tier Linux environment.
QMetry runs in Docker containers on Apache Tomcat 11.0.5, MySQL 8.4.8, and OpenJDK 17.0.2.
3 Tier Installation
The three-tier deployment uses three Linux servers. The following table lists the role of each server.
3 Tiers | Installations |
|---|---|
Server 1 | QMetry Application |
Server 2 | QMetry Reports |
Server 3 | QMetry Database |
Pre-requisites
Confirm every item below before you begin. For details, see the Pre-requisites for QMetry Application and Report Server Installation document
Prerequisite | What to confirm |
|---|---|
Operating System | Linux - CentOS 7 and 8, RHEL 8, 9, and 10, Ubuntu 24.04 |
Required commands | unzip, curl, wget, vim and docker are installed on every server. |
Installation files | You have the |
Security Protocol | Configure both the QMetry application and Reports on the same protocol, either HTTPS or HTTP. If you integrate with Jira over HTTPS, run QMetry on HTTPS as well. Both must use the same protocol. |
Root access | Docker installation requires root user access. For non-root user, refer to Installing QMetry as a Standard User. |
Storage | Docker stores data under /var/lib/ by default; the installer also asks for a QMetry data location. Ensure both directories have enough disk space. |
Required Ports
Open and reserve the following ports for each component. Confirm that ports 80, 443, and 3306 are free and not in use by other applications on their respective servers.
Component | Ports |
|---|---|
QMetry database server | 3306 |
QMetry application | 80/443 |
QMetry Reporting tool | 80/443, 8080, and 3306 |
The application server and the report server can communicate over ports 80 and 443, and with the database server over port 3306 (or your configured database port).
Open ports 8080 and 3306 on the Report server so the Application server can connect.
Confirm the Application server can reach the Report server on port 3306.
Install the QMetry Database
To install the QMetry database, perform the following steps:
Extract installation files
Copy the QMetry_Linux_Installer.zip file that you received from QMetry Support to the database server. Go to the directory that contains the file and run the following command.
unzip QMetry_Linux_Installer.zip
Run the installer
cd QMetry_Linux_Installer sudo su chmod +x install.sh ./install.sh
Online Upgrade Prompt
Options
Allowed Values
Default Value
Recommended Value
Do you want to make an online installation (Y/N)?
Y, y, N, n
Y
Y
Docker Verification
Enter the docker credentials shared as a part of the installation package.
Main Installation Menu
Enter 1 to install the QMetry database.
Specify the Application Database Password
Options
Details
Example
Enter QMetry database password for root user
Enter QMetry Application Database Password for the root user.
QMetry@123
Grant permissions to root user
docker exec -it qmetryapp_db bash mysql -uroot -p; GRANT ALL PRIVILEGES ON *.* TO 'root'@'%';
Once the script executes, check if MySQL docker is available with the name: qmetryapp_db - when you run the docker ps command.
Note
MySQL 8.4.8 is installed on port 3306 with username 'root' and password as specified in step 6.
Install QMetry Application
To install QMetry Application, perform the following steps:
Note
Recommended: Back up the application data directory on a regular schedule. Periodic backups help prevent data loss if a disaster occurs.
Extract the installation files
Copy the QMetry_Linux_Installer.zip file that you received from QMetry Support to the server. Go to the directory that contains the file, and run the following command.
unzip QMetry_Linux_Installer.zip
Run the installer
cd QMetry_Linux_Installer sudo su chmod +x install.sh ./install.sh
Online Install Prompt
Options
Allowed Values
Default Value
Recommended Value
Do you want to make an online installation (Y/N)?
Y, y, N, n
Y
Y
Docker Verification
The script runs docker.sh to verify Docker installation and prerequisites are met. Enter the docker credentials shared as a part of the installation package.
Main Menu Installation
The installer then displays the QMetry Installation Menu. Enter 2 to install the QMetry application.
Specify the application data directory
Enter a directory path on the host machine to store QMetry data such as attachments, licenses, imports, and exports. You can specify any valid path, and the installer creates the directory automatically if it does not exist.
Options
Example
Please enter QMetry application directory
/opt/QMetry_Linux_Installer
Enter the configuration parameters
Options
Details
Default Value
Example
Enter QMetry database hostname
Enter QMetry Database Host as DNS/IP Address
localhost
192.168.0.100
Enter the QMetry database port
Enter QMetry Database Port. If it is unchanged, use "3306" as the Database port.
3306
3306
Enter QMetry database schema
QMetryApplication Database schema name.
qmetry
qmetry
Enter QMetry database username
Enter the Database's Username.
-
root
Enter QMetry database password for root user
Enter QMetryApplication Database Password for the root user.
-
QMetry@123
Enter Email for QMetryadmin user
Enter QMetryuser email address for Admin.
-
Enter password for QMetry admin user
Enter QMetryuser password for Admin.
-
Admin@123
Enter Min. Heap Memory for the web server in GB
Enter Heap Memory in GB
2
2
Enter Max. Heap Memory for the web server in GB
Enter Heap Memory in GB
4
4
Enter QMetryDatabase Connection Pool Size
Enter Pool Size in number format
100
100
The installation may take a while. When it finishes QMetry displays the message "QMetry Application Installation is complete".
Verify Running Containers
docker ps
Get QMetry License and Install it
Choose the option that matches your license type.
For users evaluating QMetry: Use the evaluation license, valid for 30 days, that you received with the installation.
For users requiring a commercial license
QMetry Support needs your server's domain name and MAC address. Find the MAC address with ifconfig, then email both to qtmprofessional@qmetrysupport.atlassian.net.
Access the Application
Open the application in a browser: http://<IP Address or Domain Name>
Log in with the Default QMetry credentials.
Username: admin
Password: <user specified password in Step # 7 >
With this installation, MySQL 8.4.8 is installed on port 3306, with username root, password and schema specified in step 7.
Update the administrator profile
After the above steps are completed, log into QMetry application.
Go to "Admin" Profile and Edit the Profile.
Update the administrator email address in the Email field.
In the Base URL field, enter your QMetry URL.
Select Update.
Configure additional Tomcat settings
QMetry installs with a default configuration for minimum and maximum heap memory. You can adjust these settings to match your hardware configuration. For more information, refer to Additional Configuration for more details.
Install QMetry Report
If you have purchased Advanced Reporting then you will need a separate server for QMetry Reporting.
Note
Reports installation require Redis Server and ActiveMQ Server. Refer to the Redis and Automation installation sections for setup steps.
Pre-requisites
Before you install QMetry reports, verify the following requirements.
QMetry App is installed and running.
QMetry App DNS/IP is configured in profile section.
Active MQ and Redis containers are running and configured in QMetry App properly.
Redis Container should be up and running and configured in QMetry App.
The services are reachable from the report server: Redis (6379), ActiveMQ (61616, 8161), App (80, 443), App DB (3306).
Steps for QMetry Report Installation
To install QMetry Reports on the second server, perform the following steps:
Get the installation zip file
Connect to the report server, upload QMetry_Linux_Installer.zip to /opt, and extract it:
sudo su - cd /opt unzip QMetry_Linux_Installer.zip cd QMetry_Linux_Installer/
Run the reports installer
chmod +x install.sh ./install.sh
Online Upgrade Prompt
Options
Allowed Values
Default Value
Recommended Value
Do you want to make an online installation (Y/N)?
Y, y, N, n
Y
Y
Docker Verification
Enter the Docker credentials shared by Support Team with installation package.
Main Installation Menu
Enter 3 to install QMetry Reports.
Enter the report configuration parameters
Options
Details
Example
Enter App Database Host URL
Enter Database Host Public IP/DNS of QMetry application.
10.0.8.166
Enter App Database Port
Enter Database Port of QMetry application.
3306
Enter App Database Username
Enter Database username of QMetry application.
root
Enter App Database Password
Enter Database password of QMetry application.
root
Enter App Database Schema Name
Enter Database schema name of QMetry application.
qmetry
Enter Report Database Host URL
Enter Database Host Public IP/DNS of QMetry Report.
10.0.8.221
Enter Report Database Port
Enter Database Port of QMetry Report Database.
3306
Enter Report Database Username
Enter Database username of QMetry Reports Database.
root
Enter Report Database Password
Enter Database password of QMetry Reports Database.
root
Enter Report Database Schema
Enter Database schema name of QMetry Reports Database.
qtmanalytics
Enter MQ URL
Enter MQ Active URL
tcp://10.0.8.166:61616
Enter MQ UserName
Enter MQ Username
admin
Enter MQ Password
Enter MQ Password
admin
Enter maximum memory to allocate for CDC app in GB
Maximum memory allocation for the CDC container:
Entered memory would be used by the sync job while running full sync of data.
Enter 25% of total memory available on the server. For example, if the memory on the server is 24 GB, enter 6.
A minimum of 4 GB memory must be allocated.
To check the total memory, run the command: free -h
4
Enter maximum memory to allocate for Sync app in GB
Maximum memory allocation for the Sync container:
Entered memory would be used by the sync job while running full sync of data.
Enter 70% of total memory available on the server. For example, if the memory on the server is 24 GB, enter 17.
A minimum of 8 GB of memory must be allocated.
To check the total memory, run the command: free -h
4
Enter number of CPU’s to allocate for CDC app
Number of CPUs to allocate for the CDC container. (The default is 4)
4
Enter number of CPU’s to allocate for Sync app
Number of CPUs to allocate for the Sync container:
Allocate 70% of the available CPUs. For example, if CPU has 8 cores, enter 6.
A minimum of 4 CPU cores must be allocated.
To check total CPUs, run the command : lscpu
4
After QMetry creates the containers, the system runs a full sync. When the script finishes, QMetry displays the message "QMetry Report installation is complete".
Update the Base URL
Log into QMetry and go to your Profile section, edit the Base URL with QMetry app URL. When the full sync is complete, exit the installation by entering 0.
Configure the database connection
Login to QMetry with administrator credentials and go to Customizations.
Select Insight Configuration and open Database Configuration tab.
Under Database Configuration tab, enter the following details:
Host: Enter Report Database Host URL from the report configuration table.
Port: 3306
Username: <Enter Report database username>
Password : <Enter Report database password>
Database Name: <Report DB schema specified during installation>
Select Test to confirm a successful connection, and then select Test & Save.
Set up the report data sync
On the Sync Data tab, set up the Report Data Sync from your reports server to QMetry Reporting.
Report Server URL: Enter your report server domain URL followed by port 8081. Confirm that port 8081 is open on the report server.
Select Test to confirm a successful connection and then select Test & Save.
Note
Run Sync Data once, right after installing Reports. Sync time depends on data volume; custom reports are unavailable while it runs, so sync during off-peak hours. QMetry itself stays available.
Start using QMetry Reports when the sync is completed. QMetry remains available during this time.
Install Redis Caching Server
Redis caching improves overall performance and scalability. To install the Redis server, refer to Installing Redis Caching Server.
Install Automation API Features
The Automation API adds several automation API related features to on-premise QMetry installations, including faster automation result files. To use it, refer to Installation for Automation API.
Get support
If you are facing any issues during the installation process, kindly generate a support ticket on Support Portal for assistance.