Installation instructions

Preparation

Before installing check the following items:

You must be logged in on the server as the user that will normally start Runtime.
You need a writable folder to extract the Runtime zip file into. This will be the Runtime Installation Folder.
You need an existing empty folder to store all the Runtime data.
From this point onward, we'll be referring to this folder as the Runtime Data folder. This folder will get populated with all the information used by the customer (log files, projects, and other information), and can be maintained between versions of Runtime when updated.

Installation Path Examples

Windows

Folder	Example Location
Runtime Installation Folder	c:\Apps\Datprof\Runtime
Runtime Data folder	c:\Data\RuntimeData

Linux

Folder	Example Location
Runtime Installation Folder	/usr/app/datprof/runtime
Runtime Data Folder	/home/datprof/runtimeData

Extract the software

Extract the Runtime software in the Runtime Installation Folder.

This will create a sub-folder named runtime-<version>.

Example: c:\Apps\Datprof\runtime-4.13.1

Network setting configuration

In case the user needs to use a non-standard network configuration, this can be achieved by editing the runtime.properties file in the conf sub-folder of the runtime data folder. This folder is automatically created upon first time execution.

Runtime Properties file

runtime.properties

CODE

# Check https://docs.datprof.com/runtime/latest/runtime-installation/runtime-properties for more info about these properties

# ----------------------------------------
# SERVER PROPERTIES
# ----------------------------------------
server.port=7070
server.thread-pool.size=5

# ----------------------------------------
# DATABASE PROPERTIES
# ----------------------------------------
# Database properties for the Runtime service database
db.username=SA
db.password=
db.port=9001
db.url=jdbc:hsqldb:hsql://localhost/runtime

# ----------------------------------------
# AGENT PROPERTIES
# ----------------------------------------
broker.stomp.port=61613
broker.stomp.host=localhost
broker.jms.port=61616
broker.jms.host=localhost

agents.autostart=true
agents.scheduler.interval_ms=100

# ----------------------------------------
# SECURITY PROPERTIES
# ----------------------------------------
# The time it takes before access tokens are invalidated in minutes.
#service.access-token.expiration_min={expiration}
# The time it takes before refresh tokens are invalidated in minutes.
# The expiration time of refresh tokens should be longer than the expiration time of access tokens.
#service.refresh-token.expiration_min:{expiration}


# ----------------------------------------
# LDAP PROPERTIES
# ----------------------------------------
#ldap.url= ...
#ldap.base= ...
#ldap.username= ...
#ldap.password= ...

#ldap.userAuthenticationBase= ...
#ldap.userSearchBase= ...
#ldap.userSearchFilter= ...

# This should always be false; https://vladmihalcea.com/the-open-session-in-view-anti-pattern/
spring.jpa.open-in-view=false

# ----------------------------------------
# SSL PROPERTIES
# ----------------------------------------
#server.ssl.enabled=true
# The format used for the keystore. It could be set to JKS in case it is a JKS file
#server.ssl.key-store-type=PKCS12
# The path to the keystore containing the certificate
#server.ssl.key-store=path-to-keystore
# The password to access the keystore
#server.ssl.key-store-password=xxx
# The alias mapped to the certificate in the keystore
#server.ssl.key-alias=

# ----------------------------------------
# File upload PROPERTIES
# ----------------------------------------
# Default max. file upload for both application package and Docker image file uploads (virtualize).
spring.servlet.multipart.max-file-size=10GB
spring.servlet.multipart.max-request-size=10GB

# ----------------------------------------
# Cache configuration properties
# ----------------------------------------
# ttl = the time it takes before cache entries are invalidated. Can be specified in hours (h), minutes (m), seconds (s).
# heap = the maximum number of cache entries that can be stored in memory before the cache starts evicting entries
cache.ttl=24h
cache.heap.size=100

# ----------------------------------------
# Application verification PROPERTIES
# ----------------------------------------
# The application verification mode. Possible values are:
# - none: No verification is done.
# - restricted: Only signed application are allowed to be uploaded and deployed.
# - warning: Packages are verified but only a warning is given when verification fails.
app.application-verification-mode=none

Using these settings, the user can edit things such as ports over which the various brokers we use communicate, and over which port Runtime is hosted.

Start DATPROF Runtime

Now execute the Runtime startup script using the Datprof Runtime Data Folder as a required parameter

Windows: <Runtime Installation Folder>\runtimeStart.bat <Runtime Data Folder>
Linux: <Runtime Installation Folder>/runtimeStart <Runtime Data Folder>

Datprof Runtime opens a window and once started the following message appears: "Runtime version <x.y.z> is ready: <IP-Address>:<PortNumber>"

First time login

To connect to Runtime, you will need a web browser. Open the browser and enter the IP address and port number where Runtime is hosted. If you are using the machine where Runtime is installed, you can simply use localhost:7070 with the default configuration.

Upon connecting to the web interface, you will see a login page. Use the default credentials to log in:

Username: admin
Password: admin

Important: For security reasons, change the admin password immediately after logging in.

To update the password:

Click the user profile icon in the top-right corner.
Select Change Password from the drop-down menu.

When logging in for the first time, a message may appear in the bottom-left corner stating: No license found or license is invalid.

To resolve this issue:

Navigate to Administration → License.
Enter the correct license key to activate Runtime.