$Id: readme.txt,v 1.8 2009-12-30 11:25:30 fraynaud Exp $
=========================================
Toute la documentation d'openMairie sur: 
http://www.openmairie.org
=========================================

Pre requis :
============
Vous devez avoir installer:
- un serveur apache et php
- une base de donnees : mysql ou postgresql

En fait, reportez vous aux installations de :
- sous windows : wamp (http://www.wampserver.com/) ou easyphp(http://easyphp.fr/)
- sous linux : lamp

Dans le cas de postgresql, vous devez aussi installer postgresql
(http://www.postgresqlfr.org/)

Si vous debutez, il est plus simple de garder mysql qui est packagee avec
easyphp ou wamp.

Il est possible de faire une installation simplifiee(1)

Cette installation est interressante :
- si vous voulez faire un essai rapide
- si vous n avez pas d autres applications openMairie
- si vous souhaitez mettre en place openexemple chez votre fournisseur d acces
   (attention il faut avoir un acces a une base de donnees mysql ou pgsql)

L installation traditionnelle avec les dependances reste possible (2), elle est a
preferer si vous avez la maitrise de votre serveur.

Vous pouvez parametrer votre recherche globale (3)
Enfin, quelques liens sur des documentations fonctionnelles openexemple (4)

Parametrege var.inc (5)

1- Installation simplifiee [par defaut]
   =========================

1.1 - Installation de openmairie_exemple
   copier le repertoire openmairie_exemple sur votre serveur
   exemples
        wamp/www/openmairie_exemple
        sous linux (debian) : var/www/openmairie_exemple

1.2 - Initialisation de la base en MySQL ou postgresql

    creer la base openexemple sur mysql ou pgsql

    Ensuite, il faut creer les tables de la base de donnees
    puis executer les scripts SQL suivants :
    - en mysql :
    openmairie_exemple/data/mysql/init.sql
    - en pgsql
    openmairie_exemple/data/pgsql/init.sql

la premiere initialisation se fait avec init.sql
les modifications de version se font avec ver numero-de-version
exemple: pour passer a la version 1.08 : ver1.08.sql

1.3 parametrer la connexion dans /dyn/base.php

parametrage par defaut :

* collectivite 1 (sur mysql) : coll[1] est un tableau php qui contient les parametres
de connexion suivants
    'titre => 'openexemple (mysql)',[parametrage openexemple]
    'phptype'  => 'mysql', [ne pas changer parametrage dbpear]
    'dbsyntax' => '',[ne pas changer parametrage dbpear]
    'username' => 'root', [par defaut sur wamp easyphp ou lamp /
                           a voir avec le fournisseur d acces le cas echeant]
    'password' => '' [par defaut sur wamp easyphp ou lamp /
                        a voir avec le fournisseur d acces le cas echeant]
    'protocol' => '',
    'hostspec' => 'localhost', [nom de serveur par defaut wamp ou easyphp]
    'port'     => '',  [ne pas changer parametrage dbpear]
    'socket'   => '',  [ne pas changer parametrage dbpear]
    nom de la base => 'openexemple', [parametrage openexemple]
    format date par defaut =>'AAAA-MM-JJ' [[parametrage openexemple ne pas changer]

* collectivite 2 (sur mysql) : coll[2] est un tableau php qui contient les parametres
de connexion suivants
    'titre => 'openexemple (pgsql)',[parametrage openexemple]
    'phptype'  => 'pgsql', [ne pas changer parametrage dbpear]
    'dbsyntax' => 'pgsql',[ne pas changer parametrage dbpear]
    'username' => 'postgres', [par defaut install postgres /
                           a voir avec le fournisseur d acces le cas echeant]
    'password' => 'postgres' [par defaut install postgres/
                        a voir avec le fournisseur d acces le cas echeant]
    'protocol' => 'tcp',
    'hostspec' => 'localhost', [nom de serveur par defaut wamp ou easyphp]
    'port'     => '5432',  [ne pas changer parametrage dbpear]
    'socket'   => '',  [ne pas changer parametrage dbpear]
    nom de la base => 'openexemple', [parametrage openexemple]
    format date par defaut =>'AAAA-MM-JJ' [[parametrage openexemple ne pas changer]




ATTENTION :
Ne pas oublier de faire une sauvegarde du repertoire /trs ou sont stockees toutes
les donnees numerisees (photos, arretes, autorisation ...)

Sous linux mettre les droits d ecriture (voir 2.5)
Mise en place du logo (voir 2.6)



2. Installation d'openexemple avec les dependances
   =================================================

Cette installation est plus complexe a mettre en oeuvre par contre elle est plus
coherente par rapport a un serveur apache si plusieurs applications utilisent
les memes composants.

Vous pouvez vous reporter sur le document plus complet de l adullact a l adresse suivante
http://openmairie.org/documentation/installation


2.1 -  installer les 3 librairies (obligatoires)
exemple avec wamp ou linux (ubuntu ou debian)
  pear : wamp/php/pear usr/share/php/PEAR
           PEAR Base System PHP : http://pear.php.net/package/PEAR
           pear db  :  http://www.pear.php.net/package/DB
  fpdf  : wamp/php/fpdf   usr/share/fpdf 
           http://www.fpdf.org
  openmairie : wamp/php/openmairie ou usr/share/php/openmairie 
    http://www.openmairie.org 
    version >= 2.01

2.2 - modifier le chemin dans php.ini

* exemple sous windows avec wamp5
    include_path= ".;c:\wamp\php\includes;c:\wamp\php\pear;c:\wamp\php\fpdf;c:\wamp\php\openmairie"
* exemple avec linux (version debian ou ubuntu : etc/php5/apache2/php.ini):
include_path = ".:/usr/share/php:/usr/share/php/openmairie:/usr/share/fpdf"

2.3 - Installation de openmairie_exemple
* copier le repertoire openmairie_exemple sur votre serveur

   exemples

        wamp/www/openmairie_exemple
        sous linux (debian) : var/www/openmairie_exemple


2.4 - Initialisation de la base en MySQL

    creer la base openexemple
    puis executer les scripts SQL suivants :

    * avec mysql
    openmairie_exemple/data/mysql/init.sql = creation des tables (obligatoire)

    * ou avec postgre
    openmairie_exemple/data/pgsql/init.sql = creation des tables (obligatoire)
    parametrer la connexion dans /dyn/base.php

    * dans dyn/var.inc mettre les variables suivante a vide
    $path_fpdf, $path_om, $path_pear


    la premiere initialisation se fait avec init.sql
    les modifications de version se font avec ver numero-de-version
    exemple: pour passer a la version 1.08 : ver1.08.sql    






2.5- Sous linux : mettre les droits d ecriture pour apache (www-data)
            
        * Repertoire trs : transfert de fichier
            /var/www/openmairie_exemple$ sudo chown www-data:www-data trs
            /var/www/openmairie_exemple$ sudo chmod 755 trs  
        * Repertoire tmp : ecriture des resultats de traitement
            /var/www/openmairie_exemple$ sudo chown www-data:www-data tmp
        * Repertoire sql/mysql/  ecriture modification des etats et sous etats 
            /var/www/openmairie_exemple$ sudo chown www-data:www-data mysql 
            /var/www/openmairie_exemple$ sudo chown www-data:www-data mysql
        * Repertoire sql/pgsql/  ecriture modification des etats et sous etats
            /var/www/openmairie_exemple$ sudo chown www-data:www-data pgsql
            /var/www/openmairie_exemple$ sudo chown www-data:www-data pgsql
            
            (distribution debian ou ubuntu)



2.6 logo par collectivite

Lettre type et etat :
Pour chaque collectivite mettre le logo dans le trs/coll correspondant
(coll= numero de la collectivite)
Attention le logo doit porte le meme nom qu en trs : ex : logopdf.png
         trs/1   logopdf.png
         trs/2   logopdf.png  ...



3 - recherche globale
    =============

    Le recherche globale est parametrable dans  dyn/var.inc pour optimiser les
    temps de reponse long au demarrage de l appli
     // 1 = calcul toutes occurences puis recherche possible sur saisie
     // 0 = uniquement calcul sur saisie recherche
     $global_flag=1;   (par defaut)


4 Documentation fonctionnelle
  =====================

http://openmairie.org/documentation/



5 Parametage de dyn/var.inc
   ====================

* mode demo 
$demo=1; // login.php mode demo =1 et mode non demo =0
le mode demo desactive le changement de mot de passe (obj/utils.class.php)
et met dans login par defaut demo/demo

* integration recherche globale dans tableau de bord 1 ou 0
$global_tdb=1;

* integration recherche globale dans menu haut 1 ou 0 
$global_haut=1;

* integration choix apparence dans tableau de bord 
$look_tdb=1;

* integration des dependances (pear + fpdf + openmairie)
-> $path_xx = "" => mettre les dependances dans php ex wamp/php ou easy/php
$path_om="";
$path_pear= "";
$path_fpdf="";
-> $path_xx = "../php/xx/ => utiliser les dependances du package 
$path_om="../php/openmairie/";
$path_pear= "../php/pear/";
$path_fpdf="../php/fpdf/";


* internationalisation
$langue="francais"; // francais, anglais, allemand, espagnol

* verrou double validation
$verrou=1; // verrou =1 actif 0= inactif 
(empeche actualisation sur form valide)

===============
 LOGIN PASSWORD
===============
demo/demo
admin/admin
=============