Installation Guide

This guide contains all basic steps for installing the system on Linux and Windows Environments. 

Pre Requirements


Please visit System Requirements in order to get an overview of what Hard- and Software is recommended. 


In order to get the system working, the software requires some additional software in order to run correctly. The following lists the software which should be installed and working:

  • Java JRE (JDK is preferred) 1.8

  • JBoss EAP 7.1.0 (Requires Java)

  • Database Server

In the following, detailed information can be found about what tests should be done and what should pass in order to install the application as on-premise. 




Check Java

In order to check if Java is installed correctly, the following command can be run:

~# java -version
java version "1.8.0_201"
Java(TM) SE Runtime Environment (build 1.8.0_201-b09)
Java HotSpot(TM) 64-Bit Server VM (build 25.201-b09, mixed mode)


Since Java does not need to be installed the command also can be executed by calling the binary in the matching directory:

~# /usr/lib/jvm/java-8-oracle/jre/bin/java -version
java version "1.8.0_201"
Java(TM) SE Runtime Environment (build 1.8.0_201-b09)
Java HotSpot(TM) 64-Bit Server VM (build 25.201-b09, mixed mode)


These procedures apply for Windows and Linux Environments alike. Once a Java Environment is check proceed with the JBoss Server.  




Check JBoss 


Because there are many ways to set up the JBoss and its behavior this section will only show how to check basic functionality. Please see Architecture page for possible setups.


To check if JBoss answers on requests, commands like curl, telnet, wget, and so on can be used. Depending on which client the command is executed and where the JBoss is installed the command can vary with IP and Port. The following command will show a test on the same machine as the JBoss is installed with default settings: IP is bound to localhost and Port has no offset and is set to 8080. Please see JBoss documentation for further information on how to bind to another IP or Port or contact the support team.

~# telnet localhost 8080
Trying ::1...
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.




Database Server

The system only needs one database/schema for the whole installation. In this database, all necessary data is stored. To avoid any breakdown the database should be highly available. 

Connection

The database must be accessible from the server where the application will be installed. In order to check if the database is available, the preferred SQL Client can be used on the server where the application will be installed. If it is not possible to install/use a SQL Client it is also possible to use the telnet client in order to check the connection. Install Telnet client first:

Unix
~# apt-get install telnet
Windows
> install-windowsfeature "telnet-client"


After that, the following command can be used in order to check if the database port is reachable from the server where the application will run.

~# ~# telnet server.fqdn.com <databaseport>
Trying x.x.x.x...
Connected to server.fqdn.com 
Escape character is '^]'.

Even if telnet can connect, there may be some other issues that might bring some troubles with it. So a test with a SQL client would be preferred.




JBoss Extensions

While Installation, some Modules, Configurations, and XML-Files are provided which extend the basic JBoss Installation with the necessary extensions and settings. The following files are provided in detail:

  • bin/standalone.conf
  • bin/standalone.conf.bat
  • modules/*
  • ssl/truststore.jks
  • ssl/keystore.jks
  • standalone/configuration/standalone-tim.xml


Standalone and modules may be already in place of JBoss and should be replaced when asked for it. 


On this page