Revision f6e5b0c6
Doc admin pour VigiGraph.
Change-Id: I9739bedea456f27dfd9769a40f40f23f45b0c984
Reviewed-on: https://vigilo-dev.si.c-s.fr/review/552
Tested-by: Build system <qa@vigilo-dev.si.c-s.fr>
Reviewed-by: Francois POIROTTE <francois.poirotte@c-s.fr>
doc/admin.rst | ||
---|---|---|
1 |
********************** |
|
2 |
Guide d'administration |
|
3 |
********************** |
|
4 |
|
|
5 |
|
|
6 |
Installation |
|
7 |
============ |
|
8 |
|
|
9 |
Prérequis logiciels |
|
10 |
------------------- |
|
11 |
Afin de pouvoir faire fonctionner VigiGraph, l'installation préalable |
|
12 |
des logiciels suivants est requise : |
|
13 |
|
|
14 |
- python (>= 2.5), sur la machine où VigiGraph est installé |
|
15 |
- Apache (>= 2.2.0), sur la machine où VigiGraph est installé |
|
16 |
- apache-mod_wsgi (>= 2.3), sur la machine où VigiGraph est installé |
|
17 |
- postgresql-server (version 8.3), éventuellement sur une machine distante |
|
18 |
|
|
19 |
Reportez-vous aux manuels de ces différents logiciels pour savoir |
|
20 |
comment procéder à leur installation sur votre machine. |
|
21 |
VigiGraph requiert également la présence de plusieurs dépendances Python. |
|
22 |
Ces dépendances seront automatiquement installées en même temps que le |
|
23 |
paquet de VigiGraph. |
|
24 |
|
|
25 |
Installation du paquet RPM |
|
26 |
-------------------------- |
|
27 |
L'installation de l'application se fait en installant simplement |
|
28 |
le paquet RPM « vigilo-vigigraph ». La procédure exacte d'installation |
|
29 |
dépend du gestionnaire de paquets utilisé. |
|
30 |
Les instructions suivantes décrivent la procédure pour les gestionnaires |
|
31 |
de paquets RPM les plus fréquemment rencontrés. |
|
32 |
|
|
33 |
Installation à l'aide de urpmi :: |
|
34 |
|
|
35 |
urpmi vigilo-vigigraph |
|
36 |
|
|
37 |
Installation à l'aide de yum :: |
|
38 |
|
|
39 |
yum install vigilo-vigigraph |
|
40 |
|
|
41 |
|
|
42 |
Démarrage et arrêt de VigiGraph |
|
43 |
=============================== |
|
44 |
VigiGraph fonctionne comme un site web standard. À ce titre, il n'est pas |
|
45 |
nécessaire d'exécuter une commande spécifique pour démarrer VigiGraph, |
|
46 |
dès lors que le serveur web qui l'héberge a été lancé, à l'aide de la |
|
47 |
commande :: |
|
48 |
|
|
49 |
service httpd start |
|
50 |
|
|
51 |
De la même manière, il n'y a pas de commande spécifique pour arrêter VigiGraph. |
|
52 |
L'application est arrêtée en même temps que le serveur web, |
|
53 |
à l'aide de la commande : |
|
54 |
service httpd stop |
|
55 |
|
|
56 |
|
|
57 |
Configuration de VigiGraph |
|
58 |
========================== |
|
59 |
La configuration initialement fournie avec VigiGraph est très rudimentaire. |
|
60 |
Elle est décomposée en deux fichiers : |
|
61 |
|
|
62 |
- le fichier « settings.ini » d'une part, qui contient la majorité |
|
63 |
des options de configuration ; |
|
64 |
- et le fichier « app_cfg.py » qui contient des options de configuration |
|
65 |
plus complexes, nécessitant l'utilisation d'un langage |
|
66 |
plus complet (Python). |
|
67 |
|
|
68 |
Ce chapitre a pour but de présenter les différentes options de configuration |
|
69 |
disponibles afin de configurer VigiGraph en fonction de vos besoins. |
|
70 |
Les chapitres à reprennent l'ordre de la configuration utilisé dans |
|
71 |
le fichier « settings.ini » de l'application. Toutes les options de |
|
72 |
configuration citées ici se trouvent sous la section [app:main] du |
|
73 |
fichier « settings.ini ». |
|
74 |
Enfin, le chapitre donne des informations quant à la méthode utilisée |
|
75 |
pour intégrer VigiGraph sur un serveur web de type Apache, grâce au |
|
76 |
module mod_wsgi. |
|
77 |
La configuration de la journalisation des événements se fait également |
|
78 |
au travers du fichier « settings.ini ». Néanmoins, comme ce procédé est commun |
|
79 |
aux différents composants de Vigilo, celui-ci fait l'objet d'une documentation |
|
80 |
séparée dans le document *Vigilo – Journaux d'événements*. |
|
81 |
|
|
82 |
Configuration de la base de données |
|
83 |
----------------------------------- |
|
84 |
Pour fonctionner, VigiGraph nécessite qu'une base de données soit accessible. |
|
85 |
Ce chapitre décrit les options de configuration se rapportant à la base de |
|
86 |
données. |
|
87 |
|
|
88 |
Connexion à la base de données |
|
89 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
90 |
La configuration de la connexion à la base de base de données se fait |
|
91 |
en modifiant la valeur de la clé « sqlalchemy.url » sous la section [app:main]. |
|
92 |
Cette clé contient une URL qui contient tous les paramètres nécessaires |
|
93 |
pour pouvoir se connecter à la base de données. |
|
94 |
Le format de cette URL est le suivant :: |
|
95 |
|
|
96 |
sgbd://nom_utilisateur:mot_de_passe@adresse_serveur:port_serveur/nom_base_de_donnees |
|
97 |
|
|
98 |
Le champ « :port_serveur » est optionnel et peut être omis si vous utilisez |
|
99 |
le port par défaut d'installation du SGBD choisi. |
|
100 |
|
|
101 |
Par exemple, voici la valeur correspondant à une installation mono-poste |
|
102 |
par défaut de VigiGraph : |
|
103 |
|
|
104 |
postgres://vigilo:vigilo@localhost/vigilo |
|
105 |
|
|
106 |
.. warning:: |
|
107 |
À l'heure actuelle, seul PostgreSQL a fait l'objet de tests intensifs. |
|
108 |
D'autres SGBD peuvent également fonctionner, mais aucun support ne sera |
|
109 |
fourni pour ces SGBD. |
|
110 |
|
|
111 |
Choix d'un préfixe pour les tables de la base de données |
|
112 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
113 |
Vous pouvez choisir un préfixe qui sera appliqué aux noms des tables |
|
114 |
de la base de données en indiquant ce préfixe dans la clé « db_basename » |
|
115 |
sous la section [app:main]. Par défaut, la configuration suppose |
|
116 |
que les tables de Vigilo porteront le préfixe « vigilo_ ». |
|
117 |
|
|
118 |
Si vous optez pour l'utilisation d'un préfixe, veillez à ce que celui-ci |
|
119 |
ne contiennent que des caractères alpha-numériques (a-zA-Z0-9) |
|
120 |
ou le caractère « _ ». |
|
121 |
|
|
122 |
Si vous décidez de ne pas utiliser de préfixe, veillez à ce que |
|
123 |
la base de données configurée ne soit utilisée que par Vigilo, |
|
124 |
au risque d'un conflit avec une éventuelle application tierce. |
|
125 |
|
|
126 |
Optimisation de la couche d'abstraction |
|
127 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
128 |
L'option « sqlalchemy.echo » permet de forcer l'affichage des requêtes SQL. |
|
129 |
En production, cette valeur doit être positionnée à « False ». |
|
130 |
Elle est redondante avec la configuration des journaux d'événements |
|
131 |
(voir le document intitulé Vigilo - Journaux d'événements pour plus |
|
132 |
d'information). |
|
133 |
|
|
134 |
L'option « sqlalchemy.echo_pool » permet d'activer le mode de débogage |
|
135 |
du gestionnaire de connexions à la base de données. De même que pour |
|
136 |
l'option « sqlalchemy.echo » ci-dessus, elle doit être positionnée |
|
137 |
à « False » en production. |
|
138 |
|
|
139 |
L'option « sqlalchemy.pool_recycle » permet de définir la durée |
|
140 |
après laquelle une connexion est « recyclée » (recréée). |
|
141 |
|
|
142 |
L'option « sqlalchemy.pool_size » permet de configurer le nombre |
|
143 |
de connexions gérées simultanément par le gestionnaire de connexions |
|
144 |
à la base de données. La valeur recommandée est 20. |
|
145 |
|
|
146 |
L'option « sqlalchemy.max_overflow » permet de limiter le nombre maximal |
|
147 |
de connexions simultanées à la base de données. La limite correspond |
|
148 |
à la somme de « sqlalchemy.pool_size » et « sqlalchemy.max_overflow ». |
|
149 |
Une valeur de 100 convient généralement. |
|
150 |
|
|
151 |
La documentation d'API de SQLAlchemy (la bibliothèque d'abstraction |
|
152 |
de la base de données utilisée par Vigilo) donne quelques informations |
|
153 |
supplémentaires sur le rôle de ces différents paramètres. |
|
154 |
Cette documentation est accessible à l'adresse |
|
155 |
http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/pooling.html. |
|
156 |
|
|
157 |
Configuration des éléments de sécurité |
|
158 |
-------------------------------------- |
|
159 |
Ce chapitre décrit les options relatives à la gestion des données |
|
160 |
de sécurité (clés de chiffrements, etc.) utilisées par VigiGraph. |
|
161 |
|
|
162 |
Choix de la méthode de hachage des mots de passe |
|
163 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
164 |
Lorsque l'authentification de Vigilo se base sur les comptes contenus dans |
|
165 |
la base de données, les mots de passe des utilisateurs sont stockés sous |
|
166 |
forme hachée afin de rendre plus difficile le cassage de ces mots de passe. |
|
167 |
|
|
168 |
La méthode de hachage sélectionnée peut être configurée en modifiant |
|
169 |
la valeur de la clé « password_hashing_function » sous la section [app:main]. |
|
170 |
Les méthodes de hachage disponibles sont variées. |
|
171 |
|
|
172 |
Les fonctions de hachage suivantes sont notamment disponibles : |
|
173 |
|
|
174 |
- md5 |
|
175 |
- sha1 |
|
176 |
- sha224 |
|
177 |
- sha256 |
|
178 |
- sha384 |
|
179 |
- sha512 |
|
180 |
|
|
181 |
Des fonctions supplémentaires peuvent être disponibles en fonction |
|
182 |
de votre installation de Python. |
|
183 |
|
|
184 |
.. warning:: |
|
185 |
En cas d'absence d'une valeur pour cette option ou si la fonction de |
|
186 |
hachage indiquée n'existe pas, les mots de passe sont stockés en clair. |
|
187 |
Vérifiez donc la valeur indiquée. |
|
188 |
|
|
189 |
.. warning:: |
|
190 |
Cette option ne doit être modifiée qu'au moment de l'installation. |
|
191 |
Si vous modifiez la méthode utilisée ultérieurement, les comptes |
|
192 |
précédemment enregistrés ne seront plus utilisables. En particulier, |
|
193 |
le compte d'administration créé par défaut. |
|
194 |
|
|
195 |
Clé de chiffrement / déchiffrement des sessions |
|
196 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
197 |
Afin de ne pas dévoiler certains paramètres associés à un utilisateur, |
|
198 |
le fichier de session qui contient ces paramètres est chiffré à l'aide |
|
199 |
d'une clé symétrique, utilisée à la fois pour le chiffrement |
|
200 |
et le déchiffrement des sessions de tous les utilisateurs de VigiGraph. |
|
201 |
|
|
202 |
L'option « beaker.session.secret » permet de choisir la clé utilisée |
|
203 |
pour chiffrer et déchiffrer le contenu des sessions. Cette clé peut être |
|
204 |
la même que celle configurée pour le chiffrement / déchiffrement |
|
205 |
des cookies (voir le chapitre ), mais ceci est déconseillé |
|
206 |
afin d'éviter que la compromission de l'une des deux clés |
|
207 |
n'entraine la compromission de l'autre. |
|
208 |
|
|
209 |
De la même manière, vous pouvez configurer les autres interfaces graphiques |
|
210 |
de Vigilo pour utiliser les mêmes clés, ou opter de préférence pour des clés |
|
211 |
différentes (là encore, pour éviter la propagation d'une compromission). |
|
212 |
|
|
213 |
Clé de chiffrement / déchiffrement des cookies |
|
214 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
215 |
L'association entre un utilisateur et sa session se fait à l'aide d'un cookie |
|
216 |
de session enregistré sur le navigateur de l'utilisateur. |
|
217 |
|
|
218 |
De la même manière que les sessions sont chiffrées afin de garantir |
|
219 |
la confidentialité de leur contenu, le cookie de session est également |
|
220 |
chiffré afin de protéger son contenu. |
|
221 |
|
|
222 |
L'option « sa_auth.cookie_secret » permet de choisir la clé utilisée |
|
223 |
pour chiffrer et déchiffrer le contenu du cookie. Cette clé peut être la même |
|
224 |
que celle configurée pour le chiffrement / déchiffrement des sessions |
|
225 |
(voir le chapitre ), mais ceci est déconseillé afin d'éviter que la |
|
226 |
compromission de l'une des deux clés n'entraine la compromission de l'autre. |
|
227 |
|
|
228 |
De la même manière, vous pouvez configurer les autres interfaces graphiques |
|
229 |
de Vigilo pour utiliser les mêmes clés, ou opter de préférence pour des |
|
230 |
clés différentes (là encore, pour éviter la propagation d'une compromission). |
|
231 |
|
|
232 |
Utilisation d'un mécanisme d'authentification externe |
|
233 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
234 |
Pour utiliser un mécanisme d'authentification externe (par exemple : Kerberos), |
|
235 |
définissez la clé « external_auth » à « True » sous la section [app:main]. |
|
236 |
Dans ce mode, Vigilo ne tente pas d'authentifier l'utilisateur par rapport |
|
237 |
aux comptes contenus dans sa base de données, mais utilise uniquement |
|
238 |
le nom d'utilisateur transmis par la source d'authentification externe. |
|
239 |
|
|
240 |
Le nom d'utilisateur peut être transmis de plusieurs manières, |
|
241 |
par exemple sous la forme d'une variable d'environnement. |
|
242 |
|
|
243 |
.. warning:: |
|
244 |
N'utilisez ce mode de fonctionnement que si vous comprenez bien les |
|
245 |
risques associés. En particulier, le fait qu'aucun mot de passe ne sera |
|
246 |
demandé à l'utilisateur pour confirmer son identité. |
|
247 |
|
|
248 |
Emplacement de la configuration des authentifications / autorisations |
|
249 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
250 |
La directive « auth.config » de la section [app:main] permet d'indiquer |
|
251 |
l'emplacement du fichier contenant la configuration de la couche |
|
252 |
d'authentification / autorisation de Vigilo. |
|
253 |
|
|
254 |
Il n'est généralement pas nécessaire de modifier cette valeur. |
|
255 |
La configuration de cette couche d'abstraction est détaillée |
|
256 |
dans le document *Vigilo – Authentification et autorisation*. |
|
257 |
|
|
258 |
Configuration de l'interface |
|
259 |
---------------------------- |
|
260 |
Ce chapitre décrit les options qui modifient l'apparence de l'interface |
|
261 |
graphique de VigiGraph. |
|
262 |
|
|
263 |
Langue par défaut de VigiGraph |
|
264 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
265 |
Au sein de son interface, VigiGraph tente de s'adapter au navigateur |
|
266 |
de l'utilisateur pour afficher les pages dans sa langue. |
|
267 |
|
|
268 |
Toutefois, si l'utilisateur n'a pas paramétré sa langue ou bien si |
|
269 |
aucune traduction n'est disponible qui soit en accord avec les paramètres |
|
270 |
du navigateur de l'utilisateur, une langue par défaut est utilisée (dans |
|
271 |
l'installation par défaut de VigiGraph, cette langue est le Français « fr »). |
|
272 |
|
|
273 |
Vous pouvez modifier la langue utilisée par défaut en changeant la valeur |
|
274 |
de la clé « lang » sous la section [app:main]. La valeur de cette clé |
|
275 |
est le code de la langue à utiliser, sur deux caractères et en minuscules |
|
276 |
(format ISO 3166-1 « alpha 2 »). Exemples de codes valides : fr, en, de, … |
|
277 |
|
|
278 |
La liste complète des codes possibles est disponible sur |
|
279 |
http://fr.wikipedia.org/wiki/ISO_3166-1. La langue retenue |
|
280 |
doit être disponible parmi les traductions fournies avec VigiGraph. |
|
281 |
|
|
282 |
Emplacement de la documentation en ligne |
|
283 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
284 |
Il est possible d'ajouter un lien dans l'interface graphique qui redirige |
|
285 |
l'utilisateur vers la documentation en ligne de l'application. |
|
286 |
Ceci se fait en assignant une URL à l'option « help_link ». |
|
287 |
|
|
288 |
Si cette option est renseignée, une icône en forme de bouée de sauvetage |
|
289 |
.. image:: img/help_icon.png |
|
290 |
|
|
291 |
apparaît dans l'interface graphique qui permet à l'utilisateur d'accéder |
|
292 |
à l'URL indiquée. |
|
293 |
|
|
294 |
Délai de rafraîchissement automatique |
|
295 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
296 |
Les veilleurs ont la possibilité d'activer un rafraîchissement automatique |
|
297 |
des graphes. L'option « refresh_delay » permet de choisir le délai, |
|
298 |
en secondes, entre deux rafraîchissements automatiques d'un graphe. |
|
299 |
|
|
300 |
Configuration du lien d'accueil |
|
301 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
302 |
Vous avez la possibilité de rediriger l'utilisateur vers une page |
|
303 |
de votre choix lorsque celui-ci clique sur le logo de Vigilo |
|
304 |
.. image:: img/vigilo.png |
|
305 |
|
|
306 |
dans l'interface graphique de VigiGraph. |
|
307 |
Ceci se fait en modifiant l'URL donnée par l'option « logo_link ». |
|
308 |
|
|
309 |
Configuration des serveurs mandataires |
|
310 |
-------------------------------------- |
|
311 |
VigiGraph permet d'accéder à la page d'état Nagios d'un hôte ou d'un service, |
|
312 |
et ce malgré le fait que ces hôtes/services sont supervisés par des serveurs |
|
313 |
Nagios différents. De même, il est capable d'afficher des graphes de métrologie |
|
314 |
en interrogeant le serveur VigiRRD qui gère un hôte donné. |
|
315 |
Ceci est rendu possible par l'existence d'un serveur mandataire (proxy) au sein |
|
316 |
de Vigilo qui relaye les requêtes au serveur Nagios ou VigiRRD adéquat. |
|
317 |
Le chapitre présente tout d'abord les options communes à tous les types |
|
318 |
de serveurs mandataires de Vigilo. Puis, le chapitre détaille les options |
|
319 |
spécifiques au serveur mandataire pour Nagios intégré dans VigiGraph. |
|
320 |
Enfin, le chapitre détaille les options spécifiques au serveur mandataire |
|
321 |
pour VigiRRD, dont la configuration est très proche de celle du serveur |
|
322 |
mandataire pour Nagios. |
|
323 |
|
|
324 |
Options communes à tous les serveurs mandataires de Vigilo |
|
325 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
326 |
Les options communes à tous les serveurs mandataires de Vigilo |
|
327 |
concernent l'authentification auprès d'un serveur mandataire intermédiaire. |
|
328 |
|
|
329 |
Elles sont au nombre de trois : |
|
330 |
|
|
331 |
- « app_proxy_auth_method » indique la méthode d'authentification |
|
332 |
à utiliser et peut valoir « basic » ou « digest » , |
|
333 |
|
|
334 |
- « app_proxy_auth_username » indique le nom d'utilisateur à utiliser |
|
335 |
pour se connecter au serveur mandataire intermédiaire , |
|
336 |
|
|
337 |
- « app_proxy_auth_password » indique le mot de passe associé |
|
338 |
à ce nom d'utilisateur. |
|
339 |
|
|
340 |
Ces trois options doivent être renseignées pour que l'authentification |
|
341 |
auprès du serveur mandataire intermédiaire soit effective. |
|
342 |
|
|
343 |
Options spécifiques au serveur mandataire Nagios |
|
344 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
345 |
L'option « app_path.nagios » indique l'emplacement de l'installation |
|
346 |
de Nagios sur le serveur web distant, à partir de la racine du serveur web. |
|
347 |
Généralement, il s'agit de « /nagios/ » (emplacement par défaut lors |
|
348 |
d'une nouvelle installation de l'interface graphique CGI de Nagios). |
|
349 |
|
|
350 |
L'option « app_scheme.nagios » indique le protocole à utiliser |
|
351 |
pour communiquer avec le serveur web distant. |
|
352 |
Les protocoles supportés sont « http » et « https ». |
|
353 |
|
|
354 |
L'option « app_port.nagios » permet d'indiquer le port à utiliser |
|
355 |
pour se connecter, dans le cas où il ne s'agit pas du port standard. |
|
356 |
Par défaut, le serveur mandataire Nagios utilise le port standard associé |
|
357 |
au protocole donné par « app_scheme.nagios » (80 pour HTTP, 443 pour HTTPS). |
|
358 |
|
|
359 |
L'option « app_redirect.nagios » permet de modifier le comportement |
|
360 |
du serveur mandataire. Lorsque cette option vaut « True », |
|
361 |
le serveur mandataire agit comme un simple redirecteur de requêtes. |
|
362 |
Dans ce mode, les options d'authentification liées au serveur mandataire |
|
363 |
sont ignorées. Ce mode de fonctionnement est utile afin de tester |
|
364 |
la configuration mais n'est pas recommandé en production. |
|
365 |
|
|
366 |
Les options « app_auth_method.nagios », « app_auth_username.nagios » |
|
367 |
et « app_auth_password.nagios » permettent d'indiquer la méthode |
|
368 |
d'authentification, le nom d'utilisateur et le mot de passe pour accéder |
|
369 |
à l'interface CGI de Nagios. |
|
370 |
Ces options sont similaires à celles décrites au chapitre . |
|
371 |
|
|
372 |
Options spécifiques au serveur mandataire VigiRRD |
|
373 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
374 |
Les options de configuration pour le serveur mandataire VigiRRD |
|
375 |
sont exactement les mêmes que pour le serveur mandataire Nagios |
|
376 |
présenté au chapitre , en remplaçant simplement le suffixe « .nagios » |
|
377 |
par « .vigirrd ». |
|
378 |
|
|
379 |
Configuration des sessions |
|
380 |
-------------------------- |
|
381 |
Chaque fois qu'un utilisateur se connecte à VigiGraph, un fichier de session |
|
382 |
est créé permettant de sauvegarder certaines préférences de cet utilisateur |
|
383 |
(par exemple, le thème de l'application, la taille de la police de caractères, |
|
384 |
etc.). Ce chapitre décrit les options relatives à la gestion des sessions. |
|
385 |
|
|
386 |
Emplacement des fichiers de session |
|
387 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
388 |
Le dossier dans lequel les fichiers de session seront stockés est indiqué |
|
389 |
par l'option « cache_dir ». |
|
390 |
|
|
391 |
Nom du cookie de session |
|
392 |
^^^^^^^^^^^^^^^^^^^^^^^^ |
|
393 |
Afin d'associer un utilisateur au fichier de session qui lui correspond, |
|
394 |
un cookie de session est créé sur le navigateur de l'utilisateur. |
|
395 |
|
|
396 |
L'option « beaker.session.key » permet de choisir le nom du cookie créé. |
|
397 |
Le nom doit être composé de caractères alphanumériques (a-zA-Z0-9) |
|
398 |
et commencer par une lettre (a-zA-Z). |
|
399 |
|
|
400 |
Intégration de VigiGraph avec Apache / mod_wsgi |
|
401 |
=============================================== |
|
402 |
VigiGraph a été testé avec le serveur libre Apache. L'application utilise |
|
403 |
en outre le module Apache « mod_wsgi » pour communiquer avec le serveur. |
|
404 |
Ce module implémente un modèle de communication basé sur l'interface WSGI. |
|
405 |
Le reste de ce chapitre décrit la configuration utilisée pour réaliser |
|
406 |
cette intégration. |
|
407 |
|
|
408 |
Fichier de configuration pour Apache |
|
409 |
------------------------------------ |
|
410 |
Le fichier de configuration pour l'intégration de VigiGraph dans Apache |
|
411 |
se trouve généralement dans /etc/vigilo/vigigraph/vigigraph.conf |
|
412 |
(un lien symbolique vers ce fichier est créé dans le dossier de configuration |
|
413 |
d'Apache, généralement dans /etc/httpd/conf.d/vigigraph.conf). |
|
414 |
|
|
415 |
En général, il n'est pas nécessaire de modifier le contenu de ce fichier. |
|
416 |
Ce chapitre vise toutefois à fournir quelques informations sur |
|
417 |
le fonctionnement de ce fichier, afin de permettre d'éventuelles |
|
418 |
personnalisations de ce comportement. |
|
419 |
|
|
420 |
Ce fichier tente tout d'abord de charger le module « mod_wsgi » |
|
421 |
(directive LoadModule) puis ajoute les directives de configuration |
|
422 |
nécessaires à Apache pour faire fonctionner VigiGraph, |
|
423 |
reprises partiellement ci-dessous :: |
|
424 |
|
|
425 |
WSGIRestrictStdout off |
|
426 |
WSGIPassAuthorization on |
|
427 |
WSGIDaemonProcess vigigraph user=apache group=apache threads=2 |
|
428 |
WSGIScriptAlias /vigilo/vigigraph "/etc/vigilo/vigigraph/vigigraph.wsgi" |
|
429 |
|
|
430 |
KeepAlive Off |
|
431 |
|
|
432 |
<Directory "/etc/vigilo/vigigraph/"> |
|
433 |
<Files "vigigraph.wsgi"> |
|
434 |
WSGIProcessGroup vigigraph |
|
435 |
WSGIApplicationGroup %{GLOBAL} |
|
436 |
|
|
437 |
Order deny,allow |
|
438 |
Allow from all |
|
439 |
</Files> |
|
440 |
</Directory> |
|
441 |
|
|
442 |
L'option WSGIRestrictStdout est positionnée à « off » afin d'éviter |
|
443 |
qu'Apache ne tue le processus de l'application lorsque des données |
|
444 |
sont envoyées sur la sortie standard. Ceci permet de récupérer |
|
445 |
les erreurs critiques pouvant être émises par l'application. |
|
446 |
Ces erreurs apparaissent alors dans le journal des événements |
|
447 |
d'Apache (configuré par la directive error_log). |
|
448 |
|
|
449 |
L'option WSGIPassAuthorization positionnée à « on » indique à Apache |
|
450 |
et mod_wsgi que les informations d'authentification éventuellement |
|
451 |
transmises par l'utilisateur doivent être transmises à VigiGraph. |
|
452 |
En effet, Vigilo utilise son propre mécanisme de gestion de |
|
453 |
l'authentification et des autorisations (voir la documentation |
|
454 |
intitulée Vigilo - Authentification et autorisation) et utilise |
|
455 |
donc ces informations. |
|
456 |
|
|
457 |
L'option WSGIDaemonProcess permet de créer un groupe de processus |
|
458 |
affecté au traitement des requêtes HTTP destinées à VigiGraph. |
|
459 |
Il permet d'utiliser un nom d'utilisateur et un groupe prédéfini |
|
460 |
(afin de réduire les privilèges nécessaires), ainsi que le nombre |
|
461 |
de processus légers à utiliser pour traiter les requêtes (ici, 2). |
|
462 |
|
|
463 |
L'option WSGIScriptAlias indique l'emplacement à partir duquel |
|
464 |
VigiGraph sera accessible (ici, http://example.com/vigilo/vigigraph |
|
465 |
si le serveur Apache est configuré pour le domaine « example.com ») |
|
466 |
et l'emplacement du script WSGI nécessaire au lancement de l'application |
|
467 |
(voir le chapitre ). |
|
468 |
|
|
469 |
L'option KeepAlive positionnée à « off » est nécessaire afin de contourner |
|
470 |
un problème dans le module « mod_wsgi » d'Apache. |
|
471 |
|
|
472 |
Les autres options permettent d'exécuter le script WSGI de VigiGraph |
|
473 |
à l'aide du groupe de processus défini précédemment. |
|
474 |
|
|
475 |
La liste complète des directives de configuration supportées |
|
476 |
par le module « mod_wsgi » d'Apache est disponible à l'adresse |
|
477 |
http://code.google.com/p/modwsgi/wiki/ConfigurationDirectives. |
|
478 |
|
|
479 |
Script WSGI de VigiGraph |
|
480 |
------------------------ |
|
481 |
Le script WSGI de VigiGraph est un script Python très simple qui a pour but |
|
482 |
de démarrer l'exécution de VigiGraph à partir du fichier de configuration |
|
483 |
associé (/etc/vigilo/vigigraph/settings.ini). |
|
484 |
|
|
485 |
Vous n'avez généralement pas besoin de modifier son contenu, |
|
486 |
sauf éventuellement pour adapter l'emplacement du fichier de configuration |
|
487 |
en fonction de votre installation. |
|
488 |
|
|
489 |
Annexes |
|
490 |
======= |
|
491 |
|
|
492 |
.. include:: ../../turbogears/doc/glossaire.rst |
|
493 |
|
|
494 |
.. vim: set tw=79 : |
doc/conf.py | ||
---|---|---|
5 | 5 |
project = u'VigiGraph' |
6 | 6 |
|
7 | 7 |
pdf_documents = [ |
8 |
('admin', "admin-%s" % name, "%s : Guide d'administration" % project, u'Vigilo'), |
|
8 | 9 |
('util', "util-%s" % name, "%s : Guide d'utilisation" % project, u'Vigilo'), |
9 | 10 |
] |
10 | 11 |
|
11 | 12 |
latex_documents = [ |
13 |
('admin', 'admin-%s.tex' % name, u"%s : Guide d'administration" % project, |
|
14 |
'AA100004-2/ADM00006', 'vigilo'), |
|
12 | 15 |
('util', 'util-%s.tex' % name, u"%s : Guide d'utilisation" % project, |
13 | 16 |
'AA100004-2/UTI00004', 'vigilo'), |
14 | 17 |
] |
doc/index.rst | ||
---|---|---|
10 | 10 |
.. toctree:: |
11 | 11 |
:maxdepth: 2 |
12 | 12 |
|
13 |
admin |
|
13 | 14 |
util |
14 | 15 |
|
15 | 16 |
|
Also available in: Unified diff