Bq Docs

Appearance

How-to articles

In-premise Installation ​

This guide details the process to install  BQ C-SAPS(™) platform in your premise.

System Requirements ​

Ensure that your system meets the minimum requirements to run BQ C-SAPS™.

ServerConfiguration
Application ServerUbuntu 16.04 LTS, JDK 1.8, Tomcat 8
Node ServerUbuntu 16.04 LTS, node.js 12
DatabaseUbuntu 16.04 LTS, MariaDb 10

Prerequisites ​

  1. Ensure server machines are suitably hardened based on organization policies.
  2. Ensure swap space is configured to the same amount as RAM.

Step-by-step guide

Step 1 - Application Server
  1. Install JDK 1.8 with latest update
  2. Install Tomcat 8
  3. Update or create setenv.sh in tomcat/bin folder.
  4. Create the following folders and make them writable by tomcat user:
    1. SCREENSHOT_PATH
    2. ATTACH_PATH
setenv.sh bash<br/># IP and port to app server<br/>export BQ_AUTH_URL=http://192.168.3.243:8080<br/># IP and port to Node Server<br/>export NODE_SERVER_URL=http://192.168.3.243:8888<br/># IP for DB server<br/>export RDS_HOSTNAME=192.168.3.243<br/># DB Name<br/>export RDS_DB=bqdatabase<br/># DB Port<br/>export RDS_PORT=3306<br/># DB User<br/>export PARAM1=xxxx<br/># DB Password<br/>export PARAM2=xxxx<br/># Upload screenshots to (SERVER/Azure/S3)<br/>export SCREEN_UPLOAD=SERVER<br/># Path to screenshot if server<br/>export SCREENSHOT_PATH = /path/screen<br/># Azure Account Name<br/>export AZ_ACCOUNT_NAME=xxx<br/># Azure Account Key<br/>export AZ_ACCOUNT_KEY=xxx<br/># Log Sql<br/>export LOGSQL=false<br/># Mail Server Host Name<br/>export BQ_MAIL_HOST=secure3186.hostgator.com<br/># Mail Server Port<br/>export BQ_MAIL_PORT=25<br/># Mail FROM user<br/>export [email protected]<br/># Mail User<br/>export [email protected]<br/># Mail Server Pass<br/>export BQ_MAIL_PASS=xxxx<br/># Use SSL<br/>export BQ_MAIL_SSL=false<br/># Auth required for SMTP<br/>export BQ_MAIL_AUTH=true<br/># Enable Attachment functionality<br/>export ENABLE_ATTACHMENT=true<br/># <br/>export JAVA_OPTS="-server -XX:MaxPermSize=512m -Xms4096m -Xmx4096m "<br/># Path to Custom config<br/>export APPNAME_CONFIG=/path/cst.groovy<br/><br/><br/># Import Subtask (ICANN Only)<br/>export IMPORT_SUBTASK=false<br/># path to BQ installer<br/># This will be used if the path is different between installations.<br/>export BQ_INSTALLER_PATH=/path<br/># Max attachment file size<br/>export ATTACH_FILE_SIZE_MB=1024<br/># Path to Attachment on server<br/># Make sure this folder is created and permission given to tomcat user<br/>export ATTACH_PATH=/path/to/attach<br/># Disable Email Notifications<br/>export BQ_NOTIFICATION_DISABLE=false<br/><br/><br/>