Installation (Linux)

Requirements

The computer needs access to the Internet for installation.

Before installation can be started, the following must be installed on the computer:

Docker version 20.10.5 or higher and
Docker Compose version 1.28.5 or higher.

Docker and Docker Compose must not be installed as a Snap package.

The Linux user logged in for installation must belong to the "docker" group. This can be checked using the

CODE

id -Gn userName

command. Here, "userName" must be replaced with the relevant user ID.

The Linux user logged in for installation needs root rights and must belong to the "sudo" group.

The TCP ports 80 and 443 of the computer must not be assigned. If they are already in use, the port assignment must be changed to the base settings after installation.

The installation can be carried out both with a direct Internet connection and via a proxy server. When using a proxy server, additional configurations are required.

Installation

Copy the installation script "smartWARE_452.5.0.0.14.auto.run" (the name depends on the version number) to the user's home directory "/home/user".
Make the file executable with the following command:
CODE
```
chmod +x smartWARE_452.5.0.0.14.auto.run
```
Starting the installation script with
CODE
```
./smartWARE_452.5.0.0.14.auto.run
```

The following outputs are now displayed in the terminal:

CODE

Creating directory update_smartWARE_452.5.0.0.14
Verifying archive integrity...  100%   SHA256 checksums are OK.  100%   MD5 checksums are OK. All good.
Uncompressing smartWARE_452.5.0.0.14 Installer  100%
Input Parameter from makeself: smartWARE_452.5.0.0.14
dirname script: /home/user/update_smartWARE_452.5.0.0.14
unpackdirname script: /tmp/unpack_smartWARE_452.5.0.0.14
[sudo] password for yourusername:

Enter the password to start the installation.

The required files are initially copied to the "/tmp" directory and then into the "~/smartWARE_452.5.0.0.14" target directory. The tilde "~/" represents the user's home directory "/home/user".

To be able to access the application with the Internet browser via HTTPS, the installation script generates a self-signed certificate. This certificate, if available, can be replaced later with an official certificate.
Further information on this is available in the base settings (Linux) section.

CODE

certificate and key copied to ~/smartWAREData/reverse_proxy/certs
user is logged in registry.jumo.digital

The following directories have been newly created by the installation script:

CODE

~/smartWAREData/
~/smartWARE_452.5.0.0.14/

The "~/smartWAREData/" directory includes all persistent data from the application. Access to this directory is only possible with root rights.

The "~/smartWARE_452.5.0.0.14/" directory includes all scripts that are required to operate the application. For example, this includes the start and stop script for Docker services. Individual settings can be configured and saved in an .env file within this directory.
Further information on this is available in the base settings (Linux) section.

Persistent data

Persistent data is information that is permanently saved and is retained even after a software update. This data includes transmitted process values and the JUMO smartWARE Evaluation configuration, such as dashboards or device space information.

All data recorded from the devices is saved persistently in the Linux user's home directory by the Datastore service:

CODE

~/smartWAREData/datastore

The data is stored as compressed files and protected against manipulation by additional signed files. This entire set of data is called "cold data".

This directory must not be deleted. Deleting the directory or individual files included in it results in loss of the recorded data if there is no backup copy of the deleted data.

Web connection via HTTP proxy

If the computer is connected to the Internet via an HTTP proxy, several additional settings are required in the configuration:

Installer APT

CODE

sudo nano /etc/apt/apt.conf.d/http-proxy.conf

The following lines must be inserted into the configuration to define the proxy:

CODE

Acquire::http::Proxy "http://proxy-server-ip:port/";
Acquire::https::Proxy "http://proxy-server-ip:port/";

Save the file. Then check whether the "sudo apt-get update" request delivers a result.

Docker

The Docker must be adapted to the proxy:

CODE

sudo mkdir -p /etc/systemd/system/docker.service.d
sudo nano /etc/systemd/system/docker.service.d/http-proxy.conf

Insert the following lines:

CODE

[Service]
Environment="HTTP_PROXY=http://proxy-server-ip:port"
Environment="HTTPS_PROXY=http://proxy-server-ip:port"

Then save the configuration. The configuration is completed with the following commands:

CODE

sudo systemctl daemon-reload
sudo systemctl restart docker