X4 Server and Keycloak - RPM package for Red Hat Enterprise Linux

The following sections describe how to automatically install, register as a service and manage the X4 Server and the Keycloak based on an RPM package (.rpm) on a Red Hat Enterprise Linux system.

Installing the X4 Server

Before you begin with the installation of the X4 Server:

Make sure that the IP address of the server and the host name are specified under /etc/hosts(example: 192.168.147.153 vmettopensuse01).
Execute the dnf install redhat-lsb-core command because the redhat-lsb-core module must be installed.

Note:

The installation package will be started with sudo privileges.
The new user X4 and the new group X4 will be created during the installation of the X4 Server.
Once the installation is complete, the user X4 and the group X4 are the owner of the X4 file system.
Although the installed X4-Server service will be started with sudo privileges, the user X4 is the owner of this service execution.
Make sure that you have the relevant privileges for the specified installation path.

How to install the X4 Server and Keycloak - RPM package for Red Hat Enterprise Linux package:

Download the X4 Server and Keycloak - RPM package for Red Hat Enterprise Linux from the SoftProject website from the X4 BPMS > Downloads section.
Execute the installation using the sudo rpm -i X4-Server_RHEL-7.v.v-r.x86_64.rpm command.
Example: sudo rpm -i X4-Server_RHEL-7.0.0-1.x86_64.rpm for release 1 of the X4 Server version 7.0.0.
By default, the X4 Server will be installed at /opt/X4. You can use the --prefix parameter to change the installation path.
Example: sudo rpm -i X4-Server_RHEL-7.v.v-r.x86_64.rpm --prefix=/new_path
The X4 Server will be installed in the specified folder, registered as X4-Server server and started directly. This process may take several seconds.
Copy your x4.license license file to the installation folder of the X4 Server.
Example: sudo cp x4.license /opt/X4

Note:

In the case of errors during the start of the X4 Server or the Keycloak, you can check the error messages in the corresponding log file (/opt/X4/wildfly/standalone/log/server.log for the X4 Server and /opt/X4/keycloak/data/log/keycloak.log for the Keycloak).

After the successful installation of the X4 Server and the Keycloak using an RPM package, the installation folder contains the following items:

Item	Explanation
`jdk`	Contains the current Java Runtime Version as runtime environment for the WildFly application server.
`SQL`	Contains the in-memory database provided for testing purposes in the `H2DB` subfolder.
`wildfly`	Contains the preconfigured WildFly application server.
`keycloak`	Contains the Keycloak.
`X4DB`	Contains the central X4 Repository.
`x4.license`	License file for the X4 Server. You have to copy the license file manually into this folder, it will not be available automatically. For more information, see the Licenses chapter.
`X4config.xml`	Central configuration file of the X4 Server. For more information, see the Configuration via X4config.xml chapter in the Administration Guide.
`apache-maven`	Contains maven plug-ins for X4.
`configurations`	Folder to store custom configurations, e.g. the `keycloak_config.json` file to connect your own Keycloak installation.
`deployments`	Contains the X4 Apps you have configured.
`installation.checksum`	Contains a checksum which is used to check the validity of the installed instance.
`version.txt`	Contains the X4 version number.
`startKeycloak.sh`	Script to start the Keycloak.
`startX4.sh`	Script to start the X4 Server.
`stopX4.sh`	Script to stop the X4 Server.

Control Options for the X4-Server Service

The following options are available via the command line in order to control the X4 Server or the corresponding X4-Server service:

Action	Command
Start the `X4-Server` service	`systemctl start X4-Server`
Stop the `X4-Server` service	`systemctl stop X4-Server`
Restart the `X4-Server` service	`systemctl restart X4-Server`
View the status of the `X4-Server` service	`systemctl status X4-Server`
Reload the `X4-Server` service	`systemctl reload X4-Server`

Control Options for the Keycloak Service

The following options are available via the command line in order to control the X4-Authentication-Provider Keycloak service:

Action	Command
Start the `X4-Authentication-Provider` service	`systemctl start X4-Authentication-Provider`
Stop the `X4-Authentication-Provider` service	`systemctl stop X4-Authentication-Provider`
Restart the `X4-Authentication-Provider` service	`systemctl restart X4-Authentication-Provider`
View the status of the `X4-Authentication-Provider` service	`systemctl status X4-Authentication-Provider`
Reload the `X4-Authentication-Provider` service	`systemctl reload X4-Authentication-Provider`

Deinstalling the X4-Server Service

To deinstall an X4 Server installed using an RPM package and the corresponding X4-Server service, enter the sudo rpm -e X4-Server_RHEL-7.v.v-r.x86_64 command.