Back to QMetry All Products Help Page
QMetry and Reports Offline Installation on Linux - 2 Tier
In this guide we'll run you through installing QMetry Test Management application and QMetry Reporting Tool on a server without an internet connection.
This installation installs QMetry over Apache Tomcat 9.x and Open JDK 11 in a docker container.
Pre-requisites
1. Following should be installed on the server
- CentOS, RHEL-7 and RHEL-8
- Docker Version 20.10.4
- Docker Compose Version 1.22.0
- Yum-tools
2. Two Linux Servers are required: One for QMetry Application and the other for QMetry Reporting.
3. Refer QMetry Deployment Document for the hardware requirements.
4. All the servers should have the support of these commands: unzip, yum and curl.
5. Application and Report servers should be in the same network. Report Server should be able to communicate with Application Server over 80/443 and Database Server 3306/DB Port. Ports 8080 and 33061 should be enabled/open on Reports Server to allow connections from the QMetry application server.
6. Docker installation requires root user access. To install using a non-root user, follow the steps specified here before starting the install on both QMetry and Report servers.
7. Docker is installed under /var/lib/ directory. We recommend allocating enough space here to ensure QMetry has enough space to save your data.
- Data of QMetry database is saved under : /var/lib/docker/volumes/qmetry_mysql_data/_data
- Data of QMetry attachments added is saved under : /var/lib/docker/volumes/qmetry_attachment/_data
8. Get the following files from QMetry Support: QMetryApp.zip, QMetryApp.tar, QMetry-db.tar, QMetryReport.zip, QMetryReports.tar, QMetry-Reports-db.tar for installation.
9. Post installation, QMetry Application and QMetry Report both should be configured either on https or http.
10. If you are planning Jira integration with QMetry and Jira is running on https, make sure your QMetry is also running over https protocol. QMetry and Jira should run on the same protocol.
11. Following Ports should be open:
Installation | Ports that need to be enabled and should be available for use |
|---|---|
| QMetry Application | 80/443 & 3306 |
| QMetry Reporting Tool | 80/443, 8080 & 33061 |
Installing QMetry Application
Hardware Requirements
Supported OS: Linux - CentOS 7 and 8, RHEL 7 and 8
| Small Teams < 50 Users | Medium Teams < 500 Users | Large Teams 500+ Users | |||
| Min | Recommended | Min | Recommended | Min | Recommended |
| Stand Alone Server | |||||
CPU | 2 Cores | 4 Core | 8 Core | 12 Core | 16 Core | 24 Core |
Memory | 8 GB | 16 GB | 16 GB | 24 GB | 24 GB | 32 - 64 GB |
HDD (Free Space) | 100 GB | 250 GB | 100 GB | 500 GB | 100 GB | 500 GB |
Step 1. Download the below file images from the links provided by QMetry Support and save them in a directory on the server.
- QMetryApp.tar
- QMetry-db.tar
- QMetryApp.zip
Step 2. Go to the directory where the download images are saved and execute the commands in the below steps.
Step 3. Execute the below commands to ensure the docker containers auto start during system reboot.
- sudo systemctl start docker
- sudo systemctl enable docker
Step 4. Load both Docker Images
- sudo docker load -i QMetry-db.tar
- sudo docker load -i QMetryApp.tar
- sudo docker images
Step 5. Navigate to the directory where QMetryApp.zip file is kept and execute the following commands.
- unzip QMetryApp.zip
Step 6. Execute the following commands.
- cd QMetryApp
- sudo su
- sh +x qmetry.sh
Step 7. Once the script finishes executing, it will prompt to enter the following parameters:
Options | Details | Default Value | Example |
Enter QMetry Database Schema | QMetry Application Database schema name. | qmetry | qmetry |
Enter QMetry Database Password (root user) | Enter QMetry Application Database Password for the root user. | - | QMetry@123 |
Enter QMetry User (admin) Email (admin user) | Enter QMetry user email address for Admin. | - | |
Enter QMetry User (admin) Password | Enter QMetry user password for Admin. | - | Admin@123 |
Enter Min. Heap Memory for the webserver | Enter Heap Memory in GB(s) | 2 | 2 |
Enter Max. Heap Memory for the webserver | Enter Heap Memory in GB(s) | 4 | 4 |
Enter QMetry Database Connection Pool Size | Enter Pool Size in number format | 100 | 100 |
The installation may take a while.
After successful installation of QMetry Application, you will see the message "QMetry Application Installation is complete".
Once the installation is complete, execute the following command.
- docker ps
The docker containers installed will be shown along with their container IDs and names.
Step 8. Getting your QMetry License and Installing it.
- For users evaluating QMetry
- You should have received an evaluation license valid for 30 days along with the installation.
- Follow the Steps to Apply License file.
- For users requiring commercial license
- Server's domain name and mac address are required to generate your QMetry License. Follow the below steps to get your server mac address and send this information along with the domain name to QMetry Support to get your QMetry License generated. Send an email to qtmprofessional@qmetrysupport.atlassian.net to reach QMetry Support.
- Execute the below command to get your server mac address. Then send the MAC address to QMetry Support to receive the license file.
- ifconfig (MAC address of Ethernet card e.g. eth0/eth1 )
- Once you receive license.key from QMetry Support, you can follow the Steps to Apply License file.
- Execute the below command to get your server mac address. Then send the MAC address to QMetry Support to receive the license file.
- Server's domain name and mac address are required to generate your QMetry License. Follow the below steps to get your server mac address and send this information along with the domain name to QMetry Support to get your QMetry License generated. Send an email to qtmprofessional@qmetrysupport.atlassian.net to reach QMetry Support.
Step 9. Access QMetry application using the following address.
http://<your IP Address OR Domain Name>
Default QMetry login credentials.
- Username: admin
- Password: <user specified password in Step # 7>
Note : With installation, MySQL 5.7 will be installed on port 3306. Below are the details
- Username : root
- Password : <user specified password in Step # 7>
- Schema : qmetry
Step 10. After the above steps are completed, log into QMetry application.
- Go to "Admin" Profile and Edit the Profile.
- Update Email of Admin in the Email field.
- Enter the Base URL as your QMetry URL.
Step 11. Additional Tomcat Configuration: QMetry is installed with a default configuration of minimum and maximum heap memory utilization. You can modify these settings depending on your hardware configuration. Refer Additional Configuration for more details.
Installing QMetry Reports
Hardware Configurations Recommended
Supported OS: Linux - CentOS 7 and 8, RHEL 7 and 8
Server Configurations | Small Teams < 50 Users | Medium Teams < 500 Users | Large Teams 500+ Users | |||
| Stand Alone Server | ||||||
| Min | Recommended | Min | Recommended | Min | Recommended |
CPU | 4 Cores | 4 Core | 8 Core | 16 Core | 16 Core | 24 - 32 Core |
Memory | 8 GB | 16 GB | 16 GB | 24 GB | 32 GB | 32 - 64 GB |
HDD (Free Space) | 100 GB | 250 GB | 50 GB | 100 GB | 50 GB | 500 GB |
Step 1. Download the below file images from the links provided by QMetry Support and save them in a directory on the server.
- QMetryReports.tar
- QMetry-Reports-db.tar
- QMetryReport.zip
Step 2. Go to the directory where the download images are saved and execute the commands in the below steps.
Step 3. Execute the below commands to ensure the docker containers auto start during system reboot
- sudo systemctl start docker
- sudo systemctl enable docker
Step 4. Load both Docker Images
- sudo docker load -i QMetry-Reports-db.tar
- sudo docker load -i QMetryReports.tar
Execute the command to check whether the Repository is created.
- sudo docker images
Step 5. Navigate to the directory where QMetryReport.zip file is kept and execute the following commands.
- unzip QMetryReport.zip
Step 6. Execute the following commands.
- cd QMetryReport
- sudo su
- sh +x qmetry.sh
Step 7. Once the installation initiates, it will prompt to enter the following parameters:
Options | Details | Default Value | Example |
Enter Report Database Password (root user) | Enter password for QMetry Reports Database. | - | QMetryreports@!Nf0# |
Enter Report Database Schema | Enter Database schema name for QMetry Reports Database. | qtmanalytics | qtmanalytics |
Enter Number of CPU's to allocate | Allocate 3/4th of the available CPUs. For example, if CPU has 8 cores, enter 6 To check total CPUs, run the command : lscpu | 4 | 6 |
Enter Memory to allocate in GB(s) | Entered memory would be used by the sync job while running full sync of data. Enter 3/4th of total memory available on the server. For example, if the memory on the server is 24 GB, enter 18 | 4 | 18 |
Wait for the script file to finish executing.
Once the script finishes executing it will prompt to enter the following parameters.
Options | Details | Example |
Enter Mysql Database Host IP / DNS Name (Qmetry) | Enter Database Host Public IP/DNS of QMetry application. | 10.10.11.100 |
Enter Mysql Database Port (Qmetry) | Enter Database Port of QMetry application. If it is unchanged, use "3306" as Database port. | 3306 |
Enter Mysql Database Schema (Qmetry) | Enter Database schema name of QMetry application. | qmetry |
Enter Mysql Database Username (Qmetry) | Enter Database username of QMetry application. If it is unchanged, use "root" as username. | root |
Enter Mysql Database Password (Qmetry) | Enter Database password of QMetry application. | QMetry@123 |
Enter Mysql Database Host IP / DNS Name (Reports) | Enter Database Host Public IP/DNS of QMetry Report. If it is unchanged, enter 'qmetry-reports-db' as Database Host. | qmetry-reports-db |
Enter Mysql Database Port (Reports) | Enter Database Port of QMetry Report Database. If it is unchanged, enter "3306" as Database Port. | 3306 |
Enter Mysql Database Schema (Reports) | Enter Database schema name of QMetry Reports Database. | qtmanalytics |
Enter Mysql Database Username (Reports) | Enter Database username of QMetry Reports Database. If it is unchanged, use "root" as username. | root |
Enter Mysql Database Password (Reports) | Enter Database password of QMetry Reports Database. | QMetryreports@!Nf0# |
Enter Port To Start SyncJob (Reports) | Reports Sync Job runs from this port - 8080 | 8080 |
Do you want to Run Force Sync Now? (y/n) | Enter y to sync all the QMetry data to Reports Database with the current script. → Always enter y at the time of fresh reports install | Y |
Enter Memory to allocate in GB(s) to Spark | Entered memory would be used by the sync job while running full sync of data. Enter 3/4th of total memory available on the server. For example, if the memory on the server is 24 GB, enter 18 | 18 |
After successful installation of QMetry Report, you will see the message "QMetry Report Installation is complete".
Wait for about 2 minutes - docker ps command should give output as follows:
Step 8. Login to QMetry with 'admin' user login, and configure the reports server URL in the configuration menu
Go to QMetry > Customization > Insight Configuration
- Under Database Configurationtab
- Enter Host: Reports Server Host Public IP/DNS
- Enter Port: 33061
- Enter Username: root
- Enter Password :<user specified password in Step#7>
- Enter Database Name: <user specified Database name in Step#7>
Click Test to ensure successful connection and then hit "Test & Save".
- Under Sync Data tab, set up the Report Data Sync from your reports server to QMetry Reporting.
- Report Server URL : This should be set to your report server domain URL followed by port 8080 as shown below. Ensure port 8080 is open on the reports server.
- Click on Test to ensure successful connection and then hit "Test & Save".
- Hit "Sync Data" to start Reports Data Sync.
Note : "Sync Data" is required the first time after reports installation. Time taken to sync depends on the amount of data in QMetry. Sync Progress and Status can be monitored as shown in the below screenshot. QMetry custom reports remain inaccessible during sync and It is recommended to be run only during off-peak hours.
Users can start using QMetry Reports when the sync is completed. QMetry remains available during this time.
If you are facing any issues during the installation process, kindly generate a support ticket on Support Portal for assistance.
Back to QMetry All Products Help Page