tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
icingaweb2/doc/03-Configuration.md

78 lines
3.8 KiB
Markdown
Raw Normal View History

Update docs for better compatibility with mkdocs * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-14 16:33:05 +02:00
# Configuration <a id="configuration"></a>
Documentation: Add config overview as first draft refs #7153
2015-05-26 16:04:57 +02:00
Update docs for better compatibility with mkdocs * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-14 16:33:05 +02:00
## Overview <a id="configuration-overview"></a>
Documentation: Add config overview as first draft refs #7153
2015-05-26 16:04:57 +02:00
Apart from its web configuration capabilities, the local configuration is
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-26 18:52:32 +02:00
stored in `/etc/icingaweb2` by default (depending on your configuration setup).
File/Directory | Description
------------------------------------------------------- | ---------------------------------
[config.ini](03-Configuration.md#configuration-general) | General configuration (global, logging, themes, etc.)
[resources.ini](04-Resources.md#resources) | Global resources (Icinga Web 2 database for preferences and authentication, Icinga 2 IDO database)
[roles.ini](06-Security.md#security-roles) | User specific roles (e.g. `administrators`) and permissions
[authentication.ini](05-Authentication.md) | Authentication backends (e.g. database)
enabledModules | Symlinks to enabled modules
modules | Directory for module specific configuration
## General Configuration <a id="configuration-general"></a>
Navigate into **Configuration > Application > General **.
This configuration is stored in the `config.ini` file in `/etc/icingaweb2`.
### Global Configuration <a id="configuration-general-global"></a>
Option | Description
-------------------------|-----------------------------------------------
show\_stacktraces | **Optional.** Whether to show debug stacktraces. Defaults to `0`.
module\_path | **Optional.** Specifies the directories where modules can be installed. Multiple directories must be separated with colons.
config\_backend | **Optional.** Select the user preference storage. Can be set to `ini` (default), `db` or `none`. If `db` is selected, this requires the `config_resource` attribute.
config\_resource | **Optional.** Specify a defined [resource](04-Resources.md#resources-configuration-database) name. Can only be used if `config_backend` is set to `db`.
Example for storing the user preferences in the database resource `icingaweb_db`:
```
[global]
show_stacktraces = "0"
config_backend = "db"
config_resource = "icingaweb_db"
module_path = "/usr/share/icingaweb2/modules"
```
### Logging Configuration <a id="configuration-general-logging"></a>
Option | Description
-------------------------|-----------------------------------------------
log | **Optional.** Specifies the logging type. Can be set to `syslog`, `file` or `none`.
level | **Optional.** Specifies the logging level. Can be set to `ERROR`, `WARNING`, `INFORMATION` or `DEBUG`.
file | **Optional.** Specifies the log file path if `log` is set to `file`.
application | **Optional.** Specifies the application name if `log` is set to `syslog`.
facility | **Optional.** Specifies the syslog facility if `log` is set to `syslog`. Can be set to `user`, `local0` to `local7`. Defaults to `user`.
Example for more verbose debug logging into a file:
```
[logging]
log = "file"
level = "DEBUG"
file = "/usr/share/icingaweb2/log/icingaweb2.log"
```
### Theme Configuration <a id="configuration-general-theme"></a>
Option | Description
-------------------------|-----------------------------------------------
theme | **Optional.** Choose the theme. Can be set to `Icinga`, `high-contrast`, `Winter` or your own installed theme. Defaults to `Icinga`. Note that this setting is case-sensitive because it refers to the filename of the theme.
disabled | **Optional.** Set this to `1` if users should not be allowed to change their theme. Defaults to `0`.
Example:
```
[themes]
disabled = "1"
theme = "Icinga"
```