Commit 2c38b493 authored by spf's avatar spf

Merge branch 'readme' into 'master'

Readme

See merge request !4
parents 4267a781 aeaac4cf
Framaforms
==============
Description
===============
Framaforms helps you create online webforms and surveys.
See https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ (in French ) and https://framablog.org/2016/10/05/en-savoir-un-peu-plus-sur-le-projet-framaforms/ (in French) for further informations.
Usage
=============
There isn't yet help for Framaforms. Nevertheless, you can read https://framaforms.org/fonctionnalites (in french) and https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ for further information.
Installation
=================
Framaforms is based at 99% on Drupal 7, with some modules (like webform).
You don't need technical skills, but installation is a little bit more complicated than standard Drupal installation.
For performance reasons, Framaforms use postgresql databse which caused issues for making it a "[distribution](https://www.drupal.org/docs/7/distributions)"
## Prerequisite
* PHP 7+ (may works with previous version, but php7 is recommended for performance reason)
* Nginx (may works with Apache)
* postgresql 9.4.12 (or +)
* php extension mb_string for php7 ( ``sudo apt-get install php7.0-mbstring`` )
* a reachable web directory
## database
* create an user, a database and grant this user correct rights. See http://www.sakana.fr/blog/2007/06/06/postgresql-create-a-user-a-database-and-grant-accesses/
* next we will use ``framaforms_user`` as user and ``framaforms`` as database
* download initialization Framafoms database : http://framaforms.org/framaforms.sql (~ 20Mo)
* import this database (using ``postgres`` user)
* `psql -U framaforms_user -W -h 127.0.0.1 framaforms < /path/to/framaforms.sql`
* if you need to reimport the database, it is recommended to destroy and recreate the database before import: `dropdb framaforms;createdb --encoding=UTF8 --owner=framaforms_user framaforms`
## Files
* type `git clone https://framagit.org/framasoft/framaforms.git` in your web directory
* make sure you apply corret user rights (``chown``) and give extended write/read permissions to /path/to/framaforms/sites/default/files
* create a directory and give it write permission (but not read permission). E.g: /path/to/framaforms_private_files/
* database connection configuration:
* go to /path/to/framaforms/sites/default/
* copy default.settings.php to settings.php
* edit with database connection informations
```php
$databases = array (
'default' =>.
array (
'default' =>.
array (
'database' => 'framaforms',
'username' => 'framaforms_user',
'password' => 'yourpassword',
'host' => 'localhost',
'port' => '',
'driver' => 'pgsql',
'prefix' => '',
),
),
);
```
* You can add an option to include forms in iframe by appending this to the file:
```php
/**
* Turn off the X-Frame-Options header entirely, to restore the previous
* behavior of allowing the site to be embedded in a frame on another site.
*/
$conf['x_frame_options'] = '';
```
## Site access
At the moment, you should (if everything is fine) access your site (e.g.: mysite.com).
* go to mysite.com
* connect with id ``admin`` and password ``changemeASAP!``
* **IMPORTANT**: edit your admin password :)
* edit informations of your site https://monsite.com/admin/config/system/site-information
* check paths https://monsite.com/admin/config/media/file-system
* check your installation and if your modules are up to date https://monsite.com/admin/reports/status
* optionally, activate cache informations for production use https://monsite.com/admin/config/development/performance
Logically, you could now use your framaforms site.
Framaforms
==============
([English version available here](README.md))
Description
===============
Framaforms est un logiciel de création de formulaires en ligne.
Lire https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ et https://framablog.org/2016/10/05/en-savoir-un-peu-plus-sur-le-projet-framaforms/ pour plus d'informations.
Current version
================
1.0 - 20180402
Changelog
============
Un changelog sommaire est disponible sur https://framagit.org/framasoft/framaforms/wikis/logbook
Utilisation
=============
Il n'existe pas encore d'aide pour Framaforms. Vous pouvez cependant lire https://framaforms.org/fonctionnalites et https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ pour plus d'informations.
Installation
=================
Framaforms est basé à 99% sur Drupal 7, accompagné de différents modules (notamment le module webform).
Le niveau technique pour l'installer n'est pas très élevé, mais l'installation est tout de même plus complexe que l'installation d'un Drupal "standard".
Pour des raisons de performances, Framaforms utilise postgresql comme BDD, ce qui posait probleme pour en faire une "distribution" <https://www.drupal.org/docs/7/distributions>.
## Prérequis
* PHP 7+ (peut fonctionner avec des versions antérieures, mais PHP7 recommandé pour des raisons de performances)
* Nginx (peut fonctionner avec Apache)
* postgresql 9.4.12 (ou +)
* extension php mb_string pour php7 ( sudo apt-get install php7.0-mbstring )
* un dossier web accessible et fonctionnel
## Base de données
* Créer un utilisateur, une base de données, et attribuer les droits nécéssaires à cet utilisateur sur cette base. Ex: http://www.sakana.fr/blog/2007/06/06/postgresql-create-a-user-a-database-and-grant-accesses/
* pour la suite, nous prendrons comme exemple le user "framaforms_user" et comme BDD "framaforms"
* Télécharger la BDD d'initialisation de Framaforms : https://framagit.org/framasoft/framaforms/raw/master/framaforms.sql (pour la branche "master", ou http://framaforms.org/framaforms.sql). NB : le fichier fait environ environ 20Mo.
* Importer cette base de données (à faire avec l'utilisateur système "postgres"
* `psql -U framaforms_user -W -h 127.0.0.1 framaforms < /path/to/framaforms.sql`
* NB : si vous devez réimporter la base d'initialisation, il est conseillé de détruire puis recréer la BDD avant importation : `dropdb framaforms;createdb --encoding=UTF8 --owner=framaforms_user framaforms`
## Fichiers
* faire un `git clone https://framagit.org/framasoft/framaforms.git` dans le dossier web de votre choix
* assurez-vous d'appliquer les bons droits utilisateur (chown) et de donner des permissions étendues en lecture/écriture sur /path/to/framaforms/sites/default/files
* créez un dossier qui sera accessible en écriture (mais pas en lecture) à votre utilisateur web. Ex: /path/to/framaforms_private_files/
* configuration de la connexion à la BDD :.
* allez dans le dossier /path/to/framaforms/sites/default/
* copiez le fichier default.settings.php en settings.php
* editez ce fichier et modifiez les information de connexion à la BDD
```php
$databases = array (
'default' =>.
array (
'default' =>.
array (
'database' => 'framaforms',
'username' => 'framaforms_user',
'password' => 'yourpassword',
'host' => 'localhost',
'port' => '',
'driver' => 'pgsql',
'prefix' => '',
),
),
);
```
* profitez en pour ajouter la possibilité d'inclure vos formulaires dans des iframes en toute fin de fichier
```php
/**
* Turn off the X-Frame-Options header entirely, to restore the previous
* behavior of allowing the site to be embedded in a frame on another site.
*/
$conf['x_frame_options'] = '';
```
## Accéder au site
A ce stade, vous devriez (si tout va bien) accéder à votre site (par exemple sur monsite.com) .
* Rendez-vous sur https://monsite.com/
* Connectez vous avec l'identifiant "admin" et le mot de passe "changemeASAP!"
* IMPORTANT : Modifiez votre mot de passe administrateur :)
* Editez les infos de https://monsite.com/admin/config/system/site-information
* Vérifiez les chemins d'accès sur https://monsite.com/admin/config/media/file-system
* Vérifiez que votre installation et vos modules sont à jour sur https://monsite.com/admin/reports/status
* Activez éventuellement les informations de cache lorsque vous passerez en production : https://monsite.com/admin/config/development/performance
Logiquement, vous devriez pouvoir commencer à utiliser votre instance de Framaforms.
English version
==================
(not ready :-/ Why not help us to translate this file?)
Framaforms
==============
([English version available here](README-en.md))
Description
===============
Framaforms est un logiciel de création de formulaires en ligne.
Lire https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ et https://framablog.org/2016/10/05/en-savoir-un-peu-plus-sur-le-projet-framaforms/ pour plus d'informations.
Current version
================
1.0 - 20180402
Changelog
============
Un changelog sommaire est disponible sur https://framagit.org/framasoft/framaforms/wikis/logbook
Framaforms helps you create online webforms and surveys.
See https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ (in French ) and https://framablog.org/2016/10/05/en-savoir-un-peu-plus-sur-le-projet-framaforms/ (in French) for further informations.
Utilisation
Usage
=============
Il n'existe pas encore d'aide pour Framaforms. Vous pouvez cependant lire https://framaforms.org/fonctionnalites et https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ pour plus d'informations.
There isn't yet help for Framaforms. Nevertheless, you can read https://framaforms.org/fonctionnalites (in french) and https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ for further information.
Installation
=================
Framaforms est basé à 99% sur Drupal 7, accompagné de différents modules (notamment le module webform).
Framaforms is based at 99% on Drupal 7, with some modules (like webform).
Le niveau technique pour l'installer n'est pas très élevé, mais l'installation est tout de même plus complexe que l'installation d'un Drupal "standard".
You don't need technical skills, but installation is a little bit more complicated than standard Drupal installation.
Pour des raisons de performances, Framaforms utilise postgresql comme BDD, ce qui posait probleme pour en faire une "distribution" <https://www.drupal.org/docs/7/distributions>.
For performance reasons, Framaforms use postgresql databse which caused issues for making it a "[distribution](https://www.drupal.org/docs/7/distributions)"
## Prérequis
* PHP 7+ (peut fonctionner avec des versions antérieures, mais PHP7 recommandé pour des raisons de performances)
* Nginx (peut fonctionner avec Apache)
* postgresql 9.4.12 (ou +)
* extension php mb_string pour php7 ( sudo apt-get install php7.0-mbstring )
* un dossier web accessible et fonctionnel
## Prerequisite
* PHP 7+ (may works with previous version, but php7 is recommended for performance reason)
* Nginx (may works with Apache)
* postgresql 9.4.12 (or +)
* php extension mb_string for php7 ( ``sudo apt-get install php7.0-mbstring`` )
* a reachable web directory
## Base de données
* Créer un utilisateur, une base de données, et attribuer les droits nécéssaires à cet utilisateur sur cette base. Ex: http://www.sakana.fr/blog/2007/06/06/postgresql-create-a-user-a-database-and-grant-accesses/
* pour la suite, nous prendrons comme exemple le user "framaforms_user" et comme BDD "framaforms"
* Télécharger la BDD d'initialisation de Framaforms : https://framagit.org/framasoft/framaforms/raw/master/framaforms.sql (pour la branche "master", ou http://framaforms.org/framaforms.sql). NB : le fichier fait environ environ 20Mo.
* Importer cette base de données (à faire avec l'utilisateur système "postgres"
## database
* create an user, a database and grant this user correct rights. See http://www.sakana.fr/blog/2007/06/06/postgresql-create-a-user-a-database-and-grant-accesses/
* next we will use ``framaforms_user`` as user and ``framaforms`` as database
* download initialization Framafoms database : http://framaforms.org/framaforms.sql (~ 20Mo)
* import this database (using ``postgres`` user)
* `psql -U framaforms_user -W -h 127.0.0.1 framaforms < /path/to/framaforms.sql`
* NB : si vous devez réimporter la base d'initialisation, il est conseillé de détruire puis recréer la BDD avant importation : `dropdb framaforms;createdb --encoding=UTF8 --owner=framaforms_user framaforms`
* if you need to reimport the database, it is recommended to destroy and recreate the database before import: `dropdb framaforms;createdb --encoding=UTF8 --owner=framaforms_user framaforms`
## Fichiers
## Files
* faire un `git clone https://framagit.org/framasoft/framaforms.git` dans le dossier web de votre choix
* assurez-vous d'appliquer les bons droits utilisateur (chown) et de donner des permissions étendues en lecture/écriture sur /path/to/framaforms/sites/default/files
* créez un dossier qui sera accessible en écriture (mais pas en lecture) à votre utilisateur web. Ex: /path/to/framaforms_private_files/
* configuration de la connexion à la BDD :.
* allez dans le dossier /path/to/framaforms/sites/default/
* copiez le fichier default.settings.php en settings.php
* editez ce fichier et modifiez les information de connexion à la BDD
* type `git clone https://framagit.org/framasoft/framaforms.git` in your web directory
* make sure you apply corret user rights (``chown``) and give extended write/read permissions to /path/to/framaforms/sites/default/files
* create a directory and give it write permission (but not read permission). E.g: /path/to/framaforms_private_files/
* database connection configuration:
* go to /path/to/framaforms/sites/default/
* copy default.settings.php to settings.php
* edit with database connection informations
```php
$databases = array (
......@@ -77,7 +68,7 @@ Pour des raisons de performances, Framaforms utilise postgresql comme BDD, ce qu
);
```
* profitez en pour ajouter la possibilité d'inclure vos formulaires dans des iframes en toute fin de fichier
* You can add an option to include forms in iframe by appending this to the file:
```php
/**
......@@ -87,21 +78,16 @@ Pour des raisons de performances, Framaforms utilise postgresql comme BDD, ce qu
$conf['x_frame_options'] = '';
```
## Accéder au site
A ce stade, vous devriez (si tout va bien) accéder à votre site (par exemple sur monsite.com) .
* Rendez-vous sur https://monsite.com/
* Connectez vous avec l'identifiant "admin" et le mot de passe "changemeASAP!"
* IMPORTANT : Modifiez votre mot de passe administrateur :)
* Editez les infos de https://monsite.com/admin/config/system/site-information
* Vérifiez les chemins d'accès sur https://monsite.com/admin/config/media/file-system
* Vérifiez que votre installation et vos modules sont à jour sur https://monsite.com/admin/reports/status
* Activez éventuellement les informations de cache lorsque vous passerez en production : https://monsite.com/admin/config/development/performance
## Site access
Logiquement, vous devriez pouvoir commencer à utiliser votre instance de Framaforms.
At the moment, you should (if everything is fine) access your site (e.g.: mysite.com).
* go to mysite.com
* connect with id ``admin`` and password ``changemeASAP!``
* **IMPORTANT**: edit your admin password :)
* edit informations of your site https://monsite.com/admin/config/system/site-information
* check paths https://monsite.com/admin/config/media/file-system
* check your installation and if your modules are up to date https://monsite.com/admin/reports/status
* optionally, activate cache informations for production use https://monsite.com/admin/config/development/performance
English version
==================
(not ready :-/ Why not help us to translate this file?)
Logically, you could now use your framaforms site.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment