Author: tchemit Date: 2012-04-11 15:56:08 +0200 (Wed, 11 Apr 2012) New Revision: 526 Url: http://forge.codelutin.com/repositories/revision/echobase/526 Log: fixes #1106: Faire bien fonctionner le script de lancement de l'application sous windows refs #484: Documentation (documentation base embarqu?\195?\169e) Added: trunk/src/site/rst/embedded.rst Modified: trunk/echobase-services/src/main/resources/embedded/startEchobase.bat trunk/echobase-services/src/main/resources/embedded/startEchobase.sh trunk/echobase-ui/src/main/resources/i18n/echobase-ui_en_GB.properties trunk/echobase-ui/src/main/resources/i18n/echobase-ui_fr_FR.properties trunk/echobase-ui/src/main/webapp/WEB-INF/jsp/embeddedApplication/result.jsp trunk/src/site/rst/install.rst trunk/src/site/site_fr.xml Modified: trunk/echobase-services/src/main/resources/embedded/startEchobase.bat =================================================================== --- trunk/echobase-services/src/main/resources/embedded/startEchobase.bat 2012-04-11 12:04:24 UTC (rev 525) +++ trunk/echobase-services/src/main/resources/embedded/startEchobase.bat 2012-04-11 13:56:08 UTC (rev 526) @@ -1,2 +1,43 @@ -ECHOBASE_OPTS="$JAVA_OPTS -Xms512m -Xmx10242m -Dechobase.log.dir=./logs" -java %ECHOBASE_OPTS% -jar echobase-ui-${project.version}.war \ No newline at end of file +@REM ---------------------------------------------------------------------------- +@REM EchoBase Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM ---------------------------------------------------------------------------- +@echo off + +if not "%JDK_HOME%" == "" goto OkJHome + +echo. +echo ERROR: JDK_HOME not found in your environment. +echo Please set the JDK_HOME variable in your environment to match the +echo location of your Java installation +echo. +goto error + +:OkJHome +echo JDK_HOME defined to "%JDK_HOME%" + +if exist "%JDK_HOME%\bin\java.exe" goto doit + +echo. +echo ERROR: JDK_HOME is set to an invalid directory. +echo JDK_HOME = "%JDK_HOME%" +echo Please set the JDK_HOME variable in your environment to match the +echo location of your Java installation +echo. +goto error + +:error +set ERROR_CODE=1 +goto end + +:doit +set ECHOBASE_OPTS="-Xms512m -Xmx1024m -Dechobase.log.dir=./logs" +%JDK_HOME%\bin\java.exe "%ECHOBASE_OPTS%" -jar echobase-ui-${project.version}.war +goto end + +:end + +pause +cmd /C exit /B %ERROR_CODE% Modified: trunk/echobase-services/src/main/resources/embedded/startEchobase.sh =================================================================== --- trunk/echobase-services/src/main/resources/embedded/startEchobase.sh 2012-04-11 12:04:24 UTC (rev 525) +++ trunk/echobase-services/src/main/resources/embedded/startEchobase.sh 2012-04-11 13:56:08 UTC (rev 526) @@ -1,4 +1,10 @@ #!/bin/sh + +if [ ! -e $JDK_HOME/bin/java ]; then + echo "Do not find $JDK_HOME/bin/java, please add JDK_HOME environnement variable" + exit 1 +fi + OLDPWD=`pwd` cd `dirname $0` CURRENTPWD=`pwd` Modified: trunk/echobase-ui/src/main/resources/i18n/echobase-ui_en_GB.properties =================================================================== --- trunk/echobase-ui/src/main/resources/i18n/echobase-ui_en_GB.properties 2012-04-11 12:04:24 UTC (rev 525) +++ trunk/echobase-ui/src/main/resources/i18n/echobase-ui_en_GB.properties 2012-04-11 13:56:08 UTC (rev 526) @@ -18,6 +18,7 @@ echobase.confirm.delete.query=Confirm to delete export query echobase.error.bad.password=Bad password echobase.error.email.already.used=Email already used +echobase.action.show.embedded.documentation=Show embedded application documentation echobase.error.export.sqlQuery.forbidden.alter.word=Export query contains a forbidden word 'ALTER' echobase.error.export.sqlQuery.forbidden.delete.word=Export query contains a forbidden word 'DELETE' echobase.error.export.sqlQuery.forbidden.drop.word=Export query contains a forbidden word 'DROP' Modified: trunk/echobase-ui/src/main/resources/i18n/echobase-ui_fr_FR.properties =================================================================== --- trunk/echobase-ui/src/main/resources/i18n/echobase-ui_fr_FR.properties 2012-04-11 12:04:24 UTC (rev 525) +++ trunk/echobase-ui/src/main/resources/i18n/echobase-ui_fr_FR.properties 2012-04-11 13:56:08 UTC (rev 526) @@ -29,6 +29,7 @@ echobase.action.return=Retour echobase.action.save=Sauvegarder echobase.action.saveSqlQuery=Mettre à jour +echobase.action.show.embedded.documentation=Accéder à la documentation d'utilisation d'une application emabrquée echobase.action.show.import.documentation=Accéder à la documentation de l'import echobase.action.toEnglish=Utiliser la version anglaise echobase.action.toFrench=Utiliser la version française Modified: trunk/echobase-ui/src/main/webapp/WEB-INF/jsp/embeddedApplication/result.jsp =================================================================== --- trunk/echobase-ui/src/main/webapp/WEB-INF/jsp/embeddedApplication/result.jsp 2012-04-11 12:04:24 UTC (rev 525) +++ trunk/echobase-ui/src/main/webapp/WEB-INF/jsp/embeddedApplication/result.jsp 2012-04-11 13:56:08 UTC (rev 526) @@ -42,7 +42,14 @@ value="model.actionTime"/>. </div> +<div class="cleanBoth help"> + <s:a href="http://maven-site.forge.codelutin.com/echobase/embedded.html" + target="doc"> + <s:text name="echobase.action.show.embedded.documentation"/> + </s:a> +</div> <br/> +<br/> <div> Si le téléchargement n'a pas démarré automatiquement, suivez ce lien : Added: trunk/src/site/rst/embedded.rst =================================================================== --- trunk/src/site/rst/embedded.rst (rev 0) +++ trunk/src/site/rst/embedded.rst 2012-04-11 13:56:08 UTC (rev 526) @@ -0,0 +1,157 @@ +.. - +.. * #%L +.. * EchoBase +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2011 Ifremer, Codelutin +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Affero General Public License as published by +.. * the Free Software Foundation, either version 3 of the License, or +.. * (at your option) any later version. +.. * +.. * This program is distributed in the hope that it will be useful, +.. * but WITHOUT ANY WARRANTY; without even the implied warranty of +.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. * GNU General Public License for more details. +.. * +.. * You should have received a copy of the GNU Affero General Public License +.. * along with this program. If not, see <http://www.gnu.org/licenses/>. +.. * #L% +.. - +======== +Echobase +======== + +:Authors: Tony Chemit <chemit@codelutin.com> + +.. contents:: Table des matières + :depth: 2 + +.. sectnum:: + :start: 1 + :depth: 2 + +Création d'une application embarquée +------------------------------------ + +L'application permet de créer une application autonome comprenant un jeu de +données sélectionné par l'utilisateur. + +Procédure de création +===================== + +- Aller dans le menu *Créer une application embarquée* +- Sélectionner la ou les campagnes à inclure (ou rien si vous voulez juste le référentiel) +- Changer si besoin est le nom de l'archive à créer +- Appuyer sur le bouton Créer l'application. + +Une fois l'archive créée (l'opération peut être longue selon la quantité de +données), elle est téléchargeable depuis une page de résultat de l'opération +(normalement l'archive se met toute seule en téléchargement). + +Architecture de l'application embarquée +======================================= + +L'archive une fois décompressé à la forme suivante : + +:: + + echobase-embedded-0.6-pelgas2010 + ├── db (1) contient la base de données au format h2. + │ └── echobase.h2.db + ├── drivers (2) contient les drivers jdbc à utiliser dans LibreOffice + │ ├── h2-1.3.165.jar + │ └── postgresql-9.1-901-1.jdbc4.jar + ├── echobase.properties (3) Fichier de configuration de l'application embarquée + ├── echobase-ui-0.6.war (4) Application embarquée (war auto-exécutable) + ├── logs (5) contient les logs de l'application + │ └── echobase.log + ├── README.txt + ├── startEchobase.bat (6) Script de démarrage (windows) + └── startEchobase.sh (7) Script de démarrage (linux) + +Utilisateurs +============ + +Deux utilisateurs sont fournis dans la base embarquée : + +- admin / admin (avec des droits d'administration) +- user / user (pour la consultation) + + +Utilisation de l'application embarquée (windows) +------------------------------------------------ + +Pré-requis +========== + +Installer un environnement java de développement (une JDK) et pas une JRE +qui ne suffit pas. + +`Page de téléchargement Oracle`_ + +Une fois la JDK téléchargée et installée, ajouter dans les variables +d'environnement : + +:: + + JDK_HOME -> chemin vers où a été installé la JDK + +Installation d'echobase +======================= + +- Dézipper l'archive précédemment téléchargée du site central. + +- Ouvrir une console (Touche Windows + R , taper *cmd* , Touche Entrée) +- Se placer dans le répertoire où a été dézippée l'archive + +:: + cd Chemin vers l'archive dézippée + +- Enfin lancer le script *startEchobase.bat*. +- Dans la console on doit voir l'application démarré et produire des logs +- Lorsque l'application est prête, un navigateur s'ouvre sur la page + de login. + +Utilisation de l'application embarquée (linux) +---------------------------------------------- + +Pré-requis +========== + +Installer un environnement java de développement (une JDK) et pas une JRE +qui ne suffit pas. + +`Page de téléchargement Oracle`_ + +Une fois la JDK téléchargée et installée, ajouter dans les variables +d'environnement : + +:: + + JDK_HOME -> chemin vers où a été installé la JDK + +Installation d'echobase +======================= + +- Dézipper l'archive précédemment téléchargée du site central. +- Ouvrir une console +- Se placer dans le répertoire où a été dézippée l'archive + +:: + cd Chemin vers l'archive dézippée + +- Rendre le script de démarrage exécutable + +:: + chmod +x startEchobase.sh + +- Enfin lancer le script *startEchobase.sh*. +- Dans la console on doit voir l'application démarré et produire des logs +- Lorsque l'application est prête, un navigateur s'ouvre sur la page + de login. + +.. _Page de téléchargement Oracle: http://www.oracle.com/technetwork/java/javase/downloads/index.html Property changes on: trunk/src/site/rst/embedded.rst ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: svn:eol-style + native Modified: trunk/src/site/rst/install.rst =================================================================== --- trunk/src/site/rst/install.rst 2012-04-11 12:04:24 UTC (rev 525) +++ trunk/src/site/rst/install.rst 2012-04-11 13:56:08 UTC (rev 526) @@ -111,10 +111,10 @@ Première utilisation -------------------- -Un utilisateur par défaut est crée si la base est vide (première utilisation):: +Deux utilisateurs sont créés si la base est vide (première utilisation):: - login : admin - mot de passe : admin + login / password : admin / admin + login / password : user / user Pour des raisons de sécurité, il est conseillé de modifier le mot de passe via -l'interface de gestion des utilisateurs. \ No newline at end of file +l'interface de gestion des utilisateurs. Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2012-04-11 12:04:24 UTC (rev 525) +++ trunk/src/site/site_fr.xml 2012-04-11 13:56:08 UTC (rev 526) @@ -66,6 +66,7 @@ <menu name="Utilisateur"> <item name="Accueil" href="index.html"/> <item name="Installation" href="install.html"/> + <item name="Application embarquée" href="embedded.html"/> <item name="Les imports" href="imports.html"/> <item name="Téléchargement" href="http://forge.codelutin.com/projects/echobase/files"/>