Installation Guide for Unity Risk Indicator

Minium requirements:

OS: Ubuntu 20.04 (LTS)

CPU: 4 x vCPU

(CPU must support AVX)

Ram: 4GB Ram

Hard disk: HDD 30GB

Recommend requirements:

OS: Ubuntu 24.04 (LTS)

CPU: 8 x vCPU

(CPU must support AVX)

Ram: 8GB Ram

Hard disk: SDD 100GB

---

Option 1: Preferred Method

Using the Automatic Installation Guide

Please refer to the following link for the automatic installation guide: Unity Risk Indicator Setup Guide

TIPs

1. The new installation will take approximately 15 minutes. Once the installation is complete, please wait about 10 minutes to allow the Node.js service to start up.
2. The initial username is "super" and the password is "Admin@123".
3. If you wish to upgrade to a new version, simply run the "unitysetup.sh" script again. Keep in mind that you will need to update the IP address within the script once more, as each time the script runs, it retrieves all files from GitHub and overwrites your previous settings.

---

Option 2: Manual Installation

Follow these steps for a manual installation:

1. Install Nginx:

   • Check if it's installed: whereis nginx
   • If not, follow the guide: How to Install Nginx on Ubuntu 22.04.

2. Install Docker:

   • Check if it's installed: whereis docker
   • If not, follow the guide: How to Install and Use Docker on Ubuntu 22.04

3. Install Docker Compose:

   • Check if it's installed: whereis docker-compose
   • If not, follow the guide: How to Install and Use Docker Compose on Ubuntu 22.04.

4. Install MongoDB:

   • Check if it's installed: whereis mongod
   • If not, follow the guide: How to Install and Use MongoDB on Ubuntu.

5. Download and Extract the ZIP File:

   • Ensure you have the correct file for the Unity Risk Indicator.

6. Clone the Code Repository Using Git:

   git clone https://github.com/Netswitch-Inc/unity
   

7. Go inside the unity folder

   cd unity

8. Configure the Frontend .env File

   • Inside the unity directory, edit the frontend .env file

   vi frontend/.env

   • Update the REACT_APP_BACKEND_REST_API_URL in the .env file from http://localhost:3006 to http://<your_server_ip>:3006.

9. Configure the Backend .env File

   • Inside the unity directory, edit the backend .env file

   vi backend/.env

   • FRONT_WEB_URL from http://localhost:8081 to http://<your_server_ip>:8081
   • BACK_UNITY_URL from http://localhost:3006 to http://<your_server_ip>:3006
   • Ensure port 3006 is open on your server.

10. Run the Database import script:

sudo sh mongoImport.sh

11. Download the manually setup script:

wget https://raw.githubusercontent.com/Netswitch-Inc/unity/refs/heads/master/manuallysetup.sh

12. Run the Setup Script:

sudo sh manuallysetup.sh

• Ensure ports 3006 and 8081 are open for public access.

13. Verify Docker Containers

• Check if containers are running:

sudo docker ps -a

14. Start the Application

sudo docker-compose up --build -d

15. Stop the Application

sudo docker-compose down

16. View Container Logs

sudo docker logs --follow <container_id>

17. Update for Code Changes

• Pull the latest code from the repository.

docker-compose up -d --no-recreate --build <service-name>

• Use backend or frontend as depending on where changes were made.

18. Replace IP

• Browse http://<your_server_ip>:8081
• Replace <your_server_ip> with your actual server IP address.
• Ensure that your firewall settings allow access to the necessary ports (3006 and 8081).