Merge branch 'Adjust_INSTALL_md' into main_framasoft_develop
This commit is contained in:
Olivier PEREZ
commit
c3fbbb8bf8
159
INSTALL.md
159
INSTALL.md
@ -16,139 +16,98 @@ Auteurs de Framadate/OpenSondage : [Framasoft](https://git.framasoft.org/framaso
|
|||||||
|
|
||||||
* * *
|
* * *
|
||||||
|
|
||||||
#Avertissement
|
**_Avertissement_**
|
||||||
**Les instructions contenues ci-dessous dans ce fichier ne sont pas actualisées.**
|
|
||||||
Vous trouverez là :
|
Les instructions contenues ci-dessous dans ce fichier ne sont pas actualisées.
|
||||||
=> **[le tutoriel d'installation complet](http://framacloud.org/cultiver-son-jardin/installation-de-framadate/)**
|
|
||||||
(en Français uniquement pour le moment)
|
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
|
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
|
### PostgreSQL
|
||||||
le serveur dispose de l'extension [ADOdb](http://sourceforge.net/projects/adodb)
|
|
||||||
|
|
||||||
Cependant la base de donnée doit être créée au préalable.
|
```bash
|
||||||
Deux scripts le faisant sont fournis :
|
su - pgsql
|
||||||
install.sql: pour postgresql
|
createdb framadate
|
||||||
install.mysql.sql: pour mysql
|
```
|
||||||
|
|
||||||
Pour postgresql :
|
Attention : Si vous créez la base de données avec l'utilisateur "pgsql",
|
||||||
Après avoir renseigné les paramètres de la base de données, créez la
|
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.
|
||||||
base et pré-chargez les données par défaut. Ceci ressemble à :
|
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
|
### MySQL
|
||||||
% createdb studs
|
|
||||||
% psql -d studs -f install.sql
|
|
||||||
|
|
||||||
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".
|
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
|
# Accès à la page administrateur
|
||||||
à la page d'administration de l'application.
|
|
||||||
Modifiez le contenu de ce fichier .htaccess pour l'adapter au chemin du fichier .htpasswd
|
Le répertoire `admin/` fournit l'accès à certainnes actions et informations à protéger.
|
||||||
sur votre serveur.
|
Il convient de mettre en place un fichier `.htaccess`, pour restreindre l'accès à la page d'administration de l'application.
|
||||||
Le fichier .htpasswd à besoin d'être créé par vos soins en utilisant par exemple la commande
|
Modifiez le contenu de ce fichier `.htaccess` pour l'adapter au chemin du fichier `.htpasswd` sur votre serveur.
|
||||||
suivante :
|
Le fichier `.htpasswd` peut être créé, par exemple, via la commande suivante :
|
||||||
`htpasswd -mnb <admin_username> <admin_password>`
|
`htpasswd -mnb <admin_username> <admin_password>`
|
||||||
|
|
||||||
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 :
|
par votre serveur Web. Quelque chose comme :
|
||||||
|
|
||||||
% touch admin/logs_studs.txt
|
```bash
|
||||||
% chmod 700 admin/logs_studs.txt
|
touch admin/stdout.log
|
||||||
% chown www-data admin/logs_studs.txt
|
chmod 700 admin/stdout.log
|
||||||
|
chown www-data admin/stdout.log
|
||||||
|
```
|
||||||
|
|
||||||
devrait convenir.
|
devrait convenir.
|
||||||
|
|
||||||
##Maintenance
|
# Maintenance
|
||||||
|
|
||||||
Studs dispose d'une possibilité de mise en maintenance par le biais
|
Framadate dispose d'une possibilité de mise en maintenance par le biais d'un fichier `.htaccess`.
|
||||||
d'un fichier .htaccess.
|
|
||||||
La section `<Directory>` relative à Studs, dans la configuration d'Apache
|
La section `<Directory>` relative à Framadate, dans la configuration d'Apache doit au moins contenir :
|
||||||
doit au moins contenir :
|
|
||||||
`AllowOverride AuthConfig Options`
|
`AllowOverride AuthConfig Options`
|
||||||
Le fichier .htaccess correspondant doit être modifier pour y configurer
|
|
||||||
|
Le fichier `.htaccess` correspondant doit être modifier pour y configurer
|
||||||
l'adresse IP depuis laquelle s'effectue la maintenance.
|
l'adresse IP depuis laquelle s'effectue la maintenance.
|
||||||
N'oubliez pas de le recommenter en intégralité une fois la maintenance effectuée.
|
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,
|
La base se compose de quatre tables :
|
||||||
- sujet_studs : les sujets ou dates de tous les sondages,
|
|
||||||
- user_studs : les identifiants des sondés de tous les sondages.
|
|
||||||
|
|
||||||
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
|
# Synthèses des librairies utilisées
|
||||||
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)
|
|
||||||
|
|
||||||
SUJET_STUDS
|
[Smarty](http://www.smarty.net/),
|
||||||
|
gestion des templates pour PHP
|
||||||
|
|
||||||
Nom du champ format description
|
[o80-i18n](https://github.com/olivierperez/o80-i18n),
|
||||||
|
système d'internationalisation
|
||||||
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)
|
|
||||||
|
|||||||
2
composer.lock
generated
2
composer.lock
generated
@ -50,7 +50,9 @@
|
|||||||
"internationalization",
|
"internationalization",
|
||||||
"php"
|
"php"
|
||||||
],
|
],
|
||||||
|
"time": "2015-03-21 22:37:40"
|
||||||
"time": "2015-03-27 19:37:27"
|
"time": "2015-03-27 19:37:27"
|
||||||
|
"time": "2015-03-23 21:40:47"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "smarty/smarty",
|
"name": "smarty/smarty",
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user