558edb931b06f97824ac2d2c3613c830417ef872
[ldapsaisie.git] / doc / conf / srv-ldap.docbook
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <sect3 id="config-srv-ldap">
3   <title>Configuration des serveurs LDAP</title>
4
5 <para>Cette section décrit le tableau de configuration des différents serveurs
6 LDAP utilisés par l'application. Ce tableau contient lui même un tableau par
7 serveur LDAP.</para>
8
9 <programlisting linenumbering="unnumbered">
10   <citetitle>Structure</citetitle>...
11 <![CDATA[$GLOBALS['LSconfig'] = array(
12   ...
13   'ldap_servers' => array(
14     array (
15       'name' => [nom de l'annuaire],
16       'ldap_config'=> array(
17         // Définition des paramètres de connexion à l'annuaire
18       ),
19       'LSauth' => array (
20         'method' => [LSauth method]
21       ),
22       'LSprofiles' => array (
23         // Définition des LSprofiles
24       ),
25       'cacheLSprofiles' => [boolean],
26       'cacheSearch' => [boolean],
27       'authObjectType' => [LSobject],
28       'authObjectFilter' => [LSformat],
29       'authObjectTypeAttrPwd' => [attribut],
30       'LSaccess' => array (
31         [Type LSobject 1],
32         [Type LSobject 2],
33         ...
34       ),
35       'subDn' => array(
36         // Définition des sous-niveaux de l'annuaire
37       ),
38       'subDnLabel' => [nom des sous-niveaux],
39       'recoverPassword' => array(
40         // Définition des paramètres de configuration de la récupération de mot de passe
41       ),
42       'emailSender' => [email],
43       'keepLSsessionActive' => [booléen]
44     )
45   ...
46 );]]>
47 ...
48 </programlisting>
49
50 <!-- Début Paramètres Configuration -->  
51 <variablelist>
52 <title>Paramètres de configuration</title>
53
54 <varlistentry>
55   <term>name</term>
56   <listitem>
57     <simpara>Le nom d'affichage de ce serveur Ldap
58     (utilisé lorsque plusieurs serveur LDAP sont déclarés).</simpara>
59   </listitem>
60 </varlistentry>
61
62
63 <varlistentry>
64   <term>ldap_config</term>
65   <listitem>
66     <simpara>Informations de connexion au serveur LDAP. Ces informations sont 
67     structurées selon les attentes de la librairie &netldap;. 
68     <ulink url='http://pear.php.net/manual/fr/package.networking.net-ldap.connecting.php'>
69     Plus d'informations</ulink>
70     </simpara>
71   </listitem>
72 </varlistentry>
73
74
75 <varlistentry>
76   <term>LSprofiles</term>
77   <listitem>
78     <simpara>Définition des profils d'utilisateurs se connectant à l'annuaire.
79     <link linkend="config-LSprofile">Voir la section concernée</link>.
80     </simpara>
81   </listitem>
82 </varlistentry>
83
84
85 <varlistentry>
86   <term>LSauth</term>
87   <listitem>
88     <simpara>Définition de la méthode d'authentification &LSauthMethod;. Pour le
89     moment ce tableau associatif ne contient qu'un paramètre <parameter>
90     method</parameter> qui correpond au nom de la librairie d'authentification.
91     Exemple : pour utiliser la classe <literal>LSauthMethod_HTTP</literal>, la
92     valeur du paramètre <parameter>method</parameter> sera <literal>HTTP</literal>.
93     </simpara>
94   </listitem>
95 </varlistentry>
96
97
98 <varlistentry>
99   <term>cacheLSprofiles</term>
100   <listitem>
101     <simpara>Activation/Désactivation de la mise en cache des &LSprofiles; des 
102     utilisateurs connectés à ce serveur.</simpara>
103   </listitem>
104 </varlistentry>
105
106
107 <varlistentry>
108   <term>cacheSearch</term>
109   <listitem>
110     <simpara>Activation/Désactivation de la mise en cache du résultat des 
111     recherches sur ce serveur.</simpara>
112   </listitem>
113 </varlistentry>
114
115
116 <varlistentry>
117   <term>authObjectType</term>
118   <listitem>
119     <simpara>Nom du type d'&LSobject; pouvant être utilisé pour authentifier un 
120     utilisateur se connectant à l'interface.</simpara>
121   </listitem>
122 </varlistentry>
123
124
125 <varlistentry>
126   <term>authObjectFilter</term>
127   <listitem>
128     <simpara>&LSformat; du filtre de recherche de l'utilisateur à sa connexion.
129     Le LSformat sera composé avec la valeur de l'information fourni par l'utilisateur.
130     Cela peut pemettre par exemple de permettre à l'utilisateur de se connecter en 
131     fournissant soit son login, soit son email. Exemple de valeur : 
132     <literal>(|(uid=%{user})(mail=%{user}))</literal></simpara>
133   </listitem>
134 </varlistentry>
135
136
137 <varlistentry>
138   <term>authObjectTypeAttrPwd</term>
139   <listitem>
140     <simpara>Nom de l'attribut "mot de passe" du type d'&LSobject; utilisé pour 
141     l'authentification des utilisateurs se connectant à l'interface.</simpara>
142   </listitem>
143 </varlistentry>
144
145
146 <varlistentry id="config-LSaccess">
147   <term>LSaccess</term>
148   <listitem>
149     <simpara>Définition des types d'&LSobjects; devant apparaître dans le menu de 
150     l'interface.</simpara>
151     <important><simpara>Ce paramètre n'est utilisé que pour les annuaires n'ayant 
152     pas de sous-niveaux (&subDn;).</simpara></important>
153   </listitem>
154 </varlistentry>
155
156
157 <varlistentry>
158   <term>subDn</term>
159   <listitem>
160     <simpara>Définition des sous-niveaux de connexion à l'annuaire.
161     <link linkend="config-subDn">Voir section concernée</link>.</simpara>
162     <important><simpara>Ce paramètre remplace le paramètre 
163     <link linkend="config-LSaccess">LSaccess</link> dans le cas d'un annuaire 
164     multi-niveaux.</simpara></important>
165   </listitem>
166 </varlistentry>
167
168
169 <varlistentry>
170   <term>subDnLabel</term>
171   <listitem>
172     <simpara>Définition du label utilisé pour qualifier les sous-niveaux de
173     connexion.</simpara>
174     <important><simpara>Ce paramètre est utile uniquement dans le cas d'un annuaire 
175     multi-niveaux.</simpara></important>
176   </listitem>
177 </varlistentry>
178
179
180 <varlistentry>
181   <term>recoverPassword</term>
182   <listitem>
183     <simpara>Définition des paramètres de la récupération de mot de passe.
184     <link linkend="config-recoverPassword">Voir la section concernée</link>.</simpara>
185   </listitem>
186 </varlistentry>
187
188
189 <varlistentry>
190   <term>emailSender</term>
191   <listitem>
192     <simpara>Adresse mail utilisée par &LdapSaisie; pour envoyer des e-mails en 
193     relation avec cet annuaire. Cette adresse est celle utilisée par défaut. 
194     L'adresse utilisée peut également être configurée dans le contexte de
195     configuration du module devant envoyer des e-mails.</simpara>
196   </listitem>
197 </varlistentry>
198
199 <varlistentry>
200   <term>keepLSsessionActive</term>
201   <listitem>
202     <simpara>Activation/Désactivation du maintient de la LSsession active.</simpara>
203     <simpara>Valeurs possibles : <emphasis>True</emphasis> ou 
204     <emphasis>False</emphasis></simpara>
205   </listitem>
206 </varlistentry>
207
208
209 </variablelist>
210 <!-- Fim Paramètres Configuration -->
211
212 &conf-LSprofile;
213
214 &conf-subDn;
215
216 &conf-recoverPassword;
217
218 </sect3>