icingaweb2/doc/07-Preferences.md

# Preferences <a id="preferences"></a>

Preferences are settings a user can set for their account only,
for example the language and time zone.

Preferences can be stored either in a MySQL or in a PostgreSQL database. The database must be configured.

## Configuration <a id="preferences-configuration"></a>

The preference configuration backend is defined in the global [config.ini](03-Configuration.md#configuration-general-global) file.

You have to define a [database resource](04-Resources.md#resources-configuration-database)
which will be referenced as resource for the preferences storage.

You need to add the following section to the global [config.ini](03-Configuration.md#configuration-general-global) file
in order to store preferences in a database.

```
[global]
config_resource = "icingaweb_db"
```
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			`# Preferences <a id="preferences"></a>`
User preferences: Add doc, fix initial session write refs #4069 2013-08-02 16:37:47 +02:00
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			`Preferences are settings a user can set for their account only,`
			`for example the language and time zone.`
User preferences: Add doc, fix initial session write refs #4069 2013-08-02 16:37:47 +02:00
Update doc 2022-05-03 13:34:07 +02:00			`Preferences can be stored either in a MySQL or in a PostgreSQL database. The database must be configured.`
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
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="preferences-configuration"></a>`
User preferences: Add doc, fix initial session write refs #4069 2013-08-02 16:37:47 +02:00
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			`The preference configuration backend is defined in the global [config.ini](03-Configuration.md#configuration-general-global) file.`
User preferences: Add doc, fix initial session write refs #4069 2013-08-02 16:37:47 +02:00
Update doc 2022-05-03 13:34:07 +02:00			`You have to define a [database resource](04-Resources.md#resources-configuration-database)`
doc: Remove developer information from preferences.md 2014-12-18 15:40:26 +01:00			`which will be referenced as resource for the preferences storage.`
Add NullStore as preference fallback refs #4529 2013-09-02 16:08:17 +02:00
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			`You need to add the following section to the global [config.ini](03-Configuration.md#configuration-general-global) file`
			`in order to store preferences in a database.`
Add NullStore as preference fallback refs #4529 2013-09-02 16:08:17 +02:00
doc: Remove developer information from preferences.md 2014-12-18 15:40:26 +01:00			```
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			`[global]`
			`config_resource = "icingaweb_db"`
doc: Remove developer information from preferences.md 2014-12-18 15:40:26 +01:00			```