Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
|
serveurscrutari:installation [2012/01/08 17:30] vincent |
serveurscrutari:installation [2019/01/11 22:27] (Version actuelle) vincent |
||
|---|---|---|---|
| Ligne 1: | Ligne 1: | ||
| ====== Installation du serveur Scrutari ====== | ====== Installation du serveur Scrutari ====== | ||
| - | ===== Installation des binaires ===== | + | La compilation du code et l'installation de Scrutari sont décrites dans [[https://framagit.org/Scrutari/scrutari|le dépôt du logiciel]] |
| + | Pour la compréhension de la suite, il est important de rappeler que pour fonctionner Scrutari a besoin qu'on lui indique deux répertoires distincts : | ||
| - | Scrutari est un logiciel écrit en Java qui s'appuie sur le serveur d'application [[http://tomcat.apache.org/ | Tomcat]] , un projet de la fondation Apache. Pour installer Scrutari, il est donc nécessaire d'installer une machine virtuelle Java (version 5 ou supérieure) et Tomcat (version 5 ou supérieure). Avec [[http://openjdk.java.net/ | OpenJDK]], la version libre sous licence GPL, Java est maintenant présent dans toutes les distributions, nous n'aborderons pas ici son installation. Tomcat est également présent sous forme de paquets dans certaines distributions. Son installation à partir du fichier compressé disponible sur le [[http://tomcat.apache.org/download-60.cgi | site de Tomcat]] est assez simple : il suffit de décompresser ce fichier dans le répertoire de son choix (que nous appellerons par la suite ''$CATALINA_HOME'' pour reprendre la terminologie de Tomcat) et de lancer : ''$CATALINA_HOME/bin/startup.sh'' (éventuellement en indiquant le chemin de la machine virtuelle Java via la variable ''$JAVA_HOME'' dans le fichier ''$CATALINA_HOME/bin/catalina.sh''. | + | * le répertoire de configuration |
| + | * le répertoire des données | ||
| - | Si dans votre navigateur, l'adresse http://localhost:8080 affiche le message d'accueil de Tomcat, c'est que l'installation de Tomcat est réussie. Vous pouvez passer maintenant à l'installation de l'application Scrutari. | + | Toute la configuration de Scrutari se fait via des fichiers contenus dans le répertoire de configuration et ses sous-répertoires. L'interface d'administration du logiciel permet de vérifier la validité de la configuration mais pas de la modifier. |
| - | Tomcat propose différentes procédures pour installer une application : la déposer directement dans ''$CATALINA_HOME/webapps'', passer par un fichier ''.war'' ou encore la définir par un fichier de configuration placé dans ''$CATALINA_HOME/conf/Catalina/localhost/'' (voir la page sur le [[http://tomcat.apache.org/tomcat-6.0-doc/deployer-howto.html | déploiement d'une application]]). C'est cette dernière possibilité que nous allons utiliser pour l'application Scrutari, et ce pour deux raisons : elle permet d'installer Scrutari n'importe où, en particulier hors de ''$CATALINA_HOME'', ce qui facilite les mises à jour, et elle permet de passer des paramètres à l'application Scrutari. | + | ===== Fichier conf.xml ===== |
| - | La marche à suivre est la suivante : | + | Le fichier conf.xml de configuration globale doit être placé directement dans le répertoire de configuration. Il n'est pas obligatoire, Scrutari peut fonctionner sans. Le terme ''Configuration globale'' permet de distinguer la configuration de l'application Scrutari de la configuration propre à chaque moteur. |
| - | * Télécharger la dernière version des binaires de Scrutari (fichier ''scrutari-*-bin.zip'') : [[http://www.scrutari.net/versions]] | + | |
| - | * Décompresser le fichier zip dans le répertoire de votre choix : il apparait un répertoire ''scrutari-*'' qui contient un répertoire ''WEb-INF'' | + | Le fichier XML de configuration globale a comme racine l'élément !!<-conf>!!qui contient les éléments suivants : |
| - | * Copier le répertoire ''WEB-INF'' dans le répertoire de votre future application Tomcat, celle-ci peut-être dans le répertoire ''webapps'' de Tomcat ou partout ailleurs ; pour notre exemple, nous prendrons ''/home/tomcat/scrutari-webapps'' ; vous devez avoir alors le répertoire suivant ''/home/tomcat/scrutari-webapps/WEB-INF'' | + | * un élément optionnel !!<canonical-url>!! indiquant l'url à utiliser lorsque l'adresse du moteur doit être transmise (par exemple, la version http et la version https peuvent fonctionner l'une et l'autre indépendemment mais on transmettra de préférence la version https) |
| - | + | * un élément optionnel !!<default-lang>!! indiquant la langue à utiliser par défaut pour l'interface | |
| - | * Déclarer l'application auprès de Tomcat en créant un fichier ''scrutari.xml'' dans ''$CATALINA_HOME/conf/Catalina/localhost/'' avec le contenu suivant : | + | |
| + | Voici l'exemple de l'instance de Scrutari servant entre autres à la Coredem : | ||
| <code xml> | <code xml> | ||
| - | <Context docBase="/home/tomcat/scrutari-webapps"> | + | <conf> |
| - | <Parameter name="scrutariConfFile" value="/home/tomcat/scrutari-webapps/scrutari-conf.xml"/> | + | <canonical-url>https://sct1.scrutari.net/sct/</canonical-url> |
| - | </Context> | + | <default-lang>fr</default-lang> |
| + | </conf> | ||
| </code> | </code> | ||
| - | * Relancer Tomcat et, dans son navigateur, ouvrir la page http://localhost:8080/scrutari/ : si une page apparait avec le logo Scrutari, c'est que l'installation est réussie. | ||
| - | Revenons sur le contenu du fichier ''scrutari.xml'' installé dans ''$CATALINA_HOME/conf/Catalina/localhost/''. | ||
| - | * La valeur de l'attribut !!@docBase!! de l'élément !!<Context>!! indique le chemin du répertoire où est installé l'application en question (dans notre exemple ''/home/tomcat/scrutari-webapps''). | + | ===== DTD du fichier de configuration globale ===== |
| - | * L'élément !!<Parameter>!! permet de passer un paramètre à l'application ; le paramètre !!@name!!=''scrutariConfFile'' est obligatoire, sa valeur indique l'emplacement du fichier de configuration (dans notre exemple ''/home/tomcat/scrutari-webapps/scrutari-conf.xml'') de Scrutari. Sans ce fichier de configuration, Scrutari est installé mais ne peut rien faire. La description du contenu du fichier de configuration est décrite ci-après. | + | |
| - | ===== Configuration globale ===== | ||
| - | La configuration globale de l'application Scrutari se fait avec un seul fichier XML. Son chemin est indiqué par !!<Parameter name='scrutariConfFile'>!! dans la déclaration du contexte l'application Scrutari (voir ci-dessus). Son rôle est d'indiquer les //serveurs virtuels// gérés par l'application. | + | <code xml> |
| + | <!ELEMENT conf (canonical-url?, default-lang?)> | ||
| - | L'application Scrutari peut en effet héberger un nom illimité de //serveurs virtuels// : chaque serveur virtuel dispose de sa propre configuration et récupère ses propres fichiers au format ScrutariData. Les serveurs virtuels n'ont aucun rapport entre eux. Par exemple, l'application Scrutari qui gère le moteur de la Coredem gère également le moteur d'autres sites comme Irénées ou l'IRG. | + | <!ELEMENT canonical-url (#PCDATA)> |
| - | Dans la suite du document, le terme ''serveur Scrutari'' désigne un serveur virtuel particulier parmi ceux gérés par une application Scrutari. | + | <!ELEMENT default-lang (#PCDATA)> |
| - | Le terme ''Configuration globale'' permet de distinguer la configuration de l'application Scrutari de la configuration propre à chaque serveur virtuel. | + | </code> |
| - | Le fichier XML de configuration globale a comme racine l'élément !!<scrutari-conf>!!. Cet élément contient : | ||
| - | * un et un seul élément obligatoire <uuid> qui indique l'identifiant unique de l'application Scrutari | + | ===== Problème de codage des caractères ===== |
| - | * un et un seul élément obligatoire <conf-dir> qui indique le répertoire de base de la configuration des serveurs virtuels | + | |
| - | * un et un seul élément obligatoire <var-dir> qui indique le répertoire de base des données des serveurs virtuels | + | |
| - | * plusieurs élément !!<sctserver>!! avec l'attribut !!@name!! définissant les différents serveurs virtuels | + | |
| - | Ce qui donne l'exemple suivant : | + | Suivant la configuration de Tomcat, il peut arriver que les caractères accentuées ne passent pas au moment d'une requête. Dans ce cas, il faut rajouter dans le fichier de configuration ''server.xml'' de Tomcat l'attribut ''URIEncoding'' avec la valeur UTF-8 : |
| <code xml> | <code xml> | ||
| - | <scrutari-conf> | + | <Connector URIEncoding="UTF-8" connectionTimeout="20000" port="8080" protocol="HTTP/1.1" ...> |
| - | <uuid>08cb9560-d93e-11e0-8cf6-0002a5d5c51b</uuid> | + | |
| - | <conf-dir>/home/tomcat/scrutari-conf/</conf-dir> | + | |
| - | <var-dir>/home/tomcat/scrutari-var/</var-dir> | + | |
| - | <sctserver name="coredem"/> | + | |
| - | <sctserver name="irenees"/> | + | |
| - | <sctserver name="irg"/> | + | |
| - | </scrutari-conf> | + | |
| </code> | </code> | ||
| - | Le nom d'un serveur virtuel doit être composé des caractères de a à z (uniquement minuscule, sans accent), de chiffres (mais ne doit pas commencer par un chiffre) et du tiret de soulignement ''_'' (mais ne doit pas commencer par lui). Le nom d'un serveur virtuel se retrouve à trois endroits : | + | S'il n'est possible de changer cet attribut (conflit avec une autre application hébergée par exemple), il faut désactiver dans le fichier ''web.xml'' de Scrutari la définition du filtre SetCharacterEncodingFilter : |
| - | + | ||
| - | * dans la construction du chemin du répertoire où se trouve les fichiers de configuration du serveur sous la forme ''{valeur de <conf-dir> de la configuration globale}/{nom du serveur}'' (dans notre exemple, ''/home/tomcat/scrutari-conf/coredem'' ou ''/home/tomcat/scrutari-conf/irenees'') | + | |
| - | * dans la construction du chemin du répertoire où le serveur va enregistrer ses données sous la forme ''{valeur de <var-dir> de la configuration globale}/{nom du serveur}'' (dans notre exemple, ''/home/tomcat/scrutari-var/coredem'' ou ''/home/tomcat/scrutari-var/irenees'') | + | |
| - | * dans la construction de l'URL de base de l'accès au serveur sous la forme ''{URL de l'application Scrutari}/{nom du serveur}/'' (dans notre exemple, ''http://localhost:8080/scrutari/coredem/'' ou ''http://localhost:8080/scrutari/irenees/'') | + | |
| - | + | ||
| - | La séparation entre répertoire de configuration et répertoire des données est importante en termes de droit d'accès. En effet, l'application Scrutari a uniquement besoin d'accéder en lecture aux fichiers de configuration alors qu'elle a besoin évidemment d'accéder en lecture et écriture au répertoire de données. | + | |
| - | + | ||
| - | Autrement dit, si l'application Scrutari tourne avec l'utilisateur ''tomcat'', les fichiers de configuration peuvent appartenir à des utilisateurs différents et n'être accessible en écriture que par eux. Si on héberge de nombreux serveurs virtuels, on peut même donner accès pour un utilisateur particulier à la configuration d'un seul serveur virtuel. | + | |
| - | + | ||
| - | Une fois le fichier de configuration prêt, il est nécessaire de demander à l'application de recharger la configuration pour la mettre à jour. Cette action s'effectue via la page ''{URL de l'application Scrutari}/Reload'' (dans notre exemple, http://localhost:8080/scrutari/Reload). Cette page indique les éventuelles erreurs de configuration et, s'il n'y a pas d'erreur, liste les serveurs virtuels. | + | |
| - | + | ||
| - | La configuration globale de Scrutari est terminée. L'étape suivante est la [[serveurscrutari:config]] de chaque serveur virtuel particulier. | + | |
| - | + | ||
| - | Par la suite, l'ajout d'un serveur virtuel se fait en modifiant le fichier de configuration globale et en rechargeant la configuration via '{URL de l'application Scrutari}/Reload''. | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | ===== DTD du fichier de configuration globale ===== | + | |
| <code xml> | <code xml> | ||
| - | <!ELEMENT scrutari-conf (conf-dir, var-dir, sctserver*)> | + | <!--<filter> |
| - | + | <filter-name>SetCharacterEncodingFilter</filter-name> | |
| - | + | <filter-class>net.mapeadores.util.servlets.SetCharacterEncodingFilter</filter-class> | |
| - | <!ELEMENT conf-dir (#PCDATA)> | + | <init-param> |
| - | + | <param-name>encoding</param-name> | |
| - | <!ELEMENT var-dir(#PCDATA)> | + | <param-value>UTF-8</param-value> |
| - | + | </init-param> | |
| - | <!ELEMENT sctserver EMPTY> | + | </filter> |
| - | <!ATTLIST sctserver name NMTOKEN #REQUIRED | + | <filter-mapping> |
| + | <filter-name>SetCharacterEncodingFilter</filter-name> | ||
| + | <servlet-name>Scrutari</servlet-name> | ||
| + | </filter-mapping>--> | ||
| </code> | </code> | ||
