From cf95994ff54b4b8bd70cb675cf3d4a6648d245c7 Mon Sep 17 00:00:00 2001 From: Michael Friedrich Date: Tue, 26 May 2015 16:04:57 +0200 Subject: [PATCH] Documentation: Add config overview as first draft refs #7153 --- doc/configuration.md | 15 +++++++++++++++ modules/monitoring/doc/configuration.md | 16 ++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 doc/configuration.md create mode 100644 modules/monitoring/doc/configuration.md diff --git a/doc/configuration.md b/doc/configuration.md new file mode 100644 index 000000000..90946be83 --- /dev/null +++ b/doc/configuration.md @@ -0,0 +1,15 @@ +# Configuration + +## Overview + +Apart from its web configuration capabilities, the local configuration is +stored in `/etc/icingaweb2` by default (depending on your config setup). + + Location | File | Description + ------------------------------|-----------------------|--------------------------- + . | config.ini | General configuration (logging, preferences) + . | resources.ini | Global resources (Icinga Web 2 database for preferences and authentication, icinga ido database) + . | roles.ini | User specific roles (e.g. `administrators`) and permissions + . | [authentication.ini](authentication.md) | Authentication backends (e.g. database) + enabledModules | Symlink | Contains symlinks to enabled modules from `/usr/share/icingaweb2/modules/*`. Defaults to [monitoring](modules/monitoring/doc/configuration.md) and `doc`. + modules | Directory | Module specific configuration diff --git a/modules/monitoring/doc/configuration.md b/modules/monitoring/doc/configuration.md new file mode 100644 index 000000000..7636b1a52 --- /dev/null +++ b/modules/monitoring/doc/configuration.md @@ -0,0 +1,16 @@ +# Monitoring Module Configuration + +## Overview + +Apart from its web configuration capabilities, the local configuration is +stored in `/etc/icingaweb2` by default (depending on your config setup). + + Location | File | Description + ------------------------------|-----------------------|--------------------------- + modules/monitoring | Directory | `monitoring` module specific configuration + modules/monitoring | config.ini | Security settings (e.g. protected custom vars) for the `monitoring` module + modules/monitoring | backends.ini | Backend type and resources (e.g. Icinga IDO DB) + modules/monitoring | [instances.ini](instances.md#instances) | Instances and their transport (e.g. local external command pipe) + + +