This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository pollen. See https://gitlab.nuiton.org/chorem/pollen.git commit d93d7f03f214b3825b6b261de1329e52c28029a4 Author: Sylvain Bavencoff <bavencoff@codelutin.com> Date: Mon Oct 23 12:02:39 2017 +0200 Ajout des page de configuration et d'installation de Pollen (ref #88) --- docs/config.md | 121 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/install.md | 34 ++++++++++++++++ mkdocs.yml | 8 ++-- 3 files changed, 160 insertions(+), 3 deletions(-) diff --git a/docs/config.md b/docs/config.md new file mode 100644 index 00000000..a2a16147 --- /dev/null +++ b/docs/config.md @@ -0,0 +1,121 @@ +Configuration +============= + +API REST +-------- + +Pour configurer le serveur REST créer le fichier `/etc/pollen-rest-api.properties` + +### La base de données + +#### H2 + +Modifier le dossier d'enregistrement de la base [H2](http://www.h2database.com/html/main.html) + + pollen.data.directory=/var/local/pollen/data + +#### PostgreSQL + +Par défaut Pollen utilise un base H2 mais vous pouvez aussi configurer une base [PostgreSQL](https://www.postgresql.org/) + + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + hibernate.connection.driver_class=org.postgresql.Driver + hibernate.default_schema=public + hibernate.connection.username=<loginBD> + hibernate.connection.password=<passwordBD> + hibernate.connection.url=jdbc:postgresql://<serveurBD>/<DB> + +### Les mails + +Vous pouvez modifier le serveur SMTP sortant et l’adresse de l’expéditeur. + + pollen.smtp.host=<serveurSMTP> + pollen.smtp.port=<portSMPT> + pollen.smtp.from=expéditeur@serveur.com + +L’adresse de destination des remarques ou bugs. + + pollen.feedback.mails=feedback@serveur.com + +### les droits utilisateurs + +- Limiter l’inscription à certaines adresses mail. + + pollen.registration.emailAddressPattern=*@organisation.com + + La valeur doit être une expression régulière. Seul les adresses la validant peuvent s’enregistrer. + +- Rendre obligatoire l’inscription avant d’utiliser Pollen + + pollen.default.userConnectedRequired=true + +- Limiter la création de sondage + + pollen.default.usersCanCreatePoll=<ALL_USER ou USERS_CONNECTED ou USERS_SELECTED> + + - ALL_USER : Tous les utilisateurs (par défaut) + - USERS_CONNECTED : Seul les utilisateurs connectés + - USERS_SELECTED : Seul les utilisateurs autorisés dans le menu d’administration des utilisateurs + +- Limiter la taille des fichiers téléversé + + pollen.resource.maxSize=100000 + + exprimé en octets (10000000 pour 10 Mo) + + +### Liste des options + +| Clés | Descriptions | Types | Valeurs par défaut | +|---------------------------------------------------|-------------------------------------------------------------------------------------------------------|-----------------------------------------------|-----------------------| +| pollen.data.directory | Répertoire de données de l’application | Alpha-numérique | | +| pollen.secret | Clés de chiffrement des jetons d'authentification | Alpha-numérique | !secret# | +| pollen.default.pollType | Type de sondage par défaut lors de la création d'un nouveau sondage | FREE, RESTRICTED | FREE | +| pollen.default.voteCountingType | Type de dépouillement par défaut lors de la création d'un nouveau sondage | Numérique | 1 | +| pollen.default.voteVisibility | Visibilité des votes par défaut | ANONYMOUS, CREATOR, VOTER ou EVERYBODY | EVERYBODY | +| pollen.default.commentVisibility | Visibilité des commentaires par défaut | CREATOR, VOTER ou EVERYBODY | EVERYBODY | +| pollen.default.resultVisibility | Visibilité des résultats par défaut | CREATOR, VOTER ou EVERYBODY | EVERYBODY | +| pollen.default.continuousResults | Voire les résultats en continue par défaut | Booléen | true | +| pollen.default.voteNotification | Recevoir une notification pour les nouveaux votes par défaut | Booléen | false | +| pollen.default.commentNotification | Recevoir une notification pour les nouveaux commentaires par défaut | Booléen | false | +| pollen.default.newChoiceNotification | Recevoir une notification pour les nouveaux choix par défaut | Booléen | false | +| pollen.default.notifyMeHoursBeforePollEnds | Nombres d’heures avant la fin du vote pour recevoir une notification (0 pas de notification) | Numérique | 0 | +| pollen.default.sessionTimeoutDelay | Temps autorisé d’inactivité avant d’invalider une session utilisateur (en secondes) | Numérique | 3600 | +| pollen.smtp.host | Adresse du serveur SMTP | Alpha-numérique | | +| pollen.smtp.port | Port du serveur SMTP | Numérique | 25 | +| pollen.smtp.from | adresse mail de l’expéditeur | Alpha-numérique | noreply@serveur.com | +| pollen.logConfigurationFile | Chemin vers le fichier de configuration des logs | Alpha-numérique | | +| pollen.sendEndPollRemindersCronSchedule | Intervalle entre deux lancements de la tâche d’envoi de mails de rappel de fin de sondage | CRON | 0 0/1 * * * ? | +| pollen.resource.maxSize | Taille maximal pour un fichier de ressource de Pollen (en octets) | Numérique | 10000000 | +| pollen.resource.preview.max | Dimension maximal de la prévisualisation d'un image | Numérique | 200 | +| pollen.registration.emailAddressPattern | Expression régulière que doivent vérifier les adresses émail des utilisateurs lors de l’inscription | Alpha-numérique | | +| pollen.resendEmailsCronSchedule | Intervalle entre deux lancements de la tâche de renvoi des mails en erreur | CRON | 0 0/5 * * * ? | +| pollen.report.maxScore | Score maximum pour un signalement avant que les administrateurs soient avertis | Numérique | 100 | +| pollen.feedback.mails | Mails destinataires des retours utilisateur | Alpha-numérique | | +| pollen.feedback.locale | La locale pour envoyer les retours utlisateur | fr ou en | en | +| pollen.configuration.defaultTimeZoneId | Fuseau horaire pou l'envoie des mails par défaut | Alpha-numérique | Europe/Paris | +| pollen.default.maxVoters | Nombre maximum de votes pris en compte pour de sondage standard (0 : pas de limite) | Numérique | 0 | +| pollen.default.userConnectedRequired | Seul les utilisateurs connectés peuvent accéder à l'application | Booléen | false | +| pollen.configuration.usersCanCreatePoll | Quels utilisateurs peuvent créer des sondages | All_USERS, USERS_CONNECTED ou USERS_SELECTED | All_USERS | +| pollen.deleteObsoleteSessionTokensCronSchedule | Intervalle entre deux lancements de la suppression des tokens de session obsolètes | CRON | 0 0/5 * * * ? | + +Site public +----------- + +La configuration du site public est définie dans le fichier `conf.js` (dans le docker le fichier se trouve dans `/var/local/pollen`) + +Par défaut la configuration est la suivante : + + window.pollenConf = { + endPoint: "http://localhost:8888/pollen-rest-api", + piwikUrl: "", // add the piwik url, eg: http://localhost/piwik + piwikSiteId: "", // add the site id, eg: 3 + defaultMessageTimeout: 15, + resourceMaxSize: 10000000 // octets => 10 Mo + }; + +- `endPoint` : L’URL de l'API REST, +- `piwikUrl` : L’URL de votre tracker [Piwik](https://piwik.org/), +- `piwikSiteId` : l'identifiant du site de Pollen dans votre tracker Piwik, +- `defaultMessageTimeout` : Durée (en secondes) d'affichage des message, +- `resourceMaxSize` : Taille maximal pour un fichier de ressource de Pollen (en octets). \ No newline at end of file diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 00000000..8f7c595f --- /dev/null +++ b/docs/install.md @@ -0,0 +1,34 @@ +Installation +============ +Par un docker +------------- +Pour faciliter l'installation de Pollen nous avons généré des [dockers](https://www.docker.com/) contenant +une configuration par défaut de Pollen +Récupérer le docker et lancer le : + docker run -p 80:80 registry.nuiton.org/chorem/pollen:3.0.2 + +Vous pouvez ensuite accéder à Pollen sur votre navigateur à l’adresse [http://localhost](http://localhost). +Par défaut toute la configuration et les données de pollen se trouvent dans le dossier `/var/local/pollen` dans le docker +Manuellement +------------ +Pollen se compose de deux parties, une API REST et un site public : + +### L’API REST +Télécharger le [fichier WAR](https://gitlab.nuiton.org/chorem/pollen/-/jobs/artifacts/3.0.2/download?job=...) +Avant de le déployer vous devez indiquer le répertoire d’enregistrement des données +Créez le fichier `/etc/pollen-rest-api.properties` + pollen.data.directory=<repertoire des données> + +Déployer le fichier WAR dans votre conteneur de servlets ([Tomcat](http://tomcat.apache.org/) ou [Jetty](http://www.eclipse.org/jetty/)) +Vous pouvez le tester sur votre navigateur à l'adresse [http://localhost:8080/pollen-rest-api/v1/configuration](http://localhost:8080/pollen-rest-api/v1/configuration) +### Site de l'interface utilisateur +Télécharger l’[archive du site](https://gitlab.nuiton.org/chorem/pollen/-/jobs/artifacts/3.0.2/download?job=...) +Décomprésez installez là dans votre serveur web ([Apache](https://httpd.apache.org/) ou [Nginx](https://nginx.org/)) +Modifier le fichier `conf.js` pour faire pointer le site sur l’API REST + ... + window.pollenConf = { + endPoint: "http://<adresse API REST>/pollen-rest-api", + ... + + + diff --git a/mkdocs.yml b/mkdocs.yml index 62c525b4..9ba8253c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,15 +6,17 @@ repo_name: Gitlab repo_url: https://gitlab.nuiton.org/chorem/pollen pages: - - Home: index.md + - Accueil: index.md + - Installation: install.md + - Configuration: config.md theme: material extra: social: - type: 'gitlab' link: 'https://gitlab.nuiton.org/chorem/pollen' palette: - primary: 'orange' - accent: 'light blue' + primary: 'blue grey' + accent: 'teal' logo: 'assets/images/logo.png' markdown_extensions: - admonition -- To stop receiving notification emails like this one, please contact chorem.org SCM administrator <admin+scm@chorem.org>.