- functions :
[ldapsaisie.git] / doc / install / install.docbook
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <chapter>
3
4 <title>Installation</title>
5
6 <sect1>
7   <title>Pré-requis</title>
8   <itemizedlist>
9     <listitem><simpara>&php; 5 avec <parameter>magic_quotes_gpc</parameter> à <literal>off</literal></simpara></listitem>
10     <listitem><simpara>Le support <application>LDAP</application> dans &php; (paquet php5-ldap dans <application>Debian</application>)</simpara></listitem>
11     <listitem><simpara>Le support <application>mhash</application> dans &php; (paquet php5-mash dans <application>Debian</application>)</simpara></listitem>
12     <listitem><simpara>&netldap;</simpara></listitem>
13     <listitem><simpara>&smarty;</simpara></listitem>
14     <listitem><simpara>L'utisateur exécutant le serveur web doit avoir les droits d'écriture sur le dossier 'tmp'.</simpara></listitem>
15   </itemizedlist>
16   <warning><simpara>La librairie &netldap; oblige le fait que la racine DSE de
17   l'annuaire soit lisible en anonyme sinon la connexion à l'annuaire échouera
18   systématiquement.</simpara></warning>
19 </sect1>
20
21 <sect1 id="install-download">
22   <title>Téléchargement</title>
23   <para>Il n'existe pas encore de version stable publiée. Vous pouvez obtenir le
24   code source soit en le rapatriant à partir du serveur Subversion, soit en téléchargeant
25   le dernier snapshot nocturne de l'arbre Subversion.
26   </para>
27   
28   <sect2>
29     <title>A partir de Subversion</title>
30     <para>Le dépôt Subversion peut être récupéré anonymement en utilisant la
31     commande suivante :
32     <screen>
33       <command>svn checkout svn://labs.libre-entreprise.org/svnroot/ldapsaisie</command>
34     </screen> 
35     La racine web de l'application se trouvera alors dans le dossier <emphasis>
36     /ldapsaisie/trunk/</emphasis>.
37     </para>
38   </sect2>
39
40   <sect2>
41     <title>A partir des snapshot</title>
42     <para>Toutes les nuits, un snapshot de l'arbre Subversion est réalisé et est
43     téléchargeable au format <emphasis>tar.gz</emphasis> à l'adresse suivante : 
44     <ulink url='http://labs.libre-entreprise.org/snapshots.php?group_id=118'>
45     http://labs.libre-entreprise.org/snapshots.php?group_id=118</ulink>
46     </para>
47   </sect2>
48   
49 </sect1>
50
51 &install-arbo;
52
53 <sect1>
54   <title>Les étapes de l'installation</title>
55   <para>Cette section décrit rapidement les différentes étapes de l'installation
56   de LdapSaisie.</para>
57   
58 <orderedlist>
59   <listitem><simpara>Téléchargement et décompression si nécessaire. 
60   <link linkend="install-download">Plus de détails</link></simpara></listitem>
61   
62   <listitem><simpara>Configuration globale : Cette partie est principalement 
63   contenue dans le fichier <emphasis>conf/config.inc.php</emphasis>. Il s'agit en
64   particulier de configurer la connexion à votre annuaire. Pour plus de détails,
65   reportez-vous à <link linkend="config-globale">la section concernée</link>.
66   </simpara>
67   <note><simpara>Il est possible de passer l'application en mode <emphasis>debug
68   </emphasis> ce qui peut être utile par la suite.</simpara></note>
69   </listitem>
70   
71   <listitem><simpara>Configuration des types de &LSobjects; : Chaque type d'objet
72     manipulé par LdapSaisie doit correspondre avec un type de LSobject.</simpara>
73     
74     <orderedlist>
75     
76     <listitem><para>Création du fichier de classe : Ce fichier contient la 
77     déclaration de la classe PHP correspondant au type de LSobject. Cette classe
78     étend la classe <emphasis>LSldapObject</emphasis> qui contient pour ainsi dire
79     toute les méthodes et proprités nécessaires pour les types de LSobject simples
80     (sans &LSrelation;). Les fichiers des classes sont contenus dans le dossier
81     <emphasis>/includes/class/</emphasis> et portent les noms composés de la 
82     manière suivante : 
83     <programlisting>class.LSobjects.[nom du type d'LSobject].php</programlisting>
84     Le plus simple pour cette étape est de recopier un des fichiers d'exemple et
85     de l'adapter en changeant le nom du type d'objet dans l'ensemble du fichier.
86     Pour cela, le fichier de classe du type <emphasis>LSeepeople</emphasis> est 
87     le plus simple car il ne contient que le strict minimum.</para></listitem>
88     
89     <listitem><simpara>Configurer vos LSobject : Cette partie est certainement la
90     plus longue et consiste à déclarer l'ensemble des informations relatives aux
91     types des objets LDAP manipulés. Les fichiers d'exemples fournis vous seront
92     certainement d'une aide précieuse. Pour plus de détails, reportez-vous à 
93     <link linkend="config-LSobject">la section concernée</link>.</simpara>
94     </listitem>
95     
96     <listitem><simpara>Configurer si nécessaire les relations entre les objets
97     appelés &LSrelations;. Cette opération consiste dans un premier temps à écrire
98     les méthodes PHP nécessaires pour gérer ces relations : pour cela regardez le
99     fichier de classe du type <emphasis>LSeegroup</emphasis>. Il faudra ensuite
100     déclarer ces relations dans la configuration des types d'LSobjects : Pour plus
101     de détails, reportez-vous à <link linkend="config-LSobject-LSrelation">la 
102     section concernée</link>.</simpara>
103     </listitem>
104     
105   </orderedlist>
106   
107   </listitem>
108   
109   <listitem><simpara>Personnaliser l'interface : Il est possible de personnaliser
110   à votre goût l'interface en écrivant votre template ou en modifiant simplement
111   les fichiers CSS. Une partie de cette documentation concernera bientôt cette
112   problématique. Patience...</simpara></listitem>
113   
114 </orderedlist>
115 </sect1>
116  
117 </chapter>