This is an automated email from the git hooks/post-receive script. New commit to branch feature/6511 in repository echobase. See http://git.codelutin.com/echobase.git commit ab89acdec099f149df2898940e55a9e30f4f06b7 Author: Tony CHEMIT <chemit@codelutin.com> Date: Mon Jun 15 16:38:06 2015 +0200 update docs (refs #6511) --- src/site/rst/configure.rst.vm | 62 +++++++++ src/site/rst/install.rst.vm | 310 +++++++++++++++--------------------------- src/site/rst/update.rst.vm | 59 ++++++++ src/site/site_en.xml | 2 + src/site/site_fr.xml | 2 + 5 files changed, 236 insertions(+), 199 deletions(-) diff --git a/src/site/rst/configure.rst.vm b/src/site/rst/configure.rst.vm new file mode 100644 index 0000000..7538bf1 --- /dev/null +++ b/src/site/rst/configure.rst.vm @@ -0,0 +1,62 @@ +.. - +.. * #%L +.. * EchoBase +.. * %% +.. * 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 +======== + +Configurer EchoBase sur un serveur +---------------------------------- + +Configuration Coser +~~~~~~~~~~~~~~~~~~~ + +TODO Renseigner l'adresse de l'instance du site des indicateurs à utiliser + +Modifier la configuration par défaut +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Si vous voulez modifier la configuration (voir le `détail des options disponibles`_), +il faut positionner un fichier nommé **echobase.properties** dans +**/etc/echobase.properties** puis redémarrer tomcat. + +Gestion des logs de l'application +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Par défaut, l'application utilise l'emplacement **/var/local/echobase/data/logs** +pour y placer ses logs. + +Vous pouvez changer cela en modifiant le fichier +**/var/local/echobase/data/echobase-log.properties** qui est généré lors de la +première installation de l'application. + +Première utilisation +~~~~~~~~~~~~~~~~~~~~ + +Deux utilisateurs sont créés si la base est vide (première utilisation):: + + 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. + +.. _détail des options disponibles: ./config-report.html diff --git a/src/site/rst/install.rst.vm b/src/site/rst/install.rst.vm index 7d77ee2..dd61181 100644 --- a/src/site/rst/install.rst.vm +++ b/src/site/rst/install.rst.vm @@ -36,11 +36,11 @@ Nous préconisons aussi l'utilisation d'un serveur linux de type debian. L'installation se déroule en 2 étapes : -- création de la base de données -- installation de l'application +- installation de la base de données +- installation de l'application (et des applications dont elle dépend (apache, tomcat, qgis, ...) -Installation de postgresql et postgis -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Installation de la base de données +---------------------------------- Il vous faudra peut-être installer un dépot apt pour postgres (voir https://wiki.postgresql.org/wiki/Apt). @@ -49,204 +49,100 @@ L'application requière l'utilisation de postgresql 9.3 (et postgis 2.1). :: - sudo apt-get install postgresql-9.3 - sudo apt-get install postgresql-9.3-postgis-2.1 - sudo apt-get install postgresql-9.3-postgis-2.1-scripts + apt-get install postgresql-9.3 + apt-get install postgresql-9.3-postgis-2.1 + apt-get install postgresql-9.3-postgis-2.1-scripts Consulter la documentation suivante pour `créer une base travail`_. -Installation tomcat -~~~~~~~~~~~~~~~~~~~ - -:: - - sudo apt-get install tomcat7 +Installation de l'applicatif +---------------------------- -Préparation première installation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +L'application utilise les applicatifs suivants qu'il faut installer et configurer si nécessaire : -Pré-requis: +- tomcat7 +- apache2 +- qgis-map-server +- lizmap -- Avoir installé tomcat 7 -- Être loggué sur une console avec l'utilisateur root. - -On suppose que tomcat a été installé via le système de paquets, et donc -que le répertoire **/var/lib/tomcat7** existe. - -Toutes les données de l'application seront placées dans le répertoire **/var/local/echobase** +Installation tomcat +~~~~~~~~~~~~~~~~~~~ :: - mkdir /var/local/echobase - mkdir -p /var/local/echobase/war - cd /var/local/echobase/war - wget http://nexus.nuiton.org/nexus/content/repositories/other-releases/fr/ifremer/echobase/echobase-ui/${project.version}/echobase-ui-${project.version}-full.war - ln -s /var/local/echobase/war/echobase-ui-${project.version}-full.war /var/local/echobase/echobase.war - cp /var/local/echobase/echobase.war /var/lib/tomcat7/webapps - chown -R tomcat. . + apt-get install tomcat7 -L'application est bien déployée lorsque vous pouvez accéder à l'application à l'adresse suivante : -:: +Activez le connecteur AJP tomcat : dans le fichier **/etc/tomcat7/server.xml** décommentez la ligne:: - http://localhost:8080/echobase - -Une fois l'application déployée, vous aurez la structure de répertoires suivante : -:: - - /var/local/echobase/ - |-- data - | |-- echobase-log.config - | |-- internaldb - | | |-- echobase-user.h2.db - | |-- lib - | | |-- echobase-embedded-${project.version}.war - | | |-- h2-${h2Version}.jar - | | `-- postgresql-${postgresqlVersion}.jar - | |-- logs - | | `-- echobase.log - | `-- gis - | |-- resources - | | |-- France&Spain.shp - | | |-- pelgas09.shp - | | `-- ... - | |-- projects - | `-- templates - | |-- EchoBaseLizmapTemplate.qgs.cfg - | |-- EchoBaseQGisTemplate.qgs - | `-- ... - |-- echobase.war - `-- war - `-- echobase-ui-${project.version}-full.war - - -Mettre à jour le war de l'application -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Pré-requis : - -- Avoir installé tomcat 7 -- Être loggué sur une console avec l'utilisateur root. + <Connector port="8009" enableLookups="false" redirectPort="8443" protocol="AJP/1.3"/> -On suppose que tomcat a été installé via le système de paquets, et donc -que le répertoire **/var/lib/tomcat7** existe. +Redémarrez le service tomcat:: -Pour utiliser une nouvelle version de l'application, c'est très simple. + service tomcat7 restart -- Supprimer les répertoires suivants : +Installation apache2 +~~~~~~~~~~~~~~~~~~~~ :: - rm -rf /var/lib/tomcat7/webapps/echobase.war - rm -rf /var/lib/tomcat7/Catalina/localhost/echobase + apt-get install apache2 libapache2-mod-fcgid + a2enmod cgid + a2enmod proxy proxy_ajp rewrite + service apache2 restart -- Attendre que le répertoire **/var/lib/tomcat7/webapps/echobase** a bien été supprimé. +Création du groupe utilisateur +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Mettre l'application dans tomcat : +On crée un group utilisateur nommé *echobase* pour gérer les droits aussi bien au niveau de tomcat que d'apache :: - cd /var/local/echobase/war - wget http://nexus.nuiton.org/nexus/content/repositories/other-releases/fr/ifremer/echobase/echobase-ui/${project.version}/echobase-ui-${project.version}-full.war - unlink /var/local/echobase/echobase.war - ln -s /var/local/echobase/war/echobase-ui-${project.version}-full.war /var/local/echobase/echobase.war - cp /var/local/echobase/echobase.war /var/lib/tomcat7/webapps - -Tomcat va redéployer l'application et elle sera disponible d'ici peu à l'adresse - http://localhost:8080/echobase - -Divers ------- - -Modifier la configuration par défaut -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Si vous voulez modifier la configuration (voir le `détail des options disponibles`_), -il faut positionner un fichier nommé **echobase.properties** dans -**/etc/echobase.properties** puis redémarrer tomcat. - -Gestion des logs de l'application -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Par défaut, l'application utilise l'emplacement **/var/local/echobase/data/logs** -pour y placer ses logs. - -Vous pouvez changer cela en modifiant le fichier -**/var/local/echobase/data/echobase-log.properties** qui est généré lors de la -première installation de l'application. - -Première utilisation -~~~~~~~~~~~~~~~~~~~~ - -Deux utilisateurs sont créés si la base est vide (première utilisation):: - - login / password : admin / admin - login / password : user / user + addgroup echobase + adduser www-data echobase + adduser tomcat7 echobase -Pour des raisons de sécurité, il est conseillé de modifier le mot de passe via -l'interface de gestion des utilisateurs. +Installation Qgis map server +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Visualisation des données spatialisées --------------------------------------- +Nous utilisons la version ${qgisMapServerVersion} de Qgis map server. -EchoBase utilise `Qgis map server`_ et `Lizmap`_ pour la visualisation des données spatialisées (depuis la version 2.7). +Mise à jour des dépôts si nécessaire:: -Qgis map server -~~~~~~~~~~~~~~~ + echo "" >> /etc/apt/sources.list + echo "" >> /etc/apt/sources.list + echo "#Pour installer qgis-mapserver" >> /etc/apt/sources.list + echo "deb http://qgis.org/debian vivid main universe" >> /etc/apt/sources.list -Pour installer Qgis map server : + gpg --keyserver keyserver.ubuntu.com --recv DD45F6C3 + gpg --export --armor DD45F6C3 | sudo apt-key add - -:: - - sudo add-apt-repository ppa:ubuntugis/ubuntugis-unstable - sudo apt-get update - sudo apt-get install qgis-server libapache2-mod-fcgid qgis - sudo apt-get install apache2 - sudo a2enmod cgid - sudo service apache2 restart + apt-get update +Installation:: + apt-get install qgis-mapserver qgis L'url : http://localhost/cgi-bin/qgis_mapserv.fcgi?SERVICE=WMS&VERSION=1.3.0&REQUEST=GetCapabilities doit renvoyer un fichier XML de description des couches disponibles. -Création du groupe d'utilisateur -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:: - - addgroup echobase - adduser wwww-data echobase - adduser tomcat7 echobase - cd /var/local/echobase - chown -R tomcat7:echobase . - chmod g+w -R . - - -Lizmap -~~~~~~ +Installation Lizmap +~~~~~~~~~~~~~~~~~~~ -Nous utilisons pour le moment la version ${lizmapVersion}. +Nous utilisons la version ${lizmapVersion} de LizMap. -Installation Lizmap:: +Installation:: apt-get install php5 curl php5-curl php5-sqlite php5-gd - cd /var/www/ + mkdir -p /var/www/html + cd /var/www/html wget https://github.com/3liz/lizmap-web-client/archive/${lizmapVersion}.zip unzip ${lizmapVersion}.zip rm ${lizmapVersion}.zip - mv lizmap-web-client-${lizmapVersion} echobase-map - -**Note** - -Dans les nouvelles conventions d'Apache2, le repetoire de partage n'est plus **/var/wwww** mais **/var/www/html** . -Dans ce cas, il faudrat modifier la configuration d'Echobase comme suit : -:: - - echobase.lizmap.application.basedir=/var/www/html/echobase-map + ln -s lizmap-web-client-${lizmapVersion} echobase-map Il faut ensuite installer le style adapté pour EchoBase:: - cd /var/www/echobase-map/lizmap + cd /var/www/html/echobase-map/lizmap wget http://nexus.nuiton.org/nexus/content/repositories/other-releases/fr/ifremer/echobase/echobase-ui/${project.version}/echobase-ui-${project.version}-lizmap.zip unzip echobase-ui-${project.version}-lizmap.zip rm -rf echobase-ui-${project.version}-lizmap.zip @@ -256,46 +152,73 @@ Il faut ensuite installer le style adapté pour EchoBase:: Pour tester le server lizmap, utilisez l'url : http://localhost/echobase-map/lizmap/www +Installation dans tomcat +~~~~~~~~~~~~~~~~~~~~~~~~ -Configuration des répertoires -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +On suppose que tomcat a été installé via le système de paquets, et donc +que le répertoire **/var/lib/tomcat7** existe. -Il est possible de modifier ces différents répertoires dans la configuration (voir le `détail des options disponibles`_). +Toutes les données de l'application seront placées dans le répertoire **/var/local/echobase** -Il peut être nécessaire de redéfinir l'addresse public du serveur lizmap :: - echobase.lizmap.application.map.url=http://<serveur>/echobase-map/lizmap/www/index.php/view/map + mkdir /var/local/echobase + mkdir -p /var/local/echobase/war -Configuration du serveur Apache -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + wget http://nexus.nuiton.org/nexus/content/repositories/other-releases/fr/ifremer/echobase/echobase-ui/${project.version}/echobase-ui-${project.version}-full.war + ln -s /var/local/echobase/war/echobase-ui-${project.version}-full.war /var/local/echobase/echobase.war + cp /var/local/echobase/echobase.war /var/lib/tomcat7/webapps + cd /var/local/echobase + chown -R tomcat7:echobase . + chmod g+w -R . -Activez le connecteur tomcat : dans le fichier **/etc/tomcat7/server.xml** ajoutez ou décommentez la ligne:: +L'application est bien déployée lorsque vous pouvez accéder à l'application à l'adresse suivante : +:: - <Connector port="8009" enableLookups="false" redirectPort="8443" protocol="AJP/1.3"/> + http://localhost:8080/echobase -Redémarrez le service tomcat +Une fois l'application déployée, vous aurez la structure de répertoires suivante : :: - service tomcat7 restart + /var/local/echobase/ + |-- data + | |-- echobase-log.config + | |-- internaldb + | | `-- echobase-user.h2.db + | |-- lib + | | |-- echobase-embedded-${project.version}.war + | | |-- h2-${h2Version}.jar + | | `-- postgresql-${postgresqlVersion}.jar + | |-- logs + | | `-- echobase.log + | `-- gis + | |-- resources + | | |-- France&Spain.shp + | | |-- pelgas09.shp + | | `-- ... + | |-- projects + | `-- templates + | |-- EchoBaseLizmapTemplate.qgs.cfg + | |-- EchoBaseQGisTemplate.qgs + | `-- ... + |-- echobase.war + `-- war + `-- echobase-ui-${project.version}-full.war +Configuration du serveur Apache +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Activez les modules Apache -:: +Pour la suite de l'installation, veuillez exporter le nom de domaine de votre machine:: - a2enmod proxy proxy_ajp rewrite + export DOMAIN=acoustica -Créez le fichier **/etc/apache2/site-available/echobase.conf** -:: +Executez ces commandes (ajout modules apache, création du site echobase):: + cat << EOF > /etc/apache2/sites-available/echobase.conf <VirtualHost *:80> - ServerName echobase.nomdedomaine.org + ServerName echobase.$DOMAIN ProxyRequests Off - - RewriteEngine On - RewriteRule ^/$ http://echobase.nomdedomaine.org/echobase/ [R] - ProxyPass / ajp://localhost:8009/ ProxyPassReverse / ajp://localhost:8009/ @@ -309,45 +232,34 @@ Créez le fichier **/etc/apache2/site-available/echobase.conf** CustomLog /var/log/apache2/echobase-access.log combined </VirtualHost> - -Créez le fichier **/etc/apache2/site-available/echobase.conf** -:: - <VirtualHost *:80> - ServerName echobase-map.nomdedomaine.org + ServerName echobase-map.$DOMAIN ProxyRequests Off RewriteEngine On - RewriteRule ^/$ http://echobase-map.nomdedomaine.org/echobase-map/lizmpa/wwww [R] + RewriteRule ^/$ http://echobase-map.$DOMAIN/echobase-map/lizmap/wwww [R] - DocumentRoot /var/www + DocumentRoot /var/www/html ErrorLog /var/log/apache2/echobase-map-error.log LogLevel warn CustomLog /var/log/apache2/echobase-map-access.log combined </VirtualHost> - - -Activez les sites -:: - + EOF a2ensite echobase.conf - a2ensite echobase-map.conf - -Redémarrez le service Apache -:: - service apache2 restart -Le site Echobase est accesible à l'adresse http://echobase.nomdedomaine.org -Et le site de cartographie à l'adresse http://echobase-map.nomdedomaine.org/echobase-map/lizmap/www/index.php +L'application Echobase est accesible à l'adresse http://echobase.$DOMAIN/echobase +Et le site de cartographie à l'adresse http://echobase-map.$DOMAIN/echobase-map/lizmap/www/index.php Vous pouvez donc modifier la configuration d'Echobase avec :: - echobase.lizmap.application.map.url=http://echobase-map.mondedomaine.org/echobase-map/lizmap/www/index.php/view/... + echo "" >> /etc/echobase.properties + echo "" >> /etc/echobase.properties + echo "echobase.lizmap.application.map.url=http://echobase-map.$DOMAIN/echobase-map/lizmap/www/index.php/view/map" >> /etc/echobase.properties .. _créer une base travail: ./db.html#creation-d-une-base-postgresql diff --git a/src/site/rst/update.rst.vm b/src/site/rst/update.rst.vm new file mode 100644 index 0000000..e6be93d --- /dev/null +++ b/src/site/rst/update.rst.vm @@ -0,0 +1,59 @@ +.. - +.. * #%L +.. * EchoBase +.. * %% +.. * 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 +======== + +Mise à jour d'une version d'EchoBase sur un serveur +--------------------------------------------------- + +Pré-requis: + +- L'application doit déjà être installé dans le répertoire /var/local/echobase +- Être loggué sur une console avec l'utilisateur root. + +On suppose que tomcat a été installé via le système de paquets, et donc +que le répertoire **/var/lib/tomcat7** existe. + +Pour utiliser une nouvelle version de l'application, c'est très simple. + +- Supprimer les répertoires suivants : + +:: + + rm -rf /var/lib/tomcat7/webapps/echobase.war + rm -rf /var/lib/tomcat7/Catalina/localhost/echobase + +- Attendre que le répertoire **/var/lib/tomcat7/webapps/echobase** a bien été supprimé. + +- Mettre l'application dans tomcat : + +:: + + cd /var/local/echobase/war + wget http://nexus.nuiton.org/nexus/content/repositories/other-releases/fr/ifremer/echobase/echobase-ui/${project.version}/echobase-ui-${project.version}-full.war + unlink /var/local/echobase/echobase.war + ln -s /var/local/echobase/war/echobase-ui-${project.version}-full.war /var/local/echobase/echobase.war + cp /var/local/echobase/echobase.war /var/lib/tomcat7/webapps + +Tomcat va redéployer l'application et elle sera disponible d'ici peu à l'adresse + http://localhost:8080/echobase diff --git a/src/site/site_en.xml b/src/site/site_en.xml index 7540db5..928e142 100644 --- a/src/site/site_en.xml +++ b/src/site/site_en.xml @@ -72,6 +72,8 @@ <menu name="Administration"> <item name="Download" href="https://forge.codelutin.com/projects/echobase/files"/> <item name="Install" href="install.html"/> + <!--<item name="Update" href="update.html"/>--> + <!--<item name="Configure" href="configure.html"/>--> </menu> <menu name="User"> diff --git a/src/site/site_fr.xml b/src/site/site_fr.xml index 17fc442..e371461 100644 --- a/src/site/site_fr.xml +++ b/src/site/site_fr.xml @@ -73,6 +73,8 @@ <menu name="Administration"> <item name="Téléchargement" href="https://forge.codelutin.com/projects/echobase/files"/> <item name="Installation" href="install.html"/> + <item name="Mise à jour" href="update.html"/> + <item name="Configuration" href="configure.html"/> </menu> <menu name="Utilisateur"> -- To stop receiving notification emails like this one, please contact codelutin.com SCM administrator <admin+scm@codelutin.com>.