INSTALL.md

   1 ![English:](http://upload.wikimedia.org/wikipedia/commons/thumb/a/ae/Flag_of_the_United_Kingdom.svg/20px-Flag_of_the_United_Kingdom.svg.png)
   2 This software is governed by the CeCILL-B license. If a copy of this license
   3 is not distributed with this file, you can obtain one at
   4 [http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.txt](http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.txt)
   5
   6 Authors of STUdS (initial project): Guilhem BORGHESI (borghesi@unistra.fr) and Raphaël DROZ
   7 Authors of Framadate/OpenSondate: [Framasoft](https://git.framasoft.org/framasoft/framadate)
   8
   9 ![Français :](http://upload.wikimedia.org/wikipedia/commons/thumb/c/c3/Flag_of_France.svg/20px-Flag_of_France.svg.png)
  10 Ce logiciel est régi par la licence CeCILL-B. Si une copie de cette licence
  11 ne se trouve pas avec ce fichier vous pouvez l'obtenir sur
  12 [http://www.cecill.info/licences/Licence_CeCILL-B_V1-fr.txt](http://www.cecill.info/licences/Licence_CeCILL-B_V1-fr.txt)
  13
  14 Auteurs de STUdS (projet initial) : Guilhem BORGHESI (borghesi@unistra.fr) et Raphaël DROZ
  15 Auteurs de Framadate/OpenSondage : [Framasoft](https://git.framasoft.org/framasoft/framadate)
  16
  17 * * *
  18
  19 #Avertissement
  20 **Les instructions contenues ci-dessous dans ce fichier ne sont pas actualisées.**
  21 Vous trouverez là :
  22 => **[le tutoriel d'installation complet](http://framacloud.org/cultiver-son-jardin/installation-de-framadate/)**
  23 (en Français uniquement pour le moment)
  24
  25 * * *
  26
  27 ##Paramètres
  28
  29 Le fichier app/inc/constants.php.template contient le paramétrage par défaut de
  30 l'application Framadate. Pour personnaliser votre installation, copiez
  31 ce fichier sous le nom app/inc/constants.php et modifiez ce dernier.
  32
  33 ##Configuration du fichier php.ini
  34
  35 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.
  36
  37 ##Base de données
  38
  39 STUdS fonctionne indépendemment de la base SQL utilisée, sous réserve que
  40 le serveur dispose de l'extension [ADOdb](http://sourceforge.net/projects/adodb)
  41
  42 Cependant la base de donnée doit être créée au préalable.
  43 Deux scripts le faisant sont fournis :
  44 install.sql: pour postgresql
  45 install.mysql.sql: pour mysql
  46
  47 Pour postgresql :
  48 Après avoir renseigné les paramètres de la base de données, créez la
  49 base et pré-chargez les données par défaut. Ceci ressemble à :
  50
  51     % su - pgsql
  52     % createdb studs
  53     % psql -d studs -f install.sql
  54
  55 Attention : Si vous créez la base de données avec l'utilisateur "pgsql", il vous faudra faire un "grant all on <chaque table> 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".
  56
  57
  58 ##Accès à la page administrateur
  59
  60 Le répertoire admin/ contient un fichier .htaccess pour Apache, qui restreint l'accès
  61 à la page d'administration de l'application.
  62 Modifiez le contenu de ce fichier .htaccess pour l'adapter au chemin du fichier .htpasswd
  63 sur votre serveur.
  64 Le fichier .htpasswd à besoin d'être créé par vos soins en utilisant par exemple la commande
  65 suivante :
  66 `htpasswd -mnb <admin_username> <admin_password>`
  67
  68 Un fichier `admin/logs_studs.txt` doit être créé et accessible en écriture
  69 par votre serveur Web. Quelque chose comme :
  70
  71     % touch admin/logs_studs.txt
  72     % chmod 700 admin/logs_studs.txt
  73     % chown www-data admin/logs_studs.txt
  74
  75 devrait convenir.
  76
  77 ##Maintenance
  78
  79 Studs dispose d'une possibilité de mise en maintenance par le biais
  80 d'un fichier .htaccess.
  81 La section `<Directory>` relative à Studs, dans la configuration d'Apache
  82 doit au moins contenir :
  83 `AllowOverride AuthConfig Options`
  84 Le fichier .htaccess correspondant doit être modifier pour y configurer
  85 l'adresse IP depuis laquelle s'effectue la maintenance.
  86 N'oubliez pas de le recommenter en intégralité une fois la maintenance effectuée.
  87
  88 ##Tables de la base de données
  89
  90 Voici la structure des tables de l'application. La base se compose de trois tables :
  91
  92 - sondage : Le contenu de chacun des sondages,
  93 - sujet_studs : les sujets ou dates de tous les sondages,
  94 - user_studs : les identifiants des sondés de tous les sondages.
  95
  96 Chacune des tables contient les champs suivants :
  97
  98 SONDAGE
  99
 100     Nom du champ                format              description
 101
 102     id_sondage (clé primaire)   alpha-numérique     numéro du sondage aléatoire
 103     commentaires                text                commentaires liés au sondage
 104     mail_admin                  text                adresse de l'auteur du sondage
 105     nom_admin                   text                nom de l'auteur du sondage
 106     titre                       text                titre du sondage
 107     id_sondage_admin            alpha-numérique     numéro du sondage pour le lien d'administration
 108     date_fin                    alpha-numérique     date de fin su sondage au format SQL
 109     format                      text                format du sondage : D/D+ pour Date, A/A+ pour Autre
 110     mailsonde                   text                envoi de mail a l'auteur du sondage a chaque participation ("yes" ou vide)
 111
 112 SUJET_STUDS
 113
 114     Nom du champ                format              description
 115
 116     id_sondage (clé primaire)   alpha-numérique     numéro du sondage aléatoire
 117     sujet                       text                tous les sujets du sondage
 118
 119 USER_STUDS
 120
 121     Nom du champ                format              description
 122
 123     user                        text                nom du participant
 124     id_sondage (clé primaire)   alpha-numérique     numéro du sondage aléatoire
 125     reponses                    text                reponses a chacun des sujets proposés au vote (0 pour non, 1 pour OK)
 126     id_users                    alpha-numérique     numéro d'utilisateur par ordre croissant de participation pour garder l'ordre de participation
 127
 128 COMMENTS
 129
 130     Nom du champ                format              description
 131
 132     id_sondage (clé primaire)   alpha-numérique     numéro du sondage aléatoire
 133     comment                     text                commentaires d'un participant
 134     usercomment                 text                nom de l'utilisateur qui laisse le commentaire
 135     id_comment                  alpha-numérique     numéro de commentaire par ordre croissant de participation pour garder l'ordre de remplissage
 136
 137
 138 ##Traductions
 139
 140 Pour pouvoir bénéficier de toutes les traductions en FR, EN, DE et ES
 141 il faut avoir installé les locales fr_FR, de_DE, en_US et es_ES sur le
 142 serveur qui héberge l'application ainsi que disposer de l'extension PHP Gettext.
 143
 144 ##Synthèses des librairies utilisées
 145
 146 [ADOdb](http://sourceforge.net/projects/adodb),
 147 paquet: php5-adodb
 148
 149 [gettext](https://launchpad.net/php-gettext),
 150 paquet: php-gettext
 151
 152 Sous GNU/Linux,
 153 disposer des locales utf-8 suivantes pour la glibc:
 154 FR, EN, ES, DE (/etc/locales.gen)