Skip to content

Commit 9403fcd

Browse files
committed
Add document for the configuration of the IcingaDB-Modul
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.
1 parent 274b903 commit 9403fcd

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

Diff for: doc/03-Configuration.md

+37
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,43 @@ 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+
Navigate into `Modules` -> `icingadb`.
67+
68+
### Available Settings and defaults
69+
70+
Option | Description | Default
71+
----------------------------------|-----------------------------------|------------
72+
acknowledge_expire | Sets "Use Expire Time" in Acknowledgement dialog. | **0 (false)**
73+
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)**.
74+
acknowledge_notify | Sets "Send Notification" in Acknowledgement dialog. | **1 (true)**
75+
acknowledge_persistent | Sets "Persistent Comment" in Acknowledgement dialog. | **0 (false)**
76+
acknowledge_sticky | Sets "Sticky Acknowledgement" in Acknowledgement dialog. | **0 (false)**
77+
comment_expire | Sets "Use Expire Time" in Comment dialog. | **0 (false)**
78+
hostdowntime_comment_text | Sets default text for "Comment" in Host Downtime dialog | ""
79+
servicedowntime_comment_text | Sets default text for "Comment" in Service Downtime dialog. | ""
80+
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)**
81+
custom_notification_forced | Sets "Forced" in Custom Notification dialog. | **0 (false)**
82+
hostdowntime_all_services | Sets "All Services" in Schedule Host Downtime dialog. | **0 (false)**
83+
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)**.
84+
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)**.
85+
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)**.
86+
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)**.
87+
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)**.
88+
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)**.
89+
90+
Example for having acknowledgements with 2 hours expire time by default.
91+
92+
```
93+
# vim /etc/icingaweb2/modules/icingadb/config.ini
94+
95+
[settings]
96+
acknowledge_expire = 1
97+
acknowledge_expire_time = PT2H
98+
99+
```
100+
64101
## Security
65102

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

0 commit comments

Comments
 (0)