Einleitung
Einleitung

Einleitung / FirstSpirit installieren

FirstSpirit installieren

Installation per Installationsarchiv

Inhaltsverzeichnis

Die FirstSpirit-Installation wird über das Installationsarchiv durchgeführt:

  • für alle unterstützten Betriebssysteme und
  • für alle unterstützten Java-Versionen

Informationen zu unterstützten Betriebssystemen und Java-Versionen für den FirstSpirit-Server siehe Technische Voraussetzungen und Empfehlungen (→Dokumentation für Administratoren).

Im Dateinamen des Installationsarchivs wird eine Versionsnummer angegeben, z. B.

fs-install-1.0.0.tar.gz

Diese Versionsnummer entspricht der Versionsnummer des FirstSpirit-Backends, zu dem unter anderem der Java Service Wrapper gehört (s.u.). (Diese Versionsnummer hat keinen Bezug zur Versionsnummer des FirstSpirit-Servers.)

Im Folgenden wird für die verwendete Version des Installationsarchivs der Platzhalter [version] verwendet. Dieser muss durch die Version des für die jeweilige Installation tatsächlich verwendeten Installationsarchivs ersetzt werden.

fs-install-[version].tar.gz 

Installation (Standardeinstellung)

Eine Standard-Installation:

Zur Installation mit abweichender Portnummer siehe Installation mit abweichendem Port.

Zur Installation im Legacy Mode (siehe Installation im Legacy Mode (nicht empfohlen)).

Die Installation über das Installationsarchiv besteht aus folgenden Schritten:

1) Installationsarchiv auspacken

Normalerweise reicht tar xzf. Bei ganz einfachem tar muss das Archiv erst noch mit gunzip ausgepackt werden.

2) FirstSpirit-Server-Datei kopieren

Anschließend wird die FirstSpirit-Server-Datei fs-isolated-server.jar für die gewünschte FirstSpirit-Version in das Verzeichnis ~FS/server/lib-isolated kopiert.

~FS ist hier das Installationsverzeichnis für den FirstSpirit-Server.

Zur Bereitstellung siehe Bereitstellung der Firstpirit-Server-Dateien.

3) JDK auswählen

Über die Umgebungsvariable FS_JAVA_HOME muss der Pfad zum installierten JDK angegeben werden, z. B.:

FS_JAVA_HOME=/opt/java/jdk-11.0.4

Der vollständige Pfad zum JDK kann stattdessen auch in der Konfigurationsdatei ~FS/conf/fs-wrapper.isolated.conf angegeben werden, als Parameter wrapper.java.command.

Bei Bedarf kann der Pfad über diesen Parameter später geändert werden, siehe Parameter des Java-Wrappers (→Dokumentation für Administratoren).

4) Lizenz installieren

Nach der Installation muss eine gültige FirstSpirit-Lizenz installiert werden.

Ist keine Lizenz installiert:

  • kann FirstSpirit nach jedem Start nur für einen Zeitraum von 30 Minuten benutzt werden.
  • werden alle eingeloggten FirstSpirit-Benutzer vor dem Herunterfahren des Servers benachrichtigt.

5) Konfiguration Java VM anpassen

Anschließend sollte die Konfiguration des FirstSpirit-Servers nach Kapitel Dateisystemorganisation (→Dokumentation für Administratoren) im Handbuch "Dokumentation für Administratoren" durchgeführt werden und dort vor allem das Unterkapitel Java-VM und -Wrapper (fs-wrapper.conf) (→Dokumentation für Administratoren) beachtet werden.

6) FirstSpirit-Server starten

Anschließend kann der FirstSpirit-Server gestartet werden.

Demo- und Blueprint-Projekte

e-Spirit stellt Demo- und Blueprint-Projekte mit exemplarischen Basis-Inhalten und Konfigurationen zur Verfügung.

Bei Bedarf können die folgenden (und weitere) Projekte über den Technical Support angefordert werden.

Projekte:

Wichtig Um das Demoprojekt „Mithras Energy“ vollständig nutzen zu können, wird das Modul Apache FOP (fs-fop.fsm) benötigt (siehe Unterstützung für Apache FOP (→Dokumentation für Administratoren)).

Weitere Dokumentation:

Installation (abweichend von der Standardeinstellung)

Installation mit abweichendem Port

Vor dem Start des FirstSpirit-Servers müssen die Werte für HTTP_PORT und/oder SOCKET_PORT in der Datei ~FS/conf/fs-server.conf geändert werden (siehe Communication (→Dokumentation für Administratoren)).

Installation im Legacy Mode (nicht empfohlen)

Soll (entgegen der Empfehlung) eine Installation im „Legacy Mode“ erfolgen, ist das aktuell noch möglich.

Wichtig Der Legacy Mode wird mittelfristig entfallen.

Zur Installation eine FirstSpirit-Servers im Legacy Mode müssen die folgenden Schritte ausgeführt werden:

  1. Installationsarchiv entpacken (wie oben für die Standard-Installation beschrieben).
  2. Anschließend wird die FirstSpirit-Server-Datei fs-server.jar für die gewünschte FirstSpirit-Version in das Verzeichnis ~FS/server/lib kopiert (~FS ist hier das Installationsverzeichnis für den FirstSpirit-Server).
  3. Über die Umgebungsvariable FS_JAVA_HOME muss der Pfad zum installierten JDK angegeben werden, siehe Standard-Installation.
  4. Die Datei ~FS/bin/fs5.mode muss gelöscht werden. (Bei FirstSpirit-Servern, die im Isolated Mode betrieben werden, steht in dieser Datei der Wert isolated.)
  5. Die Datei ~FS/bin/fs5.mode.legacy muss kopiert und die kopierte Datei in ~FS/bin/fs5.mode umbenannt werden.
  6. Nach Fertigstellung der Installation muss eine gültige FirstSpirit-Lizenz installiert werden. Anschließend kann der FirstSpirit-Server im Legacy Mode gestartet werden (siehe 4) Lizenz installieren).

Erläuterung: Isolated Mode und Legacy Mode

Seit Einführung des „Isolated Mode“ für den FirstSpirit-Server können Module in zwei unterschiedlichen Modi (Isolated und Legacy) entwickelt werden.

Der „Legacy Mode“ wird mittelfristig entfallen, bis dahin sollten alle Module und Server umgestellt sein.

Zielsetzung

Der „Isolated Mode“ des FirstSpirit-Servers hat als wesentliches Ziel, dem Modulentwickler eine größere Freiheit bei der Auswahl der verwendeten Bibliotheken zu ermöglichen. Gerade die potenziellen Konflikte zu Bibliotheken, die vom FirstSpirit-Kern mitgeliefert werden, sollen dabei minimiert werden.

Neuinstallationen (Standardeinstellung - Isolated)

Bei allen Neuinstallationen wird der Server standardmäßig im Isolated Mode installiert.

Einsatz von Modulen

Werden Module eingesetzt, sollten diese Isolated-fähig sein, um einen reibungslosen Betrieb sicherstellen zu können.

Auch bestehende FirstSpirit-Module, die noch nicht auf den „Isolated Mode“ umgestellt wurden, sind (noch) weiterhin lauffähig. Wenn diese eine Web-Komponente beinhalten, die nicht im Modul vorhandene Bibliotheken nutzt, kann es notwendig sein, bis zur Umstellung des Moduls auf den „Isolated Mode“ das Kompatibilitätsmodul einzusetzen. Darüber hinaus sind kurzfristig keine Anpassungen notwendig.

Mittelfristig sollten aber alle Ressourcen in Modulen an die neuen Bedingungen angepasst werden, um die Vorteile des „Isolated Mode“ nutzen zu können.

Weiterführende Informationen zum Isolated Mode

Weiterführende Informationen zum „Isolated Mode“ siehe root (→Leitfaden Isolated Mode).

© 2005 - 2020 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2020-07 | Datenschutz | Impressum | Kontakt