Installing and updating AI-Dash PRO

Are you ready to install AI-Dash PRO?

Before installing AI-Dash PRO you must make sure that our machine meets the necessary requirements.

AI-Dash PRO has been tested on the following Ubuntu versions:

You are free to install AI-Dash PRO on other Debian-based distributions, however we do not provide support on different systems.

To not get lost, follow this list:

Update the machine

Before starting the download or installing other software it is very important to update our machine.
Open the terminal and give the following commands:

sudo apt update
sudo apt upgrade

Empty home page

Once the password is entered, all the updates will be downloaded and installed.

Go top

Download and Install AI-Dash PRO

Now it's time to download and install AI-Dash PRO!

How do I download the latest version of AI-Dash PRO?

Check your email!
One of our engineers should have sent you a direct link to the latest version of AI-DashPro.tar.gz. Click on it to start the download.
NOTE: generally the file name format should be as follows -> dashboard.1.9.2113-181012-python3.tar.gz

Select the file you downloaded from the terminal.
For example, assuming you downloaded the installation file to the Desktop, you would change the directory with the command:

cd Desktop

then you will have to extract the file with the command:

tar -zxvf dashboard.1.9.2113-18_10_12-python3.tar.gz

Empty home page

Now we need to run the install.sh script to start the installation!
From the folder we extracted the file (in the example Desktop), we must make sure that the install.sh file has execution privileges; to do this, use:

chmod + x install.sh

and then you can give the command

sudo ./install.sh

Empty home page

The installation script will install the files necessary for the operation of AI-Dash PRO and the necessary software requirements.

Right after the installation launch, you will be prompted to install MySQL for database management. If MySQL is already installed, you can skip this step. If not, you will be asked to specify the database administrator password and MySQL access through password will be enabled.

You will then be asked to install Redis. Again, you can skip this step if the software is already installed. In any case, the script will ask you to specify its configuration through these parameters:

  • Host
  • Port

Next, the terminal will ask us to name the AI-Dash PRO installation folder and will create that folder in the path /opt/dashboard.
For example, if the name chosen for the folder is DASHPRO, the installation folder will be /opt/dashboard/DASHPRO.

At this point, you will be asked to specify the credentials for accessing the database, that are:

  • Host
  • Port
  • Name
  • User
  • Password

The informations just specified, together with the informations for accessing Redis, are saved in the file dashboard.json which is located in the cnf folder of the dashboard (in the example /opt/dashboard/DASHPRO/cnf/dashboard.json). You can also edit this file manually, for example, if you want to use a different database.

The installation script will then ask you to confirm those credentials and will automatically create the account for the specified user, to do this you will need to enter the username and password of the database administrator account. Once the database is configured, the script will create the necessary tables and fill them with the default values.

Empty home page

At this point you will have to choose the PORT of the localhost where our AI-Dash PRO will be executed.
At the end of the installation, the last thing to do is choose the number of services to be assigned to AI-Dash PRO. Three types of services must be configured:

  • Worker: these are the services that manage most of the background processes of the dashboard (Reports, Weather informations, Autocleaner, etc.).
  • Worker Etl: are the processes that create event summaries for speed up the display of the home page.
  • Worker Hea: these are the services that manage heavy tasks.
  • Worker Ess: these are the services that manage essential processes.
  • Application: these are the services that manage the actual instances of the dashboard and the reception of events, each instance will run on a different port. For example, if you have chosen to run the dashboard on port 8080 and to enable three Application, three instances of AI-Dash PRO will be created on ports 8081, 8082 and 8083 (PORT + 1, PORT + 2 and PORT + 3).

After confirming, the script will enable and start the specified services and install and configure Apache to redirect requests to AI-Dash PRO on the chosen port.

Empty home page

Go top

Update AI-Dash PRO

How do I update my AI-Dash PRO to the latest version available?

If you are using an old version of AI-Dash PRO and want to update to the latest version available, all you have to do is follow the simple steps of this guide.

The only thing you will need is the new version of AI-DashPro.tar.gz.
NOTE: generally the file name format should be as follows -> dashboard.1.9.2113-181012-python3.tar.gz

First of all you need to extract the downloaded package. Assuming, for example, that you have downloaded the installation file to the Desktop, you have to move to the folder with the command:

cd Desktop

and then extract the file with the command:

tar -zxvf dashboard.1.9.2113-18_10_12-python3.tar.gz

Empty home page

At this point, in addition to the install.sh file for the installation already described in the previous paragraphs, we will have the update.sh script, necessary for the update. Now we need to make sure that the update.sh file has execution privileges; to do this, use:

chmod + x update.sh

and run it with the command:

sudo ./update.sh

First, you will be asked to install Redis. If you have a very old version of AI-Dash PRO, in fact, it is possible that this is not installed. In any case, the script will ask you to specify its configuration through these parameters:

  • Host
  • Port

Subsequently, the terminal will ask us to write first the name of the installation folder of the old AI-Dash PRO and then the name of the folder where we want to install the updated version.
NOTE: you only have to enter the name of the folder and not the whole path, for example, if AI-Dash PRO is installed in /opt/dashboard/DASHPRO, you will only have to enter DASHPRO.

The update script will automatically copy the necessary configurations from the old folder to the new one.

At this point, you will be asked to specify the credentials for accessing the database, that are:

  • Host
  • Port
  • Name
  • User
  • Password

The update script will then ask you if you want to make a backup copy of the database.
If you accept, a copy of the current database will be created and changes will be made to ensure it works with the new version of AI-Dash PRO; to proceed you will be asked for the administrator credentials. You can use the backup copy if something should fail in the update process.
If you refuse, any changes will be made directly to the current database.

Empty home page

At this point you will have to choose the PORT of the localhost where our AI-Dash PRO will be executed.
At the end of the update, the last thing to do and choose the number of services to be assigned to AI-Dash PRO. Three types of services must be configured:

  • Worker: these are the services that manage most of the background processes of the dashboard (Reports, Weather informations, Autocleaner, etc.).
  • Worker Etl: these are the processes that create event summaries to speed up the display of the home page.
  • Worker Hea: these are the services that manage heavy tasks.
  • Worker Ess: these are the services that manage essential processes.
  • Application: these are the services that manage the actual instances of the dashboard and the reception of events, each instance will run on a different port. For example, if you have chosen to run the dashboard on port 8080 and enable three Application, three instances of AI-Dash PRO will be created on ports 8081, 8082 and 8083 (PORT + 1, PORT + 2 and PORT + 3).

After confirming, the script will enable and start the specified services and install and configure Apache to redirect requests to AI-Dash PRO on the chosen port.

Empty home page

Go top

Run AI-Dash PRO

Remember that before you can access AI-Dash PRO from your browser (localhost:8080 in this example), you need to make sure that the services are started.

To check the status of a service you can use the following command:

sudo systemctl status *service_name.service*

If the service has multiple instances you must specify the instance or list of instances you need. If you have left the default configuration (3 Worker, 5 Worker Etl, 5 Worker Hea, 3 Worker Ess and only 1 Application), you can run the following commands:

sudo systemctl status dashpro@0.service
sudo systemctl status dashpro-scheduler.service
sudo systemctl status dashpro-worker@{0..2}.service
sudo systemctl status dashpro-workeretl@{0..4}.service
sudo systemctl status dashpro-workerhea@{0..4}.service
sudo systemctl status dashpro-workeress@{0..2}.service
sudo systemctl status dashpro-mqtt@0.service

If you read active then the service is running!

If a service is not active you can activate it with the following command:

sudo systemctl start *service-name.service*

or restart it with:

sudo systemctl restart *service-name.service*

It is also possible to enable a new instance of a service if you notice that the configured ones are not enough. For example, to configure a fourth worker:

sudo systemctl enable dashpro-worker@3.service

With this command, the new instance will start automatically when the system starts. You can also start it manually with the command mentioned above.

To remove a service you must first stop its execution with:

sudo systemctl stop *service-name.service*

and disable it with:

sudo systemctl disable *service-name.service*

Don't forget to use sudo and that instances of a service range from 0 to N-1.

Empty home page

We can finally use AI-Dash PRO

From your browser you can now access the Dashboard

Empty home page

to continue, visit our Getting Started section.

Have fun with AI-Dash PRO

Go top