Installing the Evaluation Package

The Evaluation Package is a limited version of the full on-premises product. It simplifies the installation of the full product and runs on a single computer for a limited time.

Prerequisites

Operating System

• Windows 10, 11, Server 2016, or higher

• Ubuntu Linux 20.04 or higher, with a desktop environment and web browser installed.

Docker

• Windows: Docker Desktop for Windows.

• Linux: Docker for Linux.

PowerShell

• Windows: Hosts running Windows 10 or Windows Server 2016 should already have PowerShell 5.1 installed. Otherwise, install the Windows Management Framework 5.1.

• Linux: Install PowerShell version 7 or higher. You can find PowerShell installation steps for Linux here.

Installation Steps

1. Visit The ScaleOut Digital Twins™ Start for Free page and complete the registration form. An email with download links will be sent to you. Download the appropriate zip file for your operating system.

2. Extract the files into a folder. The recommended paths used in this guide are:

   • Windows: C:\ScaleOutStreamServerDT

   • Linux: /srv/sossdt

   On Linux, the unzip command can be used to unzip the package on the command line:

   sudo unzip ScaleoutDigitalTwinsEvalLinux.zip -d /srv/sossdt
   

   Tip

   Do not remove this folder after running the install script. Its contents will be used by product components after installation.

3. Run the installation script.

   • Windows: Open a Windows command prompt as an Administrator. (You can do this by right-clicking on the command prompt’s icon and selecting Run as Administrator.)

     cd C:\ScaleOutStreamServerDT
     install.bat
     

   • Linux: Open a terminal window and run:

     cd /srv/sossdt
     sudo chmod +x *.sh
     sudo ./install.sh
     

4. The script performs several steps and takes several minutes to run.

Note

The installation script automatically identifies the IP address that should be used by the system’s Docker containers and the product’s in-memory compute engine. In rare cases, you may have to override this configuration, as explained in the installation of the full on-premises product here.

Note

On Windows and Linux, the Evaluation Package’s installation script will unpack OpenJDK 21.0.2 (an open-source distribution of Java SE) for the ScaleOut Digital Twins service’s executables. This will enable you to develop and deploy digital twin models in Java. The OpenJDK is unpacked to the following directories:

• Windows: C:\Program Files\Java\jdk-21.0.2

• Linux: /usr/lib/jdk-21.0.2

5. Install the SSL certificate on Linux.

   On Linux, the certificate installation instructions are specific for each browser. This public certificate can be found in the dtserver.scaleoutsoftware.com.pem file.

   To install the certificate on a Linux host, run the following commands for the respective browsers:

   • Google Chrome: certutil -d sql:$HOME/.pki/nssdb -A -t “TC,,” -n “localhost” -i /srv/sossdt/data/certs/dtserver.scaleoutsoftware.com.pem

   • Firefox: certutil -d sql:<FIREFOX_PROFILE_PATH> -A -t “TC,,” -n “localhost” -i /srv/sossdt/data/certs/dtserver.scaleoutsoftware.com.pem

Using the ScaleOut Digital Twins UI

You are now ready to use the ScaleOut Digital Twins UI, which can be accessed at the following URL:

https://localhost:5501

You can use the built-in account to log in:

• user name: admin@streamserver.dt

• password: Sc@le0ut

You can also create a new account by pressing the Log In button and clicking the Register as a new user link. Enter the email address and password that you would like to use. The password must be between 6 and 100 characters long, have at least one non-alphanumeric character, have at least one digit (‘0’-‘9’), and have at least one uppercase (‘A’-‘Z’).

After logging in, you will see the UI where you can deploy your first digital twin model! Please see the section ScaleOut Digital Twins™ UI Guide for a description of the user interface. Note that all features of the cloud service are available on-premises except for those that manage organizations.

Note

If your network is changed (e.g. when you connect to a different wi-fi network), you must re-run the install_host.bat file to update networking settings in the Digital Twins service configuration. The install_host.bat script can be re-run as many times as necessary.

Using the REST Service

Applications can send incoming messages to the built-in REST service at the following URL:

https://localhost:8801

Note that the REST service uses API keys, which can be created in the ScaleOut Digital Twins UI. This service delivers incoming messages to their respective digital twins for processing.

Starting and stopping Docker containers

Sometimes it might be necessary to restart ScaleOut’s Docker containers. On Windows, open a Windows command prompt as an Administrator. On Linux, open a new terminal window. Set the current directory of the command prompt to the installation folder.

To stop ScaleOut’s Docker containers run the following command:

docker compose down

To start the containers, run the following command:

docker compose -f docker-compose.yml -f docker-compose.onprem.yml up -d

Uninstalling the Evaluation Package

You can uninstall the evaluation package with the following steps. This process will leave the original installation folder and local data.

First, on Windows, open a Windows command prompt as an Administrator. On Linux, open a new terminal window. Set the current directory of the command prompt to the installation folder. Next, run the uninstall.bat script on Windows or the uninstall.sh on Linux to remove the current deployment.

For example, the uninstall script can be run with the following command:

uninstall.bat
or
sudo ./uninstall.sh