icingaweb2/modules/monitoring/doc/03-Configuration.md
Michael Friedrich 34bd8e14c3 Enhance the documentation and fix outdated information (preferences, etc.)
This applies a new structure for the main doc/ and modules/*/doc tree with

01-About.md
02-Installation.md
...

This allows us to link from the main doc directory into module specific
documentation entries.

Furthermore table formatting, examples, and missing settings have been added
where applicable.

This patch also takes care about proper URL anchors and file names and directories.

fixes #2950
2017-09-29 11:01:37 +02:00

36 lines
1.7 KiB
Markdown

# Monitoring Module Configuration <a id="monitoring-module-configuration"></a>
## Overview <a id="monitoring-module-configuration-overview"></a>
The module specific configuration is stored in `/etc/icingaweb2/modules/monitoring`.
File/Directory | Description
----------------------------------------------------------------------|---------------------------------
[config.ini](01-Configuration.md#monitoring-module-configuration-general) | Security settings (e.g. protected custom vars) for the `monitoring` module |
[backends.ini](02-Backends.md#monitoring-module-backends) | Data backend (e.g. the IDO database [resource](../../../doc/04-Resources.md#resources-configuration-database) name).
[commandtransports.ini](03-Command-Transports.md#commandtransports) | Command transports for specific Icinga instances
## General Configuration <a id="monitoring-module-configuration-general"></a>
Navigate into `Configuration` -> `Modules` -> `Monitoring`. This allows
you to see the provided [permissions and restrictions](06-Security.md#monitoring-security)
by this module.
### Security Configuration <a id="monitoring-module-configuration-security"></a>
Option | Description
-------------------------|-----------------------------------------------
protected\_customvars | **Optional.** Comma separated list of string patterns for custom variables which should be excluded from user's view.
Example for custom variable names which match `*pw*` or `*pass*` or `community`.
```
# vim /etc/icingaweb2/modules/monitoring/config.ini
[security]
protected_customvars = "*pw*,*pass*,community"
```