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

Fix markdown table syntax

This commit is contained in:
Eric Lippmann 2016-09-01 14:18:29 +02:00
parent cbf55ffbf1
commit 2d32f4a3be
8 changed files with 91 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/02-Installation.md
View File

@ -35,16 +35,16 @@ pagespeed Disallow "*/icingaweb2/*";
Below is a list of official package repositories for installing Icinga Web 2 for various operating systems. Below is a list of official package repositories for installing Icinga Web 2 for various operating systems.
Distribution | Repository | Distribution | Repository |
------------------------|--------------------------- | ------------- | ---------- |
Debian | [debmon](http://debmon.org/packages/debmon-jessie/icingaweb2), [Icinga Repository](http://packages.icinga.org/debian/) | Debian | [debmon](http://debmon.org/packages/debmon-jessie/icingaweb2), [Icinga Repository](http://packages.icinga.org/debian/) |
Ubuntu | [Icinga Repository](http://packages.icinga.org/ubuntu/) | Ubuntu | [Icinga Repository](http://packages.icinga.org/ubuntu/) |
RHEL/CentOS | [Icinga Repository](http://packages.icinga.org/epel/) | RHEL/CentOS | [Icinga Repository](http://packages.icinga.org/epel/) |
openSUSE | [Icinga Repository](http://packages.icinga.org/openSUSE/) | openSUSE | [Icinga Repository](http://packages.icinga.org/openSUSE/) |
SLES | [Icinga Repository](http://packages.icinga.org/SUSE/) | SLES | [Icinga Repository](http://packages.icinga.org/SUSE/) |
Gentoo | - | Gentoo | - |
FreeBSD | - | FreeBSD | - |
ArchLinux | [Upstream](https://aur.archlinux.org/packages/icingaweb2) | ArchLinux | [Upstream](https://aur.archlinux.org/packages/icingaweb2) |
Packages for distributions other than the ones listed above may also be available. Packages for distributions other than the ones listed above may also be available.
Please contact your distribution packagers. Please contact your distribution packagers.

16
doc/03-Configuration.md
View File

@ -5,11 +5,11 @@
Apart from its web configuration capabilities, the local configuration is Apart from its web configuration capabilities, the local configuration is
stored in `/etc/icingaweb2` by default (depending on your config setup). stored in `/etc/icingaweb2` by default (depending on your config setup).
| **File/Directory** | **Description/Purpose** | | File/Directory | Description/Purpose |
| :------------- | :------------------- | | ------------------------------------------------- | ------------------- |
| **config.ini** | general configuration (logging, preferences, etc.) | **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) | [**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 | **roles.ini** | user specific roles (e.g. `administrators`) and permissions |
| [**authentication.ini**](05-Authentication.md) | authentication backends (e.g. database) | [**authentication.ini**](05-Authentication.md) | authentication backends (e.g. database) |
| **enabledModules** | contains symlinks to enabled modules | **enabledModules** | contains symlinks to enabled modules |
| **modules** | directory for module specific configuration | **modules** | directory for module specific configuration |

65
doc/04-Resources.md
View File

@ -16,15 +16,15 @@ paragraphs.
A Database resource defines a connection to a SQL databases which can contain users and groups 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. to handle authentication and authorization, monitoring data or user preferences.
Directive | Description | Directive | Description |
:---------------|:------------ | ------------- | ----------- |
**type** | `db` | **type** | `db` |
**db** | Database management system. In most cases `mysql` or `pgsql`. | **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. | **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. | **port** | Port number to use. Mandatory for connections to a PostgreSQL database. |
**username** | The username to use when connecting to the server. | **username** | The username to use when connecting to the server. |
**password** | The password to use when connecting to the server. | **password** | The password to use when connecting to the server. |
**dbname** | The database to use. | **dbname** | The database to use. |
#### <a id="resources-configuration-database-example"></a> Example #### <a id="resources-configuration-database-example"></a> Example
@ -61,15 +61,15 @@ dbname = icingaweb
A LDAP resource represents a tree in a LDAP directory. LDAP is usually used for authentication and authorization. A LDAP resource represents a tree in a LDAP directory. LDAP is usually used for authentication and authorization.
Directive | Description | Directive | Description |
:---------------|:------------ | ----------------- | ----------- |
**type** | `ldap` | **type** | `ldap` |
**hostname** | Connect to the LDAP server on the given host. | **hostname** | Connect to the LDAP server on the given host. |
**port** | Port number to use for the connection. | **port** | Port number to use for the connection. |
**root_dn** | Root object of the tree, e.g. `ou=people,dc=icinga,dc=org` | **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_dn** | The user to use when connecting to the server. |
**bind_pw** | The password 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`. | **encryption** | Type of encryption to use: `none` (default), `starttls`, `ldaps`. |
#### <a id="resources-configuration-ldap-example"></a> Example #### <a id="resources-configuration-ldap-example"></a> Example
@ -89,11 +89,11 @@ 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 A SSH resource contains the information about the user and the private key location, which can be used for the key-based
ssh authentication. ssh authentication.
Directive | Description | Directive | Description |
:--------------------|:------------ | ----------------- | ----------- |
**type** | `ssh` | **type** | `ssh` |
**user** | The username to use when connecting to the server. | **user** | The username to use when connecting to the server. |
**private_key** | The path to the private key of the user. | **private_key** | The path to the private key of the user. |
#### <a id="resources-configuration-ssh-example"></a> Example #### <a id="resources-configuration-ssh-example"></a> Example
@ -105,22 +105,3 @@ user = "ssh-user"
private_key = "/etc/icingaweb2/ssh/ssh-user" private_key = "/etc/icingaweb2/ssh/ssh-user"
```` ````
### <a id="resources-configuration-livestatus"></a> 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://<host>:<port>`)
#### <a id="resources-configuration-livestatus-example"></a>Example
````
[livestatus]
type = livestatus
socket = /var/run/icinga2/cmd/livestatus
````

30
doc/05-Authentication.md
View File

@ -68,13 +68,13 @@ Active Directory or LDAP configuration method.
### <a id="authentication-configuration-ldap-authentication"></a> LDAP ### <a id="authentication-configuration-ldap-authentication"></a> LDAP
Directive | Description | Directive | Description |
------------------------|------------ | ------------------------- | ----------- |
**backend** | `ldap` | **backend** | `ldap` |
**resource** | The name of the LDAP resource defined in [resources.ini](04-Resources.md#resources). | **resource** | The name of the LDAP resource defined in [resources.ini](04-Resources.md#resources). |
**user_class** | LDAP user class. | **user_class** | LDAP user class. |
**user_name_attribute** | LDAP attribute which contains the username. | **user_name_attribute** | LDAP attribute which contains the username. |
**filter** | LDAP search filter. | **filter** | LDAP search filter. |
**Example:** **Example:**
@ -93,10 +93,10 @@ with Icinga Web 2 (e.g. an alias) no matter what the primary user id might actua
### <a id="authentication-configuration-ad-authentication"></a> Active Directory ### <a id="authentication-configuration-ad-authentication"></a> Active Directory
Directive | Description | Directive | Description |
------------------------|------------ | ------------- | ----------- |
**backend** | `msldap` | **backend** | `msldap` |
**resource** | The name of the LDAP resource defined in [resources.ini](04-Resources.md#resources). | **resource** | The name of the LDAP resource defined in [resources.ini](04-Resources.md#resources). |
**Example:** **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 [database resource](04-Resources.md#resources-configuration-database) which will be referenced as data source for the database
authentication method. authentication method.
Directive | Description | Directive | Description |
------------------------|------------ | ------------------------| ----------- |
**backend** | `db` | **backend** | `db` |
**resource** | The name of the database resource defined in [resources.ini](04-Resources.md#resources). | **resource** | The name of the database resource defined in [resources.ini](04-Resources.md#resources). |
**Example:** **Example:**

25
doc/06-Security.md
View File

@ -97,7 +97,6 @@ Roles can be changed either through the icingaweb2 interface, by navigation
to the page **Configuration > Authentication > Roles**, or through editing the to the page **Configuration > Authentication > Roles**, or through editing the
configuration file: configuration file:
/etc/icingaweb2/roles.ini /etc/icingaweb2/roles.ini
@ -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: attributes can be defined for each role in a default Icinga Web 2 installation:
Directive | Description | Directive | Description |
:--------------------------|:---------------- | ----------------------------- | ----------- |
**users** | a comma-separated list of user **user names** that are affected by this role | **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 | **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 | **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 | **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
### <a id="permissions-global"></a> Global Permissions ### <a id="permissions-global"></a> Global Permissions
Name | Permits | Name | Permits |
:-----------|:------------ | ----------------------------- | ------------ |
**\*** | allow everything, including module-specific permissions | **\*** | allow everything, including module-specific permissions |
**config/\*** | allow all configuration actions | **config/\*** | allow all configuration actions |
**config/modules** | allow enabling or disabling modules | **config/modules** | allow enabling or disabling modules |
**module/&lt;moduleName&gt;** | allow access to module &lt;moduleName&gt; | **module/&lt;moduleName&gt;** | allow access to module &lt;moduleName&gt; |
### <a id="permissions-module"></a> Monitoring Module Permissions ### <a id="permissions-module"></a> Monitoring Module Permissions

8
doc/07-Preferences.md
View File

@ -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) 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. which will be referenced as resource for the preferences storage.
Directive | Description | Directive | Description |
------------------------|------------ | ------------- | ----------- |
**type** | `db` | **type** | `db` |
**resource** | The name of the database resource defined in [resources.ini](04-Resources.md#resources). | **resource** | The name of the database resource defined in [resources.ini](04-Resources.md#resources). |
**Example:** **Example:**

12
modules/monitoring/doc/configuration.md
View File

@ -5,12 +5,12 @@
Apart from its web configuration capabilities, the local configuration is Apart from its web configuration capabilities, the local configuration is
stored in `/etc/icingaweb2` by default (depending on your config setup). stored in `/etc/icingaweb2` by default (depending on your config setup).
Location | File | Description | Location | File | Description |
------------------------------|-----------------------|--------------------------- | --------------------- | ----------------------------------------------------------------- | ----------- |
modules/monitoring | Directory | `monitoring` module specific configuration | modules/monitoring | Directory | `monitoring` module specific configuration |
modules/monitoring | config.ini | Security settings (e.g. protected custom vars) for the `monitoring` module | 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 | backends.ini | Backend type and resources (e.g. Icinga IDO DB) |
modules/monitoring | [commandtransports.ini](commandtransports.md#commandtransports) | Command transports for specific Icinga instances | modules/monitoring | [commandtransports.ini](commandtransports.md#commandtransports) | Command transports for specific Icinga instances |

6
modules/monitoring/doc/security.md
View File

@ -13,7 +13,7 @@ commands when using the monitoring module.
| Name | Permits | | Name | Permits |
|---------------------------------------------|-----------------------------------------------------------------------------| | ------------------------------------------- | --------------------------------------------------------------------------- |
| monitoring/command/* | Allow all commands | | monitoring/command/* | Allow all commands |
| monitoring/command/schedule-check | Allow scheduling host and service checks' | | monitoring/command/schedule-check | Allow scheduling host and service checks' |
| monitoring/command/acknowledge-problem | Allow acknowledging host and service problems | | monitoring/command/acknowledge-problem | Allow acknowledging host and service problems |
@ -33,7 +33,7 @@ The monitoring module allows filtering objects:
| Keys | Restricts | | Keys | Restricts |
|----------------------------|-----------------------------------------------| | ---------------------------|---------------------------------------------- |
| monitoring/filter/objects | Applies a filter to all hosts and services | | 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 | | Column |
|--------------------------------------------------------------| | ------------------------------------------------------------ |
| instance_name | | instance_name |
| host_name | | host_name |
| hostgroup_name | | hostgroup_name |