From 4a9dd039bfcd6647d175749a238cfd5c426b1e08 Mon Sep 17 00:00:00 2001 From: Olivier PEREZ Date: Thu, 26 Mar 2015 17:05:31 +0100 Subject: [PATCH] Adjust INSTALL.md to match recents versions --- INSTALL.md | 163 +++++++++++++++++++------------------------------- composer.lock | 8 +-- 2 files changed, 65 insertions(+), 106 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index b1a2243..41de376 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -16,139 +16,98 @@ Auteurs de Framadate/OpenSondage : [Framasoft](https://git.framasoft.org/framaso * * * -#Avertissement -**Les instructions contenues ci-dessous dans ce fichier ne sont pas actualisées.** -Vous trouverez là : -=> **[le tutoriel d'installation complet](http://framacloud.org/cultiver-son-jardin/installation-de-framadate/)** -(en Français uniquement pour le moment) +**_Avertissement_** + +Les instructions contenues ci-dessous dans ce fichier ne sont pas actualisées. + +Vous trouverez là : **[(FR) le tutoriel d'installation complet](http://framacloud.org/cultiver-son-jardin/installation-de-framadate/)** * * * -##Paramètres +# Paramètres -Le fichier app/inc/constants.php.template contient le paramétrage par défaut de +Le fichier `app/inc/config.template.php` contient le paramétrage par défaut de l'application Framadate. Pour personnaliser votre installation, copiez -ce fichier sous le nom app/inc/constants.php et modifiez ce dernier. +ce fichier sous le nom `app/inc/config.php` et modifiez ce dernier. -##Configuration du fichier php.ini +## Base de données -Pour que les quotes simples soient acceptées dans la partie "Création de sondage", il faut que la variable magic_quotes_gpc soit activée ("On") dans le fichier php.ini. +Framadate fonctionne indépendemment de la base SQL utilisée. -##Base de données +Cependant la base de donnée doit être créée au préalable, +après avoir renseigné les paramètres de la base de données, créez la. -STUdS fonctionne indépendemment de la base SQL utilisée, sous réserve que -le serveur dispose de l'extension [ADOdb](http://sourceforge.net/projects/adodb) +### PostgreSQL -Cependant la base de donnée doit être créée au préalable. -Deux scripts le faisant sont fournis : -install.sql: pour postgresql -install.mysql.sql: pour mysql +```bash + su - pgsql + createdb framadate +``` -Pour postgresql : -Après avoir renseigné les paramètres de la base de données, créez la -base et pré-chargez les données par défaut. Ceci ressemble à : +Attention : Si vous créez la base de données avec l'utilisateur "pgsql", +il vous faudra faire un "grant all on to `framadate`" pour donner les droits à l'utilisateur `framadate` de lire et modifier la base. +Les tables de l'applications sont décrites plus loin dans ce fichier dans la partie "Tables de la base de données". - % su - pgsql - % createdb studs - % psql -d studs -f install.sql +### MySQL -Attention : Si vous créez la base de données avec l'utilisateur "pgsql", il vous faudra faire un "grant all on to studs" pour donner les droits à l'utilisateur studs de lire et modifier la base. Les tables de l'applications sont décrites plus loin dans ce fichier dans la partie "Tables de la base de données". +TODO +### Création des tables -##Accès à la page administrateur +Pour lancer la création des tables, rendez-vous sur la page `admin/` puis allez dans la partie `Migration`. +Cette page est charger: +* soit de créer les tables si c'est votre première installation; +* soit de mettre à jour l'application si vous avec installé une nouvelle version. -Le répertoire admin/ contient un fichier .htaccess pour Apache, qui restreint l'accès -à la page d'administration de l'application. -Modifiez le contenu de ce fichier .htaccess pour l'adapter au chemin du fichier .htpasswd -sur votre serveur. -Le fichier .htpasswd à besoin d'être créé par vos soins en utilisant par exemple la commande -suivante : +# Accès à la page administrateur + +Le répertoire `admin/` fournit l'accès à certainnes actions et informations à protéger. +Il convient de mettre en place un fichier `.htaccess`, pour restreindre l'accès à la page d'administration de l'application. +Modifiez le contenu de ce fichier `.htaccess` pour l'adapter au chemin du fichier `.htpasswd` sur votre serveur. +Le fichier `.htpasswd` peut être créé, par exemple, via la commande suivante : `htpasswd -mnb ` -Un fichier `admin/logs_studs.txt` doit être créé et accessible en écriture +Un fichier `admin/stdout.log` doit être créé et accessible en écriture par votre serveur Web. Quelque chose comme : - % touch admin/logs_studs.txt - % chmod 700 admin/logs_studs.txt - % chown www-data admin/logs_studs.txt +```bash + touch admin/stdout.log + chmod 700 admin/stdout.log + chown www-data admin/stdout.log +``` devrait convenir. -##Maintenance +# Maintenance -Studs dispose d'une possibilité de mise en maintenance par le biais -d'un fichier .htaccess. -La section `` relative à Studs, dans la configuration d'Apache -doit au moins contenir : -`AllowOverride AuthConfig Options` -Le fichier .htaccess correspondant doit être modifier pour y configurer -l'adresse IP depuis laquelle s'effectue la maintenance. +Framadate dispose d'une possibilité de mise en maintenance par le biais d'un fichier `.htaccess`. + +La section `` relative à Framadate, dans la configuration d'Apache doit au moins contenir : +`AllowOverride AuthConfig Options` + +Le fichier `.htaccess` correspondant doit être modifier pour y configurer +l'adresse IP depuis laquelle s'effectue la maintenance. N'oubliez pas de le recommenter en intégralité une fois la maintenance effectuée. -##Tables de la base de données +# Tables de la base de données -Voici la structure des tables de l'application. La base se compose de trois tables : +Voici la structure des tables de l'application, le nom des tables est donné sans préfixe. -- sondage : Le contenu de chacun des sondages, -- sujet_studs : les sujets ou dates de tous les sondages, -- user_studs : les identifiants des sondés de tous les sondages. +La base se compose de quatre tables : -Chacune des tables contient les champs suivants : +- `poll` : Le paramètrage des sondages; +- `slot` : les choix disponibles pour chaque sondage; +- `vote` : les votes effectués par les utilisateurs pour chaque sondage; +- `comment` : les commentaires apportés à chaque sondage. -SONDAGE +# Traductions - Nom du champ format description +Les traductions se trouvent dans le dossier `locale`. Chaque langue est dans un fichier JSON différent organisé par section. - id_sondage (clé primaire) alpha-numérique numéro du sondage aléatoire - commentaires text commentaires liés au sondage - mail_admin text adresse de l'auteur du sondage - nom_admin text nom de l'auteur du sondage - titre text titre du sondage - id_sondage_admin alpha-numérique numéro du sondage pour le lien d'administration - date_fin alpha-numérique date de fin su sondage au format SQL - format text format du sondage : D/D+ pour Date, A/A+ pour Autre - mailsonde text envoi de mail a l'auteur du sondage a chaque participation ("yes" ou vide) +# Synthèses des librairies utilisées -SUJET_STUDS +[Smarty](http://www.smarty.net/), +gestion des templates pour PHP - Nom du champ format description - - id_sondage (clé primaire) alpha-numérique numéro du sondage aléatoire - sujet text tous les sujets du sondage - -USER_STUDS - - Nom du champ format description - - user text nom du participant - id_sondage (clé primaire) alpha-numérique numéro du sondage aléatoire - reponses text reponses a chacun des sujets proposés au vote (0 pour non, 1 pour OK) - id_users alpha-numérique numéro d'utilisateur par ordre croissant de participation pour garder l'ordre de participation - -COMMENTS - - Nom du champ format description - - id_sondage (clé primaire) alpha-numérique numéro du sondage aléatoire - comment text commentaires d'un participant - usercomment text nom de l'utilisateur qui laisse le commentaire - id_comment alpha-numérique numéro de commentaire par ordre croissant de participation pour garder l'ordre de remplissage - - -##Traductions - -Pour pouvoir bénéficier de toutes les traductions en FR, EN, DE et ES -il faut avoir installé les locales fr_FR, de_DE, en_US et es_ES sur le -serveur qui héberge l'application ainsi que disposer de l'extension PHP Gettext. - -##Synthèses des librairies utilisées - -[ADOdb](http://sourceforge.net/projects/adodb), -paquet: php5-adodb - -[gettext](https://launchpad.net/php-gettext), -paquet: php-gettext - -Sous GNU/Linux, -disposer des locales utf-8 suivantes pour la glibc: -FR, EN, ES, DE (/etc/locales.gen) +[o80-i18n](https://github.com/olivierperez/o80-i18n), +système d'internationalisation diff --git a/composer.lock b/composer.lock index 8da7369..5f72fa7 100644 --- a/composer.lock +++ b/composer.lock @@ -12,12 +12,12 @@ "source": { "type": "git", "url": "https://github.com/olivierperez/o80-i18n.git", - "reference": "45335ac7a2d24d8ed85861f737758c15cd4f52f6" + "reference": "a91b6ec4c4a2f033b5451bcdbfc2536be2bca8cc" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/olivierperez/o80-i18n/zipball/45335ac7a2d24d8ed85861f737758c15cd4f52f6", - "reference": "45335ac7a2d24d8ed85861f737758c15cd4f52f6", + "url": "https://api.github.com/repos/olivierperez/o80-i18n/zipball/a91b6ec4c4a2f033b5451bcdbfc2536be2bca8cc", + "reference": "a91b6ec4c4a2f033b5451bcdbfc2536be2bca8cc", "shasum": "" }, "require": { @@ -50,7 +50,7 @@ "internationalization", "php" ], - "time": "2015-03-21 22:37:40" + "time": "2015-03-23 21:40:47" }, { "name": "smarty/smarty",