Author: jcouteau Date: 2012-05-02 12:22:54 +0200 (Wed, 02 May 2012) New Revision: 3347 Url: http://chorem.org/repositories/revision/pollen/3347 Log: refs #538: Improve install documentation - English translation Modified: trunk/src/site/fr/rst/configure.rst trunk/src/site/fr/rst/index.rst trunk/src/site/fr/rst/install.rst.vm trunk/src/site/rst/configure.rst trunk/src/site/rst/index.rst trunk/src/site/rst/install.rst.vm Modified: trunk/src/site/fr/rst/configure.rst =================================================================== --- trunk/src/site/fr/rst/configure.rst 2012-05-02 09:56:59 UTC (rev 3346) +++ trunk/src/site/fr/rst/configure.rst 2012-05-02 10:22:54 UTC (rev 3347) @@ -22,19 +22,19 @@ .. * #L% .. - Configurer Pollen ------------------ +~~~~~~~~~~~~~~~~~ -Comment configuer Pollen ------------------------- +Comment configurer Pollen ? +--------------------------- Toute la configuration de Pollen se fait via un fichier nommé **pollen.properties**. -Ce fichier peut se trouver à différents endroits sur la machine qui démarre Pollen : +Ce fichier peut se trouver à différents endroits sur la machine qui démarre +Pollen suivant le mode d'installation choisi : :: /etc/pollen.properties - ~/.config/pollen/pollen.properties repertoireOuEstLancePollen/pollen.properties A noter que si le fichier est déposé dans plusieurs endroits, alors les @@ -80,7 +80,7 @@ hibernate.connection.username=sa hibernate.connection.password= -Pour changer de type de base données, il faut modifier modidifer +Pour changer de type de base données, il faut modifier modifier les propriétés suivantes: :: @@ -89,19 +89,16 @@ hibernate.connection.driver_class=Driver de la base hibernate.connection.url=Url de connexion à la base -Voici un tableau d'utilisation pour les bases usuelles: +Voici un tableau des propriétés pour les bases usuelles: -+-------------------------+------------------------------------------+-----------------------+------------------------------------------+ -| Type de base de données | dialect | driver | url de connexion | -+=========================+==========================================+=======================+==========================================+ -| H2 | org.hibernate.dialect.H2Dialect | org.h2.Driver | jdbc:h2:file:emplacementBaseH2/pollendb | -+-------------------------+------------------------------------------+-----------------------+------------------------------------------+ -| PostgreSql | org.hibernate.dialect.PostgreSQLDialect | org.postgresql.Driver | jdbc:postgresql:pollen | -+-------------------------+------------------------------------------+-----------------------+------------------------------------------+ -| MySql | org.hibernate.dialect.MySQLDialect | com.mysql.jdbc.Driver | jdbc:mysql:pollen | -+-------------------------+------------------------------------------+-----------------------+------------------------------------------+ ++-------------------------+------------------------------------------+-----------------------------------+------------------------------------------+ +| Type de base de données | hibernate.dialect | hibernate.connection.driver_class | hibernate.connection.url | ++=========================+==========================================+===================================+==========================================+ +| H2 | org.hibernate.dialect.H2Dialect | org.h2.Driver | jdbc:h2:file:emplacementBaseH2/pollendb | ++-------------------------+------------------------------------------+-----------------------------------+------------------------------------------+ +| PostgreSql | org.hibernate.dialect.PostgreSQLDialect | org.postgresql.Driver | jdbc:postgresql:pollen | ++-------------------------+------------------------------------------+-----------------------------------+------------------------------------------+ +| MySql | org.hibernate.dialect.MySQLDialect | com.mysql.jdbc.Driver | jdbc:mysql:pollen | ++-------------------------+------------------------------------------+-----------------------------------+------------------------------------------+ -.. _page des options: ./pollen-ui-struts2/application-config-report.html -.. _page des Téléchargements: http://www.chorem.org/projects/pollen/files -.. _Tomcat: http://tomcat.apache.org/ -.. _Jetty: http://eclipse.org/jetty/ +.. _page des options: ./pollen-ui-struts2/application-config-report.html \ No newline at end of file Modified: trunk/src/site/fr/rst/index.rst =================================================================== --- trunk/src/site/fr/rst/index.rst 2012-05-02 09:56:59 UTC (rev 3346) +++ trunk/src/site/fr/rst/index.rst 2012-05-02 10:22:54 UTC (rev 3347) @@ -37,7 +37,7 @@ -------------------------------------------- - Pollen permet de créer des consultations sur des textes, dates ou images. -- Vous pouvez utiliser plusieurs `modes de dépouillement`_ +- Vous pouvez utiliser plusieurs `modes de dépouillement`_ comme le Condorcet. - Vous pouvez voter anonymement. - Vous pouvez modifier vos votes (même anonyme). - Vous pouvez recevoir des e-mails de notification et de rappel. @@ -68,7 +68,10 @@ - Vous pouvez installer Pollen sur votre propre serveur pour garder le contrôle de vos données (consultation confidentielle par exemple). -- Pollen est libre, vous pouvez le modifier, l'améliorer ou l'adapter a vos besoins. +- Pollen est libre, vous pouvez le modifier, l'améliorer ou l'adapter a vos + besoins. +- Vous pouvez nous remonter les bugs ou demandes d'améliorations et suivre le + projet sur notre forge_ . .. image:: home.png :alt: Page d'accueil de Pollen @@ -77,3 +80,4 @@ .. _instance de Pollen: http://pollen.chorem.org/pollen .. _Télécharger Pollen: http://www.chorem.org/projects/pollen/files .. _guide d'installation: ./install.html +.. _forge: http://www.chorem.org/projects/pollen Modified: trunk/src/site/fr/rst/install.rst.vm =================================================================== --- trunk/src/site/fr/rst/install.rst.vm 2012-05-02 09:56:59 UTC (rev 3346) +++ trunk/src/site/fr/rst/install.rst.vm 2012-05-02 10:22:54 UTC (rev 3347) @@ -46,7 +46,7 @@ Pour que Pollen soit pleinement opérationnel, il faut configurer deux choses : - l'adresse publique de Pollen (voir la section `Configurer l'adresse publique`_). -- la configuration d'envoie d'emails (voir la section `Configurer l'envoi d'email`_).). +- la configuration d'envoi d'emails (voir la section `Configurer l'envoi d'email`_).). Pour tout savoir sur la configuration de Pollen, reportez vous à la `page de configuration`_. @@ -59,7 +59,8 @@ Pollen. Par mesure de sécurité il est important de supprimer cet utilisateur -après avoir créer un autre compte administrateur. +après avoir créé un autre compte administrateur ou alors de modifier son mot de +passe. Installation en mode embarqué ============================= @@ -115,13 +116,12 @@ Configurer ---------- -En mode serveur, Il faut créer un fichier de configuration nommé -**pollen.properties** qui peut se trouver dans l'un des répertoires suivants : +En mode serveur, il faut créer un fichier de configuration nommé +**pollen.properties** dans le répertoire suivant : :: /etc/pollen.properties - ~/.config/pollen.properties Par défaut les données seront stoquées dans le répertoire suivant : Modified: trunk/src/site/rst/configure.rst =================================================================== --- trunk/src/site/rst/configure.rst 2012-05-02 09:56:59 UTC (rev 3346) +++ trunk/src/site/rst/configure.rst 2012-05-02 10:22:54 UTC (rev 3347) @@ -21,87 +21,79 @@ .. * along with this program. If not, see <http://www.gnu.org/licenses/>. .. * #L% .. - -Configurer Pollen ------------------ +Configure Pollen +~~~~~~~~~~~~~~~~ -Comment configuer Pollen ------------------------- +How to configure Pollen +----------------------- -Toute la configuration de Pollen se fait via un fichier nommé **pollen.properties**. +All Pollen configuration is done via a file named **pollen.properties**. -Ce fichier peut se trouver à différents endroits sur la machine qui démarre Pollen : +This file can be located in several places on the computer that starts Pollen, +depending on the installation mode: :: /etc/pollen.properties - ~/.config/pollen/pollen.properties - repertoireOuEstLancePollen/pollen.properties + directoryWherePollenIsLaunched/pollen.properties -A noter que si le fichier est déposé dans plusieurs endroits, alors les -configurations se cumulent. +Beware, if the file is in different places, the configurations are merged. -Pour plus d'information sur les options disponibles, -rendez-vous sur la `page des options`_. +More information on the available options is available on `options page`_. -Configurer l'adresse publique ------------------------------ +Configure the public address +---------------------------- -L'adresse publique de Pollen est l'adresse utilisée dans les emails générés. +Pollen public address is the one used in the generated emails. -On peut la configurer via la propriété suivante de la configuration : +You can configure it using the following configuration option: :: - siteUrl=Adresse publique de votre instance de pollen (utilisé pour générer les liens d'accès au sondage dans les emails envoyés) + siteUrl=your Pollen instance public address(used to generate links in sent emails) -Configurer l'envoi d'email --------------------------- +Configure mail sending +---------------------- -Pour que Pollen puisse envoyer des emails vous devez bien renseigner la -configuration: +So that Pollen can send emails you must fill in the following configuration: :: - email_host= Serveur smtp pour envoyer les emails - email_port= Port du serveur smtp - email_from= Adresse de l'envoyeur de mail + email_host= Smtp server address (ex: localhost, smtp.free.fr, ...) + email_port= Smtp server port (by default: 25) + email_from= Mail sender address (ex: mypolleninstance@me.com) -Configurer la base de données ------------------------------ +Configure database +------------------ -Pollen utilise une base de données. Par défaut Pollen utilise une base type -h2. +Pollen use a database. By default, Pollen use a H2 database. -Pour modifier la configuration de la base de données, on modifie dans le -fichier de configuration les lignes: +To modify the connection information, you can modify the following lines in +the configuration: :: hibernate.connection.username=sa hibernate.connection.password= -Pour changer de type de base données, il faut modifier modidifer -les propriétés suivantes: +To change the database you want to use, you to modify the following properties: :: - hibernate.dialect=Dialect de la base - hibernate.connection.driver_class=Driver de la base - hibernate.connection.url=Url de connexion à la base + hibernate.dialect=Database dialect + hibernate.connection.driver_class=Database driver + hibernate.connection.url=Database connection url -Voici un tableau d'utilisation pour les bases usuelles: +Here are the properties for usual databases: -+-------------------------+------------------------------------------+-----------------------+------------------------------------------+ -| Type de base de données | dialect | driver | url de connexion | -+=========================+==========================================+=======================+==========================================+ -| H2 | org.hibernate.dialect.H2Dialect | org.h2.Driver | jdbc:h2:file:emplacementBaseH2/pollendb | -+-------------------------+------------------------------------------+-----------------------+------------------------------------------+ -| PostgreSql | org.hibernate.dialect.PostgreSQLDialect | org.postgresql.Driver | jdbc:postgresql:pollen | -+-------------------------+------------------------------------------+-----------------------+------------------------------------------+ -| MySql | org.hibernate.dialect.MySQLDialect | com.mysql.jdbc.Driver | jdbc:mysql:pollen | -+-------------------------+------------------------------------------+-----------------------+------------------------------------------+ ++-------------------------+------------------------------------------+-----------------------------------+------------------------------------------+ +| Database | hibernate.dialect | hibernate.connection.driver_class | hibernate.connection.url | ++=========================+==========================================+===================================+==========================================+ +| H2 | org.hibernate.dialect.H2Dialect | org.h2.Driver | jdbc:h2:file:emplacementBaseH2/pollendb | ++-------------------------+------------------------------------------+-----------------------------------+------------------------------------------+ +| PostgreSql | org.hibernate.dialect.PostgreSQLDialect | org.postgresql.Driver | jdbc:postgresql:pollen | ++-------------------------+------------------------------------------+-----------------------------------+------------------------------------------+ +| MySql | org.hibernate.dialect.MySQLDialect | com.mysql.jdbc.Driver | jdbc:mysql:pollen | ++-------------------------+------------------------------------------+-----------------------------------+------------------------------------------+ -.. _page des options: ./pollen-ui-struts2/application-config-report.html -.. _page des Téléchargements: http://www.chorem.org/projects/pollen/files -.. _Tomcat: http://tomcat.apache.org/ -.. _Jetty: http://eclipse.org/jetty/ +.. _options page: ./pollen-ui-struts2/application-config-report.html \ No newline at end of file Modified: trunk/src/site/rst/index.rst =================================================================== --- trunk/src/site/rst/index.rst 2012-05-02 09:56:59 UTC (rev 3346) +++ trunk/src/site/rst/index.rst 2012-05-02 10:22:54 UTC (rev 3347) @@ -31,7 +31,7 @@ -------------------------- - Pollen features textual, date or image vote. -- You can use different `vote counting methods`_ +- You can use different `vote counting methods`_ such as Condorcet - You can vote anonymously. - You can change your votes (even anonymous ones). - You can receive notification and/or reminder emails. @@ -52,8 +52,8 @@ How to use Pollen? - Use our `shared instance of Pollen`_, with no install on your own computer. -- `Download Pollen`_ ans install it on our own computer following - `installation guide`_ . +- `Download Pollen`_ and install it on our own computer following + the `installation guide`_ . But also... ----------- @@ -61,6 +61,7 @@ - You can install Pollen on your own server to keep the control on your data (confidential vote for example). - Pollen is Libre so you can modify it, improve it, adapt it to your needs. +- You can report bugs, features request and follow the project on our forge_ .. image:: home.png :alt: Pollen screenshot @@ -69,3 +70,4 @@ .. _shared instance of Pollen: http://pollen.chorem.org/pollen .. _Download Pollen: http://www.chorem.org/projects/pollen/files .. _installation guide: ./install.html +.. _forge: http://www.chorem.org/projects/pollen Modified: trunk/src/site/rst/install.rst.vm =================================================================== --- trunk/src/site/rst/install.rst.vm 2012-05-02 09:56:59 UTC (rev 3346) +++ trunk/src/site/rst/install.rst.vm 2012-05-02 10:22:54 UTC (rev 3347) @@ -21,73 +21,118 @@ .. * along with this program. If not, see <http://www.gnu.org/licenses/>. .. * #L% .. - -Installation guide -================== -Web container -------------- +Install Pollen +============== -To install the application, you just need to deploy the war archive in a web -container like Tomcat_. +This page describes how to instal Pollen on your computer or server. -By default, a H2 database is created in the */tmp* directory. To modify this -behaviour, you only need to create the */etc/pollen.properties* file ( you can -put it into the directory from which you launch the application or in a -*".config/"* directory in your home directory) and to fill it with the following -properties :: +Foreword +======== - # database configuration - hibernate.show_sql=false - hibernate.dialect=org.hibernate.dialect.H2Dialect - hibernate.connection.username=username - hibernate.connection.password=password - hibernate.connection.driver_class=org.h2.Driver - hibernate.connection.url=jdbc:h2:file://tmp/pollen/pollen +Installation modes +------------------ - # transfered pictures directory - upImgDir=/tmp/pollen/uploadedImages +You have two different Pollen installation modes available : - # maximal size of transfered pictures (in bytes) - upload.filesize-max=1048576 - upload.requestsize-max=10485760 +- **Embedded mode** : in this mode Pollen is an autonomous application that can + be launched without any web container. - # automatic email sending configuration - email_host=smtp.free.fr - email_port=25 - email_from=bot@pollen.org +- **Server mode** : in this mode, Pollen have to be deployed in a web container + (Tomcat, Jetty,...) with a configuration adapted to a server. - # syndication flux directory (Atom) - feedDir=/tmp/pollen/feeds +Configure Pollen +---------------- - # site adresse (used for reminder emails) - siteUrl=http://www.site.org/pollen/ +So that Pollen is fully operational, you have to configure two things : -For example, for a PostgreSQL database, we will have :: +- the public Pollen address (see the `Configure the public address`_ section). +- the mail sending configuration (see the `Configure mail sending`_ section). - hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect - hibernate.connection.driver_class=org.postgresql.Driver - hibernate.default_schema=public +If you want to know everything about Pollen configuration, go to the +`configuration page`_. -It may be necessary to redeploy the application after having modified this -file; +Connect to Pollen +----------------- -A user with administration rights is automatically added (login "admin", -password "pollen"). For safety measures, it is really important to delete this -user (or modify its password) after having created another administrator account. +A user with admin rights is automatically created (login **admin**, password +**pollen**) on Pollen first start. -Embedded container ------------------- +For security reasons, it is important to delete this user after creating another +admin account or change the password. -Since pollen-1.1.1, the war bundle embed a servlet container based on winstone. -To run it, just launch with following command : +Embedded mode installation +========================== +Install +------- + +- Download the **${project.build.finalName}-bin.zip** archive on the Downloads_ + page. +- Unzip the dowloaded archive. + +Configure +--------- + +In embedded mode, the configuration file **pollen.properties** is located at the +uncompressed archive root. + +All data is stored in the *data* directory. + +Start +----- + +You can start Pollen with one of those commands : + :: - java -jar pollen-x.x.x.war + ./pollen.sh (on linux) +:: -Then open a browser to address : http://localhost:8080/. + pollen.bat (on windows) -You can also use command line option to configure launch : http://winstone.sourceforge.net/#commandLine +Then, once Pollen started, a web browser should open at the following address +:: + + http://localhost:8888 + + +Server mode installation +======================== + +Install +------- + +- Download the **${project.build.finalName}.war** archive on the Downloads_ + page. +- Fill in the configuration (see the configuration_ section). + +Configure +--------- + +In server mode, you have to create a configuration file named +**pollen.properties** in the following directory : + +:: + + /etc/pollen.properties + +By default, the data will be stored in the following directory : + +:: + + /var/local/pollen/data + +Start +----- + +Deploy the war file in your web container like Tomcat_ or Jetty_. + +.. _configuration: ./configure.html +.. _Downloads: http://www.chorem.org/projects/pollen/files .. _Tomcat: http://tomcat.apache.org/ +.. _Jetty: http://eclipse.org/jetty/ +.. _Configure the public address: ./configure.html#Configure_the_public_address +.. _Configure mail sending: ./configure.html#Configure_mail_sending