In this guide, we will walk you through step by step to install qTest Sessions v3.0.9 on a separated Windows machine. Please go through the guide below thoroughly before starting your installations.
IMPORTANT: qTest Sessions v3.0.9 only works with qTest Manager v8.4+
Before you begin
A. Install and configure prerequisite packages
Prerequisite packages must be installed and running prior to qTest Sessions installation.
1. Install and Configure PostgreSQL
1.1 Download and Install PostgreSQL 9.5
qTest Sessions requires PostgreSQL 9.5 that you can download it here. After downloading, double click on the downloaded file and follow the installation wizard to install it.
When installation completes, verify that the PostgreSQL service is running by following below steps:
- Open command prompt and type services.msc to open Services window
- On Services window, look for the service named postgresql-x64-9.5 and make sure its Status is Running and its Startup Type is set to Automatic, as shown in below screenshot:
1.2 Configure PostgreSQL
After installing PostgreSQL, you need to enable remote access to PostgreSQL database server by doing following steps:
1.3 Create qTest Sessions database
After PostgreSQL has been successfully installed and configured, you will need to create a database schema. It will be used when installing qTest Sessions.
- Open the console on your machine. Change the current path to PostgreSQL installation directory:
C:\Users\SampleUser>cd C:\Program Files\PostgreSQL\9.5\bin
- Create a database schema using the command below:
createdb -h [YOUR_POSTGRES_SERVER_IP_ADDRESS] -p [YOUR_POSTGRES_SERVER_PORT] -U postgres -W [YOUR_DATABASE_NAME]
C:\Program Files\PostgreSQL\9.5\bin>createdb -h 192.168.74.77 -p 5432 -U postgres -W sessions //postgres is the username and sessions is the schema name
Password: [POSTGRES_PASSWORD] //enter password of user postgres
- Connect to the database:
C:\Program Files\PostgreSQL\9.5\bin>psql -h 192.168.74.77 -U postgres -W sessions
Password for user postgres: //enter your password here
WARNING: Console code page (437) differs from Windows code page (1252)
8-bit characters might not work correctly. See psql reference
page "Notes for Windows users" for details.
Type "help" for help.
- List out existing schema to verify if the above one has been successfully created:
sessions database has been created and listed.
List of databases
Name | Owner | Encoding | Collate |
Ctype | Access privileges
postgres | postgres | UTF8 | English_United States.1252 | English_United States.1252 |
template0 | postgres | UTF8 | English_United States.1252 | English_United States.1252 |
sessions | postgres | UTF8 | English_United States.1252 | English_United States.1252 |
- Quit thepsql program.
2. Install and Configure Redis
2.1 Install Redis
qTest Sessions requires Redis version 2.8+ installed. You can click here to download.
After you have downloaded the package, extract it to a folder on your machine. For example: C:\redis-2.8.17.
2.2 Configure Redis
In the extracted folder, open file redis.windows.conf. Search and update the following lines:
- # maxheap
Remove the # and specify a max heap size. The size is half the volume of your server RAM. For example, if your server's RAM is 8GB, then:
- # heapdir
Remove the # and specify heap directory path. Please make sure the directory's free space should be larger than [Total RAM + 2*maxheap]. For example:
heapdir "C:\Redis Heap"
Open your console. Change the current path to C:\redis-2.8.17. Execute the following command to install Redis as a Windows service:
C:\redis-2.8.17>redis-server --service-install redis.windows.conf --loglevel verbose
2.3 Start Redis service
- By default, Redis runs on port 6379. Make sure that the port is available and the port is not blocked by your firewall.
2.4 Verify Redis has been installed successfully on your machine:
- Open command prompt and type services.msc to open Services window
- On Services window, look for the service named Redis and verify that its Status is Running and its Startup Type is set to Automatic, as shown in below screenshot
3. Install and Configure Elasticsearch
3.1 Install Elasticsearch
qTest Sessions requires Elasticsearch version 1.7.3 installed. Click here to download Elasticsearch.
- Elasticsearch 1.7.3 requires Java SDK installed and $JAVA_HOME environment variable must be configured properly. Click here for the instruction to download, install and configure $JAVA_HOME environment variable
After downloading Elasticsearch, extract the downloaded package to a directory on your computer. For example: C:\elasticsearch-1.7.3
From the Console, access to the bin directory (C:\elasticsearch-1.7.3\bin) and run the following command to install the Elasticsearch service:
3.2 Configure Elasticsearch
- Open command prompt, type services.msc and press Enter
- On Services window, look for a service named Elasticsearch 1.7.3 (elasticsearch-service-x64). Right click on the service and select Properties
- From Elasticsearch 1.7.3 (elasticsearch-service-x64) Properties window, set `Startup type` field to Automatic, then click OK button.
- By default, Elasticsearch's HTTP and TCP ports are respectively 9200 and 9300. Make sure that the ports are available and not blocked by your firewall.
B. Install and Configure qTest Sessions
1. Install qTest Sessions
- Click download qTest Sessions 3.0.9. Once download completed, double click on the downloaded installer to start the installation
- Click the Next button to review our EULA document before proceeding
- Select the option "I accept the terms in the License Agreement." Then click the Next button to move on to the next page, in which you will be given 2 options to perform the installation:
- Express install: This will allow you to install with default installation directory and Start menu folder
- Custom install: This will allow you to manually select the installation directory and Start menu folder
- Select the Express install option, then click on Next to review the default Installation settings as illustrated below. If you would like to change these settings, click Back to return to the previous screen and select Custom install
- Once you accept with the default settings (or enter custom settings), click on the Install button to let the installer start extracting files into the installation directory
After the files are extracted, you will be allowed to specify web server ports for qTest Sessions
By default, the Configuration Wizard has already indicated 4 port numbers for HTTP, Admin, AJP and HTTPS ports as follows:
- HTTP port: 8080
- Admin port: 8005
- AJP port: 8009
- HTTPS port: 8443
However, you can freely define your own ports depending on security rules of your network by selecting Use custom ports
- Please make sure the ports you selected above are not blocked by your firewall
- When specifying the port numbers, make sure the selected ports are all available and there are no other applications running on them. Follow this Check network ports to check your network ports
- If you are installing qTest Sessions on the same machine with qTest Manager, a best practice is to select Use custom ports option then specify the port numbers that are not occupied by qTest Manager instance. As below example:
In the next screen, you will have an option to enable a secured connection (HTTPS) between users’ browsers and qTest Session servers
If you have an existing certificate, you need to specify the locations of the Certificate file and the Private Key file by clicking on the Browse button.
You can optionally provide your Chain Certificate, which is your certification authority's certificate
- If you're enabling secure connection but using a self-signed certificate, beware that the first time you access to qTest Sessions from a web browser, the web browser will show the security warning for the unsecured connection. You must accept the untrusted connection for the system to work properly
- You are then required to configure the connection to your PostgreSQL database. Database host name, port number and a database schema are required
- The database schema must be created in advance. Go to Create qTest Sessions database section for the instructions to create qTest Sessions database
- You can select the checkbox to Reset data, and existing data in the database schema will be removed
- Specify the hostname and port number to connect to Redis server. Click Next to continue
- Specify the information of your Elasticsearch server. qTest Sessions supports one cluster and one node. Click Next to continue
NOTE: By default, the cluster name is elasticsearch. Go to Get Elasticsearch cluster name for the instructions to get the cluster name.
- You may specify the directory to sessions data. Click Next to continue
- Specify the URL and qTest Master Token to connect to your qTest Manager instance. Click Next to continue
- Your qTest Manager instance must be running
- The port must be included in the URL: http://[qTest_Manager_IP_Address]:[HTTP_Port] or http://[qTest_Manager_Domain_Name]:[HTTP_Port]
- If your qTest Manager is using SSL, you need to input the URL with HTTPS protocol and HTTPS port. For example: https://[qTest_Manager_IP_Address]:8443 or https://[qTest_Manager_Domain_Name]:8443
- Go to Get qTest Master Token for instructions to get your qTest Master Token
- After you have input all required information and click on Next button, the wizard starts configuring qTest Sessions services
- After this process is done, you will be directed to the final information screen, where you can review all the installed components and their settings
- Click Finish to exit the installation wizard
NOTE: qTest Manager must be configured to connect with Sessions. Please proceed to the following steps
2. Configure qTest Manager to connect to qTest Sessions
- Login to your qTest Manager using a Site Administrator username and password
- Click into the Site Administration page and click on the tab SYSTEM CONFIGURATIONS
- In the QTEST EXPLORER | SESSIONS section, input the URL of your qTest Sessions server, such as http://[qTest_Sessions_IP_Address]:[HTTP_Port] or https://[qTest_Sessions_IP_Address]:[HTTP_port] if you installed qTest Sessions with SSL certificate.
- Click on Save button. Follow the remaining steps to validate that Sessions was installed and configured successfully
- From qTest Manager's top navigation, access to qTest Sessions
- Click + Session button to create a new Session
- Enter Session's Title and click Save & Close
- Verify that the Session you have recently saved appears in the Query Result