Doc : updated documentation with the new file tree and git scm
[ldapsaisie.git] / public_html / INSTALL
1  INSTALLATION
2 ===================
3
4 1. Pré-requis
5 =============
6
7     * PHP 5 avec magic_quotes_gpc à off
8     * Le support LDAP dans PHP (paquet php5-ldap dans Debian)
9     * Le support mhash dans PHP (paquet php5-mash dans Debian)
10     * Net_LDAP2
11     * Smarty
12     * L'utisateur exécutant le serveur web doit avoir les droits d'écriture sur le dossier 'tmp'.
13
14 [Avertissement]
15
16 La librairie Net_LDAP2 oblige le fait que la racine DSE de l'annuaire soit lisible en anonyme sinon la connexion à l'annuaire échouera systématiquement.
17
18
19 2. Téléchargement
20 =================
21
22 Il n'existe pas encore de version stable publiée. Vous pouvez obtenir le code source soit en le rapatriant à partir du serveur Git, soit en téléchargeant le dernier snapshot nocturne de l'arbre Git.
23
24 2.1. A partir de Git
25 ~~~~~~~~~~~~~~~~~~~~
26
27 Le dépôt Git peut être récupéré anonymement en utilisant la commande suivante :
28
29       git clone git://git.labs.libre-entreprise.org/ldapsaisie.git
30     
31
32 La racine web de l'application se trouvera alors dans le dossier /ldapsaisie/public_html/.
33
34 2.2. A partir des snapshot
35 ~~~~~~~~~~~~~~~~~~~~~~~~~~
36
37 Toutes les nuits, un snapshot de l'arbre Git est réalisé et est téléchargeable au format tar.gz à l'adresse suivante : http://labs.libre-entreprise.org/snapshots.php?group_id=118
38
39
40 3. Arborescence du projet
41 =========================
42
43 Racine
44
45 doc/
46     Les fichiers sources de la documentation (docbook).
47
48 lsexample/
49     Les fichiers relatifs à l'annuaire d'exemple.
50
51 public_html /
52     
53     conf/
54     
55         Contient les fichiers de configuration.
56     
57         LSobjects/
58             Configuration des LSobjets.
59         LSaddons/
60             Configuration des LSaddons.
61     
62     includes/
63     
64         Contient les fichiers des ressources.
65     
66         addons/
67             Les addons au projet.
68         class/
69             Les fichiers de définition des classes PHP.
70         js/
71             Les fichiers Javascript.
72         libs/
73             Les librairies utilisées.
74     
75     lang/
76         Les fichiers d'internationalisation.
77     templates/
78         Les fichiers template de l'interface. Il y a un sous-dossier par template.
79     css/
80         Les fichiers css de l'interface. Il y a un sous-dossier par template CSS.
81     images/
82         Les images de l'interface. Il y a un sous-dossier par template d'image.
83     tmp/
84         Les fichiers temporaires (y compris le cache des templates).
85
86
87 4. Les étapes de l'installation
88 ===============================
89
90 Cette section décrit rapidement les différentes étapes de l'installation de LdapSaisie.
91
92    1. Téléchargement et décompression si nécessaire. (Cf : 2. Téléchargement)
93
94    2. Configuration globale : Cette partie est principalement contenue dans le fichier conf/config.inc.php. Il s'agit en particulier de configurer la connexion à votre annuaire. Pour plus de détails, consulter la documentation du projet. [1]
95
96       [Note]
97       Il est possible de passer l'application en mode debug ce qui peut être utile par la suite.
98
99    3. Configuration des types de LSobjects : Chaque type d'objet manipulé par LdapSaisie doit correspondre avec un type de LSobject.
100
101          1. Création du fichier de classe : Ce fichier contient la déclaration de la classe PHP correspondant au type de LSobject. Cette classe étend la classe LSldapObject qui contient pour ainsi dire toute les méthodes et proprités nécessaires pour les types de LSobject simples (sans LSrelation). Les fichiers des classes sont contenus dans le dossier /includes/class/ et portent les noms composés de la manière suivante :
102
103             class.LSobjects.[nom du type d'LSobject].php
104
105             Le plus simple pour cette étape est de recopier un des fichiers d'exemple et de l'adapter en changeant le nom du type d'objet dans l'ensemble du fichier. Pour cela, le fichier de classe du type LSpeople est le plus simple car il ne contient que le strict minimum.
106
107          2. Configurer vos LSobject : Cette partie est certainement la plus longue et consiste à déclarer l'ensemble des informations relatives aux types des objets LDAP manipulés. Les fichiers d'exemples fournis vous seront certainement d'une aide précieuse. Pour plus de détails, consulter la documentation du projet. [1]
108
109          3. Configurer si nécessaire les relations entre les objets appelés LSrelations. Cette opération consiste dans un premier temps à écrire les méthodes PHP nécessaires pour gérer ces relations : pour cela regardez le fichier de classe du type LSgroup. Il faudra ensuite déclarer ces relations dans la configuration des types d'LSobjects : Pour plus de détails, consulter la documentation du projet. [1]
110
111    4. Personnaliser l'interface : Il est possible de personnaliser à votre goût l'interface en écrivant votre template ou en modifiant simplement les fichiers CSS. Une partie de cette documentation concernera bientôt cette problématique. Patience...
112
113 Liens
114 =====
115  1. Documentation du projet : http://ldapsaisie.easter-eggs.org/doc