Installing QAnswer on premise
Introduction
If you are interested to install QAnswer on premise you need to reach us at info@the-qa-company.com to get a license key and the various access to be able to follow this guide.
Requirements
To run QAnswer you need:
- a linux distribution (we use Ubuntu by default)
- A GPU with at least 24GB of memory (we recommend NVIDIA® RTX™ 3090)
- Docker
Install Nvidia Drivers
- Download and install the CUDA drivers from the NVIDIA website. If you are using a Ubuntu distribution you can use the following command to install the drivers
sudo ubuntu-drivers install --gpgpu
Install Docker
You need to install Docker on your machine. You can follow the official documentation to install it on your machine.
Then you need to install the nvidia container runtime by following the official documentation
After that you need to restart docker by running the following command
sudo service docker restart
Install QAnswer
QAnswer is provided as a docker-compose file. You can clone the repository by running the following command
git clone https://gitlab.the-qa-company.com/qanswer-app/bundle.git
The first thing you have to do is from template.env create a .env file with the secret of your installation.
In this file you have to fill the following field:
Configuration overview
System details
The credential used to get the images of QAnswer (supplied by us)
| Property | Value |
|---|---|
| USER | The username to access the registry |
| PASSWORD | The password to access the registry |
Application details
| Property | Value |
|---|---|
| QA_KEY | The license Key to activate the application we provide |
| QA_PUBLIC_UI_URL | The URL of the frontend |
| QA_PUBLIC_URL | The URL of the backend for http/https |
| QA_PUBLIC_WSURL | The URL of the backend for websocket |
| QA_ADMIN_USERNAME | The username for the admin account |
| QA_ADMIN_EMAIL | The email for the admin account |
| QA_ADMIN_PASSWORD | the password for the admin account |
| SPRING_DATASOURCE_PASSWORD | The password of the database |
| APP_JWTSECRET | A JWT secret token |
Contact Email
The email that people will be encourage to contact in case there is a problem
| Property | Value |
|---|---|
| CONTACT_MAIL | The email of the contact |
Run QAnswer
Then after filling everything you have to run to generate the configuration of QAnswer
./generate-config.sh
After that, pull all the image of QAnswer by running the following command
./init.sh
Then you can run finally the following command to have QAnswer running
docker compose up -d