icingaweb2/doc/01-About.md

# About Icinga Web 2 <a id="about"></a>

Icinga Web 2 is a powerful PHP framework for web applications that comes in a clean and reduced design.
It's fast, responsive, accessible and easily extensible with modules.

## The monitoring module <a id="about-monitoring"></a>

This is the core module for most Icinga Web 2 users.

It provides an intuitive user interface for monitoring with Icinga 2.
Especially there are lots of list and detail views (e.g. for hosts and services)
you can sort and filter depending on what you want to see.

You can also control the monitoring process itself by sending external commands to Icinga.
Most such actions (like rescheduling a check) can be done with just a single click.

More details about this module can be found in [this chapter](../modules/monitoring/doc/01-About.md#monitoring-module-about).

## Installation <a id="about-installation"></a>

Icinga Web 2 can be installed easily from packages from the official package repositories.
Setting it up is also easy with the web based setup wizard.

See [here](02-Installation.md#installation) for more information about the installation.

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

Icinga Web 2 can be configured via the user interface and .ini files.

See [here](03-Configuration.md#configuration) for more information about the configuration.

## Authentication <a id="about-authentication"></a>

With Icinga Web 2 you can authenticate against relational databases, LDAP and more.
These authentication methods can be easily configured (via the corresponding .ini file).

See [here](05-Authentication.md#authentication) for more information about
the different authentication methods available and how to configure them.

## Authorization <a id="about-authorization"></a>

In Icinga Web 2 there are permissions and restrictions to allow and deny (respectively)
roles to view or to do certain things.
These roles can be assigned to users and groups.

See [here](06-Security.md#security) for more information about authorization
and how to configure roles.

## User preferences <a id="about-preferences"></a>

Besides the global configuration each user has individual configuration options
like the interface's language or the current timezone.
They can be stored either in a database or in .ini files.

See [here](07-Preferences.md#preferences) for more information about a user's preferences
and how to configure their storage type.

## Documentation <a id="about-documentation"></a>

With the documentation module you can read the documentation of the framework (and any module) directly in the user interface.

The module can also export the documentation to PDF.

More details about this module can be found in [this chapter](../modules/doc/doc/01-About.md#doc-module-about).

## Translation <a id="about-translation"></a>

With the translation module every piece of text in the user interface (of the framework itself and any module) can be translated to a language of your choice.

Currently provided languages:

* German
* Italian
* Portuguese

More details about this module can be found in [this chapter](../modules/translation/doc/01-About.md#translation-module-about).


## Accessibility <a id="about-accessibility"></a>

In the Icinga Web 2 interface even the blind can see - 
easy navigation with a screen reader and specific themes for different kinds of vision deficiencies
make it possible for everyone to monitor their systems without impairments.
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			`# About Icinga Web 2 <a id="about"></a>`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
doc/about.md: add introduction refs #9379 2015-06-08 17:43:12 +02:00			`Icinga Web 2 is a powerful PHP framework for web applications that comes in a clean and reduced design.`
			`It's fast, responsive, accessible and easily extensible with modules.`

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			`## The monitoring module <a id="about-monitoring"></a>`
doc/about.md: add section `The monitoring module' refs #9379 2015-06-08 17:43:12 +02:00
			`This is the core module for most Icinga Web 2 users.`

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			`It provides an intuitive user interface for monitoring with Icinga 2.`
doc/about.md: add section `The monitoring module' refs #9379 2015-06-08 17:43:12 +02:00			`Especially there are lots of list and detail views (e.g. for hosts and services)`
			`you can sort and filter depending on what you want to see.`

			`You can also control the monitoring process itself by sending external commands to Icinga.`
			`Most such actions (like rescheduling a check) can be done with just a single click.`

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			`More details about this module can be found in [this chapter](../modules/monitoring/doc/01-About.md#monitoring-module-about).`

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			`## Installation <a id="about-installation"></a>`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
			`Icinga Web 2 can be installed easily from packages from the official package repositories.`
			`Setting it up is also easy with the web based setup wizard.`

Fix links in about doc Without this change, the links in the about doc are broken. Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com> 2016-09-15 20:36:29 +02:00			`See [here](02-Installation.md#installation) for more information about the installation.`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +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="about-configuration"></a>`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
doc/about.md: typos and grammar refs #9379 2015-06-08 17:43:12 +02:00			`Icinga Web 2 can be configured via the user interface and .ini files.`
Add introduction to section `Configuration' refs #9379 2015-06-09 14:54:50 +02:00
Fix links in about doc Without this change, the links in the about doc are broken. Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com> 2016-09-15 20:36:29 +02:00			`See [here](03-Configuration.md#configuration) for more information about the configuration.`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +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			`## Authentication <a id="about-authentication"></a>`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
Add introduction to section `Authentication' refs #9379 2015-06-09 14:54:50 +02:00			`With Icinga Web 2 you can authenticate against relational databases, LDAP and more.`
doc/about.md: typos and grammar refs #9379 2015-06-08 17:43:12 +02:00			`These authentication methods can be easily configured (via the corresponding .ini file).`
Add introduction to section `Authentication' refs #9379 2015-06-09 14:54:50 +02:00
Fix links in about doc Without this change, the links in the about doc are broken. Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com> 2016-09-15 20:36:29 +02:00			`See [here](05-Authentication.md#authentication) for more information about`
doc/about.md: typos and grammar refs #9379 2015-06-08 17:43:12 +02:00			`the different authentication methods available and how to configure them.`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +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			`## Authorization <a id="about-authorization"></a>`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
Add introduction to section `Authorization' refs #9379 2015-06-09 14:54:50 +02:00			`In Icinga Web 2 there are permissions and restrictions to allow and deny (respectively)`
			`roles to view or to do certain things.`
			`These roles can be assigned to users and groups.`

Fix links in about doc Without this change, the links in the about doc are broken. Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com> 2016-09-15 20:36:29 +02:00			`See [here](06-Security.md#security) for more information about authorization`
Add introduction to section `Authorization' refs #9379 2015-06-09 14:54:50 +02:00			`and how to configure roles.`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +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			`## User preferences <a id="about-preferences"></a>`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
doc/about.md: typos and grammar refs #9379 2015-06-08 17:43:12 +02:00			`Besides the global configuration each user has individual configuration options`
			`like the interface's language or the current timezone.`
Add introduction to section `User preferences' refs #9379 2015-06-09 14:54:50 +02:00			`They can be stored either in a database or in .ini files.`

Fix links in about doc Without this change, the links in the about doc are broken. Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com> 2016-09-15 20:36:29 +02:00			`See [here](07-Preferences.md#preferences) for more information about a user's preferences`
doc/about.md: typos and grammar refs #9379 2015-06-08 17:43:12 +02:00			`and how to configure their storage type.`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +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			`## Documentation <a id="about-documentation"></a>`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
			`With the documentation module you can read the documentation of the framework (and any module) directly in the user interface.`

			`The module can also export the documentation to PDF.`

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			`More details about this module can be found in [this chapter](../modules/doc/doc/01-About.md#doc-module-about).`

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			`## Translation <a id="about-translation"></a>`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
doc/about.md: typos and grammar refs #9379 2015-06-08 17:43:12 +02:00			`With the translation module every piece of text in the user interface (of the framework itself and any module) can be translated to a language of your choice.`
Add doc/about.md refs #9379 2015-06-08 17:43:12 +02:00
			`Currently provided languages:`

			`* German`
			`* Italian`
			`* Portuguese`
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
			`More details about this module can be found in [this chapter](../modules/translation/doc/01-About.md#translation-module-about).`
Adjust documentation 2019-04-17 09:02:25 +02:00

			`## Accessibility <a id="about-accessibility"></a>`

			`In the Icinga Web 2 interface even the blind can see -`
			`easy navigation with a screen reader and specific themes for different kinds of vision deficiencies`
			`make it possible for everyone to monitor their systems without impairments.`