Author: tchemit Date: 2012-04-12 16:11:40 +0200 (Thu, 12 Apr 2012) New Revision: 530 Url: http://forge.codelutin.com/repositories/revision/echobase/530 Log: refs #484: Documentation Added: trunk/src/doc/reunions/reunion-2012-04-12.txt Modified: trunk/src/site/rst/embedded.rst trunk/src/site/rst/install.rst Added: trunk/src/doc/reunions/reunion-2012-04-12.txt =================================================================== --- trunk/src/doc/reunions/reunion-2012-04-12.txt (rev 0) +++ trunk/src/doc/reunions/reunion-2012-04-12.txt 2012-04-12 14:11:40 UTC (rev 530) @@ -0,0 +1,27 @@ +projet echobase +--------------- + +Vendredi 6 avril 2012 (Ifremer) + +Présents : Mathieu et Tony + +Retours +------- + +- ajouter un exemple d'ajout de variables d'environnment (avec le ~1...) +- voir pour les problème d'echotypes sur les données legacy (#1107) +- voir pour modifier les regions dans les données legacy +- revoir doc pour install +- fournir petits scripts pour regénérer la base +- desactiver scmwebeditor lors d'une release. +- redonner des fichiers de traductions à Mathieu +- chiffrage lot 2 + + +Action +------ + + +Prochaine réunion : + + - Vendredi 13 Avril à 10h00 \ No newline at end of file Modified: trunk/src/site/rst/embedded.rst =================================================================== --- trunk/src/site/rst/embedded.rst 2012-04-12 13:27:05 UTC (rev 529) +++ trunk/src/site/rst/embedded.rst 2012-04-12 14:11:40 UTC (rev 530) @@ -93,12 +93,12 @@ `Page de téléchargement Oracle`_ -Une fois la JDK téléchargée et installée, ajouter dans les variables -d'environnement : +Une fois la JDK téléchargée et installée, ajouter la variable d'environnement +**JDK_HOME** qui est le chemin vers où a été installé Java. :: - JDK_HOME -> chemin vers où a été installé la JDK + JDK_HOME -> C:/Program Files/Java/jdk1.7.0_03 Installation d'echobase ======================= Modified: trunk/src/site/rst/install.rst =================================================================== --- trunk/src/site/rst/install.rst 2012-04-12 13:27:05 UTC (rev 529) +++ trunk/src/site/rst/install.rst 2012-04-12 14:11:40 UTC (rev 530) @@ -34,39 +34,27 @@ :start: 1 :depth: 2 -Configuration d'Echobase ------------------------- +Installation d'EchoBase sur un serveur +-------------------------------------- -La configuration d'Echobase se trouve par défaut de le fichier -**/etc/echobase.properties**. +Nous préconisons toujours d'utiliser les valeurs par défaut fournies pour une +meilleur réactivité si un problème d'installation survient. -Ce fichier permet de surcharger la configuration par défaut. +Nous préconisons aussi l'utilisation d'un serveur linux de type debian :)... -*Nous préconisons* l'utilisation de la configuration par défaut. +L'installation se déroule en 2 étapes : -Par défaut le répertoire de travail ce trouve dans */var/local/echobase*. -Le war du projet (pour créer une application embarquée) se trouve dans le -repertoire "war" du répertoire de travail. Voici contenu de celui-ci par défaut:: +- création de la base de données +- installation de l'application - data.directory=/var/local/echobase # Repertoire de l'application - war.directory=${data.directory}/war # Répertoire où est stoqué le war - war.location=${war.directory}/echobase-ui-${project.version}.war # Chemin complêt d'accès au war - -Vous pouvez surcharger toutes les propriétés ci-dessus, dans la plupart des -cas, seul la modification de data.directory est normalement nécessaire. - -Il suffit de créer le fichier */etc/echobase.properties* et d'y ajouter -la/les ligne(s) ci-dessus modifiée(s). - -Une base de donnée h2 est crée dans le répertoire de travail (data.directory) -mais il est possible de configurer une base Postgres. - Installation de la base de données ----------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Pré-requis : - - **postgres** doit être installé sur la machine (exemple pour un système Debian : apt-get install postgresql) - - être connecté avec l'utilisateur (postgres par défaut) qui a les droits d'administrer cette base de donnée. + - **postgres** doit être installé sur la machine (exemple pour un système + Debian : **sudo apt-get install postgresql**) + - être connecté avec l'utilisateur (postgres par défaut) qui a les droits + d'administrer cette base de donnée dans une console shell. 1. Création de l'utilisateur Postgres @@ -80,23 +68,120 @@ createdb -U postgres -E UTF-8 -O echobase echobase -3. Il faut positionner le fichier de configuration echobase.properties_ dans - /etc et remplacer le mot de passe (hibernate.connection.password) par celui - rentré lors de la création de l'utilisateur Postgres. +3. Donner les droits d'acces à l'utilisateur echobase (cela varie d'un système + à l'autre, donc se référer à la documentation du système). Cela fonctionne + lorsqu'on peut accéder à la base via cette commande : -.. _echobase.properties: echobase.properties +:: -Installation de l'application ------------------------------ + psql -h localhost -U echobase echobase -L'application qui est fournit sous forme le war doit être placée dans le -répertoire dédié dans le serveur web. +Préparation première installation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Il faut aussi placer ce war dans le répertoire défini dans la configuration par -la propriété *war.location* qui par défaut est situé dans */var/local/echobase/war* +Il faut être loggué sur une console avec l'utilisateur root. +On suppose ici que tomcat a été installé dans le répertoire */opt/tomcat* . + +Toutes les données de l'application (et sa configuration) seront placées dans +le répertoire **/var/local/echobase** + +- Créer les répertoires + +:: + + mkdir /var/local/echobase + mkdir /var/local/echobase/war + +- Placer le war à utiliser dans **/var/local/echobase/war** + +- Ajouter une lien symoblique vers le war à utiliser + +:: + + ln -s /var/local/echobase/war/echobase-ui-XXX.var /var/local/echobase/echobase.war + +- Ajouter un lien symbolique dans le répertoire **webapps** de tomcat vers ce + lien symbolique + +:: + + ln -s /var/local/echobase/echobase.war /opt/tomcat/webapps/echobase.war + +- Copier le fichier de configuration echobase.properties_ de l'application + dans **/var/local/echobase/** + +- Editer ce fichier pour adapter le mot de passe de l'utilisateur et peut-être + aussi l'url de connexion. Voici un exemple fichier modifié + +:: + + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + hibernate.connection.driver_class=org.postgresql.Driver + hibernate.connection.url=jdbc:postgresql://monNomDeMachine/echobase + hibernate.connection.username=echobase + hibernate.connection.password=motDePasseModifie + +- Ajouter un lien symbolique ver le fichier de configuration dans */etc* + +:: + + ln -s /var/local/echobase/echobase.properties /etc/echobase.properties + +Le répertoire au final devrait ressembler à ça : + +:: + +tchemit@tc:~/projets/forge/echobase$ tree /var/local/echobase/ + /var/local/echobase/ + ├── echobase.properties (configuration) + ├── echobase.war -> war/echobase-ui-1.0.war (war actuellement utilisé) + ├── logs (répertoire des logs) + └── war (répertoire des wars) + ├── echobase-ui-0.2.war + ├── echobase-ui-0.4.war + ├── echobase-ui-0.6.war + └── echobase-ui-1.0.war + +Une fois le serveur tomcat démarré, vous pouvez accéder à l'application à +l'adresse suivante : + +:: + + http://localhost:8080/echobase + + +Mettre à jour le war de l'application +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Il faut être loggué sur une console avec l'utilisateur root. + +On suppose ici que tomcat a été installé dans le répertoire */opt/tomcat* . + +Pour utiliser une nouvelle version de l'application, c'est en 5 étapes : + +1. Arrêter le serveur tomcat +2. Supprimer les répertoires suivants : + +:: + + rm -rf /opt/tomcat/webapps/echobase + rm -rf /opt/tomcat/work/Catalina/localhost/echobase + +3. Copier le nouveau war dans **/var/local/echobase/war** +4. Changer le lien symbolique **/var/local/echobase/echobase.war** + +:: + + ln -fvs /var/local/echobasewar/echobase-ui-XXX.war /var/local/echobase/echobase.war + +5. Relancer le serveur tomcat + +Divers +------ + Gestion des logs de l'application ---------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Avant de lancer l'application, il faut avoir positionner une variable **echobase.log.dir** de jvm qui définit le répertoire où positionner les logs @@ -109,7 +194,7 @@ CATALINA_OPTS="$CATALINA_OPTS -Dechobase.log.dir=/var/local/echobase/logs" Première utilisation --------------------- +~~~~~~~~~~~~~~~~~~~~ Deux utilisateurs sont créés si la base est vide (première utilisation):: @@ -118,3 +203,6 @@ Pour des raisons de sécurité, il est conseillé de modifier le mot de passe via l'interface de gestion des utilisateurs. + +.. _echobase.properties: echobase.properties +