X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

X4 Server und Keycloak - Debian-Paket für Ubuntu Linux

In den folgenden Abschnitten wird beschrieben, wie Sie den X4 Server und den Keycloak auf Basis eines Debian-Pakets (.deb) automatisch auf einem Ubuntu- bzw. Debian-Linux-System installieren, als Dienst registrieren, starten und verwalten.

X4 Server installieren


Hinweis:

  • Das Installationspaket wird mit sudo-Berechtigungen gestartet.

  • Während der Installation des X4 Servers werden der neue Benutzer X4 und die neue Gruppe X4 angelegt.

  • Nach der Installation gehört das X4 Server-Dateisystem dem Benutzer X4 und der Gruppe X4.

  • Der installierte Dienst X4-Server wird zwar mit sudo-Berechtigungen gestartet, jedoch ist der Benutzer X4 Eigentümer dieser Dienstausführung.

  • Stellen Sie sicher, dass Sie über die entsprechenden Rechte für den angegebenen Installationspfad verfügen.

Hinweis:

Vor der Installation des aktuellen Pakets müssen Sie alle möglicherweise bereits vorhandenen Installationen des X4 Servers mit dem entsprechenden Befehl deinstallieren.


So installieren Sie das Paket X4 Server und Keycloak - Debian-Paket für Ubuntu Linux:

  1. Laden Sie das Paket X4 Server und Keycloak - Debian-Paket für Ubuntu Linux von der SoftProject-Website aus dem Bereich Ressourcen > Software X4 BPMS herunter.

  2. Führen Sie die Installation mit dem Befehl sudo dpkg -i X4-Server_Ubuntu-7.v.v-r.x86_64.deb aus.

    Wenn Sie den Authentifizierungsprovider Keycloak nicht installieren möchten, verwenden Sie den Befehl sudo X4_INSTALL_AUTH_PROVIDER=no dpkg -i X4-Server_Ubuntu-7.v.v-r.x86_64.deb.
    Beispiel: sudo dpkg -i X4-Server_Ubuntu-7.0.0-1.x86_64.debfür Release 1 der X4 Server-Version 7.0.0.

    Der X4 Server wird standardmäßig unter /opt/X4 installiert. Mit der Variablen INSTALL_PATH kann der Installationspfad geändert werden.
    Beispiel: sudo INSTALL_PATH=/myNewPath/Tools dpkg -i X4-Server_Ubuntu-7.v.v-r.x86_64.deb

    Der X4 Server wird nun im angegebenen Ordner installiert, als Dienst X4-Server registriert und direkt gestartet. Dieser Vorgang kann einige Sekunden dauern.

  3. Prüfen Sie, ob das Serverprotokoll /opt/X4/wildfly/standalone/log/server.log Fehlermeldungen enthält.
    Ein korrekt installierter und gestarteter X4 Server gibt keine Fehlermeldungen (ERROR oder FATAL) aus. Dies sollte spätestens beim zweiten Start des X4 Servers der Fall sein.

  4. Prüfen Sie, ob das Keycloak-Protokoll /opt/X4/keycloak/standalone/log/server.log Fehlermeldungen enthält.
    Ein korrekt installierter und gestarteter Keycloak gibt keine Fehlermeldungen (ERROR oder FATAL) aus. Dies sollte spätestens beim zweiten Start des Keycloaks der Fall sein.

  5. Starten Sie den X4 Server mit dem Befehl sudo service X4-Server restart neu.
    Der X4 Server wurde erfolgreich installiert und wird als Dienst X4-Server ausgeführt.

  6. Starten Sie den Keycloak mit dem Befehl sudo service X4-Authentication-Provider restart neu.
    Der Keycloak wurde erfolgreich installiert.

Nach erfolgreicher Installation bzw. Aktualisierung des X4 Servers über ein Debian-Paket enthält der Installationsordner folgende Elemente:


Ordner

Erläuterung

jdk

Enthält die aktuelle Java Runtime Version als Laufzeitumgebung für den WildFly-Applikationsserver.

SQL

Enthält in Unterordner H2DB die mitgelieferte In-Memory-Datenbank für Testzwecke.

wildfly

Enthält den vorkonfigurierten WildFly-Applikationsserver.

X4DB

Enthält das zentrale X4 Repository.

x4.license

Lizenzdatei für den X4 Server. Sie müssen die Lizenzdatei manuell in den Ordner kopieren, sie ist nicht automatisch vorhanden. Weitere Informationen hierzu finden Sie im Kapitel 

Lizenzen verwalten

.

X4config.xml

Zentrale Konfigurationsdatei des X4 Servers. Weitere Informationen hierzu finden Sie unter 

Konfiguration über X4config.xml

.

apache-maven

Enthält Maven-Plugins für X4.

configurations

Ordner zum Hinterlegen eigener Konfigurationen, z. B. der Datei keycloak_config.json zum Anbinden einer eigenen Keycloak-Installation.

deployments

Enthält die von Ihnen konfigurierten X4 Apps.

installation.checksum

Enthält eine Prüfsumme, mit der die Gültigkeit der installierten Instanz validiert wird.

version.txt

Enthält die X4 Versionsnummer.

startKeycloak.sh

Skript zum Starten des Keycloaks.

startX4.sh

Skript zum Starten des X4 Servers.

stopX4.sh

Skript zum Stoppen des X4 Servers. 


Steuerungsmöglichkeiten für den Dienst X4-Server

Über die Kommandozeile stehen folgende Optionen zur Verfügung, um den X4 Server bzw. dessen Dienst X4-Server zu steuern:

Aktion

Befehl

Dienst X4-Server starten

service X4-Server start

Dienst X4-Server stoppen

service X4-Server stop

Dienst X4-Server neu starten

service X4-Server restart


Steuerungsmöglichkeiten für den Keycloak-Dienst

Über die Kommandozeile stehen folgende Optionen zur Verfügung, um den Keycloak-Dienst  X4-Authentication-Provider zu steuern:

Aktion

Befehl

Dienst X4-Authentication-Provider starten

service X4-Authentication-Provider

Dienst X4-Authentication-Provider stoppen

service X4-Authentication-Provider

Dienst X4-Authentication-Provider neu starten

service X4-Authentication-Provider


Dienst X4-Server deinstallieren

Um einen via Debian-Paket installierten X4 Server und dessen Dienst X4-Server zu deinstallieren, geben Sie den Befehl sudo dpkg -r X4-Server ein.

Das rückstandslose Entfernen aller Installationsartefakte, einschließlich der Konfigurationsdateien etc., zum Dienst X4-Server ist über den Befehl sudo dpkg -P X4-Server möglich.

Beim Deinstallieren ist das Setzen der Variablen INSTALL_PATH nicht notwendig.