Relecture
This commit is contained in:
gcolpart
parent
ebf6f43820
commit
33b9b52b05
350
HowtoTomcat.md
350
HowtoTomcat.md
|
|
@ -1,32 +1,166 @@
|
|||
---
|
||||
categories: java
|
||||
categories: web java
|
||||
title: Howto Tomcat
|
||||
...
|
||||
|
||||
* Documentation : <http://tomcat.apache.org/tomcat-7.0-doc/>
|
||||
* Documentation : <http://tomcat.apache.org/tomcat-8.0-doc/>
|
||||
* Rôle Ansible : <https://forge.evolix.org/projects/ansible-roles/repository/revisions/unstable/show/tomcat-instance>
|
||||
|
||||
[Tomcat](http://tomcat.apache.org/) est un serveur d'applications Java : il rend accessible des pages JSP (moteur _Jasper_) et des servlets Java (moteur _Catalina_) via le protocole [HTTP](HowtoHTTP) (connecteur _Coyote_) ou [AJP (Apache JServ Protocol)](https://fr.wikipedia.org/wiki/Protocole_Apache_JServ). On l'utilise en général avec [Apache](HowtoApache) en complément.
|
||||
|
||||
## Installation
|
||||
|
||||
Cette documentation se concentre sur l'installation et la configuration de Tomcat sur Debian Jessie en mode multi-instances.
|
||||
|
||||
Ce mode permet de faire tourner plusieurs instances Tomcat de façon complètement indépendantes, avec leurs propres réglages et en permettant des arrêts/redémarrages d'une instance sans impacter les autres, le tout en mutualisant les binaires.
|
||||
|
||||
Sous Debian Jessie, Tomcat 7 et 8 sont disponibles.
|
||||
|
||||
~~~
|
||||
# apt install tomcat7 tomcat7-user || apt install tomcat8 tomcat8-user
|
||||
# apt install openjdk-7-jdk tomcat8 tomcat8-user
|
||||
|
||||
# /usr/share/tomcat8/bin/version.sh
|
||||
Using CATALINA_BASE: /usr/share/tomcat8
|
||||
Using CATALINA_HOME: /usr/share/tomcat8
|
||||
Using CATALINA_TMPDIR: /usr/share/tomcat8/temp
|
||||
Using JRE_HOME: /usr
|
||||
Using CLASSPATH: /usr/share/tomcat8/bin/bootstrap.jar:/usr/share/tomcat8/bin/tomcat-juli.jar
|
||||
Server version: Apache Tomcat/8.0.14 (Debian)
|
||||
Server built: Feb 13 2017 09:37:48
|
||||
Server number: 8.0.14.0
|
||||
OS Name: Linux
|
||||
OS Version: 3.16.0-4-amd64
|
||||
Architecture: amd64
|
||||
JVM Version: 1.7.0_121-b00
|
||||
JVM Vendor: Oracle Corporation
|
||||
~~~
|
||||
|
||||
### Unité systemd utilisateur
|
||||
> *Note* : on peut également installer Tomcat 7 avec les paquets _tomcat7*_
|
||||
|
||||
Installer la librairie PAM pour systemd :
|
||||
|
||||
## Configuration
|
||||
|
||||
La configuration système de Tomcat, et notamment les paramètres de la JVM, se trouve dans le fichier `/etc/default/tomcat8` que l'on adapte ainsi :
|
||||
|
||||
~~~
|
||||
# Rare sont les cas ou l'on peut activer le Java security manager
|
||||
TOMCAT6_SECURITY=no
|
||||
|
||||
# Reglages memoire de base (a adapter selon votre quantite de RAM, dans l'exemple on a une seule instance et 4 Go de RAM)
|
||||
JAVA_OPTS="${JAVA_OPTS} -Xms1g -Xmx2g -XX:NewSize=512m -XX:MaxPermSize=256m -Xss256k"
|
||||
|
||||
# Reglages du garbage collector
|
||||
JAVA_OPTS="${JAVA_OPTS} -XX:+UseConcMarkSweepGC -XX:+CMSIncrementalMode -XX:CMSInitiatingOccupancyFraction=80"
|
||||
|
||||
# Compression des adresses 64bits sur 32bits pour gagner en memoire libre
|
||||
JAVA_OPTS="${JAVA_OPTS} -XX:+UseCompressedOops"
|
||||
|
||||
# file limits pour eviter les "too many open files"
|
||||
ulimit -n 8192
|
||||
~~~
|
||||
|
||||
La configuration des options de Tomcat se trouve dans le répertoire `/etc/tomcat8/` notamment dans le fichier `/etc/tomcat8/server.xml` :
|
||||
|
||||
~~~{.xml}
|
||||
<?xml version='1.0' encoding='utf-8'?>
|
||||
|
||||
<Server port="8005" shutdown="SHUTDOWN">
|
||||
<Listener className="org.apache.catalina.startup.VersionLoggerListener" />
|
||||
<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 port="8080" protocol="HTTP/1.1" connectionTimeout="20000" URIEncoding="UTF-8" redirectPort="8443" />
|
||||
<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">
|
||||
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
|
||||
prefix="localhost_access_log" suffix=".txt" pattern="%h %l %u %t "%r" %s %b" />
|
||||
</Host>
|
||||
</Engine>
|
||||
</Service>
|
||||
</Server>
|
||||
~~~
|
||||
|
||||
On peut ainsi désactiver le déploiement automatique (à chaud) en modifiant :
|
||||
|
||||
~~~{.xml}
|
||||
<Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="false">
|
||||
~~~
|
||||
|
||||
Ou encore changer les paramètres du connecteur HTTP (port TCP utilisé, _timeout_ de la connexion) via :
|
||||
|
||||
~~~{.xml}
|
||||
<Connector port="8765" protocol="HTTP/1.1" connectionTimeout="5000" URIEncoding="UTF-8" redirectPort="8443" />
|
||||
~~~
|
||||
|
||||
|
||||
## Arborescence
|
||||
|
||||
Les fichiers de _Tomcat_ sont dispersés, voici les répertoires importants :
|
||||
|
||||
* CATALINA_BASE : ${catalina.base} = /var/lib/tomcat8
|
||||
* CATALINA_HOME : ${catalina.home} = /usr/share/tomcat8
|
||||
|
||||
Le répertoire CATALINA_BASE contient :
|
||||
|
||||
~~~
|
||||
/var/lib/tomcat8/
|
||||
├── conf -> /etc/tomcat8
|
||||
├── lib
|
||||
├── logs -> /var/log/tomcat8
|
||||
├── policy
|
||||
│ └── catalina.policy
|
||||
├── webapps (répertoire où l'on peut déposer les servlets)
|
||||
│ └── ROOT
|
||||
│ ├── index.html
|
||||
│ └── META-INF
|
||||
│ └── context.xml
|
||||
└── work -> /var/cache/tomcat8
|
||||
~~~
|
||||
|
||||
Un élément important concerne les classes Java qui peuvent être déposées à différents endroits.
|
||||
L'ordre de chargement de ces classes (_Class Loader_) se fait ainsi :
|
||||
|
||||
* /usr/share/tomcat6/lib/ : classes communes à toutes les servlets
|
||||
* /var/lib/tomcat8/webapps/foo/WEB-INF/lib/ : classes spécifiques à la servlet foo
|
||||
|
||||
|
||||
## Administration
|
||||
|
||||
### Manager Tomcat
|
||||
|
||||
On peut installer le _Manager Tomcat_, une interface web permettant notamment déployer des servlets Java :
|
||||
|
||||
~~~
|
||||
# apt install tomcat8-admin
|
||||
~~~
|
||||
|
||||
Il faut ensuite ajouter un utilisateur au rôle _manager_, dans le fichier `/etc/tomcat8/tomcat-users.xml` :
|
||||
|
||||
~~~{.xml}
|
||||
<tomcat-users>
|
||||
[...]
|
||||
<role rolename="manager"/>
|
||||
<user username="foo" password="PASSWORD" roles="manager"/>
|
||||
</tomcat-users>
|
||||
~~~
|
||||
|
||||
L'accès au _Manager Tomcat_ se fait sur http://127.0.0.1:8080/manager/html
|
||||
|
||||
|
||||
## Instances Tomcat
|
||||
|
||||
On peut faire tourner plusieurs instances Tomcat complètement indépendantes, avec leurs propres réglages et en permettant des arrêts/redémarrages d'une instance sans impacter les autres, le tout en mutualisant les binaires.
|
||||
|
||||
Pour cela, on s'appuye sur [systemd](HowtoSystemd) pour lequel il faut installer la bibliothèque PAM :
|
||||
|
||||
~~~
|
||||
# apt install libpam-systemd
|
||||
~~~
|
||||
|
||||
Créer l'unité tomcat dans /etc/systemd/user/tomcat.service.
|
||||
Et l'on crée une unité systemd `/etc/systemd/user/tomcat.service` :
|
||||
|
||||
~~~{.ini}
|
||||
[Unit]
|
||||
|
|
@ -38,34 +172,29 @@ WorkingDirectory=%h
|
|||
Environment="CATALINA_BASE=%h"
|
||||
EnvironmentFile=%h/conf/env
|
||||
UMask=0002
|
||||
ExecStart=/usr/share/tomcat8/bin/startup.sh
|
||||
ExecStop=/usr/share/tomcat8/bin/shutdown.sh
|
||||
# Pour Tomcat 7
|
||||
ExecStart=/usr/share/tomcat7/bin/startup.sh
|
||||
ExecStop=/usr/share/tomcat7/bin/shutdown.sh
|
||||
# Pour Tomcat 8
|
||||
#ExecStart=/usr/share/tomcat8/bin/startup.sh
|
||||
#ExecStop=/usr/share/tomcat8/bin/shutdown.sh
|
||||
#ExecStart=/usr/share/tomcat7/bin/startup.sh
|
||||
#ExecStop=/usr/share/tomcat7/bin/shutdown.sh
|
||||
Type=forking
|
||||
|
||||
[Install]
|
||||
WantedBy=default.target
|
||||
~~~
|
||||
|
||||
## Création d'une instance
|
||||
|
||||
Créer un utilisateur dédié à l'instance et créer son arborescence via tomcatX-instance-create.
|
||||
On peut ensuite créer une instance nommée _foo_ avec un utilisateur dédié :
|
||||
|
||||
~~~
|
||||
# mkdir -p /srv/tomcat
|
||||
# tomcat7-instance-create /srv/tomcat/app || tomcat8-instance-create /srv/tomcat/app
|
||||
# useradd -d /srv/tomcat/app app
|
||||
# chown -R app:app /srv/tomcat/app
|
||||
# chmod -R u=rwX,g=rX,o= /srv/tomcat/app
|
||||
# chmod -R g+ws /srv/tomcat/app
|
||||
# tomcat8-instance-create /srv/tomcat/foo
|
||||
# useradd -d /srv/tomcat/foo foo
|
||||
# chown -R app:app /srv/tomcat/foo
|
||||
# chmod -R u=rwX,g=rX,o= /srv/tomcat/foo
|
||||
# chmod -R g+ws /srv/tomcat/foo
|
||||
~~~
|
||||
|
||||
### Configuration
|
||||
|
||||
Créer les variables d'environnement dans /srv/tomcat/app/conf/env
|
||||
Créer les variables d'environnement dans `/srv/tomcat/foo/conf/env` :
|
||||
|
||||
~~~{.bash}
|
||||
# Memory allocation options.
|
||||
|
|
@ -73,94 +202,133 @@ Créer les variables d'environnement dans /srv/tomcat/app/conf/env
|
|||
# Xms Allocated memory at startup.
|
||||
# XX:MaxPermSize Memory allocated to internal objects.
|
||||
JAVA_HOME="/usr/lib/jvm/java-1.7.0-openjdk-amd64"
|
||||
JAVA_OPTS="-server -XmxTOMCAT_INSTANCE_RAMm -XmsTOMCAT_INSTANCE_RAMm -XX:MaxPermSize=(TOMCAT_INSTANCE_RAM/2)m -XX:+UseParNewGC -XX:+UseConcMarkSweepGC -XX:+CMSPermGenSweepingEnabled -XX:+CMSClassUnloadingEnabled -Xverify:none"
|
||||
JAVA_OPTS="${JAVA_OPTS} -server -Xms1g -Xmx2g -XX:NewSize=512m -XX:MaxPermSize=256m -Xss256k"
|
||||
JAVA_OPTS="${JAVA_OPTS} -XX:+UseConcMarkSweepGC -XX:+CMSIncrementalMode -XX:CMSInitiatingOccupancyFraction=80"
|
||||
JAVA_OPTS="${JAVA_OPTS} -XX:+UseCompressedOops"
|
||||
JAVA_OPTS="${JAVA_OPTS} -XX:+UseParNewGC -XX:+CMSPermGenSweepingEnabled -XX:+CMSClassUnloadingEnabled -Xverify:none"
|
||||
~~~
|
||||
|
||||
Il reste ensuite à ajuster les ports HTTP et SHUTDOWN dans /srv/tomcat/app/conf/server.xml
|
||||
Il reste ensuite à ajuster les ports HTTP et SHUTDOWN dans `/srv/tomcat/app/conf/server.xml` :
|
||||
|
||||
~~~{.xml}
|
||||
<Server port="SHUTDOWN_PORT" shutdown="SHUTDOWN">
|
||||
<Connector port="HTTP_PORT" protocol="HTTP/1.1" connectionTimeout="20000" URIEncoding="UTF-8" redirectPort="8443"/>
|
||||
~~~
|
||||
|
||||
### Garder la session utilisateur active
|
||||
|
||||
Activer la conservation de la session de l'utilisateur.
|
||||
Enfin, il est nécessaire d'activer la conservation de la session de l'utilisateur :
|
||||
|
||||
~~~
|
||||
# loginctl enable-linger foo
|
||||
~~~
|
||||
|
||||
### Reverse proxy avec Apache
|
||||
### Gestion d'une instance Tomcat
|
||||
|
||||
Activer le mod proxy et proxy_http :
|
||||
Activation au démarrage de l'instance :
|
||||
|
||||
~~~
|
||||
# su - foo
|
||||
$ systemctl --user enable tomcat
|
||||
~~~
|
||||
|
||||
Démarrage de l'instance :
|
||||
|
||||
~~~
|
||||
# su - foo
|
||||
$ systemctl --user start tomcat
|
||||
~~~
|
||||
|
||||
Arrêt de l'instance :
|
||||
|
||||
~~~
|
||||
# su - foo
|
||||
$ systemctl --user stop tomcat
|
||||
~~~
|
||||
|
||||
Redémarrage de l'instance :
|
||||
|
||||
~~~
|
||||
# su - foo
|
||||
$ systemctl --user restart tomcat
|
||||
~~~
|
||||
|
||||
Afficher le statut de l'instance :
|
||||
|
||||
~~~
|
||||
# su - foo
|
||||
$ systemctl --user status -l tomcat
|
||||
~~~
|
||||
|
||||
|
||||
|
||||
## Configuration avec Apache
|
||||
|
||||
Nous conseillons d'utiliser [Apache](HowtoApache) comme reverse-proxy HTTP/HTTPS devant _Tomcat_.
|
||||
Pour cela on conseille d'utiliser le module *proxy_http* avec le connecteur HTTP de _Tomcat_.
|
||||
On peut également utiliser le module mod-jk avec le connecteur AJP de _Tomcat_.
|
||||
|
||||
### avec proxy_http
|
||||
|
||||
~~~
|
||||
# a2enmod proxy_http
|
||||
~~~
|
||||
|
||||
Voici un VirtualHost type :
|
||||
|
||||
~~~{.apache}
|
||||
<VirtualHost *:80>
|
||||
ServerName SERVER_NAME
|
||||
CustomLog /var/log/apache2/access.log combined
|
||||
CustomLog /var/log/apache2/INSTANCE_NAME_access.log combined
|
||||
ErrorLog /var/log/apache2/INSTANCE_NAME_error.log
|
||||
ServerName www.example.com
|
||||
|
||||
Include /etc/apache2/nocache-js.conf
|
||||
|
||||
<IfModule mod_proxy_http.c>
|
||||
ProxyPass / http://127.0.0.1:HTTP_PORT/
|
||||
ProxyPassReverse / http://127.0.0.1:HTTP_PORT/
|
||||
<Proxy http://127.0.0.1:HTTP_PORT/>
|
||||
Allow from all
|
||||
</Proxy>
|
||||
</IfModule>
|
||||
<IfModule mod_proxy_http.c>
|
||||
ProxyPass / http://127.0.0.1:8080/
|
||||
ProxyPassReverse / http://127.0.0.1:8080/
|
||||
<Proxy http://127.0.0.1:8080/>
|
||||
Allow from all
|
||||
</Proxy>
|
||||
</IfModule>
|
||||
</VirtualHost>
|
||||
~~~
|
||||
|
||||
## Utilisation
|
||||
|
||||
Les instances Tomcat étant gérées via une unité utilisateur Systemd, les commandes suivantes doivent être lancées via l'utilisateur dédié à l'instance.
|
||||
### avec mod-jk
|
||||
|
||||
~~~
|
||||
# su - app
|
||||
# apt install libapache2-mod-jk
|
||||
~~~
|
||||
|
||||
#### Activation au démarrage
|
||||
Il faut ensuite s'assurer d'avoir activer le connecteur AJP dans le fichier `server.xml` :
|
||||
|
||||
~~~
|
||||
$ systemctl --user enable tomcat
|
||||
~~~{.xml}
|
||||
<Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
|
||||
~~~
|
||||
|
||||
#### Démarrage
|
||||
On édite `/etc/libapache2-mod-jk/workers.properties` pour lister les instances Tomcat concernées :
|
||||
|
||||
~~~
|
||||
$ systemctl --user start tomcat
|
||||
workers.tomcat_home=/usr/share/tomcat8
|
||||
workers.java_home=/usr/lib/jvm/default-java
|
||||
worker.list=ajp13_worker
|
||||
worker.ajp13_worker.port=8009
|
||||
worker.ajp13_worker.host=localhost
|
||||
worker.ajp13_worker.type=ajp13
|
||||
~~~
|
||||
|
||||
#### Extinction
|
||||
Voici un VirtualHost type :
|
||||
|
||||
~~~
|
||||
$ systemctl --user stop tomcat
|
||||
~~~{.apache}
|
||||
<VirtualHost *:80>
|
||||
ServerName www.example.com
|
||||
|
||||
JkMount /* ajp13_worker
|
||||
</VirtualHost>
|
||||
~~~
|
||||
|
||||
#### Redémarrage
|
||||
> *Note* : les options pour _libapache2-mod-jk_ sont configurables dans le fichier `/etc/apache2/mods-available/jk.conf`
|
||||
|
||||
~~~
|
||||
$ systemctl --user restart tomcat
|
||||
~~~
|
||||
|
||||
#### Status
|
||||
## FAQ
|
||||
|
||||
~~~
|
||||
$ systemctl --user status -l tomcat
|
||||
~~~
|
||||
### access_log de Tomcat
|
||||
|
||||
## Divers
|
||||
|
||||
### Activation du « access_log » de Tomcat
|
||||
|
||||
Pour loguer tous les accès, il suffit de décommenter cette partie dans le server.xml :
|
||||
_Tomcat_ peut générer des journaux d'accès similaires à ceux d'Apache. On configure cela via le fichier `server.xml` :
|
||||
|
||||
~~~{.xml}
|
||||
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
|
||||
|
|
@ -169,32 +337,38 @@ Pour loguer tous les accès, il suffit de décommenter cette partie dans le serv
|
|||
|
||||
### Connecteur HTTP
|
||||
|
||||
Activer la compression gzip de certains types de fichiers :
|
||||
|
||||
Dans le fichier server.xml, rajouter ceci dans le connecteur HTTP :
|
||||
Pour activer la compression GZIP de certains types de fichiers, ajouter les options suivantes dans le connecteur HTTP via le fichier `server.xml` :
|
||||
|
||||
~~~
|
||||
compression="on" compressionMinSize="2048" compressableMimeType="text/html,text/xml,text/plain,text/javascript,application/javascript"
|
||||
~~~
|
||||
|
||||
### Manager Tomcat
|
||||
### Drivers JDBC
|
||||
|
||||
Une des méthodes possibles pour le déployment d'applications java est de le faire via une interface web, le manager Tomcat.
|
||||
|
||||
Installation :
|
||||
Pour installer le driver JDBC pour MySQL :
|
||||
|
||||
~~~
|
||||
# apt install tomcat7-admin || apt install tomcat8-admin
|
||||
# aptitude install libmysql-java
|
||||
# cd /usr/share/tomcat6/lib/
|
||||
# ln -s ../../java/mysql-connector-java.jar mysql.jar
|
||||
~~~
|
||||
|
||||
Il faut ensuite ajouter un utilisateur au rôle _manager_, dans le fichier tomcat-users.xml (équivalent d'un fichier htpasswd d'Apache) :
|
||||
Pour installer le driver JDBC pour PostgreSQL :
|
||||
|
||||
~~~
|
||||
<tomcat-users>
|
||||
[...]
|
||||
<role rolename="manager"/>
|
||||
<user username="jdoe" password="s3cret" roles="manager"/>
|
||||
</tomcat-users>
|
||||
# aptitude install libpg-java
|
||||
# cd /usr/share/tomcat6/lib/
|
||||
# ln -s ../../java/mysql-connector-java.jar mysql.jar
|
||||
~~~
|
||||
|
||||
Une fois Tomcat redémarré, l'accès au manager se fait sur l'URI : <http://example.com:8080/manager/html>
|
||||
### Qu'est-ce que c'est JSVC ? Pourquoi l'utiliser ?
|
||||
|
||||
JSVC est un outil permettant d'uniformiser le lancement de "daemon" en JAVA pour tous les systèmes, notamment sous Windows. Sous Linux, il est parfois utilisé, mais son utilisation reste déconseillée vu qu'il existe d'autres outils pour faire cela *et* que son utilisation ne permet pas une gestion via JMX. Sous Debian, il a été utilisé sous Debian Lenny, mais il n'est plus utilisé dans les versions suivantes.
|
||||
|
||||
### Tomcat n'écoute pas en IPv4, pourquoi ? Comment le corriger ?
|
||||
|
||||
Les versions récentes de Java préfèrent l'IPv6 si elle est présente. Le problème c'est que dans ce cas, il peut arriver que tomcat n'écoute pas en IPv4. Il faut alors modifier les propriétés par défaut en ajoutant ceci aux JAVA_OPTS :
|
||||
|
||||
~~~
|
||||
-Djava.net.preferIPv4Stack=true
|
||||
~~~
|
||||
Loading…
Reference in New Issue