X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

X4 Server and Keycloak – Debian Package for Ubuntu Linux

The following sections describe how to automatically install the X4 Server on a Ubuntu or Debian Linux system based on a Debian package (.deb).

Installing the X4 Server

Note:

Before installing the current package, you must uninstall any existing installations of the X4 Server with the appropriate command.

  1. Download the X4 Server and Keycloak – Debian package for Ubuntu Linux package from the Resources > X4 Downloads section of the the SoftProject website.

  2. Run the installation using the sudo dpkg -i X4-Server_Ubuntu-7.v.v-r.x86_64.deb command.

For example, sudo dpkg -i X4-Server_Ubuntu-7.0.0-1.x86_64.debfor release 1 of X4 Server version 7.0.0.

By default, the X4 Server is installed under /opt/X4. The INSTALL_PATH variable can be used to change the installation path.

For example, sudo INSTALL_PATH=/myNewPath/Tools dpkg -i X4-Server_Ubuntu-7.v.v-r.x86_64.deb

The X4 Server will now be installed in the specified folder. This process may take a few seconds.

  1. Add a valid X4 license. For more information, see License Information .

  2. Start the X4 Server manually by running the startX4.sh script in the installation path.

If you want to install the X4 Server as a service, follow the steps in Instructions: Creating and Managing systemd Services for X4-Server and X4-Authentication-Provider .

  1. After running the script or starting the service, check whether the server log /opt/X4/WildFly/standalone/log/server.log contains error messages.
    A correctly installed and started X4 server does not display any error messages (ERROR or FATAL). This should be the case at the latest at the second start of the X4 Server.

Control options for the X4-Server service

The following options are available via the command line to control the X4 Server or its service X4-Server.

Note:

These options are available only if you have completed the required service installation steps. For more information, see Instructions: Creating and Managing systemd Services for X4-Server and X4-Authentication-Provider.

Action

Command

Start the X4-Server service

service X4-Server start

Stop the X4-Server service

service X4-Server stop

Restart the X4-Server service

service X4-Server restart


Unstalling the X4 Server

To uninstall an X4 Server installed via the Debian package, enter the sudo dpkg -r X4-server command.

Note:

If you have manually installed service files and want to remove them, follow the steps in Instructions: Creating and Managing systemd Services for X4-Server and X4-Authentication-Provider .