Prerequisites for On-Premises Deployment

 TABLE OF CONTENTS

1. Overview

2. Installations

2.1 Install NodeJS 18

2.2 Install Java 17

2.3. Install Python 3.11

2.4. Install MySQL 8

2.5. Install MySQL Workbench

2.6 Install AWS CLI V2

2.7. Install MongoDB and Set Up Mongo DB on Windows

1. Overview

This article provides the procedure for setting up prerequisites and configuring environment variables for the deployment of the on-premises algoQA test automation platform.

2. Installations

Perform the following:

2.1 Install NodeJS 18

1. Download NodeJS 18 from the official website: NodeJS Download. Select the appropriate version from the drop-down list that is compatible with your operating system and click Download button displaying corresponding version.
2. Run the downloaded installer and follow the installation instructions.
3. Verify the installation by opening a command prompt and running the command node -v to check the NodeJS version.

2.2 Install Java 17

1. Download Java 17 or the compatible version from the Oracle website: Java 17 Download.
2. Run the downloaded installer and follow the installation instructions.
3. Verify the installation by opening a command prompt and running the command java -version to check the Java version.

2.3. Install Python 3.11

1. Download Python 3.11 or the compatible version from the official website: Python 3.11 Download.
2. Run the downloaded installer and follow the installation instructions.
3. Verify the installation by opening a command prompt and running the command python --version to check the Python version.

2.4. Install MySQL 8

1. Download MySQL 8 or the compatible version from the MySQL website: MySQL 8 Download.
2. Run the downloaded installer and follow the installation instructions.
3. During the installation, set up a MySQL root password and remember it for future use. 

2.5. Install MySQL Workbench

1. Download MySQL Workbench 8 or the compatible version from the MySQL website: MySQL Workbench Download.
2. Run the downloaded installer and follow the installation instructions.
3. Launch MySQL Workbench after installation and configure it to connect to your MySQL server using the root password set during MySQL installation.

 2.6 Install AWS CLI V2

1. Before downloading and installing AWS CLI, ensure that your system has internet access.
   The AWS CLI installer requires internet connectivity to download the necessary files and dependencies.
2. Download AWS CLI V2 from the AWS website: AWS CLI V2 Download.
3. Run the downloaded installer and follow the installation instructions.
4. Verify the installation by opening a command prompt and running the command aws --version to check the AWS CLI version.

 2.7. Install MongoDB and Set Up Mongo DB on Windows

1. Download MongoDB Community server from the website: mongodb.com or install using
   MSI installer from here.
2. When installing MongoDB, make sure to check the checkbox to download MongoDB
   Compass. If the checkbox is already checked, indicating that MongoDB Compass will be downloaded as part of the MongoDB installation. If not selected, download and install MongoDB Compass separately from here. 
3. Setup the environment variable path:
   • After installation, navigate to the respective MongoDB folder path and copy path till bin. (e.g., C:\Program Files\MongoDB\Server\7.0\bin)
   • Search for "Environment Variables" in the Windows search bar and select "Edit the system environment variables."
   • In the System Properties window, click on "Environment Variables."
   • In the Environment Variables window, under "System variables," select the "Path" variable and click "Edit."
   • Add the path copied into system variable path.
   • Click OK to confirm the changes.
4. Download mongo shell from the website: mongodb.com or follow the installation instructions to install mongo shell from here.
5. Open the command prompt from the same folder path where you have installed mongo shell.
6. Verify the installation by running the following command and press Enter.

   mongod --version

7. Connect to Mongodb by running the following command and press Enter.

   mongosh

8. After connecting to the database, run the following command and press Enter to display a list of available databases.

   show dbs

9. Create a database by running the ‘create db’ command.
10. Manage database and user management by switching to specific database by running use <dbname> command.
11. Create a user with a password by running the following commands:

    • db.createUser({user:"<username>", pwd:"<password>", roles:[]})
      This command creates a new user with the specified username and password and assigns an empty set of roles.
      
      

    • db.auth("<username>", "<password>")
       This command verifies the user's identity using the supplied credentials.

12. Configure Backend. env File after generating MongoDB credentials, add them into your backend .env file.
    Include the following variables:

• MONGO_DATABASE_HOST: MongoDB server's host address.

• DATABASE_MONGO_USER: Username for MongoDB database access.

• MONGO_DATABASE_NAME: Name of the MongoDB database.

• DATABASE_MONGO_PASSWORD: Password associated with the MongoDB user

Note: Ensure that you have administrative privileges on your windows machine to install the software components.