Skip to content

Commit 4293461

Browse files
Add document for the configuration of the IcingaDB-Modul (#971)
This adds a listing of the possible settings for the module in the configuration files. It is quite similar to the monitoring module, but wasn't documented for this one. --------- Co-authored-by: Johannes Meyer <[email protected]>
1 parent 2e2b053 commit 4293461

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

doc/03-Configuration.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,45 @@ For this you need an `ApiUser` object with at least the following permissions on
6161
also configure the secondary master's API command transport.
6262
Icinga DB Web then uses this transport if the primary one is not available.
6363

64+
## General Configuration
65+
66+
You can adjust some default values of options users have while interacting with particular dialogs in the UI. (e.g. While acknowledging a problem)
67+
These options can not be adjusted in the UI directly, but have to be set in the
68+
configuration file `/etc/icingaweb2/modules/icingadb/config.ini`.
69+
70+
### Available Settings and defaults
71+
72+
Option | Description | Default
73+
----------------------------------|-----------------------------------|------------
74+
acknowledge_expire | Sets "Use Expire Time" in Acknowledgement dialog. | **0 (false)**
75+
acknowledge_expire_time | Sets the value for "Expire Time" in Acknowledgement dialog, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**.
76+
acknowledge_notify | Sets "Send Notification" in Acknowledgement dialog. | **1 (true)**
77+
acknowledge_persistent | Sets "Persistent Comment" in Acknowledgement dialog. | **0 (false)**
78+
acknowledge_sticky | Sets "Sticky Acknowledgement" in Acknowledgement dialog. | **0 (false)**
79+
comment_expire | Sets "Use Expire Time" in Comment dialog. | **0 (false)**
80+
hostdowntime_comment_text | Sets default text for "Comment" in Host Downtime dialog | ""
81+
servicedowntime_comment_text | Sets default text for "Comment" in Service Downtime dialog. | ""
82+
comment_expire_time | Sets default value for "Expire Time" in Comment dialog, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**
83+
custom_notification_forced | Sets "Forced" in Custom Notification dialog. | **0 (false)**
84+
hostdowntime_all_services | Sets "All Services" in Schedule Host Downtime dialog. | **0 (false)**
85+
hostdowntime_end_fixed | Sets default value for "End Time" in Schedule Host Downtime dialog for **Fixed** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**.
86+
hostdowntime_end_flexible | Sets default value for "End Time" in Schedule Host Downtime dialog for **Flexible** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **2 hours (PT2H)**.
87+
hostdowntime_flexible_duration | Sets default value for "Flexible Duration" in Schedule Host Downtime dialog for **Flexible** downtime. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **2 hour (PT2H)**.
88+
servicedowntime_end_fixed | Sets default value for "End Time" in Schedule Service Downtime dialog for **Fixed** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**.
89+
servicedowntime_end_flexible | Set default value for "End Time" in Schedule Service Downtime dialog for **Flexible** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**.
90+
servicedowntime_flexible_duration | Set default value for "Flexible Duration" in Schedule Service Downtime dialog for **Flexible** downtime. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **2 hour (PT2H)**.
91+
92+
93+
### Example
94+
95+
Setting acknowledgements with 2 hours expire time by default.
96+
97+
```
98+
[settings]
99+
acknowledge_expire = 1
100+
acknowledge_expire_time = PT2H
101+
```
102+
64103
## Security
65104

66105
To grant users permissions to run commands and restrict them to specific views,

doc/10-Migration.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ If that is the case, this chapter has you covered.
88

99
## Configuration
1010

11+
### General configuration via config.ini
12+
13+
Icinga DB Web still uses the same configuration format as the monitoring module. This means that the file
14+
`/etc/icingaweb2/modules/monitoring/config.ini` can simply be copied over to
15+
`/etc/icingaweb2/modules/icingadb/config.ini`:
16+
17+
```
18+
cp /etc/icingaweb2/modules/monitoring/config.ini /etc/icingaweb2/modules/icingadb/config.ini
19+
```
20+
21+
The behaviour of those options remains the same.
22+
1123
### Command Transports
1224

1325
Icinga DB Web still uses the same configuration format for command transports. This means that the file
@@ -158,3 +170,4 @@ general access to the monitoring module, this is not automatically migrated. You
158170
It gives you the chance to review the performed changes, before letting them loose on your users. Please also
159171
take in mind, that Icinga DB Web handles permissions and restrictions differently. Our blog provides details
160172
on that: https://icinga.com/blog/2021/04/07/web-access-control-redefined/#icingadb-permission-linkage
173+

0 commit comments

Comments
 (0)