4edc44320cf95a5f09a9bcc70053095b78a1e667
[ldapsaisie.git] / doc / conf / globale.docbook
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <sect1 id='config-globale'>
3   <title>Configuration globale</title>
4   <para>
5     La plus grande partie de la configuration globale se trouve dans le fichier 
6     <filename>config.inc.php</filename>.
7   </para>
8   
9 <programlisting linenumbering="unnumbered">
10   <citetitle>Structure</citetitle>
11 <![CDATA[// Variables globales
12 $GLOBALS['LSconfig'] = array(
13   // Variables globales
14 );
15
16 // Variables et constantes indépendantes
17 $var1 = 'val1'
18 $var2 = 'val2'
19 ...
20 define('CONST1','val1')
21 define('CONST2','val2')
22 ...
23 ?>]]>
24 </programlisting>
25
26 <sect2>
27 <title>Variables globales</title>
28
29 <!-- Début Variables globales -->
30 <variablelist>
31
32 <varlistentry>
33   <term>NetLDAP2</term>
34   <listitem>
35     <simpara>Chemin vers la librairie PEAR &netldap;.</simpara>
36     <informalexample>
37       <programlisting><![CDATA[/usr/share/php/Net/LDAP2.php]]></programlisting>
38     </informalexample>
39   </listitem>
40 </varlistentry>
41
42
43 <varlistentry>
44   <term>Smarty</term>
45   <listitem>
46     <simpara>Chemin vers le moteur de template &smarty;.</simpara>
47     <informalexample>
48       <programlisting><![CDATA[/usr/share/php/smarty/libs/Smarty.class.php]]></programlisting>
49     </informalexample>
50   </listitem>
51 </varlistentry>
52
53
54 <varlistentry>
55   <term>lang</term>
56   <listitem>
57     <simpara>Paramètre utilisé pour l'internationalisation :  code de la langue.</simpara>
58     <informalexample>
59       <programlisting><![CDATA[fr_FR]]></programlisting>
60       <programlisting><![CDATA[en_US]]></programlisting>
61     </informalexample>
62   </listitem>
63 </varlistentry>
64
65 <varlistentry>
66   <term>encoding</term>
67   <listitem>
68     <simpara>Encodage de caractère.</simpara>
69     <informalexample>
70       <programlisting><![CDATA[UTF8]]></programlisting>
71     </informalexample>
72   </listitem>
73 </varlistentry>
74
75
76 <varlistentry>
77   <term>cacheLSprofiles</term>
78   <listitem>
79     <simpara>Activation/Désactivation de la mise en cache des profils des 
80     utilisateurs connectés (&LSprofiles;).</simpara>
81     <simpara>Valeurs possibles : <literal>True</literal> ou <literal>False</literal></simpara>
82     <simpara>Valeur recommandée : <literal>True</literal></simpara>
83     <important><simpara>Ce paramètre a une action globale mais non prioritaire 
84     sur le comportement de l'application.</simpara></important>
85   </listitem>
86 </varlistentry>
87
88
89 <varlistentry>
90   <term>cacheSubDn</term>
91   <listitem>
92     <simpara>Activation/Désactivation de la mise en cache des niveaux de 
93     connexion (&subDn;) dans l'annuaire.</simpara>
94     <simpara>Valeurs possibles : <emphasis>True</emphasis> ou <emphasis>False</emphasis></simpara>
95     <simpara>Valeur recommandée : <emphasis>True</emphasis></simpara>
96     
97     <important><simpara>Ce paramètre a une action globale mais non prioritaire 
98     sur le comportement de l'application.</simpara></important>
99   </listitem>
100 </varlistentry>
101
102
103 <varlistentry>
104   <term>cacheSearch</term>
105   <listitem>
106     <simpara>Activation/Désactivation de la mise en cache du résultat des 
107     recherches dans l'annuaire.</simpara>
108     <simpara>Valeurs possibles : <emphasis>True</emphasis> ou 
109     <emphasis>False</emphasis></simpara>
110     <simpara>Valeur recommandée : <emphasis>True</emphasis></simpara>
111     
112     <important><simpara>Ce paramètre a une action globale mais non prioritaire 
113     sur le comportement de l'application.</simpara></important>
114   </listitem>
115 </varlistentry>
116
117
118 <varlistentry>
119   <term>keepLSsessionActive</term>
120   <listitem>
121     <simpara>Activation/Désactivation du maintient de la LSsession active.</simpara>
122     <simpara>Valeurs possibles : <emphasis>True</emphasis> ou 
123     <emphasis>False</emphasis></simpara>
124     
125     <important><simpara>Ce paramètre a une action globale mais non prioritaire 
126     sur le comportement de l'application.</simpara></important>
127   </listitem>
128 </varlistentry>
129
130
131 <varlistentry>
132   <term>ldap_servers</term>
133   <listitem>
134     <simpara>Configuration des serveurs LDAP. 
135     <link linkend="config-srv-ldap">Voir section concernée</link>.</simpara>
136   </listitem>
137 </varlistentry>
138
139 </variablelist>
140
141 &conf-srv-ldap;
142
143 </sect2>
144
145 <sect2>
146 <title>Variables et constantes indépendantes</title>
147
148 <!-- Début Variables globales -->
149 <variablelist>
150
151 <varlistentry>
152   <term>LS_THEME</term>
153   <listitem>
154     <simpara>Constante déterminant le nom du theme utilisé.</simpara>
155     <simpara>Valeur par défaut : <emphasis>default</emphasis></simpara>
156   </listitem>
157 </varlistentry>
158
159 <varlistentry>
160   <term>LS_TEMPLATES_DIR</term>
161   <listitem>
162     <simpara>Constante déterminant le chemin du dossier des templates.</simpara>
163     <simpara>Valeur par défaut : <emphasis>templates</emphasis></simpara>
164   </listitem>
165 </varlistentry>
166
167 <varlistentry>
168   <term>LS_IMAGES_DIR</term>
169   <listitem>
170     <simpara>Constante déterminant le chemin du dossier des images.</simpara>
171     <simpara>Valeur par défaut : <emphasis>images</emphasis></simpara>
172   </listitem>
173 </varlistentry>
174
175 <varlistentry>
176   <term>LS_CSS_DIR</term>
177   <listitem>
178     <simpara>Constante déterminant le chemin du dossier des CSS.</simpara>
179     <simpara>Valeur par défaut : <emphasis>css</emphasis></simpara>
180   </listitem>
181 </varlistentry>
182
183 <varlistentry>
184   <term>LSdebug</term>
185   <listitem>
186     <simpara>Variable booléenne déterminant si le mode debug est activé.</simpara>
187   </listitem>
188 </varlistentry>
189
190 <varlistentry>
191   <term>$GLOBALS['LSlog']['enable']</term>
192   <listitem>
193     <simpara>Variable booléenne déterminant si les logs sont activés.</simpara>
194   </listitem>
195 </varlistentry>
196
197 <varlistentry>
198   <term>$GLOBALS['LSlog']['filename']</term>
199   <listitem>
200     <simpara>Variable déterminant le chemin du fichier de log.</simpara>
201     <simpara>Valeur par défaut : <emphasis>/tmp/LS.log</emphasis></simpara>
202   </listitem>
203 </varlistentry>
204
205 <varlistentry>
206   <term>NB_LSOBJECT_LIST</term>
207   <listitem>
208     <simpara>Constante déterminant le nombre d'objet affichés par page de résultat
209     de recherche.</simpara>
210   </listitem>
211 </varlistentry>
212
213 <varlistentry>
214   <term>NB_LSOBJECT_LIST_SELECT</term>
215   <listitem>
216     <simpara>Constante déterminant le nombre d'objet affichés par page de résultat
217     de recherche dans une fenêtre &LSselect;.</simpara>
218   </listitem>
219 </varlistentry>
220
221 <varlistentry>
222   <term>MAX_SEND_FILE_SIZE</term>
223   <listitem>
224     <simpara>Constante déterminant la taille maximale d'un fichier envoyé à travers
225     les formulaires.</simpara>
226   </listitem>
227 </varlistentry>
228
229 <varlistentry>
230   <term>$GLOBALS['defaultJSscipts']</term>
231   <listitem>
232     <simpara>Tableau déterminant les fichiers Javascript à charger sur toute les pages.</simpara>
233   </listitem>
234 </varlistentry>
235
236 <varlistentry>
237   <term>$GLOBALS['defaultCSSfiles']</term>
238   <listitem>
239     <simpara>Tableau déterminant les fichiers CSS à charger sur toute les pages. Ces fichiers seront
240     chargés dans l'ordre et en dernier permettant de surcharger tous paramètres de style.</simpara>
241   </listitem>
242 </varlistentry>
243
244 </variablelist>
245
246 </sect2>
247
248 &conf-LSformat;
249 &conf-LDAP_search_params;
250
251 </sect1>