QMetry Reports Offline Upgrade Document for Linux

In this guide, we will run you through upgrading QMetry Test Management Reports in your environment. These steps are to be followed on your QMetry Reports server hosted on the Linux machine.

Download Docker Image & Upgrade Files for QMetry Reports Upgrade

Follow these steps on the Internet-enabled machine on which the docker images of QMetry Reports is to be downloaded.

Step 1. Execute the following command. Next, it will ask for docker's credentials. Enter the required credentials. Please contact QMetry Support, if you do not have the credentials.

  • docker login

After entering docker credentials, it will show the success message as shown below. 

Step 2. Execute the following commands to pull QMetry Reports docker image from the docker repository.

  • docker pull qmetry/qmetry:reports_latest

 The download process is started. Wait till the time it gets finished.

After the process gets finished, it will display the message as shown.

Execute the following command to verify that docker image has been downloaded.

  • docker images  

Step 3. Execute the following command to save QMetry Reports docker image as .tar file. You can change the path of .tar file in the following command.

  • docker save -o /opt/QMetryReports.tar qmetry/qmetry:reports_latest

Step 4: Download Required Files.

You can generate a request on QMetry Support Portal to get the latest version of QMetry Reports Upgrade Files.

Step 5. Transfer the QMetryReports.tar and QMetryReportsUpgrade.zip  file to the QMetry Reports server.

Steps to upgrade existing QMetry Reports to the latest version

Upgrade Steps

Step 1. On QMetry Reports server, navigate to the directory where .tar file has been placed and execute the following command.

  • sudo docker load -i QMetryReports.tar

Step 2. Execute the following command to check whether the docker images have been restored correctly or not.

  • sudo docker images

Step 3. Check the container name using the following command

  • sudo su

  • docker ps -a --format "table {{.ID}}\t{{.Names}}\t{{.Image}}"

Step 4. Go to the Upgrade Zip file location where you have placed QMetryReportsUpgrade.zip.

  • Unzip QMetryReportsUpgrade.zip

    • unzip QMetryReportsUpgrade.zip 

  • Go to QMetryReportsUpgrade folder

    • cd QMetryReportsUpgrade/

Step 5. Modifying the container name.

Here, if the QMetry Reports Container name is different than 'qmetry-reports', then please perform Step 5. Otherwise, you can skip the step.

  • Open the file – upgrade.sh in edit mode.

    • vi upgrade.sh

  • Update the file for changed value with the respective name of the container

    • Press i to change the file mode to insert

    • Update the variable value according to docker container name which exist in upgrade.sh file

      • OLD_CONTAINER_NAME=<existing docker container’s name>

    • Press Esc, and type :wq to save the changes

Step 6. Give permission to upgrade.sh file through the following commands.

  • chmod +x upgrade.sh

  • sh upgrade.sh

The next question during the upgrade process will be as follows.


Allowed Values

Default Value

Recommended Value


Allowed Values

Default Value

Recommended Value

Do you want to make an online installation (Y/N)?

Y, y, N, n


Enter “N to begin the offline upgrade.

Step 7. While running the script it will ask for verifying the QMetry App Database and QMetry Reports Database connection configurations that were in place earlier and take the next step accordingly.

  • Press ‘y’ – If the database configurations shown are correct and don’t want to modify anything in that.

  • Press ‘n’ – If the database configurations shown are incorrect and want to change anything in that.

    • You will be asked to enter the new configuration details.

  • Press ‘e’ – If you don’t want to continue the upgrade process and want to exit.

If you have pressed ‘y’ or ‘n’ then in that case after pressing an option you will be asked to enter the number of CPU’s and Memory to allocate .

Once that is entered wait for the script execution to complete.

Note: Depending on your data this process can take time as it will be performing full data QMetry Data Sync. Users can continue to use QMetry Application during this time. But, QMetry custom reports remain inaccessible when syncing in progress.


If you are facing any issues during the upgrade process, kindly generate a support ticket on Support Portal for assistance.