| Scroll Ignore |
|---|
| scroll-pdf | true |
|---|
| scroll-office | true |
|---|
| scroll-chm | true |
|---|
| scroll-docbookhtml | truefalse |
|---|
| scroll-eclipsehelpdocbook | true |
|---|
| scroll-epubeclipsehelp | true |
|---|
| scroll-htmlepub | true |
|---|
|
|
Le fichier webui_cfg_overload.cfg permettra de modifier des comportements sur tous les modules WebUI ( qui implémente ce fichier - voir le chapitre surcharge de la configuration de la pageConfiguration du module WebUI )
De plus, les fichiers de configuration des paramètres du module Webui peuvent être modifiés par des commandes d'installation de Shinken.
Il est donc préférable d'ajuster les paramètres nécessaires dans ce fichier.
Les paramètres définis dans ce fichier vont écraser ( seront prioritaires ) sur ceux dans les fichiers de configuration des modules WebUI.
Pour plus de détails sur les paramètres, référez-vous à la page suivante : Configuration du module WebUI
Adresse par défaut du ficher : /etc/shinken-user/configuration/daemons/brokers/modules/webui/webui_cfg_overload.cfg
Exemple : Surcharge de la configuration de l'interface Web
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ─────────────────────────────────────────────────────────────────────────────────────────────────────── #
# This comment is used by Shinken to recognize this file, please do not edit or remove it.
# If done so, several parts of Shinken, like sanitize, may not work properly.
# __OVERRIDE_TYPE__ webui_cfg_overload
# ─────────────────────────────────────────────────────────────────────────────────────────────────────── #
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────── HIVE ──────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ──────────────── default grid layout ──────────────────────────────────────────────────────────────── #
# ─── default_tiles_format ───
# ─── Describe how the tiles are displayed in the hive ───
# ───
# ... : context_and_status => Tile color is split by status and context when there is one ───
# ... : status => Tile color matches the status, context displayed by a secondary icon ───
# Default : context => Tile color matches the context if one, else matches the status ───
# ─── ───
tiles_background context_and_status
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────── PAGE DETAIL ──────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ────────────────────── Graphics ───────────────────────────────────────────────────────────────────── #
# ─── Colors for graphics ───
# ─── Give the list of color format hexadecimal (without the #) separate by comma ───
# ───
# ... : X => infinite number of any existing color ───
# ─── ───
colors_graphics 6cc4b9,4485aa,314293,329347,72a82c,ef7c14,d82e2e,931616,FF00FF,000000
# ────────────────────── Historic ───────────────────────────────────────────────────────────────────── #
# ─── history__nb_changes_displayed ───
# ─── Number of changes displayed in change detail area of each days in History/SLA tab ───
# ─── in History/SLA tab ───
# ─── This number will be also used to display next changes went ───
# ─── a user click on button "show more" ───
# ───
# ... : X => positive integer ───
# ─── ───
history__nb_changes_displayed 30
# ─── history__size_sla_pane ───
# ─── The default width of SLA column in History/SLA tab ───
# ─── The width is define in px. If not set, the history column will ───
# ─── be take 60% of the detail pane width ───
# ───
# ... : X => positive integer ───
# ─── ───
# history__size_sla_pane 250
# ─── history__default_display_outputs ───
# ─── The default status of the output display on the History/SLA ───
# ─── tab for all new users (it still editable in UI) ───
# ───
# ... : 0 => outputs will be hidden ───
# Default : 1 => outputs will be display ───
# ─── ───
history__default_display_outputs 1
# ─── history__default_collapse_outputs ───
# ─── The default state of outputs folding in History/SLA ───
# ─── tab for all new users (it still editable in UI) ───
# ───
# ... : 1 => outputs will be fold ───
# Default : 0 => outputs will be unfold ───
# ─── ───
history__default_collapse_outputs 0
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────────────────────────────────────────────────────────────── REPORTSLOGS ────────────────────────────────────────────────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── SynthesisWebui Authentication External Log ───
# ─── Log the webui authentication history in a file ───
# ─── These parameters are used to configure the Synthesis (or "Wall") menu. ───
# ───
# ... : 01 => disabledenabled ───
# Default : 10 => enabled disabled ───
# ─── ───
broker__module_webui__synthesislog_users_report__enableenabled 1
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #0
# │─── ───────────────────────────────────────────File use for log LOGSauthentication history ──────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Webui Authentication External Log ───
# ─── ───
# ─── Log the webui authentication history in a file ───
# ───
broker__module_webui__log_users__file_path /var/log/shinken/webui/log_users.log
# ─── Add user name to log ───
# ... : 1 => enabled ───
# ... Default : 01 => disabledenabled ───
# ─── Default : 0 => disabled ───
# ─── ───
broker__module_webui__log_users__enabled 0
# ─── File use for log authentication history ───
# ───broker__module_webui__log_users__add_user_name 0
# ─── The log files will be rotated daily, up to the number of days configured. ───
# ─── All log files older than the configured number of days will be deleted automatically. ───
# ───
broker__module_webui__log_users__file_path /var/log/shinken/webui/log_users.log
# ─── Add user name to log ───
# ───
Default : #7 (days) ───
# ─── ───
# ... : 1 => enabled ───
broker__module_webui__log_users__logs_rotation__nb_days_before_deletion 7
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───
────────────────────────────────── #INTERFACE VIEWS OPTIONS ────────────────────────────────── │ #
Default :# 0 => disabled└─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ────────────────────── History ────────────────────────────────────────────────────────────────────── #
# ─── This option allows you to set the maximum number of changes saved in database for each view. ───
# ─── /!\ If you decrease the value, the extra history can be deleted on daemon startup. ───
# ───
# ─── /!\ Minimum value is 10. ───
# ───
Default broker__module_webui__log_users__add_user_name: 100 0
# ─── The log files will be rotated daily, up to the number of days configured. ───
# ─── All log files older than the configured number of days will be deleted automatically. ───
# ───
# broker__module_webui__views_history__nb_changes_kept__default_for_all 100
# ─────────────────────── Trash ─────────────────────────────────────────────────────────────────────── #
# ─── This option Default : 7 (days) allows you to set the maximum number of days that views are kept in the trash. ───
# ─── /!\ After this delay, the views are permanently DELETED. ───
# ─── /!\ If you decrease the value, the too old views can be DELETED on daemon startup. ───
# ─── /!\ Minimum value is 30 days. ───
broker__module_webui__log_users__logs_rotation__nb_days_before_deletion 7
# # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐Default #
: 30 (days) # │ ────────────────────────────────── INTERFACE VIEWS OPTIONS ────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ────────────────────── History ────────────────────────────────────────────────────────────────────── #
# ─── This option allows you to set the maximum number of changes saved in database for each view. ───
# ─── /!\ If───
you decrease the value,# the extra history can be deleted on daemon startup. ───
# ─── /!\ Minimum value is 10. ───
# Default : 100 broker__module_webui__views_trash__delay_before_deletion__default_for_all 30
|
Détails des sections composant le fichier de configuration
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────── HIVE ──────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ──────────────── default grid layout ──────────────────────────────────────────────────────────────── #
# ─── default_tiles_format ───
# ───
# ─── Describe how the tiles are displayed in the hive ───
# broker__module_webui__views_history__nb_changes_kept__default_for_all 100
# ─────────────────────── Trash ─────────────────────────────────────────────────────────────────────── #
# ─── This option allows you to set the maximum number of days that views are kept in the trash. ───
# ─── /!\ After this delay, the views are permanently DELETED. ───
# ─── /!\ If you decrease... the value, the too old views can be DELETED on daemon startup. : context_and_status => Tile color is split by status and context when there is one ───
# ─── /!\ Minimum value is 30 days ... : status => Tile color matches the status, context displayed by a secondary icon ───
# Default : 30 (days) context => Tile color matches the context if one, else matches the status ───
# ─── ───
# ───
tiles_background context_and_status
───
# broker__module_webui__views_trash__delay_before_deletion__default_for_all 30
|
Détails des sections composant le fichier de configuration
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| No Format |
|---|
tiles_background |
| Texte | --- | context_and_status | Modifie l'affichage des tuiles du portail - context : S'il y a un contexte, la tuile à la couleur du contexte, sinon la couleur du statut.
- statut : la tuile a toujours la couleur du statut.
- context_and_status : le tuile a un double affichage ( moitié statut et moitié contexte ).
( voir la page Paramétrage de l'interface de Visualisation )
|
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ # |
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────────────────────────────────────────────── PAGE HIVEDETAIL ──────────────────────────────────────────────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ────────────────────────────────────── defaultGraphics grid layout ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── #
# ─── default_tiles_format Colors for graphics ───
# ─── DescribeGive how the tileslist areof displayedcolor informat thehexadecimal hive(without the #) separate by comma ───
# ───
# ... : context_and_statusX => Tileinfinite colornumber isof splitany byexisting status andcolor context when there is one ───
# ... : status => Tile color matches the status, context displayed by a secondary icon ───
# ─── Default : context => Tile color matches the context if one, else matches the status ───
# ─── ───
colors_graphics 6cc4b9,4485aa,314293,329347,72a82c,ef7c14,d82e2e,931616,FF00FF,000000
# ────────────────────── Historic ───────────────────────────────────────────────────────────────────── #
# ───
history__nb_changes_displayed tiles_background context_and_status
|
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| No Format |
|---|
tiles_background |
| Texte | --- | context_and_status | Modifie l'affichage des tuiles du portail ( voir la page Paramétrage de l'interface de Visualisation ) |
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────── PAGE DETAIL ──────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ────────────────────── Graphics ───────────────────────────────────────────────────────────────────── #
# ───
Colors for graphics# ─── Number of changes displayed in change detail area of each days in History/SLA tab ───
# ─── in History/SLA tab ───
# ─── Give the list of color format hexadecimal (without the #) separate by comma ───
# ─── This number will be also used to display next changes went ───
# ─── a user click on button "show more" ───
# ... : X => infinite number of───
any existing color # ───
# ─── ───
# ... : X => positive integer ───
colors_graphics 6cc4b9,4485aa,314293,329347,72a82c,ef7c14,d82e2e,931616,FF00FF,000000
# ────────────────────── Historic ───────────────────────────────────────────────────────────────────── #
# ─── history__nb_changes_displayed ───
# ─── ───
# ─── Number of changes displayed in change detail area of each days in History/SLA tab ───
# ─── in History/SLA tab history__nb_changes_displayed 30
# ─── history__size_sla_pane ───
# ─── This number will be also used to display next changes wentThe default width of SLA column in History/SLA tab ───
# ─── The width is define in px. If not set, the history column will ─── a user click on button "show more"
# ─── be take 60% of the detail pane width ───
# ───
# ... : X => positive integer ───
# ─── ───
# history__nbsize_changes_displayedsla_pane 30250
# ─── history__sizedefault_sla_pane display_outputs ───
# ─── The default widthstatus of the output SLAdisplay columnon inthe History/SLA tab ───
# ─── tab for all new users (it ───
still editable in UI) # ─── The width is define in px. If not set, the history column will ───
# ─── be take 60% of the detail pane width ───
# ───
# ... : 0 => outputs will be hidden ───
#───
# ... Default : X1 => positiveoutputs integerwill be display ───
# ─── ───
# history__sizedefault_sladisplay_pane 250outputs 1
# ─── history__default_displaycollapse_outputs ───
# ─── The default statusstate of theoutputs outputfolding display onin the History/SLA ───
# ─── tab for all new users (it still editable in UI) ───
# ───
# ... : 01 => outputs will be fold hidden ───
# Default : 10 => outputs will be unfold display ───
# ─── ───
history__default_displaycollapse_outputs 1
0 # ─── history__default_collapse_outputs ───
# ─── The default state of outputs folding in History/SLA ───
# ─── tab for all new users (it still editable in UI) ───
# ───
# ... : 1 => outputs will be fold ───
# Default : 0 => outputs will be unfold ───
# ─── ───
history__default_collapse_outputs 0 |
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| Texte | --- | 6cc4b9,4485aa,314293,329347,72a82c,ef7c14,d82e2e,931616,FF00FF,000000s | Choix des couleurs des graphiques ( voir la page Paramétrage de l'interface de Visualisation ) |
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| No Format |
|---|
history__nb_changes_displayed |
| Entier | --- | 30 | Limite le nombre d'entrées ( changements ) pour chaque journée dans l'onglet Historique/SLA(permet d'éviter le fait que les pages soient trop lourdes à l'ouverture. L'utilisateur pourra toujours en voir plus sur une journée, en utilisant le bouton approprié "Voir Plus")( voir la page Paramétrage de l'interface de Visualisation )
| No Format |
|---|
history__size_sla_pane |
| Entier | --- | 250 | Taille de la colonne SLA en pixel par défaut, lorsque les deux colonnes sont affichées ( voir la page Paramétrage de l'interface de Visualisation ) |
| No Format |
|---|
history__default_display_outputs |
| Entier | --- | 1 | Permet de définir si par défaut le résultat et le résultat long de chaque changement d'état sont affichés.  Ce paramètre est un paramètre d’initialisation pour les nouveaux utilisateurs. Cette valeur peut être changée par chaque utilisateur quand celui-ci clique sur le bouton d'affichage ou cache tous les résultats sur l'interface de visualisation.
( voir la page Paramétrage de l'interface de Visualisation ) |
| No Format |
|---|
history__size_sla_pane |
| Entier | --- | 0 | Permet de définir si par défaut les résultats sont affichés en réduit ou en totalité.
- 0 : affichage total
- 1 : affichage réduit
Ce paramètre est un paramètre d’initialisation pour les nouveaux utilisateurs. Cette valeur peut être changée par chaque utilisateur quand celui-ci clique sur le bouton de réduire ou d'étendre tous les résultats sur l'interface de visualisation.( voir la page Paramétrage de l'interface de Visualisation )
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| No Format |
|---|
history__nb_changes_displayed |
| Entier | --- | 30 | Limite le nombre d'entrées ( changements ) pour chaque journée dans l'onglet Historique/SLA(permet d'éviter le fait que les pages soient trop lourdes à l'ouverture. L'utilisateur pourra toujours en voir plus sur une journée, en utilisant le bouton approprié "Voir Plus") ( voir la page Paramétrage de l'interface de Visualisation ) |
| No Format |
|---|
history__size_sla_pane |
| Entier | --- | 250 | Taille de la colonne SLA en pixel par défaut, lorsque les deux colonnes sont affichées ( voir la page Paramétrage de l'interface de Visualisation ) |
| No Format |
|---|
history__default_display_outputs |
| Entier | --- | 1 | Permet de définir si par défaut le résultat et le résultat long de chaque changement d'état sont affichés. Ce paramètre est un paramètre d’initialisation pour les nouveaux utilisateurs. Cette valeur peut être changée par chaque utilisateur quand celui-ci clique sur le bouton d'affichage ou cache tous les résultats sur l'interface de visualisation. ( voir la page Paramétrage de l'interface de Visualisation ) |
| No Format |
|---|
history__default_collapse_outputs |
| Entier | --- | 0 | Permet de définir si par défaut les résultats sont affichés en réduit ou en totalité. - 0 : affichage total
- 1 : affichage réduit
Ce paramètre est un paramètre d’initialisation pour les nouveaux utilisateurs. Cette valeur peut être changée par chaque utilisateur quand celui-ci clique sur le bouton de réduire ou d'étendre tous les résultats sur l'interface de visualisation.
( voir la page Paramétrage de l'interface de Visualisation ) |
Propriétés expliquées dans la page "Configuration du module WebUI"
Pour toutes les propriétés suivantes, l'explication est dans la page Configuration du module WebUI
| Nom |
|---|
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| broker__module_webui__log_users__enabled |
|
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| broker__module_webui__log_users__file_path |
|
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| broker__module_webui__log_users__add_user_name |
|
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| broker__module_webui__log_users__logs_rotation__nb_days_before_deletion |
|
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────────── REPORTS ────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Synthesis ───
# ─── These parameters are used to configure the Synthesis (or "Wall") menu. ───
# ───
# ... : 0 => disabled ───
# Default : 1 => enabled ───
# ─── ───
broker__module_webui__synthesis__report__enable 1 |
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| No Format |
|---|
broker__module_webui__synthesis__report__enable |
| Entier | --- | 1 | Surcharge de la propriété du fichier /etc/shinken/modules/webui .cfg ( voir la page Configuration du module WebUI ) |
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────── LOGS ──────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Webui Authentication External Log ───
# ─── Log the webui authentication history in a file ───
# ───
# ... : 1 => enabled ───
# Default : 0 => disabled ───
# ─── ───
broker__module_webui__log_users__enabled 0
# ─── File use for log authentication history ───
# ─── ───
broker__module_webui__log_users__file_path /var/log/shinken/webui/log_users.log
# ─── Add user name to log ───
# ───
# ... : 1 => enabled ───
# Default : 0 => disabled ───
# ─── ───
broker__module_webui__log_users__add_user_name 0
# ─── The log files will be rotated daily, up to the number of days configured. ───
# ─── All log files older than the configured number of days will be deleted automatically. ───
# ───
# Default : 7 (days) ───
# ─── ───
broker__module_webui__log_users__logs_rotation__nb_days_before_deletion 7
|
| Nom | Type | Unité | Défaut | Commentaire |
|---|
| No Format |
|---|
broker__module_webui__synthesis__report__enable |
| Booléen | --- | 0 | Surcharge de la propriété du fichier /etc/shinken/modules/webui .cfg ( voir la page Configuration du module WebUI ) |
| No Format |
|---|
broker__module_webui__log_users__file_path |
| Text | --- | /var/log/shinken/webui/log_users.log | Surcharge de la propriété du fichier /etc/shinken/modules/webui .cfg ( voir la page Configuration du module WebUI ) |
| No Format |
|---|
broker__module_webui__log_users__add_user_name |
| Booléen | --- | 0 | Surcharge de la propriété du fichier /etc/shinken/modules/webui .cfg ( voir la page Configuration du module WebUI ) |
| No Format |
|---|
broker__module_webui__log_users__logs_rotation__nb_days_before_deletion |
| Entier | jour | 7 | Surcharge de la propriété du fichier /etc/shinken/modules/webui .cfg ( voir la page Configuration du module WebUI ) |
Options pour les vues de l'interface
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────── INTERFACE VIEWS OPTIONS ────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ────────────────────── History ────────────────────────────────────────────────────────────────────── #
# ─── This option allows you to set the maximum number of changes saved in database for each view. ───
# ─── /!\ If you decrease the value, the extra history can be deleted on daemon startup. ───
# ─── /!\ Minimum value is 10. ───
# Default : 100 ───
# ───
# broker__module_webui__views_history__nb_changes_kept__default_for_all 100
# ─────────────────────── Trash ─────────────────────────────────────────────────────────────────────── #
# ─── This option allows you to set the maximum number of days that views are kept in the trash. ───
# ─── /!\ After this delay, the views are permanently DELETED. ───
# ─── /!\ If you decrease the value, the too old views can be DELETED on daemon startup. ───
# ─── /!\ Minimum value is 30 days. ───
# Default : 30 (days) ───
# ───
# broker__module_webui__views_trash__delay_before_deletion__default_for_all 30 |
| Nom | Type | Unité | Défaut | Commentaire |
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| broker__module_webui__views_history__nb_changes_kept__default_for_all |
|
Texte | --- | 100 | Surcharge de la propriété du fichier /etc/shinken/modules/webui .cfg ( voir la page Configuration du module WebUI ) | | Nom | Type | Unité | DéfautCommentaire | | Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| broker__module_webui__views_trash__delay_before_deletion__default_for_all |
|
Texte | Jours | 30 | Surcharge de la propriété du fichier /etc/shinken/modules/webui .cfg
( voir la page Configuration du module WebUI )