Author: tchemit Date: 2013-10-20 17:37:21 +0200 (Sun, 20 Oct 2013) New Revision: 857 Url: http://forge.codelutin.com/projects/echobase/repository/revisions/857 Log: fixes #3551: Simplifier la proc?\195?\169dure d'installation de l'application Added: trunk/echobase-ui/src/main/assembly/embedded-zip.xml trunk/echobase-ui/src/main/assembly/full-war.xml trunk/src/site/en/rst/usage.rst.vm trunk/src/site/rst/usage.rst.vm Removed: trunk/echobase-ui/src/main/assembly/bin.xml trunk/src/site/en/rst/usage.rst trunk/src/site/rst/usage.rst Modified: trunk/echobase-domain/src/main/java/fr/ifremer/echobase/config/EchoBaseConfiguration.java trunk/echobase-domain/src/main/java/fr/ifremer/echobase/config/EchoBaseConfigurationOption.java trunk/echobase-domain/src/main/resources/i18n/echobase-domain_en_GB.properties trunk/echobase-domain/src/main/resources/i18n/echobase-domain_fr_FR.properties trunk/echobase-ui/deploy.sh trunk/echobase-ui/pom.xml trunk/echobase-ui/src/main/java/fr/ifremer/echobase/ui/EchoBaseApplicationContext.java Modified: trunk/echobase-domain/src/main/java/fr/ifremer/echobase/config/EchoBaseConfiguration.java =================================================================== --- trunk/echobase-domain/src/main/java/fr/ifremer/echobase/config/EchoBaseConfiguration.java 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/echobase-domain/src/main/java/fr/ifremer/echobase/config/EchoBaseConfiguration.java 2013-10-20 15:37:21 UTC (rev 857) @@ -150,7 +150,8 @@ } public File getLibDirectory() { - File file = new File(getDataDirectory(), "lib"); + File file = applicationConfig.getOptionAsFile( + EchoBaseConfigurationOption.LIBRARY_DIRECTORY.key); Preconditions.checkNotNull(file); return file; } Modified: trunk/echobase-domain/src/main/java/fr/ifremer/echobase/config/EchoBaseConfigurationOption.java =================================================================== --- trunk/echobase-domain/src/main/java/fr/ifremer/echobase/config/EchoBaseConfigurationOption.java 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/echobase-domain/src/main/java/fr/ifremer/echobase/config/EchoBaseConfigurationOption.java 2013-10-20 15:37:21 UTC (rev 857) @@ -41,8 +41,12 @@ /** Main directory where to put echobase data (logs, and others...). */ DATA_DIRECTORY("echobase.data.directory", n_("echobase.config.data.directory.description"), - "/var/local/echobase", + "/var/local/echobase/data", File.class), + LIBRARY_DIRECTORY("echobase.lib.directory", + n_("echobase.config.lib.directory.description"), + "${echobase.data.directory}/lib", + File.class), INTERNAL_DB_DIRECTORY( "echobase.internal.db.directory", n_("echobase.config.internal.db.directory.description"), @@ -64,7 +68,7 @@ ";", char.class), WAR_LOCATION("echobase.war.location", n_("echobase.config.war.location.description"), - "${echobase.data.directory}/war/echobase-ui-${echobase.version}-embedded.war", + "${echobase.lib.directory}/echobase-embedded-${echobase.version}.war", File.class), DOCUMENTATION_URL("echobase.documentationUrl", n_("echobase.config.documentationUrl.description"), Modified: trunk/echobase-domain/src/main/resources/i18n/echobase-domain_en_GB.properties =================================================================== --- trunk/echobase-domain/src/main/resources/i18n/echobase-domain_en_GB.properties 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/echobase-domain/src/main/resources/i18n/echobase-domain_en_GB.properties 2013-10-20 15:37:21 UTC (rev 857) @@ -34,6 +34,7 @@ echobase.config.embedded.description=Flag used for embedded application (will create a h2 working db configuration to access database) echobase.config.h2Version.description=H2 jdbc driver version echobase.config.internal.db.directory.description=Directory of the internal database +echobase.config.lib.directory.description=Directory where to put internal libraries (jdbc drivers, embedded war) echobase.config.postgresqlVersion.description=Postgresql driver version echobase.config.version.description=Application version echobase.config.war.location.description=Location of the war used to create embedded applications Modified: trunk/echobase-domain/src/main/resources/i18n/echobase-domain_fr_FR.properties =================================================================== --- trunk/echobase-domain/src/main/resources/i18n/echobase-domain_fr_FR.properties 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/echobase-domain/src/main/resources/i18n/echobase-domain_fr_FR.properties 2013-10-20 15:37:21 UTC (rev 857) @@ -32,6 +32,7 @@ echobase.config.embedded.description=Pour créer au démarrage une configuration vers la base h2 embarquée (uniquement pour les applications embarquées) echobase.config.h2Version.description=Version du pilote jdbc H2 echobase.config.internal.db.directory.description=Répertoire de la base interne +echobase.config.lib.directory.description=Chemin où sont stockés les libraires internes (drivers + application embarquée) echobase.config.postgresqlVersion.description=Version du pilote jdbc Postgresql echobase.config.version.description=Version de l'application echobase.config.war.location.description=Chemin d'accèss au war embarqué à utiliser pour créer des applications embarquées Modified: trunk/echobase-ui/deploy.sh =================================================================== --- trunk/echobase-ui/deploy.sh 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/echobase-ui/deploy.sh 2013-10-20 15:37:21 UTC (rev 857) @@ -1,6 +1,6 @@ #! /bin/sh #mvn package -cp target/*.war /var/local/echobase +cp target/echobase-full-*.war /var/local/echobase v=$( mvn help:evaluate -Dexpression=project.version | grep -v "INFO" | grep -v "WARNING" | grep -v "Download" ) echo "version=$v" (cd /var/local/echobase; ./deploy.sh $v ) \ No newline at end of file Modified: trunk/echobase-ui/pom.xml =================================================================== --- trunk/echobase-ui/pom.xml 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/echobase-ui/pom.xml 2013-10-20 15:37:21 UTC (rev 857) @@ -24,15 +24,16 @@ <env>dev</env> + <embeddedWarName>echobase-embedded-${project.version}</embeddedWarName> + <fullWarName>echobase-full-${project.version}</fullWarName> + <redmine.releaseFiles> - ${project.build.directory}/${project.build.finalName}.war, - ${project.build.directory}/${project.build.finalName}-embedded.war, - ${project.build.directory}/${project.build.finalName}-embedded.zip + ${project.build.directory}/${fullWarName}.war, + ${project.build.directory}/${embeddedWarName}.zip </redmine.releaseFiles> <deployFiles> - ${project.build.directory}/${project.build.finalName}.war, - ${project.build.directory}/${project.build.finalName}-embedded.war + ${project.build.directory}/${fullWarName}.war </deployFiles> <!-- Post Release configuration --> @@ -365,7 +366,6 @@ </property> </activation> <properties> - <embeddedWarName>echobase-ui-${project.version}-embedded</embeddedWarName> <embeddedTmpWarDir> ${project.build.directory}/${embeddedWarName}-temp </embeddedTmpWarDir> @@ -492,16 +492,12 @@ </executions> </plugin> - <!-- Build embedded zip --> + <!-- Build embedded zip + full war --> <plugin> <artifactId>maven-assembly-plugin</artifactId> <configuration> - <descriptors> - <descriptor>src/main/assembly/bin.xml</descriptor> - </descriptors> <attach>false</attach> - <finalName>${embeddedWarName}</finalName> <appendAssemblyId>false</appendAssemblyId> </configuration> <executions> @@ -511,7 +507,26 @@ <goals> <goal>single</goal> </goals> + <configuration> + <descriptors> + <descriptor>src/main/assembly/embedded-zip.xml</descriptor> + </descriptors> + <finalName>${embeddedWarName}</finalName> + </configuration> </execution> + <execution> + <id>create-full-war</id> + <phase>package</phase> + <goals> + <goal>single</goal> + </goals> + <configuration> + <descriptors> + <descriptor>src/main/assembly/full-war.xml</descriptor> + </descriptors> + <finalName>${fullWarName}</finalName> + </configuration> + </execution> </executions> </plugin> </plugins> Deleted: trunk/echobase-ui/src/main/assembly/bin.xml =================================================================== --- trunk/echobase-ui/src/main/assembly/bin.xml 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/echobase-ui/src/main/assembly/bin.xml 2013-10-20 15:37:21 UTC (rev 857) @@ -1,69 +0,0 @@ -<!-- - #%L - EchoBase :: UI - $Id$ - $HeadURL$ - %% - Copyright (C) 2011 - 2012 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% - --> -<assembly> - <id>bin</id> - <formats> - <format>zip</format> - </formats> - - <fileSets> - - <fileSet> - <directory>target</directory> - <outputDirectory>/</outputDirectory> - <fileMode>0755</fileMode> - <includes> - <include>echobase-ui-${project.version}-embedded.war</include> - </includes> - </fileSet> - - <fileSet> - <directory>target/classes</directory> - <outputDirectory>/</outputDirectory> - <includes> - <include>THIRD-PARTY.txt</include> - <include>LICENSE.txt</include> - </includes> - </fileSet> - - <fileSet> - <directory>src/main/assembly/dist</directory> - <outputDirectory>/</outputDirectory> - <includes> - <include>**/*.properties</include> - <include>**/*.txt</include> - </includes> - </fileSet> - - <fileSet> - <directory>src/main/assembly/dist</directory> - <outputDirectory>/</outputDirectory> - <fileMode>0755</fileMode> - <filtered>true</filtered> - <includes> - <include>**/*.sh</include> - <include>**/*.bat</include> - </includes> - </fileSet> - </fileSets> -</assembly> Copied: trunk/echobase-ui/src/main/assembly/embedded-zip.xml (from rev 853, trunk/echobase-ui/src/main/assembly/bin.xml) =================================================================== --- trunk/echobase-ui/src/main/assembly/embedded-zip.xml (rev 0) +++ trunk/echobase-ui/src/main/assembly/embedded-zip.xml 2013-10-20 15:37:21 UTC (rev 857) @@ -0,0 +1,72 @@ +<!-- + #%L + EchoBase :: UI + $Id$ + $HeadURL$ + %% + Copyright (C) 2011 - 2012 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% + --> +<assembly + xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> + <id>embedded-zip</id> + <formats> + <format>zip</format> + </formats> + + <fileSets> + + <fileSet> + <directory>target</directory> + <outputDirectory>/</outputDirectory> + <fileMode>0755</fileMode> + <includes> + <include>${embeddedWarName}.war</include> + </includes> + </fileSet> + + <fileSet> + <directory>target/classes</directory> + <outputDirectory>/</outputDirectory> + <includes> + <include>THIRD-PARTY.txt</include> + <include>LICENSE.txt</include> + </includes> + </fileSet> + + <fileSet> + <directory>src/main/assembly/dist</directory> + <outputDirectory>/</outputDirectory> + <includes> + <include>**/*.properties</include> + <include>**/*.txt</include> + </includes> + </fileSet> + + <fileSet> + <directory>src/main/assembly/dist</directory> + <outputDirectory>/</outputDirectory> + <fileMode>0755</fileMode> + <filtered>true</filtered> + <includes> + <include>**/*.sh</include> + <include>**/*.bat</include> + </includes> + </fileSet> + </fileSets> +</assembly> Added: trunk/echobase-ui/src/main/assembly/full-war.xml =================================================================== --- trunk/echobase-ui/src/main/assembly/full-war.xml (rev 0) +++ trunk/echobase-ui/src/main/assembly/full-war.xml 2013-10-20 15:37:21 UTC (rev 857) @@ -0,0 +1,54 @@ +<!-- + #%L + EchoBase :: UI + $Id$ + $HeadURL$ + %% + Copyright (C) 2011 - 2012 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% + --> +<assembly + xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> + <id>full-war</id> + <formats> + <format>war</format> + </formats> + <includeBaseDirectory>false</includeBaseDirectory> + + <fileSets> + + <!-- content of primary war --> + <fileSet> + <directory>target/${project.build.finalName}</directory> + <outputDirectory>/</outputDirectory> + <includes> + <include>**/*</include> + </includes> + </fileSet> + + <!-- copy embedded war in WEB-INF/classes/embedded --> + <fileSet> + <directory>target</directory> + <outputDirectory>/WEB-INF/classes/embedded</outputDirectory> + <fileMode>0755</fileMode> + <includes> + <include>${embeddedWarName}.war</include> + </includes> + </fileSet> + </fileSets> +</assembly> Property changes on: trunk/echobase-ui/src/main/assembly/full-war.xml ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Added: svn:eol-style + native Modified: trunk/echobase-ui/src/main/java/fr/ifremer/echobase/ui/EchoBaseApplicationContext.java =================================================================== --- trunk/echobase-ui/src/main/java/fr/ifremer/echobase/ui/EchoBaseApplicationContext.java 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/echobase-ui/src/main/java/fr/ifremer/echobase/ui/EchoBaseApplicationContext.java 2013-10-20 15:37:21 UTC (rev 857) @@ -200,11 +200,11 @@ // init database (and create minimal admin user if required) initInternalDatabase(serviceContext); - // copy drivers if required + // extract files to library directory if required try { - copyDriverFiles(serviceContext); + extractFiles(serviceContext); } catch (IOException e) { - throw new TopiaException("Could not install drivers", e); + throw new TopiaException("Could not extract files (drivers + embedded war)", e); } } @@ -367,10 +367,12 @@ } } - protected void copyDriverFiles(EchoBaseServiceContext serviceContext) throws IOException { + protected void extractFiles(EchoBaseServiceContext serviceContext) throws IOException { EmbeddedApplicationService service = serviceContext.newService(EmbeddedApplicationService.class); EchoBaseConfiguration configuration = serviceContext.getConfiguration(); + + // copy drivers File libDirectory = configuration.getLibDirectory(); for (DriverType driverType : DriverType.values()) { String pilotFileName = driverType.getPilotFileName(configuration); @@ -385,5 +387,19 @@ service.copyEmbeddedBinaryFile(pilotFileName, libDirectory); } } + + // copy embedded war + File warLocation = configuration.getWarLocation(); + File embeddedWarDirectory = warLocation.getParentFile(); + String embeddedWarFileName = warLocation.getName(); + if (!warLocation.exists()) { + + // copy it from class-path + if (log.isInfoEnabled()) { + log.info("Copy embedded war " + embeddedWarFileName + + " to directory " + embeddedWarDirectory); + } + service.copyEmbeddedBinaryFile(embeddedWarFileName, embeddedWarDirectory); + } } } Deleted: trunk/src/site/en/rst/usage.rst =================================================================== --- trunk/src/site/en/rst/usage.rst 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/src/site/en/rst/usage.rst 2013-10-20 15:37:21 UTC (rev 857) @@ -1,167 +0,0 @@ -.. - -.. * #%L -.. * EchoBase -.. * $Id$ -.. * $HeadURL$ -.. * %% -.. * Copyright (C) 2011 - 2012 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% -.. - - -==================== -Première utilisation -==================== - -Comment utiliser EchoBase -------------------------- - -*TODO Translate me* - -L'application est fournit sous deux modes: - -- une version en *mode portable* qui ne nécessite pas de serveur -- une version en *mode serveur* qui nécessite l'installation d'*EchoBase* dans - un serveur web de type *tomcat* ou *jetty*. - -Utiliser la version mode portable -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -En mode portable, pas besoin de serveur, il faut juste avoir java d'installer -sur la machine. - -Pré-requis pour utilisation sous Windows -________________________________________ - -Installer un environnement d'exécution java. - -`Page de téléchargement Oracle`_ - -Pré-requis pour utilisation sous Linux -______________________________________ - -Installer un environnement d'execution java . - -`Page de téléchargement Oracle`_ - -Procédure d'installation -________________________ - -Une fois les pré-requis remplis, c'est très simple : - -- Récupérer l'archive zip `echobase-${project.version}-embedded.zip`_. - -- Décompresser l'archive, vous obtenez une arborescence de ce type: - -:: - - echobase-ui-1.1-embedded - ├── echobase.properties (1) Fichier de configuration de l'application embarquée - ├── echobase-ui-${project.version}-embedded.war - ├── LICENSE.txt - ├── README.txt - ├── startEchobase.bat (2) Script de démarrage (windows) - ├── startEchobase.sh (3) Script de démarrage (linux) - └── THIRD-PARTY.txt - -- Lancer le script *startEchobase.sh* (linux) ou *startEchobase.bat* (windows). - -L'application va démarrer et est accessible à l'adresse suivante: - -:: - - http://localhost:8888 - -Procédure détaillée (sous windows) -__________________________________ - -- 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. - -Procédure détaillée (sous linux) -________________________________ - -- 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. - -Utilisateurs -____________ - -Par défaut, deux utilisateurs sont fournis dans la base embarquée : - -- admin / admin (avec des droits d'administration) -- user / user (pour la consultation) - -Configuration base de travail -_____________________________ - -Une configuration de base de travail est aussi crée automatiquement vers une -base de type *H2* stoquée dans le répertoire *db* avec les identifiants suivants : - -- login: *sa* -- mot de passe: *sa* - -Utiliser la version mode serveur -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Il faut que l'application est au préalable installée sur un serveur web. - -Demandez à votre administrateur l'url de connexion, et les identifiants. - -Si vous voulez installer EchoBase sur un serveur, veuillez consulter la -`page installation`_. - -.. _echobase-${project.version}-embedded.zip: http://forge.codelutin.com/projects/echobase/files -.. _page installation: ./install.html -.. _Page de téléchargement Oracle: http://www.oracle.com/technetwork/java/javase/downloads/index.html - - Copied: trunk/src/site/en/rst/usage.rst.vm (from rev 853, trunk/src/site/en/rst/usage.rst) =================================================================== --- trunk/src/site/en/rst/usage.rst.vm (rev 0) +++ trunk/src/site/en/rst/usage.rst.vm 2013-10-20 15:37:21 UTC (rev 857) @@ -0,0 +1,167 @@ +.. - +.. * #%L +.. * EchoBase +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2011 - 2012 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% +.. - + +==================== +Première utilisation +==================== + +Comment utiliser EchoBase +------------------------- + +*TODO Translate me* + +L'application est fournit sous deux modes: + +- une version en *mode portable* qui ne nécessite pas de serveur +- une version en *mode serveur* qui nécessite l'installation d'*EchoBase* dans + un serveur web de type *tomcat* ou *jetty*. + +Utiliser la version mode portable +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +En mode portable, pas besoin de serveur, il faut juste avoir java d'installer +sur la machine. + +Pré-requis pour utilisation sous Windows +________________________________________ + +Installer un environnement d'exécution java. + +`Page de téléchargement Oracle`_ + +Pré-requis pour utilisation sous Linux +______________________________________ + +Installer un environnement d'execution java . + +`Page de téléchargement Oracle`_ + +Procédure d'installation +________________________ + +Une fois les pré-requis remplis, c'est très simple : + +- Récupérer l'archive zip `echobase-embedded-${project.version}.zip`_. + +- Décompresser l'archive, vous obtenez une arborescence de ce type: + +:: + + echobase-embedded-${project.version} + ├── echobase.properties (1) Fichier de configuration de l'application embarquée + ├── echobase-embedded-${project.version}.war + ├── LICENSE.txt + ├── README.txt + ├── startEchobase.bat (2) Script de démarrage (windows) + ├── startEchobase.sh (3) Script de démarrage (linux) + └── THIRD-PARTY.txt + +- Lancer le script *startEchobase.sh* (linux) ou *startEchobase.bat* (windows). + +L'application va démarrer et est accessible à l'adresse suivante: + +:: + + http://localhost:8888 + +Procédure détaillée (sous windows) +__________________________________ + +- 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. + +Procédure détaillée (sous linux) +________________________________ + +- 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. + +Utilisateurs +____________ + +Par défaut, deux utilisateurs sont fournis dans la base embarquée : + +- admin / admin (avec des droits d'administration) +- user / user (pour la consultation) + +Configuration base de travail +_____________________________ + +Une configuration de base de travail est aussi crée automatiquement vers une +base de type *H2* stoquée dans le répertoire *db* avec les identifiants suivants : + +- login: *sa* +- mot de passe: *sa* + +Utiliser la version mode serveur +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Il faut que l'application est au préalable installée sur un serveur web. + +Demandez à votre administrateur l'url de connexion, et les identifiants. + +Si vous voulez installer EchoBase sur un serveur, veuillez consulter la +`page installation`_. + +.. _echobase-embedded-${project.version}.zip: http://forge.codelutin.com/projects/echobase/files +.. _page installation: ./install.html +.. _Page de téléchargement Oracle: http://www.oracle.com/technetwork/java/javase/downloads/index.html + + Deleted: trunk/src/site/rst/usage.rst =================================================================== --- trunk/src/site/rst/usage.rst 2013-10-20 15:28:07 UTC (rev 856) +++ trunk/src/site/rst/usage.rst 2013-10-20 15:37:21 UTC (rev 857) @@ -1,165 +0,0 @@ -.. - -.. * #%L -.. * EchoBase -.. * $Id$ -.. * $HeadURL$ -.. * %% -.. * Copyright (C) 2011 - 2012 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% -.. - - -==================== -Première utilisation -==================== - -Comment utiliser EchoBase -------------------------- - -L'application est fournit sous deux modes: - -- une version en *mode portable* qui ne nécessite pas de serveur -- une version en *mode serveur* qui nécessite l'installation d'*EchoBase* dans - un serveur web de type *tomcat* ou *jetty*. - -Utiliser la version mode portable -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -En mode portable, pas besoin de serveur, il faut juste avoir java d'installer -sur la machine. - -Pré-requis pour utilisation sous Windows -________________________________________ - -Installer un environnement d'exécution java. - -`Page de téléchargement Oracle`_ - -Pré-requis pour utilisation sous Linux -______________________________________ - -Installer un environnement d'execution java . - -`Page de téléchargement Oracle`_ - -Procédure d'installation -________________________ - -Une fois les pré-requis remplis, c'est très simple : - -- Récupérer l'archive zip `echobase-${project.version}-embedded.zip`_. - -- Décompresser l'archive, vous obtenez une arborescence de ce type: - -:: - - echobase-ui-1.1-embedded - ├── echobase.properties (1) Fichier de configuration de l'application embarquée - ├── echobase-ui-${project.version}-embedded.war - ├── LICENSE.txt - ├── README.txt - ├── startEchobase.bat (2) Script de démarrage (windows) - ├── startEchobase.sh (3) Script de démarrage (linux) - └── THIRD-PARTY.txt - -- Lancer le script *startEchobase.sh* (linux) ou *startEchobase.bat* (windows). - -L'application va démarrer et est accessible à l'adresse suivante: - -:: - - http://localhost:8888 - -Procédure détaillée (sous windows) -__________________________________ - -- 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. - -Procédure détaillée (sous linux) -________________________________ - -- 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. - -Utilisateurs -____________ - -Par défaut, deux utilisateurs sont fournis dans la base embarquée : - -- admin / admin (avec des droits d'administration) -- user / user (pour la consultation) - -Configuration base de travail -_____________________________ - -Une configuration de base de travail est aussi crée automatiquement vers une -base de type *H2* stoquée dans le répertoire *db* avec les identifiants suivants : - -- login: *sa* -- mot de passe: *sa* - -Utiliser la version mode serveur -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Il faut que l'application est au préalable installée sur un serveur web. - -Demandez à votre administrateur l'url de connexion, et les identifiants. - -Si vous voulez installer EchoBase sur un serveur, veuillez consulter la -`page installation`_. - -.. _echobase-${project.version}-embedded.zip: http://forge.codelutin.com/projects/echobase/files -.. _page installation: ./install.html -.. _Page de téléchargement Oracle: http://www.oracle.com/technetwork/java/javase/downloads/index.html - - Copied: trunk/src/site/rst/usage.rst.vm (from rev 853, trunk/src/site/rst/usage.rst) =================================================================== --- trunk/src/site/rst/usage.rst.vm (rev 0) +++ trunk/src/site/rst/usage.rst.vm 2013-10-20 15:37:21 UTC (rev 857) @@ -0,0 +1,165 @@ +.. - +.. * #%L +.. * EchoBase +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2011 - 2012 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% +.. - + +==================== +Première utilisation +==================== + +Comment utiliser EchoBase +------------------------- + +L'application est fournit sous deux modes: + +- une version en *mode portable* qui ne nécessite pas de serveur +- une version en *mode serveur* qui nécessite l'installation d'*EchoBase* dans + un serveur web de type *tomcat* ou *jetty*. + +Utiliser la version mode portable +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +En mode portable, pas besoin de serveur, il faut juste avoir java d'installer +sur la machine. + +Pré-requis pour utilisation sous Windows +________________________________________ + +Installer un environnement d'exécution java. + +`Page de téléchargement Oracle`_ + +Pré-requis pour utilisation sous Linux +______________________________________ + +Installer un environnement d'execution java . + +`Page de téléchargement Oracle`_ + +Procédure d'installation +________________________ + +Une fois les pré-requis remplis, c'est très simple : + +- Récupérer l'archive zip `echobase-embedded-${project.version}.zip`_. + +- Décompresser l'archive, vous obtenez une arborescence de ce type: + +:: + + echobase-embedded-${project.version} + ├── echobase.properties (1) Fichier de configuration de l'application embarquée + ├── echobase-embedded-${project.version}.war + ├── LICENSE.txt + ├── README.txt + ├── startEchobase.bat (2) Script de démarrage (windows) + ├── startEchobase.sh (3) Script de démarrage (linux) + └── THIRD-PARTY.txt + +- Lancer le script *startEchobase.sh* (linux) ou *startEchobase.bat* (windows). + +L'application va démarrer et est accessible à l'adresse suivante: + +:: + + http://localhost:8888 + +Procédure détaillée (sous windows) +__________________________________ + +- 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. + +Procédure détaillée (sous linux) +________________________________ + +- 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. + +Utilisateurs +____________ + +Par défaut, deux utilisateurs sont fournis dans la base embarquée : + +- admin / admin (avec des droits d'administration) +- user / user (pour la consultation) + +Configuration base de travail +_____________________________ + +Une configuration de base de travail est aussi crée automatiquement vers une +base de type *H2* stoquée dans le répertoire *db* avec les identifiants suivants : + +- login: *sa* +- mot de passe: *sa* + +Utiliser la version mode serveur +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Il faut que l'application est au préalable installée sur un serveur web. + +Demandez à votre administrateur l'url de connexion, et les identifiants. + +Si vous voulez installer EchoBase sur un serveur, veuillez consulter la +`page installation`_. + +.. _echobase-embedded-${project.version}.zip: http://forge.codelutin.com/projects/echobase/files +.. _page installation: ./install.html +.. _Page de téléchargement Oracle: http://www.oracle.com/technetwork/java/javase/downloads/index.html + +