date.chapril.org-framadate/INSTALL.md

114 lines
4.5 KiB
Markdown
Raw Normal View History

2015-02-25 20:58:04 +01:00
![English:](http://upload.wikimedia.org/wikipedia/commons/thumb/a/ae/Flag_of_the_United_Kingdom.svg/20px-Flag_of_the_United_Kingdom.svg.png)
This software is governed by the CeCILL-B license. If a copy of this license
is not distributed with this file, you can obtain one at
[http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.txt](http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.txt)
Authors of STUdS (initial project): Guilhem BORGHESI (borghesi@unistra.fr) and Raphaël DROZ
Authors of Framadate/OpenSondate: [Framasoft](https://git.framasoft.org/framasoft/framadate)
![Français :](http://upload.wikimedia.org/wikipedia/commons/thumb/c/c3/Flag_of_France.svg/20px-Flag_of_France.svg.png)
Ce logiciel est régi par la licence CeCILL-B. Si une copie de cette licence
ne se trouve pas avec ce fichier vous pouvez l'obtenir sur
[http://www.cecill.info/licences/Licence_CeCILL-B_V1-fr.txt](http://www.cecill.info/licences/Licence_CeCILL-B_V1-fr.txt)
Auteurs de STUdS (projet initial) : Guilhem BORGHESI (borghesi@unistra.fr) et Raphaël DROZ
Auteurs de Framadate/OpenSondage : [Framasoft](https://git.framasoft.org/framasoft/framadate)
* * *
**_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/)**
2015-02-25 20:58:04 +01:00
* * *
# Paramètres
2015-02-25 20:58:04 +01:00
Le fichier `app/inc/config.template.php` contient le paramétrage par défaut de
2015-02-25 20:58:04 +01:00
l'application Framadate. Pour personnaliser votre installation, copiez
ce fichier sous le nom `app/inc/config.php` et modifiez ce dernier.
## Base de données
2015-02-25 20:58:04 +01:00
Framadate fonctionne indépendemment de la base SQL utilisée.
2015-02-25 20:58:04 +01:00
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.
2015-02-25 20:58:04 +01:00
### PostgreSQL
2015-02-25 20:58:04 +01:00
```bash
su - pgsql
createdb framadate
```
2015-02-25 20:58:04 +01:00
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 `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".
2015-02-25 20:58:04 +01:00
### MySQL
2015-02-25 20:58:04 +01:00
TODO
2015-02-25 20:58:04 +01:00
### Création des tables
2015-02-25 20:58:04 +01:00
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.
2015-02-25 20:58:04 +01:00
# Accès à la page administrateur
2015-02-25 20:58:04 +01:00
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 :
2015-02-25 20:58:04 +01:00
`htpasswd -mnb <admin_username> <admin_password>`
Un fichier `admin/stdout.log` doit être créé et accessible en écriture
2015-02-25 20:58:04 +01:00
par votre serveur Web. Quelque chose comme :
```bash
touch admin/stdout.log
chmod 700 admin/stdout.log
chown www-data admin/stdout.log
```
2015-02-25 20:58:04 +01:00
devrait convenir.
# Maintenance
2015-02-25 20:58:04 +01:00
Framadate dispose d'une possibilité de mise en maintenance par le biais d'un fichier `.htaccess`.
2015-02-25 20:58:04 +01:00
La section `<Directory>` relative à Framadate, dans la configuration d'Apache doit au moins contenir :
`AllowOverride AuthConfig Options`
2015-02-25 20:58:04 +01:00
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.
2015-02-25 20:58:04 +01:00
# Tables de la base de données
2015-02-25 20:58:04 +01:00
Voici la structure des tables de l'application, le nom des tables est donné sans préfixe.
2015-02-25 20:58:04 +01:00
La base se compose de quatre tables :
2015-02-25 20:58:04 +01:00
- `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.
2015-02-25 20:58:04 +01:00
# Traductions
2015-02-25 20:58:04 +01:00
Les traductions se trouvent dans le dossier `locale`. Chaque langue est dans un fichier JSON différent organisé par section.
2015-02-25 20:58:04 +01:00
# Synthèses des librairies utilisées
2015-02-25 20:58:04 +01:00
[Smarty](http://www.smarty.net/),
gestion des templates pour PHP
2015-02-25 20:58:04 +01:00
[o80-i18n](https://github.com/olivierperez/o80-i18n),
système d'internationalisation