Tomcat Installieren: Unterschied zwischen den Versionen

Aus Hostsharing Wiki
Zur Navigation springen Zur Suche springen
(→‎Weitergehende Informationen: Hinweis ergänzt, wo das Log zu finden ist)
K (unixsocket for monit)
(47 dazwischenliegende Versionen von 7 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
== Allgemein ==
== Allgemein ==


=== Allgemeine Hinweise ===
[http://tomcat.apache.org/ Apache Tomcat] ist ein Webserver (HTTP-Server), der in der Programmiersprache Java entwickelt ist. Er dient in erster Linie dazu, dynamische Web-Anwendungen zu betreiben, die ebenfalls in Java programmiert sind. Basis-Technologien sind [http://de.wikipedia.org/wiki/Servlet Java-Servlets] und [http://de.wikipedia.org/wiki/JSP Java Server Pages (JSP)].


Diese Anleitung dokumentiert die Installation des Apache Tomcat Servers als Paket-Admin in einem Dynamic-Web Paket bei Hostsharing. Ist die entsprechende Tarif-Option gebucht worden, richtet ein Hostmaster einmalig die Tomcat-Umgebung im Paket ein und sie kann dann genutzt werden. Der Paket-Admin kann anschließend weitere Domains im Tomcat konfigurieren, Anwendungen aufsetzen und den Tomcat starten oder beenden.
Mit Hilfe von Apache Tomcat ist bei Hostsharing das Hosting von komplexen Java Web-Applikationen problemlos möglich.


Das Installationsskript kann vom Paket-Admin auch später weitere Male aufgerufen werden, wenn er selbst den Tomcat erneut installieren möchte. Dazu muss allerdings vorher die aktuelle Installation entfernt oder verschoben sein.
== Spezielle Installation bei Hostsharing ==


=== Spezielle Installation bei Hostsharing ===
In jedem dynamischen Webhosting-Paket der Hostsharing eG können einer (oder mehrere) Tomcat-Webserver betrieben werden.


Jedes Paket mit gebuchter JSP-Option startet einen eigenen Tomcat, der jedoch durch eine zentrale Tomcat-Installation bereitgestellt wird. Lediglich die Anwendungs-, Arbeits- und Temp-Verzeichnisse sind in den Paketen eingerichtet und so für jede Tomcat-Instanz eindeutig und von den anderen getrennt.
Dazu muss für jede Tomcat-Instanz die Option "Betrieb eines eigenen Serverdienstes" gebucht werden. Im Bereich des Shared Hosting ist die Option kostenpflichtig.  


Dieses Verhalten wird durch die Umgebungsvariablen CATALINA_HOME und CATALINA_BASE, die Tomcat zur Laufzeit auswertet, ermöglicht. Unter CATALINA_HOME liegt die zentrale Tomcat-Installation und unter CATALINA_BASE werden die oben genannten Verzeichnisse gesucht.
Diese Anleitung dokumentiert die Installation des Apache Tomcat Servers als Service-User in einem WEB-Paket bei Hostsharing. Mit der Einrichtung der Option "eigener Serverdienst" werden für die Paket-IP-Adresse einer oder mehrere IP-Ports reserviert. An diese Ports wird der eigene Serverdienst (also der Tomcat-Server) am Localhost-Interface gebunden.


=== Systemumgebung und verwendete Versionen ===
Geben Sie bei der Bestellung der Option "Eigener Serverdienst" an:
 
Version der Java Laufzeitumgebung: 1.6.0_10
 
Version des Apache Tomcat: 5.5.27
 
Das Start- und Stop-Skript /opt/tomcat/bin/rc-tomcat setzt die entsprechenden bzw. notwendigen Umgebungsvariablen automatisch.


# den Service User, mit dessen Rechten der Tomcat-Dienst laufen soll (also zum Beispiel "xyz00-tomcat")
# wieviele IP-Ports reserviert werden sollen (in der folgenden Anleitung verwenden wir drei nicht-privilegierte Ports:
* 38005 als "Shutdown"-Schnittstelle
* 38006 für eine AJP-Listener
* 38008 für den HTTP-Listener des Monit-Prozessmonitors


== Installation ==  
== Installation ==  


=== Voraussetzungen ===
Auf den Hostsharing-Servern ist das Debian-Paket "tomcat9-user" installiert. Es stellt den  
 
Apache Tomcat Server in der Version 9.0.x für den Betrieb als normaler (nicht privilegierter) User bereit.
Für eine zulässige und erfolgreiche Installation des Tomcat in einem Paket müssen folgende Dinge gegeben sein:
Dabei wird die zentral installierte Tomcat-Software benutzt, die über Betriebssystem-Updates mit Sicherheits-Updates versorgt wird.
 
* Man muss Paket-Admin eines Dynamic-Web Pakets sein
* Gebuchte JSP-Option (per Email an bestellung(at)hostsharing.net)
* Portvermerk in /etc/ports oder eigene IP für das Paket und entsprechende iptables-Regeln - je nach Installationsmodus (bei der Bestellung angeben, Preise hier)
 
=== Art der Installation ===
 
Es stehen zwei Installationsmodi zur Verfügung. In beiden Modi läuft der Tomcat jedoch mit den Rechten des Paket-Users und kann somit nur auf nicht-privilegierte Ports (> 1024) zugreifen.
 
Einer der Modi muss bei der Bestellung der JSP-Option angegeben werden, damit die Hostmaster den Tomcat entsprechend installieren und die entsprechenden Einträge vornehmen können.
 
==== Apache Webserver als Proxy: mod_proxy ====
 
Hierbei läuft vor dem Tomcat Server der Apache Webserver mit mod_proxy und leitet alle Anfragen an den Tomcat weiter. Er arbeitet als Proxy. Dieses Verhalten wird über .htaccess-Dateien konfiguriert, die in den entsprechenden Subdomain-Verzeichnissen liegen müssen und eine bestimmte Rewrite-Regel beinhalten. Eine beispielhafte .htaccess-Datei sieht folgendermaßen aus:
 
RewriteEngine On
RewriteCond %{SERVER_PORT} ^80$
RewriteBase /
RewriteRule ^(.*)$ http://www.example.com:30031/${escape:$1} [P,L]


Die benutzten Ports werden von den Hostmastern in der Datei /etc/ports eingetragen.
Für die Installation der Konfigurations-Dateien in Heimat-Verzeichnis des Benutzers wird folgender Befehl
mit den Rechten des Service-Users aufgerufen:


==== Eigene Paket-IP: iptables ====
    xyz00-tomcat@h00:~$ tomcat9-instance-create tomcat


In dieser Konfiguration läuft der Tomcat auf einer eigenen IP und dem (Standard-)Port 8080, weswegen kein Eintrag in /etc/ports notwendig ist. Alle Anfragen an Port 80 werden über iptables-Regeln an den Tomcat weiter gereicht. Das Paket bekommt eine eigene IP und die Regeln müssen von einem Hostmaster in iptables eingetragen werden.
Ich bevorzuge das catalina.sh-Startskript zum Testen:


=== Installationsskript ===
    xyz00-tomcat@h00:~$ cp /usr/share/tomcat9/bin/catalina.sh tomcat/bin/


Das Installationsskript steht auf allen Hives mit Dynamic-Web Paketen unter dem Pfad /opt/tomcat/bin/install-tomcat zur Verfügung und hat folgende Aufrufsyntax:
Dieser Befehl legt ein Verzeichnis "tomcat" mit der üblichen Dateistruktur für einen Tomcat-Server an:


xyz00@host:~$ /opt/tomcat/bin/install-tomcat -h
    bin
    bin/catalina.sh
Usage: install-tomcat [OPTIONS]
    bin/setenv.sh
    bin/shutdown.sh
This script creates all necessary directories, files and links to run Apache Tomcat in your package. You must invoke it as a package user.
    bin/startup.sh
    conf
-h, --help show this help
    conf/Catalina
-m, --mode set install mode
    conf/Catalina/localhost
mod_proxy: read ports from /etc/ports (default)
    conf/catalina.properties
iptables : use default ports 8005, 8080 and 8443
    conf/context.xml
-t, --test set test mode, does not create anything
    conf/jaspic-providers.xml
    conf/logging.properties
xyz00@host:~$
    conf/server.xml
    conf/tomcat-users.xml
    conf/web.xml
    logs
    policy
    policy/catalina.policy
    temp
    webapps
    work


Das Skript prüft zuerst ob es von einem gültigen Paket-User (nur Paket-Admins) aufgerufen wurde, ob die entsprechenden Ports in /etc/ports verfügbar sind (nur im Modus mod_proxy) und keine Verzeichnisse oder Dateien einer vorherigen Installation vorhanden sind. Entsprechende Fehler mit Hilfevorschlägen werden ausgegeben.
In der Hauptsache muss die Konfigurationsdatei "server.xml" im Verzeichnis "~/tomcat/conf/" angepasst werden.


Wird das Skript mit dem Parameter -t aufgerufen; beendet es sich nach diesen Prüfungen selbst.
Beispiel für eine minimale "server.xml":


Wird es ohne Parameter oder mit dem Parameter -m aufgerufen, installiert es alle notwendigen Dateien und gibt entsprechende Meldungen aus.
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<Server port="38005" shutdown="SHUTDOWN">
  <Listener className="org.apache.catalina.startup.VersionLoggerListener" />
  <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
  <Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
  <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
  <Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
  <GlobalNamingResources>
    <Resource name="UserDatabase" auth="Container"
              type="org.apache.catalina.UserDatabase"
              description="User database that can be updated and saved"
              factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
              pathname="conf/tomcat-users.xml" />
  </GlobalNamingResources>
  <Service name="Catalina">
    <Connector protocol="AJP/1.3" address="127.0.0.1" port="38006" redirectPort="443" secretRequired="false" />
    <Engine name="Catalina" defaultHost="localhost">
      <Realm className="org.apache.catalina.realm.LockOutRealm">
        <Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase"/>
      </Realm>
      <Host name="localhost"  appBase="../webapps" unpackWARs="true" autoDeploy="true"></Host>
    </Engine>
  </Service>
</Server>
</pre>


=== Angelegte Verzeichnisse und Dateien ===
Angepasst werden müssen:
* die beiden IP-Ports (im Beispiel 38005 und 38006 am Localhost-Interface)


* Verzeichnisse
Das Startskript kann durch Anpassung der Datei ''setenv.sh'' angepasst werden. Für den Monit-Prozessmonitor setze ich insbesondere die Variable ''CATALINA_PID''. Mit ''JAVA_HOME'' sorge ich dafür, dass Java 11 zum Einsatz kommt:
o ~/etc/tomcat
Für die Konfigurationsdateien des Tomcat.
o ~/tomcat/
Für Symlinks in wichtige Verzeichnisse.
o ~/var/cache/
o ~/var/cache/tomcat/
Für installierte Anwendungen (zur Laufzeit).
o ~/var/cache/tomcat/_tmp/
Für temporäre Dateien des Tomcat (zur Laufzeit).
o ~/webapps/
Für Anwendungen. Jeder konfigurierte Host bekommt ein Unterverzeichnis.
o ~/webapps/xyz00.hostsharing.net/
Anwendungen des Default-Host.
o ~/webapps/tomcat.example.com/
Anwendungen einer weiteren Domain mit vorkonfigurierter Subdomain tomcat.
* Dateien
o ~/etc/tomcat/server.xml
Die Tomcat Konfigurationsdatei.
o ~/etc/tomcat/tomcat-users.xml
Tomcats servserseitige Benutzerverwaltung.
o ~/etc/tomcat/web.xml
Konfigurationsdatei des Servlet-Containers.
* Symlinks
o ~/tomcat/conf
Link auf ~/etc/tomcat
o ~/tomcat/work
Link auf ~/var/cache/tomcat
o ~/tomcat/temp
Link auf ~/var/cache/tomcat/_tmp


=== Server starten und beenden ===
<pre>
#!/bin/sh
#
HOME=/home/pacs/xyz00/users/tomcat
CATALINA_HOME=/usr/share/tomcat9
CATALINA_PID=$HOME/tomcat/work/catalina.pid
JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64
PATH=$JAVA_HOME/bin:$PATH
# Default Java options
if [ -z "$JAVA_OPTS" ]; then
JAVA_OPTS="-Djava.awt.headless=true"
fi
</pre>


Das Start- und Stop-Skript findet man unter dem Pfad /opt/tomcat/bin/rc-tomcat und es hat folgende Aufrufsyntax:
== Deployment einer Anwendung ==


xyz00@host:~$ /opt/tomcat/bin/rc-tomcat
In der Beispiel-Konfiguration wurde das Verzeichnis ''$HOME/webapps/'' für die Anwendungen konfiguriert. Wir legen dieses Verzeichnis an und kopieren eine minimale Anwendung hinein:
Using CATALINA_BASE: /home/pacs/xyz00/tomcat
Using CATALINA_HOME: /opt/tomcat/current55
Using CATALINA_TMPDIR: /home/pacs/xyz00/tomcat/temp
Using JRE_HOME: /opt/java/current60
Usage: rc-tomcat ( commands ... )
commands:
debug Start Catalina in a debugger
debug -security Debug Catalina with a security manager
jpda start Start Catalina under JPDA debugger
run Start Catalina in the current window
run -security Start in the current window with security manager
start Start Catalina in a separate window
start -security Start in a separate window with security manager
stop Stop Catalina
stop -force Stop Catalina (followed by kill -KILL)
version What version of tomcat are you running?
xyz00@host:~$


== Weitergehende Informationen ==
    mkdir -p $HOME/webapps/hello/WEB-INF/


=== Start des Tomcat bei Server Reboot ===
Dort legen wir die Datei ~/webapps/hello/WEB-INF/web.xml mit folgendem Inhalt an:


Der Tomcat-Prozess wird von Hand gestartet und nicht von den Hostmastern überwacht. Es liegt in deiner Verantwortung nach einem Reboot des Hostsharing-Servers deinen Tomcat neu zu starten. Das geht am einfachsten über einen Eintrag in der [[Cron| Crontab]]:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<web-app
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
id="WebApp_ID" version="3.0">
</web-app>
</pre>


JAVA_HOME=/opt/java/current60
Dazu eine einfache JSP-Datei ~/webapps/hello/index.jsp:
HOME=/home/pacs/xyz99


PATH=$JAVA_HOME/bin:/usr/bin:/bin:/usr/local/bin
<pre>
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
# Starte Tomcat beim Reboot
<!DOCTYPE html>
<html lang="de-de">
  @reboot /opt/tomcat/bin/rc-tomcat start
<body>
<h1>Hallo Welt</h1>
<p>Java Version: <%= System.getProperty("java.version") %></p>
</body>
</html>
</pre>


=== Logging ===
Nun können wir die HTTP-Requests, die an eine Domain im Paket gesendet werden, an den Tomcat weiterleiten.
Das funktioniert über eine ''.htaccess''-Datei, zum Beispiel im Verzeichnis ''~/doms/hs-example.de/htdocs-ssl'':


Die Log-Datei zum Status des Tomcat und den Meldungen beim Starten kann man sich als Paket-Admin ansehen per
<pre>
DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule ^(.*) ajp://127.0.0.1:38006/$1 [proxy,last]
</pre>


less ~/var/catalina.out
Achtung der IP-Port 38006 muss hier wieder angepasst werden!


Dadurch ist die Mini-Anwendung unter der URL "https://hs-example.de/hello/" erreichbar.
=== Anwendung: Tomcat Dokumentation ===


Die Tomcat-Dokumentation findet man online im unten angegebenen Link. Außerdem enthält die Server-Konfiguration in der Datei server.xml einen auskommentierten Bereich, der die Anwendung "Tomcat Dokumentation" für einen bestimmten Host unter dem Pfad /tomcat-docs einbindet. Um diese Anwendung für einen bestimmten Host zu aktivieren, muss vor dem Starten des Tomcat folgender Bereich im jeweiligen Host-Bereich der server.xml aus dem Kommentar genommen werden.
== Start des Tomcat Servers ==


<Context displayName="Tomcat Documentation"
Der Tomcat kann über die Skripte in "~/tomcat/bin/" gestartet und gestoppt werden.
    docBase="${catalina.home}/webapps/tomcat-docs"
    path="/tomcat-docs"
    antiResourceLocking="false" antiJARLocking="false"/>


=== Anwendung: Tomcat Manager ===
<pre>
cd ~/tomcat
./bin/startup.sh
</pre>


Die Server-Konfiguration enthält in der Datei server.xml einen auskommentierten Bereich, der die Anwendung "Tomcat Manager" für einen bestimmten Host unter dem Pfad /manager einbindet. Um diese Anwendung für einen bestimmten Host zu aktivieren muss vor dem Starten des Tomcat folgender Bereich im jeweiligen Host der server.xml aus dem Kommentar genommen werden.
Log-Ausgaben des Servers sind in "~/tomcat/logs/catalina.out" zu finden.


<Context displayName="Tomcat Manager"
Damit der Tomcat bei einem Reboot der Hostsharing-Server automatisch gestartet wird,
    docBase="${catalina.home}/server/webapps/manager"
kann "monit" als einfaches Überwachungswerkzeug genutzt werden.
    path="/manager" privileged="true"
    antiResourceLocking="false" antiJARLocking="false">
 


Um als Benutzer Zugriff auf die Manager-Anwendung zu bekommen muss in der Benutzerverwaltung tomcat-users.xml dem Benutzer die Rolle  manager zugewiesen sein.
Dazu legt man eine Datei ''.monitrc'' im $HOME-Verzeichnis an. Der Inhalt ist zum Beispiel:


Im Browser kann man dann den manager aufrufen per (8080 ist der individuell zugewiesene Port!)
<pre>
set daemon 60 with start delay 120
set logfile /home/pacs/xyz00/users/tomcat/monit/var/monit.log
set idfile /home/pacs/xyz00/users/tomcat/monit/var/monit.id
set statefile /home/pacs/xyz00/users/tomcat/monit/var/monit.state
set mailserver localhost
set mail-format { from: monit@xyz00.hostsharing.net }
set alert ich@meine-domain.de
set httpd unixsocket /home/pacs/xyz00/users/tomcat/monit/var/monit.sock
    permission 600
    allow monit:geheim
check process tomcat with pidfile /home/pacs/xyz00/users/tomcat/tomcat/work/catalina.pid
    start program "/home/pacs/xyz00/users/tomcat/tomcat/bin/startup.sh"
    stop program "/home/pacs/xyz00/users/tomcat/tomcat/bin/shutdown.sh"
</pre>


http://www.example.com:8080/manager
Monit lässt sich mit folgendem Kommando starten:


z.B. Auflistung der laufenden Apps
    mkdir -p $HOME/monit/var
    monit -c $HOME/.monitrc


http://www.example.com:8080/manager/list
Die letzte Aufgabe ist das Einrichten der Bereinigung für die Log-Dateien.


z.B. Status-Seite
Dazu lege ich die Konfigurationsdatei ''.logrotate'' im $HOME-Verzeichnis an:


http://www.example.com:8080/manager/status
<pre>
/home/pacs/xyz00/users/tomcat/tomcat/logs/catalina.out {
  copytruncate
  compress
  rotate 5
  daily
  missingok
}
/home/pacs/xyz00/users/tomcat/monit/var/monit.log {
  copytruncate
  compress
  rotate 2
  weekly
  missingok
}
</pre>


Falle: Lässt man den zugewiesenen Port weg, bekommt man (zumindest in Tomcat 5.5)  überraschender Weise einen Fehler "403 Forbidden".
Für den automatischen Start von Monit und für die Bereinigung der Log-Dateien noch eine ''crontab'':
Siehe hierzu auch [http://www.apacheserver.net/tomcat-manager-not-working-at192997.htm http://www.apacheserver.net/tomcat-manager-not-working-at192997.htm]


{{Textkasten|rot|Achtung|Die Manager-Anwendung bringt gewisse Risiken mit sich, da über sie der komplette Tomcat gesteuert (z.B. deploy und undeploy von Anwendungen) werden kann! Bitte nur aktivieren, wenn man weiß was man tut.}}
<pre>
PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
HOME=/home/pacs/xyz00/users/tomcat
MAILTO=ich@meine-domain.de
# m h  dom mon dow  command
@reboot /bin/rm -f $HOME/tomcat/work/catalina.pid && /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
14 3 * * * /usr/bin/find $HOME/tomcat/logs -type f -mmin +10080 -delete
</pre>


=== Links ===
Dann gehen wir daran unsere Anwendungen im Tomcat zu deployen.


o[http://tomcat.apache.org/ Apache Tomcat Homepage (Englisch)]
== Links ==


o[http://tomcat.apache.org/tomcat-5.5-doc/index.html Apache Tomcat Dokumentation (Version 5.*, Englisch)]
*[http://tomcat.apache.org/ Apache Tomcat Homepage (Englisch)]
*[http://tomcat.apache.org/tomcat-9.0-doc/index.html Apache Tomcat Dokumentation (Version 9.0, Englisch)]
*[http://wiki.apache.org/tomcat/FrontPage Apache Tomcat Wiki (Englisch)]
*[[Monit installieren]]
*[https://github.com/tpokorra/Hostsharing-Ansible-Tomcat Ansible Playbook für Hostsharing]


o[http://wiki.apache.org/tomcat/FAQ Apache Tomcat FAQ (Englisch)]
----
----
[[Kategorie:HSDoku]]
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Ansible Playbook]]
[[Kategorie:Software]]
[[Kategorie:Software]]
[[Kategorie:Eigene Daemons]]
[[Kategorie:Eigene Daemons]]

Version vom 30. Dezember 2021, 11:48 Uhr

Apache Tomcat installieren

Allgemein

Apache Tomcat ist ein Webserver (HTTP-Server), der in der Programmiersprache Java entwickelt ist. Er dient in erster Linie dazu, dynamische Web-Anwendungen zu betreiben, die ebenfalls in Java programmiert sind. Basis-Technologien sind Java-Servlets und Java Server Pages (JSP).

Mit Hilfe von Apache Tomcat ist bei Hostsharing das Hosting von komplexen Java Web-Applikationen problemlos möglich.

Spezielle Installation bei Hostsharing

In jedem dynamischen Webhosting-Paket der Hostsharing eG können einer (oder mehrere) Tomcat-Webserver betrieben werden.

Dazu muss für jede Tomcat-Instanz die Option "Betrieb eines eigenen Serverdienstes" gebucht werden. Im Bereich des Shared Hosting ist die Option kostenpflichtig.

Diese Anleitung dokumentiert die Installation des Apache Tomcat Servers als Service-User in einem WEB-Paket bei Hostsharing. Mit der Einrichtung der Option "eigener Serverdienst" werden für die Paket-IP-Adresse einer oder mehrere IP-Ports reserviert. An diese Ports wird der eigene Serverdienst (also der Tomcat-Server) am Localhost-Interface gebunden.

Geben Sie bei der Bestellung der Option "Eigener Serverdienst" an:

  1. den Service User, mit dessen Rechten der Tomcat-Dienst laufen soll (also zum Beispiel "xyz00-tomcat")
  2. wieviele IP-Ports reserviert werden sollen (in der folgenden Anleitung verwenden wir drei nicht-privilegierte Ports:
  • 38005 als "Shutdown"-Schnittstelle
  • 38006 für eine AJP-Listener
  • 38008 für den HTTP-Listener des Monit-Prozessmonitors

Installation

Auf den Hostsharing-Servern ist das Debian-Paket "tomcat9-user" installiert. Es stellt den Apache Tomcat Server in der Version 9.0.x für den Betrieb als normaler (nicht privilegierter) User bereit. Dabei wird die zentral installierte Tomcat-Software benutzt, die über Betriebssystem-Updates mit Sicherheits-Updates versorgt wird.

Für die Installation der Konfigurations-Dateien in Heimat-Verzeichnis des Benutzers wird folgender Befehl mit den Rechten des Service-Users aufgerufen:

   xyz00-tomcat@h00:~$ tomcat9-instance-create tomcat

Ich bevorzuge das catalina.sh-Startskript zum Testen:

   xyz00-tomcat@h00:~$ cp /usr/share/tomcat9/bin/catalina.sh tomcat/bin/

Dieser Befehl legt ein Verzeichnis "tomcat" mit der üblichen Dateistruktur für einen Tomcat-Server an:

   bin
   bin/catalina.sh
   bin/setenv.sh
   bin/shutdown.sh
   bin/startup.sh
   conf
   conf/Catalina
   conf/Catalina/localhost
   conf/catalina.properties
   conf/context.xml
   conf/jaspic-providers.xml
   conf/logging.properties
   conf/server.xml
   conf/tomcat-users.xml
   conf/web.xml
   logs
   policy
   policy/catalina.policy
   temp
   webapps
   work

In der Hauptsache muss die Konfigurationsdatei "server.xml" im Verzeichnis "~/tomcat/conf/" angepasst werden.

Beispiel für eine minimale "server.xml":

<?xml version="1.0" encoding="UTF-8"?>
<Server port="38005" shutdown="SHUTDOWN">
  <Listener className="org.apache.catalina.startup.VersionLoggerListener" />
  <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
  <Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
  <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
  <Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
  <GlobalNamingResources>
    <Resource name="UserDatabase" auth="Container"
              type="org.apache.catalina.UserDatabase"
              description="User database that can be updated and saved"
              factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
              pathname="conf/tomcat-users.xml" />
  </GlobalNamingResources>
  <Service name="Catalina">
    <Connector protocol="AJP/1.3" address="127.0.0.1" port="38006" redirectPort="443" secretRequired="false" />
    <Engine name="Catalina" defaultHost="localhost">
      <Realm className="org.apache.catalina.realm.LockOutRealm">
        <Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase"/>
      </Realm>
      <Host name="localhost"  appBase="../webapps" unpackWARs="true" autoDeploy="true"></Host>
    </Engine>
  </Service>
</Server>

Angepasst werden müssen:

  • die beiden IP-Ports (im Beispiel 38005 und 38006 am Localhost-Interface)

Das Startskript kann durch Anpassung der Datei setenv.sh angepasst werden. Für den Monit-Prozessmonitor setze ich insbesondere die Variable CATALINA_PID. Mit JAVA_HOME sorge ich dafür, dass Java 11 zum Einsatz kommt:

#!/bin/sh
#
HOME=/home/pacs/xyz00/users/tomcat
CATALINA_HOME=/usr/share/tomcat9
CATALINA_PID=$HOME/tomcat/work/catalina.pid
JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64
PATH=$JAVA_HOME/bin:$PATH
# Default Java options
if [ -z "$JAVA_OPTS" ]; then
	JAVA_OPTS="-Djava.awt.headless=true"
fi

Deployment einer Anwendung

In der Beispiel-Konfiguration wurde das Verzeichnis $HOME/webapps/ für die Anwendungen konfiguriert. Wir legen dieses Verzeichnis an und kopieren eine minimale Anwendung hinein:

   mkdir -p $HOME/webapps/hello/WEB-INF/

Dort legen wir die Datei ~/webapps/hello/WEB-INF/web.xml mit folgendem Inhalt an:

<?xml version="1.0" encoding="UTF-8"?>
<web-app 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee"
	xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" 
	id="WebApp_ID" version="3.0">
</web-app>

Dazu eine einfache JSP-Datei ~/webapps/hello/index.jsp:

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html lang="de-de">
<body>
<h1>Hallo Welt</h1>
<p>Java Version: <%= System.getProperty("java.version")  %></p>
</body>
</html>

Nun können wir die HTTP-Requests, die an eine Domain im Paket gesendet werden, an den Tomcat weiterleiten. Das funktioniert über eine .htaccess-Datei, zum Beispiel im Verzeichnis ~/doms/hs-example.de/htdocs-ssl:

DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule ^(.*) ajp://127.0.0.1:38006/$1 [proxy,last]

Achtung der IP-Port 38006 muss hier wieder angepasst werden!

Dadurch ist die Mini-Anwendung unter der URL "https://hs-example.de/hello/" erreichbar.

Start des Tomcat Servers

Der Tomcat kann über die Skripte in "~/tomcat/bin/" gestartet und gestoppt werden.

cd ~/tomcat
./bin/startup.sh

Log-Ausgaben des Servers sind in "~/tomcat/logs/catalina.out" zu finden.

Damit der Tomcat bei einem Reboot der Hostsharing-Server automatisch gestartet wird, kann "monit" als einfaches Überwachungswerkzeug genutzt werden.

Dazu legt man eine Datei .monitrc im $HOME-Verzeichnis an. Der Inhalt ist zum Beispiel:

set daemon 60 with start delay 120
set logfile /home/pacs/xyz00/users/tomcat/monit/var/monit.log
set idfile /home/pacs/xyz00/users/tomcat/monit/var/monit.id
set statefile /home/pacs/xyz00/users/tomcat/monit/var/monit.state
set mailserver localhost
set mail-format { from: monit@xyz00.hostsharing.net }
set alert ich@meine-domain.de
set httpd unixsocket /home/pacs/xyz00/users/tomcat/monit/var/monit.sock
    permission 600
    allow monit:geheim
check process tomcat with pidfile /home/pacs/xyz00/users/tomcat/tomcat/work/catalina.pid
    start program "/home/pacs/xyz00/users/tomcat/tomcat/bin/startup.sh"
    stop program "/home/pacs/xyz00/users/tomcat/tomcat/bin/shutdown.sh"

Monit lässt sich mit folgendem Kommando starten:

   mkdir -p $HOME/monit/var
   monit -c $HOME/.monitrc

Die letzte Aufgabe ist das Einrichten der Bereinigung für die Log-Dateien.

Dazu lege ich die Konfigurationsdatei .logrotate im $HOME-Verzeichnis an:

/home/pacs/xyz00/users/tomcat/tomcat/logs/catalina.out {
   copytruncate
   compress
   rotate 5
   daily
   missingok
}
/home/pacs/xyz00/users/tomcat/monit/var/monit.log {
   copytruncate
   compress
   rotate 2
   weekly
   missingok
}

Für den automatischen Start von Monit und für die Bereinigung der Log-Dateien noch eine crontab:

PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
HOME=/home/pacs/xyz00/users/tomcat
MAILTO=ich@meine-domain.de
# m h  dom mon dow   command
@reboot /bin/rm -f $HOME/tomcat/work/catalina.pid && /usr/bin/monit -c $HOME/.monitrc
1 1 * * * /usr/sbin/logrotate -s $HOME/.logrotate.state $HOME/.logrotate
14 3 * * * /usr/bin/find $HOME/tomcat/logs -type f -mmin +10080 -delete

Dann gehen wir daran unsere Anwendungen im Tomcat zu deployen.

Links