Revision 0e86c6f5
Mini-améliorations doc admin de VigiBoard.
Change-Id: Ib285c0b5928de5e3c63ca5498b9176851ad8259b
Reviewed-on: https://vigilo-dev.si.c-s.fr/review/649
Tested-by: Build system <qa@vigilo-dev.si.c-s.fr>
Reviewed-by: Francois POIROTTE <francois.poirotte@c-s.fr>
| doc/admin.rst | ||
|---|---|---|
| 97 | 97 |
|
| 98 | 98 |
postgres://vigilo:vigilo@localhost/vigilo |
| 99 | 99 |
|
| 100 |
**ATTENTION** : à l'heure actuelle, seul PostgreSQL a fait l'objet de tests |
|
| 101 |
intensifs. D'autres SGBD peuvent également fonctionner, mais aucun support ne |
|
| 102 |
sera fourni pour ces SGBD. |
|
| 100 |
.. warning:: |
|
| 101 |
À l'heure actuelle, seul PostgreSQL a fait l'objet de tests intensifs. |
|
| 102 |
D'autres SGBD peuvent également fonctionner, mais aucun support ne |
|
| 103 |
sera fourni pour ces SGBD. |
|
| 103 | 104 |
|
| 104 | 105 |
Choix d'un préfixe pour les tables |
| 105 | 106 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| ... | ... | |
| 165 | 166 |
sha512. D'autres fonctions peuvent être disponibles en fonction de votre |
| 166 | 167 |
installation de Python. |
| 167 | 168 |
|
| 168 |
**Attention :** en cas d'absence d'une valeur pour cette option ou si la |
|
| 169 |
fonction de hachage indiquée n'existe pas, les mots de passe sont stockés en |
|
| 170 |
clair. Vérifiez donc la valeur indiquée. |
|
| 169 |
.. warning:: |
|
| 170 |
En cas d'absence d'une valeur pour cette option ou si la fonction |
|
| 171 |
de hachage indiquée n'existe pas, les mots de passe sont stockés |
|
| 172 |
en clair. Vérifiez donc la valeur indiquée. |
|
| 171 | 173 |
|
| 172 |
**Attention :** cette option ne doit être modifiée qu'au moment de |
|
| 173 |
l'installation. Si vous modifiez la méthode utilisée ultérieurement, les |
|
| 174 |
comptes précédemment enregistrés ne seront plus utilisables. En particulier, le |
|
| 175 |
compte d'administration créé par défaut. |
|
| 174 |
.. warning:: |
|
| 175 |
Cette option ne doit être modifiée qu'au moment de l'installation. |
|
| 176 |
Si vous modifiez la méthode utilisée ultérieurement, les comptes |
|
| 177 |
précédemment enregistrés ne seront plus utilisables. |
|
| 178 |
En particulier, le compte d'administration créé par défaut. |
|
| 176 | 179 |
|
| 177 | 180 |
Clé de chiffrement / déchiffrement des sessions |
| 178 | 181 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| ... | ... | |
| 241 | 244 |
3166-1 ``alpha 2``). Exemples de codes valides : fr, en, de, ... |
| 242 | 245 |
|
| 243 | 246 |
La liste complète des codes possibles est disponible sur |
| 244 |
http://fr.wikipedia.org/wiki/ISO_3166-1. La langue retenue doit être disponible |
|
| 245 |
parmi les traductions fournies avec VigiBoard. |
|
| 247 |
http://fr.wikipedia.org/wiki/ISO_3166-1. |
|
| 248 |
La langue retenue doit être disponible parmi les traductions fournies |
|
| 249 |
avec VigiBoard. |
|
| 246 | 250 |
|
| 247 | 251 |
Emplacement de la documentation en ligne |
| 248 | 252 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| ... | ... | |
| 263 | 267 |
veilleurs. L'option ``refresh_delay`` permet de choisir le délai, en secondes, |
| 264 | 268 |
entre deux rafraîchissements automatiques de la page. |
| 265 | 269 |
|
| 266 |
NOTE : Les veilleurs ont la possibilité de désactiver le rafraîchissement |
|
| 267 |
automatique durant leur session. Dans tous les cas, si une boîte de dialogue de |
|
| 268 |
VigiBoard est affichée à l'écran, le rafraîchissement automatique est mis en |
|
| 269 |
pause afin de ne pas perturber les opérations en cours. |
|
| 270 |
.. note:: |
|
| 271 |
Les veilleurs ont la possibilité de désactiver le rafraîchissement |
|
| 272 |
automatique durant leur session. Dans tous les cas, si une boîte |
|
| 273 |
de dialogue de VigiBoard est affichée à l'écran, le rafraîchissement |
|
| 274 |
automatique est mis en pause afin de ne pas perturber les opérations |
|
| 275 |
en cours. |
|
| 270 | 276 |
|
| 271 | 277 |
État initial du rafraîchissement automatique |
| 272 | 278 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| ... | ... | |
| 274 | 280 |
du bac à événements pour les veilleurs, en positionnant l'option |
| 275 | 281 |
``refresh_enabled`` à ``True``. |
| 276 | 282 |
|
| 277 |
NOTE : Les veilleurs ont la possibilité de désactiver le rafraîchissement |
|
| 278 |
automatique durant leur session. Leur choix (rafraîchissement automatique actif |
|
| 279 |
ou non) est conservé en session durant un certain temps. |
|
| 283 |
.. note:: |
|
| 284 |
Les veilleurs ont la possibilité de désactiver le rafraîchissement |
|
| 285 |
automatique durant leur session. Leur choix (rafraîchissement automatique |
|
| 286 |
actif ou non) est conservé en session durant un certain temps. |
|
| 280 | 287 |
|
| 281 | 288 |
Configuration du nombre d'événements affichés par page |
| 282 | 289 |
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| ... | ... | |
| 336 | 343 |
nombre de trois : |
| 337 | 344 |
|
| 338 | 345 |
- ``app_proxy_auth_method`` indique la méthode d'authentification à utiliser et |
| 339 |
peut valoir ``basic`` ou ``digest`` , |
|
| 346 |
peut valoir ``basic`` ou ``digest`` |
|
| 347 |
|
|
| 340 | 348 |
- ``app_proxy_auth_username`` indique le nom d'utilisateur à utiliser pour se |
| 341 |
connecter au serveur mandataire intermédiaire , |
|
| 349 |
connecter au serveur mandataire intermédiaire |
|
| 350 |
|
|
| 342 | 351 |
- ``app_proxy_auth_password`` indique le mot de passe associé à ce nom |
| 343 | 352 |
d'utilisateur. |
| 344 | 353 |
|
| ... | ... | |
| 353 | 362 |
installation de l'interface graphique CGI de Nagios). |
| 354 | 363 |
|
| 355 | 364 |
L'option ``app_scheme.nagios`` indique le protocole à utiliser pour communiquer |
| 356 |
avec le serveur Web distant. Les protocoles supportés sont ``http`` et
|
|
| 357 |
``https``. |
|
| 365 |
avec le serveur Web distant. Pour le moment, seuls les protocoles ``http`` et
|
|
| 366 |
``https`` sont supportés.
|
|
| 358 | 367 |
|
| 359 | 368 |
L'option ``app_port.nagios`` permet d'indiquer le port à utiliser pour se |
| 360 | 369 |
connecter, dans le cas où il ne s'agit pas du port standard. Par défaut, le |
| ... | ... | |
| 421 | 430 |
d'affichage, de gauche à droite sur un navigateur configuré pour un utilisateur |
| 422 | 431 |
français, et de droite à gauche pour un utilisateur hébreu). |
| 423 | 432 |
|
| 424 |
Exemple de configuration possible:: |
|
| 433 |
Exemple de configuration possible : |
|
| 434 |
|
|
| 435 |
.. sourcecode:: python |
|
| 425 | 436 |
|
| 426 | 437 |
base_config['vigiboard_plugins'] = ( |
| 427 |
'details', |
|
| 428 |
'date', |
|
| 429 |
'priority', |
|
| 430 |
'occurrences', |
|
| 431 |
'hostname', |
|
| 432 |
'servicename', |
|
| 433 |
'output', |
|
| 434 |
'hls', |
|
| 435 |
'status', |
|
| 438 |
'details',
|
|
| 439 |
'date',
|
|
| 440 |
'priority',
|
|
| 441 |
'occurrences',
|
|
| 442 |
'hostname',
|
|
| 443 |
'servicename',
|
|
| 444 |
'output',
|
|
| 445 |
'hls',
|
|
| 446 |
'status',
|
|
| 436 | 447 |
) |
| 437 | 448 |
|
| 438 | 449 |
Configuration des liens externes |
| ... | ... | |
| 442 | 453 |
dialogue de détail d'un événement (figure ). |
| 443 | 454 |
|
| 444 | 455 |
La configuration des liens externes est donnée sous la forme d'un tuple de |
| 445 |
tuples, de la forme:: |
|
| 456 |
tuples, de la forme ::
|
|
| 446 | 457 |
|
| 447 | 458 |
(libellé du lien, URL cible) |
| 448 | 459 |
|
| ... | ... | |
| 461 | 472 |
- ``%(message)s`` est remplacé par le message de supervision remonté par |
| 462 | 473 |
Nagios. |
| 463 | 474 |
|
| 464 |
Exemple de configuration possible:: |
|
| 475 |
Exemple de configuration possible : |
|
| 476 |
|
|
| 477 |
.. sourcecode:: python |
|
| 465 | 478 |
|
| 466 | 479 |
base_config['vigiboard_links.eventdetails'] = ( |
| 467 | 480 |
( |
| ... | ... | |
| 507 | 520 |
- ``%(tt)s`` est remplacé par la référence du ticket d'incident, telle que |
| 508 | 521 |
saisie par un utilisateur. |
| 509 | 522 |
|
| 510 |
Exemple de configuration possible:: |
|
| 523 |
Exemple de configuration possible : |
|
| 524 |
|
|
| 525 |
.. sourcecode:: python |
|
| 511 | 526 |
|
| 512 |
base_config['vigiboard_links.tt'] = 'http://bugs.example.com/?ticket_id=%(tt)s' |
|
| 527 |
base_config['vigiboard_links.tt'] = \ |
|
| 528 |
'http://bugs.example.com/?ticket_id=%(tt)s' |
|
| 513 | 529 |
|
| 514 | 530 |
|
| 515 | 531 |
.. _confmodwsgi: |
| ... | ... | |
| 574 | 590 |
nécessaires), ainsi que le nombre de processus légers à utiliser pour traiter |
| 575 | 591 |
les requêtes (ici, 2). |
| 576 | 592 |
|
| 577 |
L'option ``WSGIScriptAlias`` indique l'emplacement à partir duquel VigiBoard sera accessible (ici, ``http://example.com/vigilo/vigiboard`` si le serveur Apache est configuré pour le domaine ``example.com``) et l'emplacement du script WSGI nécessaire au lancement de l'application (voir le chapitre suivant). |
|
| 593 |
L'option ``WSGIScriptAlias`` indique l'emplacement à partir duquel VigiBoard |
|
| 594 |
sera accessible (ici, ``http://example.com/vigilo/vigiboard`` si le serveur |
|
| 595 |
Apache est configuré pour le domaine ``example.com``) et l'emplacement du script |
|
| 596 |
WSGI nécessaire au lancement de l'application (voir le chapitre suivant). |
|
| 578 | 597 |
|
| 579 | 598 |
L'option ``KeepAlive`` positionnée à ``off`` est nécessaire afin de contourner |
| 580 | 599 |
un problème dans le module ``mod_wsgi`` d'Apache. |
Also available in: Unified diff