Skip to main content

Installation

Follow the steps below to install and run the project successfully.

Requirements:

  • Docker, Docker Compose
  • Recommended OS: Ubuntu / any Linux distribution
  • On Windows: run the script using Git Bash

Installation Package​

.env​

This file contains environment variables used by Docker and the application. Example content:

GRAFANA_PORT=3000
BACKEND_PORT=9983
FRONTEND_PORT=8080

docker-compose.yml​

This file defines the Docker services, ports, volumes, and environment variables. It will use the values defined in the .env file.

install.sh​

This is a bash script that automates the installation and configuration process. It prompts for necessary values and launches the Docker containers.

Installation Guide​

1. Grant permission to the script file​

Make sure the script file has execution permissions:

chmod +777 install.sh

2. Run the script​

Once permissions are set, launch the script:

./install.sh

Installation Script Walkthrough​

1. Internet Connectivity Check​

During the installation, the script will ask if you have an internet connection:

  • If yes:

    • You will be asked to log in to Azure Registry (required to pull images).
    • The script will use docker login and then pull the required images.

  • If no:

    • You will be asked to provide a path where local Docker image .tar files are stored.
    • The script will use docker load -input to load images from the provided .tar files.

2. Provide Configuration in the Terminal​

The script will then prompt you to enter key configuration values. If you leave any field empty, the default values will be used.

  • Frontend Port

    Enter frontend port [default: 8080]:

    This port is used to access the application's web-based user interface.

  • Backend Port

    Enter backend port [default: 9983]:

    This port allows the frontend to communicate with the backend services (APIs, data processing).

  • Grafana Port

    Enter Grafana port [default: 3000]:

    This port is used to access the Grafana dashboard for metrics and visualization.

  • Host Address (hostname/IP)

    Enter hostname/IP [default: 10.100.22.27]

    This is the IP or hostname where your application will be accessible. It is especially important when the frontend or users need to connect from a remote location.

  • Path to Configuration Directory

    Install directory [default: current]:

    This is the directory where configuration files and Docker volumes will be stored. Useful if you want to persist data or organize deployments.

note

If you leave any of these fields empty, the default values shown in brackets will be used automatically.

Once all the steps above have been completed, the setup process is fully automated. The system will configure the necessary containers, apply environment settings, and launch all services in the background.

Manual Startup​

If you prefer not to use the script:

  1. Configure .env.
  2. Run Docker Compose directly:
docker-compose up -d

Your application should now be running and accessible using the defined host and port.