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 Prochaine révision Les deux révisions suivantes | ||
|
serveurscrutari:installation [2016/09/26 17:08] vincent [Configuration globale] |
serveurscrutari:installation [2019/01/11 22:17] vincent [Installation du serveur Scrutari] |
||
|---|---|---|---|
| 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 7 ou supérieure) et Tomcat (version 6 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 | ||
| - | Note : voir aussi [[serveurscrutari:installation:debian7wheezy|l'installation sur une Debian 7 Wheezy]] | + | 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. |
| - | + | ||
| - | 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. | + | |
| - | + | ||
| - | 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. | + | |
| - | + | ||
| - | La marche à suivre est la suivante : | + | |
| - | * Télécharger la dernière version « quasi-stable » des binaires de Scrutari sur [[http://www.scrutari.net/versions]]. Cette version est appelée « quasi-stable » car elle est en production pour plusieurs moteurs (dont celui de la Coredem) mais comme elle suit de près les développements, elle n'est pas non plus exempte de bogues (qui ne risque cependant pas de passer inaperçu longtemps). Le nom du fichier binaire est sous la forme ''scrutari-*-bin.zip'' où ''*'' est le numéro de révision du dépôt Subversion. | + | |
| - | + | ||
| - | * 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'' | + | |
| - | + | ||
| - | * 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'' | + | |
| - | + | ||
| - | * 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 : | + | |
| - | + | ||
| - | <code xml> | + | |
| - | <Context docBase="/home/tomcat/scrutari-webapps"> | + | |
| - | <Parameter name="scrutariConfFile" value="/home/tomcat/scrutari-webapps/scrutari-conf.xml"/> | + | |
| - | </Context> | + | |
| - | </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''). | + | |
| - | * 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 ===== | ===== Configuration globale ===== | ||
| Ligne 44: | Ligne 20: | ||
| Le fichier XML de configuration globale a comme racine l'élément !!<scrutari-conf>!!qui contient les éléments suivants : | Le fichier XML de configuration globale a comme racine l'élément !!<scrutari-conf>!!qui contient les éléments suivants : | ||
| - | * un et un seul élément obligatoire !!<uuid>!! qui indique l'identifiant unique de l'application Scrutari | + | * un et un seul élément obligatoire !!<name>!! qui indique le nom identifiant l'application Scrutari (cela peut être un nom de domaine ou un UUID) |
| * un et un seul élément obligatoire !!<conf-dir>!! qui indique le répertoire de base de la configuration des moteurs | * un et un seul élément obligatoire !!<conf-dir>!! qui indique le répertoire de base de la configuration des moteurs | ||
| * un et un seul élément obligatoire !!<var-dir>!! qui indique le répertoire de base des données des moteurs | * un et un seul élément obligatoire !!<var-dir>!! qui indique le répertoire de base des données des moteurs | ||
| * un et un seul élément obligatoire !!<url>!! qui indique l'URL d'accès à l'application | * un et un seul élément obligatoire !!<url>!! qui indique l'URL d'accès à l'application | ||
| - | * un élément optionnel !!<default-lang-ui>!! indiquant la langue à utiliser par défaut pour l'interface | + | * un élément optionnel !!<default-lang>!! indiquant la langue à utiliser par défaut pour l'interface |
| - | * plusieurs élément !!<engine>!! avec l'attribut !!@name!! définissant les différents moteurs et comme attribut optionnel !!@default-lang-ui!! dont la valeur est le code de la langue à utiliser par défaut pour l'interface de ce moteur (supplante l'éventuelle valeur de //@default-lang-ui// définie au niveau de //<scrutari-conf>//) | + | |
| Voici l'exemple de l'instance de Scrutari servant entre autres à la Coredem : | Voici l'exemple de l'instance de Scrutari servant entre autres à la Coredem : | ||
| Ligne 55: | Ligne 30: | ||
| <code xml> | <code xml> | ||
| <scrutari-conf> | <scrutari-conf> | ||
| - | <uuid>04ca9560-d93e-11e0-8cf6-0002a5d5c51b</uuid> | + | <name>04ca9560-d93e-11e0-8cf6-0002a5d5c51b</name> |
| <conf-dir>/home/tomcat/scrutari-conf/</conf-dir> | <conf-dir>/home/tomcat/scrutari-conf/</conf-dir> | ||
| <var-dir>/home/tomcat/scrutari-var/</var-dir> | <var-dir>/home/tomcat/scrutari-var/</var-dir> | ||
| <url>http://sct1.scrutari.net/sct/</url> | <url>http://sct1.scrutari.net/sct/</url> | ||
| - | <default-lang-ui>fr</default-lang-ui> | + | <default-lang>fr</default-lang> |
| </scrutari-conf> | </scrutari-conf> | ||
| </code> | </code> | ||
| Ligne 65: | Ligne 40: | ||
| Les moteurs gérés par l'instance vont être déduits des sous-répertoires contenus dans le répertoire défini par ''<conf-dir>'' : tous les répertoires dont le nom est composé uniquement de 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) sont censés désigner un moteur et contenir les fichiers de configuration de celui-ci. Le nom du répertoire est le nom du moteur. | Les moteurs gérés par l'instance vont être déduits des sous-répertoires contenus dans le répertoire défini par ''<conf-dir>'' : tous les répertoires dont le nom est composé uniquement de 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) sont censés désigner un moteur et contenir les fichiers de configuration de celui-ci. Le nom du répertoire est le nom du moteur. | ||
| - | Pour ajouter un nouveau moteur, il suffit donc de créer un répertoire avec un nom éligible dans le répertoire de configuration. Pour supprimer le moteur, il suffit de supprimer le répertoire. On peut également désactiver temporairement un moteur en le renommant avec un nom invalide (par exemple, en le précédent du tiret de soulignement). Après intervention sur les répertoires, il est nécessaire d'indiquer à Scrutari de recharger la configuration avec la commande ''reload'' comme précisé ci-dessous. | + | Pour ajouter un nouveau moteur, il suffit donc de créer un répertoire avec un nom éligible dans le répertoire de configuration. Pour supprimer le moteur, il suffit de supprimer le répertoire. On peut également désactiver temporairement un moteur en le renommant avec un nom invalide (par exemple, en le précédent du tiret de soulignement). Après intervention sur les répertoires, il est nécessaire d'indiquer à Scrutari de recharger la configuration avec l'instruction ''_reload'' comme précisé ci-dessous. |
| Le nom du moteur va être également utilisé aux deux endroits suivants : | Le nom du moteur va être également utilisé aux deux endroits suivants : | ||
| Ligne 76: | Ligne 51: | ||
| 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 moteur. | 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 moteur. | ||
| - | 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 moteurs. | + | 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 moteurs. |
| La configuration globale de Scrutari est terminée. L'étape suivante est la [[serveurscrutari:config|configuration]] de chaque moteur particulier. | La configuration globale de Scrutari est terminée. L'étape suivante est la [[serveurscrutari:config|configuration]] de chaque moteur particulier. | ||
| Ligne 88: | Ligne 63: | ||
| <code xml> | <code xml> | ||
| - | <!ELEMENT scrutari-conf (uuid, conf-dir, var-dir, url, default-lang-ui?)> | + | <!ELEMENT scrutari-conf (name, conf-dir, var-dir, url, default-lang?)> |
| - | <!ELEMENT uuid (#PCDATA)> | + | <!ELEMENT name (#PCDATA)> |
| <!ELEMENT conf-dir (#PCDATA)> | <!ELEMENT conf-dir (#PCDATA)> | ||
| Ligne 98: | Ligne 73: | ||
| <!ELEMENT url (#PCDATA)> | <!ELEMENT url (#PCDATA)> | ||
| - | <!ELEMENT default-lang-ui (#PCDATA)> | + | <!ELEMENT default-lang (#PCDATA)> |
| </code> | </code> | ||
