Menu

Insights 1.21.12 Single Server Installation Guide

Overview

In this article, we provide step-by-step instructions to install qTest Insights 1.21.12 on a CentOS/ Ubuntu machine using Docker and connect to qTest Manager 9.8.3 on another machine.

Note: If you want to deploy qTest Insights 1.21.12 and qTest Manager 9.8.3 on the same machine using Docker, read Manager 9.8.3 Single Server Install Guide for Docker.

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

Note: If you are not performing a fresh install and are upgrading, use the Upgrade Request Form and reference the OnPremise Upgrades Guide.

New for This Release: Insights Enhanced Security Enablement

During an attempted CSRF attack, user credentials may potentially be inherited and then used to maliciously perform undesirable actions, usually affecting a change of state of server. Please note that this does not result in any data theft.

3 Insights features are impacted by this new security configuration:

  • embed reports/dashboard
  • shareable URL dashboard
  • rapid dashboard 

Insights allow users to generate an HTML template and embed it into an external website ex: Confluence. Therefore, the domain of this website need to be included in the Whitelist domain. SSL must be enabled. 

  • qTest Managers HTTP or HTTPS Port
  • URL to access qTest Manager outside of this machine
  • qTest Insights HTTP or HTTPS Port
  • URL to access qTest Insights outside of this machine
  • External Reporting domain i.e. Confluence

Before You Begin

  • qTest Insights 1.21.12 only works with qTest Manager 9.8.3 or later.
  • Docker 17.03 has been installed. Follow these instructions to install Docker on your machine if you have not already done so.
  • For CentOS, you need to follow additional instructions to adjust Docker Storage Driver from overlay to device mapper.
  • For CentOS 7.X+ or Ubuntu 16.10 machines: Docker requires a 64-bit installation and your kernel must be at least 3.10.

Read the following:

Install qTest Insights 1.21.12

Download the docker deployment package

 $ wget <ENTER DOWNLOAD LINK HERE>
 $ wget <ENTER DOWNLOAD LINK HERE> 

Extract the Package and Access the Directory 

 $ tar -zxf <DOWNLOADED PACKAGE FILE NAME> 
 $ cd <DOWNLOADED PACKAGE FILE NAME>

Configure Before Deploying

Access to the directory where you've extracted the package, and run the ./configure command to deploy the package.

The command has to include URL & port of qTest Insights.

 Configure to deploy HTTP 

$ ./configure  --insights-url "http://<IP of current machine>:<insights port>" --insights-http "<insights port>" --cluster "<IP address of qTest machine>"

Configure to deploy HTTPS  

$ ./configure --ssl-key "<SSL Key>" --ssl-cert "<SSL Cert>" --ssl-ca "<SSL Ca>" --insight

Enhanced Security Whitelist Example:

Configure to deploy with the Enhanced Security

$ ./configure --insights-security-csrf-trusted-source-pattern "<Whitelist domains>"

If you are configuring an external configuration, e.g Confluence, then the Confluence URL should be whitelisted:

$ ./configure --insights-security-csrf-trusted-source-pattern "<qtest-manager-domain>[:port]|<qtest-insights-domain>[:port]|<confluence-domain>"

For example

$ ./configure --insights-security-csrf-trusted-source-pattern "qtest-manager.com|insights.com|confluence.atlassian.net"

Start the Deployment Process 

 $ ./startup

The script will download the application images to the Docker. It may take a couple of hours depending on your network connection.

Once the installation is complete, access to qTest Manager via your browser and setup for qTest Insights.

Set up qTest Insights

  1. Hover over your username, and select Administration from the drop-down.
  2. Under the Configuration page, scroll to section MISCELLANEOUS and enter the qTest URL into the field qTest server's Domain.
  3. Scroll to the Insights section and enter the Insights URL:
    • http://<IP of the machine where you installed qTest Insights>:<Insights port which you've specified in the config file>.
  4. Test Connection and Save the configuration.

You now can access qTest Insights via its option in 9box icon.

NOTE:

In order for the scheduler to work properly, you might want to check the SMTP port in a setting file to ensure it matches with your SMTP server port.

  1. Open the setting file "build.gradle" under qtestctl/insights/build.gradle.
  2. Find keyword "connSMTP".
  3. Set the SMTP authentication method. The default is 0.
    SmtpAuthenticationMethod="0"
    • Enter 0 for None
    • 1 for Logon
    • 2 for CramMD5
    • 3 for TLS/SSL
  4. Set the SmtpPort. You will need to change the value to your SMTP server port if it is not 465, as that is the default. 
    SmtpPort="465"

 

Powered by Zendesk