Server-Installation (Umstellung auf Isolated mode)

Ab FirstSpirit 2019-02 ist der Isolated Mode der Standard für Neuinstallationen. Die Umstellung eines bestehenden Servers (Legacy Mode) wird weiter unten beschrieben.

Generell kann ein Server umgestellt werden, auch wenn noch nicht alle Module umgestellt sind. Siehe Kapitel Module: Kompatibilität sicherstellen.

Hinweis: Dass ein Server im Isolated Mode betrieben wird, zeigt die Angabe der Server-Version (z. B. auf der Startseite, unter Server-Version / Weitere Details). In diesem Fall wird die Versionsnummer um das Kürzel „(I)“, als Hinweis auf den Isolated Mode, erweitert.

Unterschiede Isolated vs. Legacy Server

• Anders als für Legacy Server wird für Isolated Server die Datei fs-isolated-server.jar verwendet (statt fs-server.jar).
• Die Dateien fs-isolated-server.jar und wrapper.jar liegen im Verzeichnis server/lib-isolated (statt server/lib).
• Statt der Konfigurationsdatei für den Wrapper fs-wrapper.conf wird im Isolated Mode die Datei fs-wrapper.isolated.conf verwendet.
• Bei FirstSpirit-Servern, die im Isolated Mode betrieben werden, steht in der Datei bin/fs5.mode der Wert „isolated“. Ist das nicht der Fall, wird der Server im Legacy Mode gestartet.
• Der Inhalt der Datei fs5.mode wird ignoriert und der Server wird immer im Isolated Mode gestartet.

Neuinstallationen im Isolated Mode

Standardmäßig werden FirstSpirit-Server, die mit FirstSpirit 2019-02 oder höher neu installiert werden, im Isolated Mode installiert. Die Installation erfolgt über die Datei

fs-install-[version].tar.gz

Sie ist per Download erhältlich (für Zugangsdaten wenden Sie sich bitte an den Technical Support).

Eine Installation über das tar.gz-Archiv besteht aus fünf Schritten:

• Auspacken des Installationsarchivs. Gegebenenfalls muss das Archiv zunächst dekomprimiert (G(un)zip) und dann ausgepackt werden.
• Kopieren der FirstSpirit-Server-Datei (fs-isolated-server.jar) für die gewünschte FirstSpirit-Version in das Verzeichnis ~FS/server/lib-isolated. (~FS = Installationsverzeichnis für den FirstSpirit-Server)
• Kopieren der Lizenzdatei (fs-license.conf) in das Verzeichnis ~FS/conf. (Die Lizenzdatei kann über den zuständigen vertrieblichen Ansprechpartner oder über den Technical Support angefordert werden.)
• Setzen der Umgebungsvariable FS_JAVA_HOME auf das Verzeichnis in der gewünschten Java-Version (z. B. FS_JAVA_HOME=/opt/java/jdk-17.0.3+7).
  Alternativ kann in der Datei fs-wrapper.isolated.conf auch der vollständige Java-Pfad mit dem Parameter wrapper.java.command angegeben werden.
• Erststart des FirstSpirit-Servers:
  • unter Linux mit ~FS/bin/fs-server start oder mit ~FS/bin/fs-server installstart (installieren als Dienst und anschließendes Starten dieses Dienstes)
  • unter Windows mit ~FS\bin\fs-server install und ~FS\bin\fs-server start (durch Start des neu installierten Dienstes)
    oder alternativ mit ~FS\bin\fs-server console (ohne Nutzung eines Windows-Dienstes)

Achtung! Für den Aufruf von fs-server install werden unter Windows-Administratorenrechte benötigt.

Die Installation erfolgt im Isolated Mode, für den HTTP-Port wird 8000 und für den Socket-Port 1088 verwendet.

Installation des Windows-Dienstes

• ~FS\bin\fs-server install
  Die Konfiguration des Windows-Dienstes in der Datei fs-wrapper.isolated.conf kann über die Parameter wrapper.ntservice.* angepasst werden.

Installation mit abweichendem Port

• Vor Schritt 5) müssen die Werte für HTTP_PORT und/oder SOCKET_PORT in der Datei ~FS/conf/fs-server.conf geändert werden.

Hinweise für die Installation unter Linux:

• Unter Linux wird von dem Betrieb als root dringend abgeraten.
• Eine automatische Anlage von Benutzern und Gruppen ist nicht vorgesehen, d.h. der Administrator muss sich vor der Installation um die Anlage und Konfiguration eines Accounts kümmern.
• Für die Installation des Dienstes "fs-server" kann ~FS/bin/fs-server installverwendet werden.

Migration zum Isolated Mode

1) Betriebsumgebung mit fs-update-[version].tar.gz aktualisieren

Falls die Betriebsumgebung des Servers (Java-Wrapper und Konfigurationsdateien) nicht ganz aktuell ist, oder sie noch mit einer Datei fs-installer-[version].tgz (statt mit der neuen Datei fs-install-[version].tar.gz, verfügbar seit FirstSpirit 2018-11) installiert wurde, sollte zunächst die Betriebsumgebung aktualisiert werden, und zwar mit folgender Datei:

fs-update-[version].tar.gz

(auch Aktualisierungsarchiv)

Die Aktualisierung der Betriebsumgebung erfolgt durch das Auspacken dieser Datei im FirstSpirit-Server-Installationsverzeichnis.
Exemplarischer Aufruf unter Linux:

~/firstspirit5$ tar xvfz fs-update-3.0.6.tar.gz

Nach dem Auspacken sollten die Benutzer- und Gruppenrechte der ausgepackten Dateien betrachtet und ggfs. angepasst werden. Die Rechte sollten so vergeben sein, wie sie auch für die FirstSpirit-Installation gelten.

Die bisher nicht genutzte Datei ~FS/conf/fs-wrapper.isolated.conf sollte mit der Datei ~FS/conf/conf-all/fs-wrapper.isolated.conf.default.txt überschrieben werden, damit die aktuell empfohlenen Startparameter genutzt werden. Spezielle Einstellungen (z.B. Name des Windows Dienstes, manuell konfigurierte Java Version) sollten danach ergänzt bzw. aus der ~FS/conf/fs-wrapper.conf übernommen werden.

2) fs-isolated-server.jar im Server-Verzeichnis ablegen
Die Datei fs-isolated-server-[version].jar wird im Server-Verzeichnis unter dem Pfad server/lib-isolated abgelegt. Die fs-server.jar (oder sogar das komplette server/lib-Verzeichnis) kann nach erfolgter Umstellung gelöscht werden. Der Name der jar-Datei spielt keine Rolle (sofern er mit .jar endet), aber es dürfen nicht mehrere Versionen der fs-isolated-server.jar in dem Verzeichnis abgelegt sein!

Anschließend wird der FirstSpirit-Server (Legacy Mode) heruntergefahren.

3) Klassen und Jars kopieren
Wenn in den Verzeichnissen ~FS/shared/lib oder ~FS/shared/classes Dateien vorhanden sein sollten, so müssen diese in dei Verzeichnisse ~FS/shared/lib-isolated bzw. ~FS/shared/classes-isolated kopiert werden.

Entsprechende Libraries sollten statt dessen besser als Modul zur Verfügung gestellt werden.

4) Server starten
Schließlich kann der Server, wie gewohnt, über das Kommando fs-server wieder gestartet werden (als Isolated-Server). Nach erfolgreicher Umstellung werden beim ersten Server-Neustart automatisch die Webapplikationen neu ausgerollt.

5) Aufräumen
Wenn der FirstSpirit Server im Isolated Mode problemlos genutzt werden kann, können folgende Verzeichnisse gelöscht werden:
~FS/shared/lib
~FS/shared/classes
~FS/server/lib
~FS/server/classes
Weiterhin können im ~FS/bin Verzeichnis alle Dateien gelöscht werden, die mit fs5 beginnen.

Hinweis für Windows-Betriebssystem

Wenn FirstSpirit als Dienst auf einem Windows-Betriebssystem verwendet wird, so muss der alte Dienst deinstalliert werden

fs5 remove

Nach dem Update der Betriebsumgebung (und gegebenenfalls notwendigen Anpassungen an der fs-wrapper.isolated.conf sowie der fs5.mode-Datei) wird der Dienst mittels

fs-server install

wieder installiert. Für beide Aktionen werden Windows-Administratorenrechte benötigt.

Für weitere Informationen zur Installation und Aktualisierung eines FirstSpirit-Servers siehe Installation (→Dokumentation für Administratoren)