Knowledge Base

Frontline Command Center (FCC), Database und Keycloak werden selbst gehostet und gelten als zentrale Komponenten der Frontline-Systemumgebung. Alle kundensensiblen Daten werden in der selbstgehosteten Datenbank und im lokalen Speicher der VM gehostet.

Installation auf einem Ubuntu-System

Datenbank

1. Installieren Sie Maria DB gemäß den offiziellen Installationsanweisungen.
2. Überprüfen Sie die Installation mit dem folgenden Befehl (abhängig von der tatsächlichen MariaDB kann der Dienst aufgerufen MariaDB werden oder mysqld):

systemctl start mysql 
systemctl status mysql 

3. Konfigurieren Sie die Datenbank und den entsprechenden Benutzer:

sudo mysql -uroot -e "CREATE DATABASE frontlinecommandcenter CHARACTER set = 'utf8' COLLATE = utf8_bin; " 
sudo mysql -uroot -e "CREATE USER 'frontline'@'localhost' IDENTIFIED BY '$PASS'" 
sudo mysql -uroot -e "GRANT ALL ON frontlinecommandcenter.* TO 'frontline'@'localhost' IDENTIFIED BY '$PASS' WITH GRANT OPTION; " 

4. Ersetzen Sie den $PASS Platzhalter durch ein sicheres Passwort.

Frontline Command Center

1. Erstellen Sie ein Verzeichnis für die frontline.jar Datei: sudo mkdir /var/opt/frontline

2. Erstellen Sie ein Verzeichnis für die Benutzerdaten: sudo mkdir /var/data/frontline

3. Laden Sie die JAR-Datei der Serveranwendung über Frontline-Downloads herunter.

4. Benennen Sie es die Datei in frontline.jar um und kopieren Sie diese /var/opt/frontline: sudo cp ~/Downloads/frontline.jar /var/opt/frontline

5. Machen Sie frontline.jar ausführbar: sudo chmod +x /var/opt/frontline/frontline.jar 

6. Frontline wird als Spring Boot Service ausgeführt. Navigieren Sie zu /etc/systemd/system einer Datei mit den Dienstdetails, und erstellen Sie eine Datei: sudo touch frontline.service

7. Bearbeiten Sie frontline.service und fügen Sie Folgendes hinzu:

[Einheit] 
Beschreibung=Frontline-Kommandozentrale 
After=mysql.service 

[Dienst] 
Environment="UBIMAX_HOME=/var/data/frontline/"
 ExecStart=/var/opt/frontline/frontline.jar 
SuccessExitStatus=143 

[Installieren] 
WantedBy=multi-user.target 

8. Um den Dienst zu aktivieren, verwenden Sie systemctl enable frontline.service

9. Starten Sie den Dienst über systemctl start frontline.service

10. Der Dienst erstellt einige Konfigurationsdateien /var/data/frontline und wird dann heruntergefahren.

Installation auf einem Windows-System

Datenbank

1. Laden Sie die neueste stabile Version von MariaDB von der offiziellen Website herunter und folgen Sie der Installationsanleitung.

2. Führen Sie den MariaDB-Installer inklusive des HeidiSQL-Unterstützungsprogramms aus.

3. Erstellen Sie ein Root-Passwort für die Datenbank.

4. Klicken Sie auf Weiter.

5. Nachdem Sie die Installation abgeschlossen haben, starten Sie das HeidiSQL-Dienstprogramm. Unter der Annahme einer Standardinstallation befindet sich die Datei hier:  C:\Program Files (x86)\Common Files\MariaDBShared\HeidiSQL\heidisql.exe

6. Klicken Sie auf Neu.

7. Erstellen Sie eine neue Datenbank mit einem bestimmten Namen (z. B. Frontline_Test).

8. Ersetzen Sie den $PASS Platzhalter durch Ihre zuvor erstellte dbrootpassword.

9. Optional: Passen Sie den Hostnamen/die IP-Adresse und die Portnummer an.

Wenn ein anderes Datenbanksystem verwendet wird, passen Sie die folgende SQL-Anweisung an die Datenbank an:

CREATE DATABASE FrontlineCommandCenter ZEICHENSATZ = 'utf8' COLLATE = utf8_bin;  
ERSTELLEN SIE DEN BENUTZER 'FRONTLINE'@'%', IDENTIFIZIERT DURCH '$PASS';  
GRANT ALL ON FrontlineCommandCenter.* TO 'frontline'@'%' IDENTIFIZIERT DURCH '$PASS' MIT GRANT-OPTION;  

Kommandozentrale an vorderster Front

1. Rufen Sie die Seite Frontline-Downloads auf.
2. Laden Sie die Serveranwendungsdatei herunter, und benennen Sie sie in frontline.jar um.
3. Laden Sie den Serverdienst-Wrapper von derselben Seite herunter.

FCC benötigt ein Installationsverzeichnis und ein DATA-Verzeichnis: 

1. Installationsverzeichnis : Enthält die frontline.jar Datei und die WinSW_frontline.exe und WinSW_frontline.xml Service-Wrapper-Dateien. 
   1. Ort: C:\Frontline 
   2. ID: $BASE$ 
2. DATA-Verzeichnis - Dies wird als Home-Verzeichnis verwendet. Es wird für Kunden-Assets wie Login-Karten und Themes verwendet. Erstellen Sie einen neuen Ordner innerhalb des Installationsverzeichnisses, und nennen Sie ihn DATA. 
   1. Ort: C:\Frontline\DATA 
   2. ID: $FRONTLINE_HOME$ 

Der WinSW_frontline.exe Service-Wrapper ermöglicht es Benutzern, den FCC-Dienst als Windows-Dienst zu installieren. 

1. Wahlfrei: Wenn Sie einen Forward-Proxy konfigurieren müssen (z. B. um FCC den Zugriff auf unseren Lizenzserver zu ermöglichen), öffnen Sie die Datei WinSW_frontline.xml und fügen Sie sie am Anfang des <arguments> Elements hinzu-Dhttps.proxyHost=$HOST -Dhttps.proxyPort=$PORT -Dhttps.nonProxyHosts=localhost, wobei Sie und durch die Werte Ihres Proxys ersetzen$HOST. $PORT
2. Öffnen Sie eine Eingabeaufforderung (mit Administratorrechten).
3. Ändern Sie das Verzeichnis in $BASE$.
4. Führen Sie WinSW_frontline.exe install.
5. net start frontline(Standarddienst-ID ist frontline).

Beim ersten Start wird der Dienst nach dem Extrahieren der Konfigurationsdateien automatisch gestoppt. Windows meldet den Dienst möglicherweise als fehlgeschlagen oder abgestürzt.  

Das FCC-Konfigurationsverzeichnis befindet sich innerhalb des Verzeichnisses $FRONTLINE_HOME$ . Der Speicherort sollte C:\Frontline\DATA\config\configuration\sein. Die Konfigurationsdatei xserver.properties sollte wie unten beschrieben bearbeitet werden. 

Erstkonfiguration von Frontline Command Center (Ubuntu und Windows)

1. Öffnen Sie die Datei xserver.properties , die sich unter UBIMAX_HOME/config/configuration/befindet.
2. Ändern Sie die IP-Adresse, den Benutzernamen und das Kennwort der Datenbank (um die IP-Adresse anzuzeigen, verwenden Sie den ip addr show Befehl).
3. Wenn der Kunde einen Hostnamen hat, xserver.url.external.http kann anstelle der IP-Adresse verwendet werden. Der Port muss in server.porterwähnt werden. SSL muss konfiguriert werden, es sei denn, es gibt einen Reverseproxy mit SSL-Terminierung.  

Je nach individuellem System und Anforderungen wird die Einrichtung bzw. Konfiguration von Komponenten wie Keycloak, xAssist Stack, ffmpeg, Email und FaaS benötigt. 

FaaS (obligatorisch)

1. Um Frontline-Clouddienste zu verwenden, legen Sie die folgende Eigenschaft fest: 

fcc.faas.base-url=https://functions.svc.frontlineworker.com/function/ 

2. Beim Self-Hosting kann der Endpunkt jedes FaaS einzeln überschrieben werden:

fcc.faas.function.<function>.override-url=

wohingegen function , imagemagickpdfmake oder progloveist. 

3. Für ImageMagick und Proglove ist keine zusätzliche Konfiguration erforderlich.

4. Für PDFMake müssen die folgenden Umgebungsvariablen gesetzt werden:  

RAW_BODY: "true" 
MAX_RAW_SIZE: "100MB" 

Starten des Servers

1. Nachdem die Einrichtung der Eigenschaften abgeschlossen ist, starten Sie den Server mit dem folgenden Befehl: systemctl start frontline.service (UBUNTU) oder net start frontline (WINDOWS)
2. Der Status des Dienstes kann unter UBIMAX_HOME/log/server/fronline.logüberprüft werden.
3. Beim ersten erfolgreichen Start von FCC wird ein Systemadministrator-Benutzer mit sysadmin einem zufälligen Kennwort erstellt. Dieser Benutzer wird verwendet, um FCC zu konfigurieren. 
4. Das Kennwort für den sysadmin Benutzer kann aus den Protokolldateien abgerufen werden, die sich unter$FRONTLINE_HOME\logs befinden.
5. Öffnen Sie die frontline.log Datei, und das Kennwort wird im folgenden Format angezeigt: 

INFO  de.ubimax.xserver.DatabaseSetupManager - ########################################################## - -:-/- 
INFO  de.ubimax.xserver.DatabaseSetupManager - ########################################################## - -:-/-
 INFO  de.ubimax.xserver.DatabaseSetupManager - ########################################################## - -:-/- 
INFO  de.ubimax.xserver.DatabaseSetupManager - ########################################################## - -:-/- 
INFO  de.ubimax.xserver.DatabaseSetupManager - IHR GENERIERTES SYSADMIN-PASSWORT: 123456789 - -:-/-
 INFO  de.ubimax.xserver.DatabaseSetupManager - ÄNDERN SIE DIESES PASSWORT SO SCHNELL WIE MÖGLICH IN EIN PERSONALISIERTES. - -:-/- 
INFO  de.ubimax.xserver.DatabaseSetupManager - ########################################################## - -:-/- 
INFO  de.ubimax.xserver.DatabaseSetupManager - ########################################################## - -:-/-
 INFO  de.ubimax.xserver.DatabaseSetupManager - ########################################################## - -:-/- 
INFO  de.ubimax.xserver.DatabaseSetupManager - ##################################################### 

6. Melden Sie sich mit dem sysadmin Benutzer an und ändern Sie das Kennwort.

So importieren Sie eine Lizenz:

1. Öffnen Sie das Frontline Command Center.
2. Gehen Sie zu Konfiguration.
3. Gehen Sie zu Lizenzen.
4. Klicken Sie auf Lizenz importieren.
5. Klicken Sie im nachfolgend angezeigten Modal auf Lizenz importieren, um den Eintrag mit dem Lizenzserver zu synchronisieren. 

Keycloak (obligatorisch)

Beim Ausführen von Keycloak gibt es zwei Betriebsmodi: den Standalone-Modus und den Cluster-Modus. Welchen Sie wählen, hängt von Ihren individuellen Anforderungen ab. Eine detaillierte Anleitung zur Einrichtung finden Sie in der offiziellen Keycloak-Installationsanleitung. Frontline unterstützt Version 15 oder höher.

Nachdem Keycloak erfolgreich installiert wurde, müssen die Realms, die in dieser Installation verwendet werden sollen, erstellt werden. Jede Domäne für eine FCC-Installation muss über einen separaten Bereich verfügen.

1. Laden Sie diese JSON-Datei herunter.
2. Öffnen Sie die JSON-Datei für den Bereichsexport.
3. Ersetzen Sie alle Vorkommen von durch <the-fcc-url> die tatsächliche FCC-URL.
4. Optional: Ersetzen Sie alle Vorkommen von durch frontline-realm einen anderen Realmnamen (nur anwendbar, wenn mehrere Frontline-Realms in Keycloak benötigt werden).
5. Optional: Suchen Sie nach "claim.name": "domain" dem entsprechenden Domänenwert , und ersetzen Sie ihn (nur anwendbar, wenn FCC eine andere Domäne als die Standarddomäne ubimax verwendet).
6. Melden Sie sich über den Browser bei der Keycloak-Administrationskonsole an. 
7. Klicken Sie auf Bereich auswählen.
8. Wählen Sie Bereich hinzufügen aus.
9. Wählen Sie eine Datei aus, die importiert werden soll.
10. Öffnen Sie den importierten Bereich.
11. Navigieren Sie zu Clients/FCC/Credentials.
12. Klicken Sie auf Secret neu generieren.
13. Kopieren Sie diesen Wert.
14. Der kopierte Wert muss in der Datei xserver.properties der FCC als fcc.keycloak.realms.<domain>.clientSecret (<domain> festgelegt werden ubimax .
15. Optional: Konfigurieren Sie einen SMTP-Server auf der Registerkarte "E-Mail" der Realm-Einstellungen.
16. Nachdem Keycloak konfiguriert wurde, müssen die folgenden Eigenschaften pro Domäne in der Datei xserver.properties der FCC festgelegt werden:
    1. Alle Platzhalter, die in Chevrons (<>) geschrieben sind, müssen durch die entsprechenden Angaben ersetzt werden.
    2. Es ist beabsichtigt, die KeyMan URI auf null.

fcc.keycloak.enabled=true 
fcc.keycloak.realms.<domain>.name=<realm-name>
 fcc.keycloak.realms.<domain>.domainTag=<domain>
 fcc.keycloak.realms.<domain>.realmId=<realm-name> 
fcc.keycloak.realms.<domain>.serverUrl=<keycloak-external-url>
 fcc.keycloak.realms.<domain>.clientId=fcc 
fcc.keycloak.realms.<domain>.clientSecret=< Client-Secret> 
fcc.keycloak.keyman.uri= 

Hochladen der Clientanwendung

Sobald der Keycloak konfiguriert ist, muss ein Admin-Benutzer erstellt und die Client-Anwendung in das Frontline Command Center hochgeladen werden.

1. Erstellen Sie einen Benutzer mit einer Administratorrolle , indem Sie die auf der Seite Benutzerverwaltung genannten Schritte ausführen.
2. Laden Sie die neueste Frontline Workplace-Smart-Glass-Anwendung von der Download-Seite herunter.
3. Wählen Sie in der Frontline Command Center oben links die Option Navigationsbereich aus.
4. Gehen Sie zu Konfiguration.
5. Führen Sie die auf der Seite Anwendungsverwaltung genannten Schritte aus, um die Anwendung hochzuladen.

Identity Brokering (optional)

Mit Identity Brokering können Keycloak-Realms mit externen OpenID-basierten Identity Providern (IDPs) verbunden werden. Das bedeutet, dass der Benutzer statt der Eingabe von Zugangsdaten in Keycloak zu einem externen IDP (z. B. Azure AD oder Okta) weitergeleitet wird und nach erfolgreicher Authentifizierung wieder zu Keycloak (und dann weiter zu Frontline) weitergeleitet wird. 

Die folgende Abbildung zeigt den grundlegenden Authentifizierungsprozess, wenn sich ein Benutzer anmeldet:

Der Benutzer wird sein Passwort niemals an FCC weitergeben, sondern wird zu Keycloak und dem Identitätsanbieter weitergeleitet, der ein Authentifizierungstoken erstellt. Standardmäßig versucht Keycloak, den externen Benutzer über die E-Mail-Adresse mit einem bestehenden Frontline-Benutzer abzugleichen. Wenn dies nicht möglich ist (wenn kein passender Benutzer gefunden wurde), wird der Anmeldevorgang abgebrochen und der Zugriff auf Frontline verweigert. 

Ein Keycloak-Realm kann mehrere Identitätsbroker (z. B. Azure AD) enthalten. Dies bietet die Möglichkeit, sich sowohl mit lokalen Konten als auch mit verschiedenen externen Konten anzumelden. In bestimmten Szenarien kann es von Vorteil sein, Benutzer on-the-fly zu erstellen, sobald ein neuer Benutzer versucht, sich anzumelden. Dies wird als Benutzerbereitstellung bezeichnet und kann mithilfe der folgenden Eigenschaft in FCC aktiviert werden: 

fcc.keycloak.user-provisioning.enabled=true 

Darüber hinaus müssen die folgenden Eigenschaften konfiguriert werden: 

server.servlet.session.cookie.same-site=none 
server.servlet.session.cookie.secure=true 

Auf diese Weise werden zwar Benutzerkonten bei der ersten Anmeldung erstellt, aber das Konto selbst ist zu diesem Zeitpunkt praktisch nutzlos, da ihm weder eine Lizenzstufe noch Rollen zugewiesen sind. Dieses Verhalten kann über die folgenden Eigenschaften geändert werden. Die folgenden Änderungen führen dazu, dass alle bereitgestellten Benutzer in FCC mit der xAssist-Rolle aus der zugewiesenen xAssist-Lizenzstufe landen: 

fcc.keycloak.user-provisioning.default-license-tiers=xAssist
fcc.keycloak.user-provisioning.default-roles=xAssist

Die Identitätsvermittlung erfordert eine gewisse Einrichtung auf der Seite des Identitätsanbieters, den Sie verwenden möchten. Das folgende Beispiel zeigt, wie Azure AD als Identitätsanbieter konfiguriert wird. Andere Identitätsanbieter verfolgen ähnliche Ansätze.  

So konfigurieren Sie Azure AD als Identitätsanbieter in Keycloak:

1. Wählen Sie Ihren Bereich aus.
2. Wechseln Sie zu Identitätsanbieter.
3. Fügen Sie einen neuen OpenID Connect v1.0-Anbieter hinzu.
4. Scrollen Sie ganz nach unten zu Import External IDP Config.
5. Fügen Sie Ihre Discovery-URL ein.
6. Klicken Sie auf Importieren. Dies sollte Felder wie Autorisierungs-URL oder Token-URL ausfüllen. 
7. Bearbeiten Sie die folgenden Werte manuell:   
   1. Alias und Name: Diese können auf benutzerdefinierte Werte festgelegt werden, wobei der Name derjenige ist, der später auf der Anmeldeseite angezeigt wird, während der Alias im Umleitungs-URI zu finden ist. 
   2. ClientAuthMethod - Wählen Sie client_secret_post
   3. ClientID: Wird beim Erstellen einer App in Azure gefunden. 
   4. ClientSecret : Wird beim Erstellen einer App in Azure gefunden. 
8. Speichern Sie den neu hinzugefügten Identitätsanbieter. Danach sollte es auf der Single-Sign-On-Seite erscheinen.

Azure AD als Identitätsanbieter

1. Melden Sie sich bei Azure an.
2. Navigieren Sie zu App-Registrierungen.
3. Gehen Sie zu Neue Registrierung.
4. Nennen Sie die App Frontline Keycloak.
5. Legen Sie sie auf Single Tenant fest. Der Umleitungs-URI wird noch nicht benötigt.

6. Sobald die App erstellt wurde, wird die Client-ID auf der Hauptseite angezeigt.

7. Die Discovery-URL finden Sie unter Endpunkte. Es handelt sich um das OpenID Connect-Metadatendokument . 

8. Generieren Sie das Client Secret. Klicken Sie dazu auf die aktuellen Client-Anmeldeinformationen. 

9. Um ein neues Client Secret hinzuzufügen, klicken Sie auf New Client Secret. Die Beschreibung sollte Frontline secret sein und die Dauer sollte auf 24 Monate festgelegt werden. 

10. Sobald das Geheimnis hinzugefügt wurde, wird ein Eintrag mit einem Wert und einer Geheimnis-ID generiert.

So konfigurieren Sie den fehlenden Umleitungs-URI in Azure:

1. Navigieren Sie über die App-Registrierung zu unserer App Frontline Keycloak.
2. Wählen Sie Redirect-URIs aus. 

3. Wählen Sie Plattform/Web hinzufügen aus. 

4. Der Redirect URI, der eingegeben werden muss, sieht wie folgt aus:

<Local-Keycloak-Url>/auth/realms/<your-realm-name>.