Installation Guide

Database Server Setup

  • Install docker version 18.* from repository.

sudo apt-get update
sudo apt-get install \ apt-transport-https \ ca-certificates \
curl \
gnupg-agent \
Software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo apt-key fingerprint 0EBFCD88
sudo add-apt-repository \ "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ $(lsb_release -cs) \ stable"

  • Check if the docker is installed in the machine by running the following command

sudo docker -v

  • Other images needed from docker hub is : Mongo 4.0.0

docker pull mongo:4.0.0

  • Load and run Mongo Docker image by navigating to the download directory

docker run -d --name simplifyDB -p 27017:27017 -v ~/simplifyqa_db:/data/db -e MONGO_INITDB_ROOT_USERNAME=<admin-username> -e MONGO_INITDB_ROOT_PASSWORD=<admin-password> mongo:4.0.0

  • Run the following command to create User in mongoDB

docker exec -it simplifyDB mongo -u <admin-username> -p <admin-password>
--authenticationDatabase admin --eval "db.createUser({user: '<db-username>', pwd: '<db-password>', roles:[{role:'readWrite', db: 'bolt'},{role:'dbAdmin', db: 'bolt'}]});" bolt

Boltupload and mongodata will be provided in email. Unzip the Provided files.

  • Verify if the docker is up and running by executing the following command

sudo docker ps -a

Application Server Setup

  • Install docker v18.* from repository and check docker version

sudo docker -v

  • Other images needed from docker hub are: RabbitMQ:3-Management and Node:12

1.	docker pull rabbitmq:3-management
2.	docker pull node:12

  • Download the docker image simplifyqa.tar and rabbitmq.tar file from the secure lnk using the following command

docker load -i <filename>.tar

Note: tar files would be provided over email.

Backup Server Setup

The db dump path from the file system will be configured for backup purposes.

App Server Configuration

  • Execute the following command to run our Application

docker run -d -p 4011:4011 -v /root/boltupload:/root/boltupload -v
/root/simplifyQA/projectconfig.js:/simplifyqaweb/config/projectconfig.js -v
/root/simplifyQA/logs/qaserver.log:/var/log/simplifyqa.log -v /etc/hosts:/etc/hosts simplifyqaweb

  • Run the following command to check running containers

docker ps

  • Update projectconfig.js in application server with below content


1."dburl": "mongodb://<username>:<password>@dbserverIP:27017/bolt" 
2."dblogUrl": "mongodb://<username>:<password>@dbserverIP:27017/bolt" 
3."serverUrl": "http://serverIP:4011"
4."executionIp": "serverIP:4011", 
5."rabbitUrl":"amqp://<username>:<password>@serverIP:5671"

Email Configuration

  • Update SMTP E-mail configuration in both projectconfig.js file in application project as well as simplifyRabbitMQ .

"email": "[email protected]",
"mail_perpose_forgot": "Generating forgot password", 
"mail_perpose_new": "Generating new password", 
"mail_subject_new": "Welcome to company name", 
"mail_subject_forgot": "New password to login", 
"smtp_host": "SMTP hostname",
"smtp_port": SMTP Port, 
"secure":true/false, 
"mail_from":"from-email",
"simplify3x_username": "email",//for smtp authentication 
"simplify3x_password": "password"

MQ Configuration

  • Eecute the below command to run RabbitMQ:3-Management Docker Image

docker run -d --hostname rabbitmq --name qarabbitmq -e RABBITMQ_DEFAULT_USER=<username> -e RABBITMQ_DEFAULT_PASS=<password>
-p 5671:5672 -p 15671:15672 rabbitmq:3-management

  • Execute the below command to for changes to be made in SimplifyQARabbitMQ projectonfig.js file before running the simplifyRabbitMQ Docker image

1."dburl": "mongodb://<username>:<password>@dbserverIP:27017/bolt" 
2."rabbitUrl":"amqp://<username>:<password>@serverIP:5671"
3. “serverUrl": "http://serverIP:4011”

  • Execute the simplifyRabbitMQ Docker Image

docker run -d -v
/root/simplify-RabbitMQ/projectconfig.js:/simplifyqarabbitmq/configuration/projectc onfig.js -v
/root/simplify-RabbitMQ/logs/simplifyqarabbitmq.log:/var/log/simplifyqarabbitmq.log simplifyqarabbitmq

  • Create file simplifyqarabbitmq.log within logs directory

mkdir logs

Note: In this Example have mounted projectconfig.js file outside the project folder of both simplifyQA application and SimplifyQA rabbitMQ.

ssh username@Ipaddress

ubuntu 18.04 machine

Troubleshooting on-premise deployment

  • Execute the below command to view the SimplifyQA app logs

File Location: projectfolder/logs/qaserver.logs

  • Execute the below command to view the SimplifyQA RabbitMQ logs

File Location: projectfolder/logs/simplifyqarabbitmq.log
PreviousPre-requisitesNextSupport and Resources

Last updated