diff --git a/doc/02-Installation.md b/doc/02-Installation.md index ae37dbbc5..e301afa4a 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -35,16 +35,16 @@ pagespeed Disallow "*/icingaweb2/*"; Below is a list of official package repositories for installing Icinga Web 2 for various operating systems. -Distribution | Repository -------------------------|--------------------------- -Debian | [debmon](http://debmon.org/packages/debmon-jessie/icingaweb2), [Icinga Repository](http://packages.icinga.org/debian/) -Ubuntu | [Icinga Repository](http://packages.icinga.org/ubuntu/) -RHEL/CentOS | [Icinga Repository](http://packages.icinga.org/epel/) -openSUSE | [Icinga Repository](http://packages.icinga.org/openSUSE/) -SLES | [Icinga Repository](http://packages.icinga.org/SUSE/) -Gentoo | - -FreeBSD | - -ArchLinux | [Upstream](https://aur.archlinux.org/packages/icingaweb2) +| Distribution | Repository | +| ------------- | ---------- | +| Debian | [debmon](http://debmon.org/packages/debmon-jessie/icingaweb2), [Icinga Repository](http://packages.icinga.org/debian/) | +| Ubuntu | [Icinga Repository](http://packages.icinga.org/ubuntu/) | +| RHEL/CentOS | [Icinga Repository](http://packages.icinga.org/epel/) | +| openSUSE | [Icinga Repository](http://packages.icinga.org/openSUSE/) | +| SLES | [Icinga Repository](http://packages.icinga.org/SUSE/) | +| Gentoo | - | +| FreeBSD | - | +| ArchLinux | [Upstream](https://aur.archlinux.org/packages/icingaweb2) | Packages for distributions other than the ones listed above may also be available. Please contact your distribution packagers. diff --git a/doc/03-Configuration.md b/doc/03-Configuration.md index 5ded2eaff..879c11545 100644 --- a/doc/03-Configuration.md +++ b/doc/03-Configuration.md @@ -5,11 +5,11 @@ Apart from its web configuration capabilities, the local configuration is stored in `/etc/icingaweb2` by default (depending on your config setup). -| **File/Directory** | **Description/Purpose** | -| :------------- | :------------------- | -| **config.ini** | general configuration (logging, preferences, etc.) -| [**resources.ini**](04-Ressources.md) | 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**](05-Authentication.md) | authentication backends (e.g. database) -| **enabledModules** | contains symlinks to enabled modules -| **modules** | directory for module specific configuration +| File/Directory | Description/Purpose | +| ------------------------------------------------- | ------------------- | +| **config.ini** | general configuration (logging, preferences, etc.) | +| [**resources.ini**](04-Ressources.md) | 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**](05-Authentication.md) | authentication backends (e.g. database) | +| **enabledModules** | contains symlinks to enabled modules | +| **modules** | directory for module specific configuration | diff --git a/doc/04-Resources.md b/doc/04-Resources.md index a464cfe91..3fb0fe802 100644 --- a/doc/04-Resources.md +++ b/doc/04-Resources.md @@ -16,15 +16,15 @@ paragraphs. A Database resource defines a connection to a SQL databases which can contain users and groups to handle authentication and authorization, monitoring data or user preferences. -Directive | Description -:---------------|:------------ -**type** | `db` -**db** | Database management system. In most cases `mysql` or `pgsql`. -**host** | Connect to the database server on the given host. For using unix domain sockets, specify `localhost` for MySQL and the path to the unix domain socket directory for PostgreSQL. -**port** | Port number to use. Mandatory for connections to a PostgreSQL database. -**username** | The username to use when connecting to the server. -**password** | The password to use when connecting to the server. -**dbname** | The database to use. +| Directive | Description | +| ------------- | ----------- | +| **type** | `db` | +| **db** | Database management system. In most cases `mysql` or `pgsql`. | +| **host** | Connect to the database server on the given host. For using unix domain sockets, specify `localhost` for MySQL and the path to the unix domain socket directory for PostgreSQL. | +| **port** | Port number to use. Mandatory for connections to a PostgreSQL database. | +| **username** | The username to use when connecting to the server. | +| **password** | The password to use when connecting to the server. | +| **dbname** | The database to use. | #### Example @@ -61,26 +61,26 @@ dbname = icingaweb A LDAP resource represents a tree in a LDAP directory. LDAP is usually used for authentication and authorization. -Directive | Description -:---------------|:------------ -**type** | `ldap` -**hostname** | Connect to the LDAP server on the given host. -**port** | Port number to use for the connection. -**root_dn** | Root object of the tree, e.g. `ou=people,dc=icinga,dc=org` -**bind_dn** | The user to use when connecting to the server. -**bind_pw** | The password to use when connecting to the server. -**encryption** | Type of encryption to use: `none` (default), `starttls`, `ldaps`. +| Directive | Description | +| ----------------- | ----------- | +| **type** | `ldap` | +| **hostname** | Connect to the LDAP server on the given host. | +| **port** | Port number to use for the connection. | +| **root_dn** | Root object of the tree, e.g. `ou=people,dc=icinga,dc=org` | +| **bind_dn** | The user to use when connecting to the server. | +| **bind_pw** | The password to use when connecting to the server. | +| **encryption** | Type of encryption to use: `none` (default), `starttls`, `ldaps`. | #### Example ```` [ad] -type = ldap -hostname = localhost -port = 389 -root_dn = "ou=people,dc=icinga,dc=org" -bind_dn = "cn=admin,ou=people,dc=icinga,dc=org" -bind_pw = admin +type = ldap +hostname = localhost +port = 389 +root_dn = "ou=people,dc=icinga,dc=org" +bind_dn = "cn=admin,ou=people,dc=icinga,dc=org" +bind_pw = admin ```` @@ -89,38 +89,19 @@ bind_pw = admin A SSH resource contains the information about the user and the private key location, which can be used for the key-based ssh authentication. -Directive | Description -:--------------------|:------------ -**type** | `ssh` -**user** | The username to use when connecting to the server. -**private_key** | The path to the private key of the user. +| Directive | Description | +| ----------------- | ----------- | +| **type** | `ssh` | +| **user** | The username to use when connecting to the server. | +| **private_key** | The path to the private key of the user. | #### Example ```` [ssh] -type = "ssh" -user = "ssh-user" -private_key = "/etc/icingaweb2/ssh/ssh-user" - -```` - -### Livestatus - -A Livestatus resource represents the location of a Livestatus socket which is used for fetching monitoring data. - -Directive | Description -:---------------|:------------ -**type** | `livestatus` -**socket** | location of the livestatus socket (either a path to a local livestatus socket or a path to a remote livestatus socket in the format `tcp://:`) - -#### Example - -```` - -[livestatus] -type = livestatus -socket = /var/run/icinga2/cmd/livestatus +type = "ssh" +user = "ssh-user" +private_key = "/etc/icingaweb2/ssh/ssh-user" ```` diff --git a/doc/05-Authentication.md b/doc/05-Authentication.md index c30c593ff..8bf10970f 100644 --- a/doc/05-Authentication.md +++ b/doc/05-Authentication.md @@ -68,13 +68,13 @@ Active Directory or LDAP configuration method. ### LDAP -Directive | Description -------------------------|------------ -**backend** | `ldap` -**resource** | The name of the LDAP resource defined in [resources.ini](04-Resources.md#resources). -**user_class** | LDAP user class. -**user_name_attribute** | LDAP attribute which contains the username. -**filter** | LDAP search filter. +| Directive | Description | +| ------------------------- | ----------- | +| **backend** | `ldap` | +| **resource** | The name of the LDAP resource defined in [resources.ini](04-Resources.md#resources). | +| **user_class** | LDAP user class. | +| **user_name_attribute** | LDAP attribute which contains the username. | +| **filter** | LDAP search filter. | **Example:** @@ -93,10 +93,10 @@ with Icinga Web 2 (e.g. an alias) no matter what the primary user id might actua ### Active Directory -Directive | Description -------------------------|------------ -**backend** | `msldap` -**resource** | The name of the LDAP resource defined in [resources.ini](04-Resources.md#resources). +| Directive | Description | +| ------------- | ----------- | +| **backend** | `msldap` | +| **resource** | The name of the LDAP resource defined in [resources.ini](04-Resources.md#resources). | **Example:** @@ -112,10 +112,10 @@ If you want to authenticate against a MySQL or a PostgreSQL database, you have t [database resource](04-Resources.md#resources-configuration-database) which will be referenced as data source for the database authentication method. -Directive | Description -------------------------|------------ -**backend** | `db` -**resource** | The name of the database resource defined in [resources.ini](04-Resources.md#resources). +| Directive | Description | +| ------------------------| ----------- | +| **backend** | `db` | +| **resource** | The name of the database resource defined in [resources.ini](04-Resources.md#resources). | **Example:** diff --git a/doc/06-Security.md b/doc/06-Security.md index 9c4dc13f4..7c0fd40f4 100644 --- a/doc/06-Security.md +++ b/doc/06-Security.md @@ -97,8 +97,7 @@ Roles can be changed either through the icingaweb2 interface, by navigation to the page **Configuration > Authentication > Roles**, or through editing the configuration file: - - /etc/icingaweb2/roles.ini + /etc/icingaweb2/roles.ini #### Introducing Example @@ -125,12 +124,12 @@ Each role is defined as a section, with the name of the role as section name. Th attributes can be defined for each role in a default Icinga Web 2 installation: - Directive | Description -:--------------------------|:---------------- - **users** | a comma-separated list of user **user names** that are affected by this role - **groups** | a comma-separated list of **group names** that are affected by this role - **permissions** | a comma-separated list of **permissions** granted by this role - **monitoring/filter/objects** | a **filter expression** that restricts the access to services and hosts +| Directive | Description | +| ----------------------------- | ----------- | +| **users** | a comma-separated list of user **user names** that are affected by this role | +| **groups** | a comma-separated list of **group names** that are affected by this role | +| **permissions** | a comma-separated list of **permissions** granted by this role | +| **monitoring/filter/objects** | a **filter expression** that restricts the access to services and hosts | @@ -156,12 +155,12 @@ through a group) all permissions are added together to get the users actual perm ### Global Permissions -Name | Permits -:-----------|:------------ -**\*** | allow everything, including module-specific permissions -**config/\*** | allow all configuration actions -**config/modules** | allow enabling or disabling modules -**module/<moduleName>** | allow access to module <moduleName> +| Name | Permits | +| ----------------------------- | ------------ | +| **\*** | allow everything, including module-specific permissions | +| **config/\*** | allow all configuration actions | +| **config/modules** | allow enabling or disabling modules | +| **module/<moduleName>** | allow access to module <moduleName> | ### Monitoring Module Permissions diff --git a/doc/07-Preferences.md b/doc/07-Preferences.md index e89a507bf..198969378 100644 --- a/doc/07-Preferences.md +++ b/doc/07-Preferences.md @@ -30,10 +30,10 @@ In order to be more flexible in distributed setups you can store preferences in For storing preferences in a database, you have to define a [database resource](04-Resources.md#resources-configuration-database) which will be referenced as resource for the preferences storage. -Directive | Description -------------------------|------------ -**type** | `db` -**resource** | The name of the database resource defined in [resources.ini](04-Resources.md#resources). +| Directive | Description | +| ------------- | ----------- | +| **type** | `db` | +| **resource** | The name of the database resource defined in [resources.ini](04-Resources.md#resources). | **Example:** diff --git a/modules/monitoring/doc/configuration.md b/modules/monitoring/doc/configuration.md index 5c3a23aa4..da63d8bbd 100644 --- a/modules/monitoring/doc/configuration.md +++ b/modules/monitoring/doc/configuration.md @@ -5,12 +5,12 @@ 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 | [commandtransports.ini](commandtransports.md#commandtransports) | Command transports for specific Icinga instances +| 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 | [commandtransports.ini](commandtransports.md#commandtransports) | Command transports for specific Icinga instances | diff --git a/modules/monitoring/doc/security.md b/modules/monitoring/doc/security.md index cce3727a8..74ca69519 100644 --- a/modules/monitoring/doc/security.md +++ b/modules/monitoring/doc/security.md @@ -13,7 +13,7 @@ commands when using the monitoring module. | Name | Permits | -|---------------------------------------------|-----------------------------------------------------------------------------| +| ------------------------------------------- | --------------------------------------------------------------------------- | | monitoring/command/* | Allow all commands | | monitoring/command/schedule-check | Allow scheduling host and service checks' | | monitoring/command/acknowledge-problem | Allow acknowledging host and service problems | @@ -33,7 +33,7 @@ The monitoring module allows filtering objects: | Keys | Restricts | -|----------------------------|-----------------------------------------------| +| ---------------------------|---------------------------------------------- | | monitoring/filter/objects | Applies a filter to all hosts and services | @@ -48,7 +48,7 @@ The following filter column names are available in filter expressions: | Column | -|--------------------------------------------------------------| +| ------------------------------------------------------------ | | instance_name | | host_name | | hostgroup_name |