Commit 2b1755a1 authored by root's avatar root

update du README

parent fec7767a
Framaforms
==============
(documentation is mainly in french. Some informations in english at the bottom of this file, you are very welcome to help translating)
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.
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 : http://framaforms.org/framaforms.sql (environ 20Mo)
* Importer cette base de données (à faire avec l'utilisateur système "postgres"
* `psql -U framaforms_users -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
```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?)
CONTENTS OF THIS FILE
---------------------
* About Drupal
* Configuration and features
* Installation profiles
* Appearance
* Developing for Drupal
ABOUT DRUPAL
------------
Drupal is an open source content management platform supporting a variety of
websites ranging from personal weblogs to large community-driven websites. For
more information, see the Drupal website at http://drupal.org/, and join the
Drupal community at http://drupal.org/community.
Legal information about Drupal:
* Know your rights when using Drupal:
See LICENSE.txt in the same directory as this document.
* Learn about the Drupal trademark and logo policy:
http://drupal.com/trademark
CONFIGURATION AND FEATURES
--------------------------
Drupal core (what you get when you download and extract a drupal-x.y.tar.gz or
drupal-x.y.zip file from http://drupal.org/project/drupal) has what you need to
get started with your website. It includes several modules (extensions that add
functionality) for common website features, such as managing content, user
accounts, image uploading, and search. Core comes with many options that allow
site-specific configuration. In addition to the core modules, there are
thousands of contributed modules (for functionality not included with Drupal
core) available for download.
More about configuration:
* Install, upgrade, and maintain Drupal:
See INSTALL.txt and UPGRADE.txt in the same directory as this document.
* Learn about how to use Drupal to create your site:
http://drupal.org/documentation
* Download contributed modules to sites/all/modules to extend Drupal's
functionality:
http://drupal.org/project/modules
* See also: "Developing for Drupal" for writing your own modules, below.
INSTALLATION PROFILES
---------------------
Installation profiles define additional steps (such as enabling modules,
defining content types, etc.) that run after the base installation provided
by core when Drupal is first installed. There are two basic installation
profiles provided with Drupal core.
Installation profiles from the Drupal community modify the installation process
to provide a website for a specific use case, such as a CMS for media
publishers, a web-based project tracking tool, or a full-fledged CRM for
non-profit organizations raising money and accepting donations. They can be
distributed as bare installation profiles or as "distributions". Distributions
include Drupal core, the installation profile, and all other required
extensions, such as contributed and custom modules, themes, and third-party
libraries. Bare installation profiles require you to download Drupal Core and
the required extensions separately; place the downloaded profile in the
/profiles directory before you start the installation process. Note that the
contents of this directory may be overwritten during updates of Drupal core;
it is advised to keep code backups or use a version control system.
Additionally, modules and themes may be placed inside subdirectories in a
specific installation profile such as profiles/your_site_profile/modules and
profiles/your_site_profile/themes respectively to restrict their usage to only
sites that were installed with that specific profile.
More about installation profiles and distributions:
* Read about the difference between installation profiles and distributions:
http://drupal.org/node/1089736
* Download contributed installation profiles and distributions:
http://drupal.org/project/distributions
* Develop your own installation profile or distribution:
http://drupal.org/developing/distributions
APPEARANCE
----------
In Drupal, the appearance of your site is set by the theme (themes are
extensions that set fonts, colors, and layout). Drupal core comes with several
themes. More themes are available for download, and you can also create your own
custom theme.
More about themes:
* Download contributed themes to sites/all/themes to modify Drupal's
appearance:
http://drupal.org/project/themes
* Develop your own theme:
http://drupal.org/documentation/theme
DEVELOPING FOR DRUPAL
---------------------
Drupal contains an extensive API that allows you to add to and modify the
functionality of your site. The API consists of "hooks", which allow modules to
react to system events and customize Drupal's behavior, and functions that
standardize common operations such as database queries and form generation. The
flexible hook architecture means that you should never need to directly modify
the files that come with Drupal core to achieve the functionality you want;
instead, functionality modifications take the form of modules.
When you need new functionality for your Drupal site, search for existing
contributed modules. If you find a module that matches except for a bug or an
additional needed feature, change the module and contribute your improvements
back to the project in the form of a "patch". Create new custom modules only
when nothing existing comes close to what you need.
More about developing:
* Search for existing contributed modules:
http://drupal.org/project/modules
* Contribute a patch:
http://drupal.org/patch/submit
* Develop your own module:
http://drupal.org/developing/modules
* Follow best practices:
http://drupal.org/best-practices
* Refer to the API documentation:
http://api.drupal.org/api/drupal/7
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