XPLANBOX-1053 updated operations manual how to set application variables in Tomcat

xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/installation/konfigurationApplikationsserver.adoc

@@ -3,48 +3,48 @@
 
 Wie im Abschnitt <<anwendung-installieren>> beschrieben,
 werden für den Betrieb aller Komponenten der xPlanBox getrennte Tomcat-Instanzen empfohlen,
-der _Dienste-Tomcat_, _Anwendungs-Tomcat_ und _API-Tomcat_. Im Folgenden wird die
-Konfiguration der Tomcat-Instanzen beschrieben.
+der _Anwendungs-Tomcat_, _Dienste-Tomcat_ und _API-Tomcat_. Im Folgenden wird die
+Konfiguration der drei Tomcat-Instanzen beschrieben.
 
 [[anwendungs-tomcat]]
 ==== Anwendungs-Tomcat
 
-Im _Anwendungs-Tomcat_ muss folgende Konfigurationen vorgenommen werden:
+Im _Anwendungs-Tomcat_ muss folgende Konfiguration vorgenommen werden:
 
-Für den XPlanManagerWeb muss die Variable _XPLANBOX_CONFIG_ als Java Property gesetzt werden. Das mit Hilfe dieser Variable referenzierte Verzeichnis muss die Konfiguration des XPlanManagerWeb und XPlanValidatorWeb enthalten, mit den Dateien _managerConfiguration.properties_,
-_managerWebConfiguration.properties_ und _validatorConfiguration.properties_.
-Wurde der Anleitung in Abschnitt <<anwendung-installieren>> gefolgt, befindet sich das Verzeichnis mit dem Namen _xplan-manager-config_ im Verzeichnis _.deegree_ im Home-Verzeichnis des Nutzers. Wird ausschließlich der XPlanValidatorWeb installiert, heißt das Verzeichnis _xplan-validator-config_.
+. Für den XPlanManagerWeb muss die Variable _XPLANBOX_CONFIG_ als Java Property gesetzt werden. Das mit Hilfe dieser Variable referenzierte Verzeichnis muss die Konfiguration des XPlanManagerWeb und XPlanValidatorWeb enthalten, mit den Dateien _managerConfiguration.properties_,
+_managerWebConfiguration.properties_ und _validatorConfiguration.properties_. Wurde der Anleitung in Abschnitt <<anwendung-installieren>> gefolgt, befindet sich das Verzeichnis mit dem Namen _xplan-manager-config_ im Verzeichnis _.deegree_ im Home-Verzeichnis des Nutzers. Wird ausschließlich der XPlanValidatorWeb installiert, heißt das Verzeichnis _xplan-validator-config_.
+. Die Bibliothek JTS muss über die Variable `jts.overlay=ng` konfiguriert werden.
+. Die Bibliothek deegree muss über die Variable `javax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl` konfiguriert werden.
 
-IMPORTANT: Wurden die Workspaces nicht im Verzeichnis _.deegree_ des Home-Verzeichnis abgelegt, ist das Setzen der Umgebungsvariable _DEEGREE_WORKSPACE_ROOT_ erforderlich.
+IMPORTANT: Wurden die Workspaces nicht im Verzeichnis _.deegree_ des Home-Verzeichnis abgelegt, ist das Setzen der Umgebungsvariable _DEEGREE_WORKSPACE_ROOT_ zusätzlich erforderlich.
 
-TIP: Es wird empfohlen die Zeitzone im _Anwendungs-Tomcat_ auf "Europe/Berlin" zu konfigurieren, wenn dies nicht bereits auf Ebene des Betriebssystems gesetzt ist. Andernfalls kann es beim Editieren eines Plans veränderten Datumsangaben (z. B. Herstellungsdatum) kommen. Für die Konfiguration im Tomcat muss folgende Option zusätzlich in den `JAVA_OPTS` ergänzt werden: `-Duser.timezone=Europe/Berlin`.
+TIP: Es wird empfohlen die Zeitzone im _Anwendungs-Tomcat_ auf "Europe/Berlin" zu konfigurieren, wenn dies nicht bereits auf Ebene des Betriebssystems gesetzt ist. Andernfalls kann es beim Editieren eines Plans veränderten Datumsangaben (z. B. Herstellungsdatum) kommen. Für die Konfiguration im Tomcat muss folgende Option zusätzlich in den `CATALINA_OPTS` ergänzt werden: `-Duser.timezone=Europe/Berlin`.
 
 [[anwendungs-tomcat-linux]]
 ===== Linux
 
-Für die Konfiguration der oben genannten Punkte muss zunächst im
-Verzeichnis _<CATALINA_HOME>/bin_ der Instanz _Anwendungs-Tomcat_ eine neue Datei mit dem Namen
-_setenv.sh_ angelegt werden.
+Unter Linux muss im Verzeichnis _<CATALINA_HOME>/bin_ der Instanz _Anwendungs-Tomcat_ ggfs. eine neue Datei mit dem Namen _setenv.sh_ angelegt werden.
 
-In dieser Datei erfolgt das Setzen der Variable _XPLANBOX_CONFIG_ und ggf. von _DEEGREE_WORKSPACE_ROOT_ durch das Hinzufügen von:
+In dieser Datei wird die Variable `CATALINA_OPTS` wie folgt erweitert:
 
 ----
-export JAVA_OPTS='-DXPLANBOX_CONFIG=/home/xplanbox/.deegree/xplan-manager-config -DDEEGREE_WORKSPACE_ROOT=/pfad/zu/den/workspaces'
+export CATALINA_OPTS='-DXPLANBOX_CONFIG=/home/xplanbox/.deegree/xplan-manager-config -DDEEGREE_WORKSPACE_ROOT=/pfad/zu/den/workspaces -Djts.overlay=ng -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl -Duser.timezone=Europe/Berlin'
 ----
 
-Falls es bereits einen Export von `JAVA_OPTS` in dieser Datei gibt, muss die Variable `-DXPLANBOX_CONFIG=/home/xplanbox/.deegree/xplan-manager-config` und ggf. `-DDEEGREE_WORKSPACE_ROOT=/pfad/zu/den/workspaces` in die bestehenden `JAVA_OPTS` integriert werden.
+Falls bereits einen Export von `CATALINA_OPTS` in dieser Datei vorhanden ist, muss die Variable `CATALINA_OPTS` erweitert werden.
 
 [[anwendungs-tomcat-windows]]
 ===== Windows
 
-Für das Setzen der Variable _XPLANBOX_CONFIG_ sowie muss zunächst eine neue Datei mit dem Namen _setenv.bat_
-im Verzeichnis _<CATALINA_HOME>/bin_ der Instanz _Anwendungs-Tomcat_ angelegt werden. Dort wird diese Variable, sowie _DEEGREE_WORKSPACE_ROOT_ wie folgt hinzugefügt:
+Unter Windows muss im Verzeichnis _<CATALINA_HOME>/bin_ der Instanz _Anwendungs-Tomcat_ ggfs. eine neue Datei mit dem Namen _setenv.bat_ angelegt werden.
+
+In dieser Datei wird die Variable `CATALINA_OPTS` wie folgt erweitert:
 
 ----
-export JAVA_OPTS='-DXPLANBOX_CONFIG=C:\.deegree\xplan-manager-config -DDEEGREE_WORKSPACE_ROOT=C:\pfad\zu\den\workspaces'
+export CATALINA_OPTS='-DXPLANBOX_CONFIG=C:\.deegree\xplan-manager-config -DDEEGREE_WORKSPACE_ROOT=C:\pfad\zu\den\workspaces -Djts.overlay=ng -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl -Duser.timezone=Europe/Berlin'
 ----
 
-Falls es bereits einen Export von `JAVA_OPTS` in dieser Datei gibt, muss die Variable `-DXPLANBOX_CONFIG=C:\.deegree\xplan-manager-config` und ggf. `-DDEEGREE_WORKSPACE_ROOT=C:\pfad\zu\den\workspaces` in die bestehenden `JAVA_OPTS` integriert werden.
+Falls bereits einen Export von `CATALINA_OPTS` in dieser Datei vorhanden ist, muss die Variable  `CATALINA_OPTS` erweitert werden.
 
 IMPORTANT: Der _Anwendungs-Tomcat_ muss mindestens über 4GB Arbeitsspeicher verfügen, dies kann durch Setzen der Umgebungsvariable: `export JAVA_OPTS='-Xmx4096m'` erfolgen.
 
@@ -70,9 +70,27 @@ NOTE: Der Nutzername und das Passwort müssen in die
 _managerConfiguration.properties_ eingetragen werden (s. Kapitel
 <<automatischer-workspace-reload>>.
 
+Für den _Dienste-Tomcat_ muss auch die Variable `CATALINA_OPTS` wie folgt erweitert werden:
+
+----
+export CATALINA_OPTS='-DDEEGREE_WORKSPACE_ROOT=/pfad/zu/den/workspaces -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl'
+----
+
 CAUTION: Der _Dienste-Tomcat_ muss ebenfalls mindestens über 4GB Arbeitsspeicher verfügen,
 dies kann durch Setzen der Umgebungsvariable: `export JAVA_OPTS='-Xmx4096m'` erfolgen.
 
+[[api-tomcat]]
+==== API-Tomcat
+
+Für den _API-Tomcat_ muss auch die Variable `CATALINA_OPTS` wie auch für den <<dienste-tomcat,_Dienste-Tomcat_>> wie folgt erweitert werden:
+
+----
+export CATALINA_OPTS='-DXPLANBOX_CONFIG=/home/xplanbox/.deegree/xplan-manager-config -DDEEGREE_WORKSPACE_ROOT=/pfad/zu/den/workspaces -Djts.overlay=ng -Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl -Duser.timezone=Europe/Berlin'
+----
+
+CAUTION: Der _API-Tomcat_ muss ebenfalls mindestens über 4GB Arbeitsspeicher verfügen,
+dies kann durch Setzen der Umgebungsvariable: `export JAVA_OPTS='-Xmx4096m'` erfolgen.
+
 ==== Absicherung des Tomcat und der Webanwendungen
 
 Wenn die xPlanBox in einer produktiven Umgebung betrieben wird, sollte der Apache Tomcat abgesichert werden. Dazu sind die allgemeinen Empfehlungen aus der https://tomcat.apache.org/tomcat-9.0-doc/security-howto.html[Dokumentation von Apache Tomcat zum Thema Sicherheit] zu beachten.