Menu

Parameters 2.1 Single Server Installation Guide for Linux (non-Docker)

To request installation assistance or to obtain the links to self-install, please click here to fill out the New Install Form.

In this guide, we will walk you through step by step to install qTest Parameters 2.1 on a CentOS/Ubuntu machine. Please go through the guide below thoroughly before starting your installations.

Before you begin

Most of the installation steps are performed on Terminal. It is highly recommended that you copy and paste the command/scripts to your Terminal and execute it.

1. Update system packages

1. Open Terminal

2. Make sure you perform all the installation steps as system user by executing following command

# sudo su

3. Execute following command to update and upgrade system packages

Ubuntu

# apt-get update -y && apt-get upgrade -y

CentOS

# yum check-update && yum update

2. Install MongoDB 3.4

qTest Parameters requires MongoDB 3.4 to be installed.  If you have already installed MongoDB 3.4, skip this step and jump to step #3. Otherwise, follow these instructions to install and configure MongoDB.

3. Install and Configure qTest Parameters

3.1. Download qtestctl

Note: 

  • If you are installing qTest Parameters in the same server with other qTest application, e.g. qTest Manager, then you do not need to re-download this installation package but use the one you downloaded when you installed qTest Manager. Otherwise, if you plan to install qTest Parameters on a separate server, follow steps below to download qTest Parameters
  • To learn more about qtestctl, refer to this article qTest OnPremise - Technical detail about qtestctl

Change to /usr/local directory, and start to download qTest Parameters

# cd /usr/local
# wget <DOWNLOAD LINK>

Extract downloaded package and navigate to the extracted folder

# tar xzvf <DOWNLOADED PACKAGE FILE NAME>
# cd qtestctl

3.2. Configure qTest Parameters

Edit qtest.config file using following command:

Ubuntu

/usr/local/qtestctl# vim qtest.config
Press insert to edit config file

CentOS

/usr/local/qtestctl# vi qtest.config
Press insert to edit config file

Now you can start edit qtest.config file.

3.2.1. Configure applications

If you are installing qTest Parameters on a separate server, make sure there is 'tdm' in apps list

apps = ['tdm']

If you are installing qTest Parameters on the same server with other qTest application(s), e.g. qTest Manager, append tdm to the app list.

apps = ['manager', 'tdm']

3.2.2. Configure database

Navigate to external section in qtest.config file as shown below then replace blue text with actual values. Only information listed out here needs to be updated. Other information should remain unchanged. 

external {
mongo {
host = '[MongoDB Server's IP or hostname]:[MongoDB Server Port]' // example: localhost:27017
replSet = 'rs0'
auth {
user = 'tdm' // this is the user name you created in step #3.2
pass = 'password' // this is the password you created in step #3.2
db = 'admin'
ssl = false
}
}

3.2.3 Configure SSL

If you want to deploy qTest Parameters with SSL, navigate to section common in qTest.config file as shown below then replace blue text with actual values. Only information listed out here needs to be updated, other information should remain unchanged.

  • enable: set to true to enable secured connection (HTTPS) between user browser and the server. Default value is false.
  • cert: absolute path to the certificate file on this server. Please use \\ or / in the path. It is mandatory if enable is set to true.
  • key: absolute path to the private key file on this server. Please use \\ or / in the path. It is mandatory if enable is set to true.
  • pass: passphrase of your certificate. This field is optional (default value is empty).
  • strict: set this to false to allow self-signed SSL certificate.
common {
ssl {
enabled = false
cert = "${path}/server.crt"
key = "${path}/server.key"
pass = ""
strict = false
}
}

3.2.4. Configure qTest Parameters

In qtest.config file, navigate to section tdm as shown below to configure qTest Parameters application. Replace blue text with actual values. Only information listed out here needs to be updated, other information should remain unchanged.

  • port: configure server port that qTest Parameters will be listening
  • qtest: configure qTest Manager application URL
    • host: qTest Manager URL
...
tdm {
port: [qTest Parameters Running Port]
...
qtest {
host = '[http or https]://[qTest Manager server's IP or hostname]:[HTTP port]' /* use https if SSL is enabled */
}
...
}

Press ESC and save the configuration with following command

:wq

4. Start qTest Parameters

Make sure qtestctl has 'execute' permission by enter following command

/usr/local/qtestctl# sudo chmod +x qtestctl

Next, enter following command to start qTest Parameters:

/usr/local/qtestctl# ./qtestctl start

start-parameters-ubuntu.png

5. Configure qTest Manager to connect to qTest Parameters

5.1 Login to your qTest Manager using a Site Administrator account.

5.2 Click into the Site Administration page then click on the tab SYSTEM CONFIGURATIONS.

5.3 In MISCELLANEOUS section, enter URL of qTest Manager

  • http://[qTest_Manager_IPAddress]:[Port] if you installed qTest Manager without SSL certificate
  • Or https://[qTest_Manager_IPAddress]:[Port] if you installed qTest Manager with SSL certificate.

qtest-server-domain.png

5.4 In PARAMETERS section, input the URL of your qTest Parameters server to Parameter URL field:

  • http://[qTest_Parameters_IP_Address]:[HTTP_Port] if you installed qTest Parameters without SSL certificate
  • https://[qTest_Parameters_IP_Address]:[HTTP_port] if you installed qTest Parameters with SSL certificate

qtest-connect-to-parameters.png

5.5 Click Test Connection and wait for qTest Manager to show a message "Connected to server successfully" then click Save to save the configuration.

6. Access to qTest Parameters

Follow these steps to validate that qTest Parameters was installed and configured successfully.

6.1 From qTest Manager's top navigation, access to qTest Parameters from nine box.

param-9box.png

6.2 The parameters home page will be shown as below.

parameters-homepage.png

7. Install qTest service

To enable qTest Parameters to automatically start on system startup, we need to install qTest service.

Note: if you plan to install qTest Parameters with other qTest Application(s) in the same server, you only need to execute install command once and only once when you finished installing all the applications in this server. Refer to this article to learn more about installing qtest service.

7.1 In the Terminal, press `ctl + c` if qtestctl is running

7.2 Execute below command to install qtest service

/usr/local/qtestctl# ./install

install-service-ubuntu.png

7.3 Verify that the service has been successfully installed with following command

# systemctl status qtest

If the installation was successful, you will see output that includes the text like below

verify-service-ubuntu.png

However, if you see:

Active: inactive (dead)

then enter following command to start the service

# systemctl start qtest

You have finished installing qTest Parameters on Linux (non Docker) environment.

Next Steps

Powered by Zendesk