From: Michael Friedrich <michael.friedrich@icinga.com>
Date: Thu, 7 Sep 2017 15:06:11 +0000 (+0200)
Subject: Docs: Update ApiListener object type
X-Git-Tag: v2.8.0~87^2~5
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f6b267b843bdeb40c4da7aec3b0afed6fd6be5d7;p=icinga2

Docs: Update ApiListener object type

refs #5450
---

diff --git a/doc/09-object-types.md b/doc/09-object-types.md
index e278baaee..0aba518ff 100644
--- a/doc/09-object-types.md
+++ b/doc/09-object-types.md
@@ -31,12 +31,15 @@ The `NodeName` constant must be defined in [constants.conf](04-configuring-icing
 
 Example:
 
-    object ApiListener "api" {
-      cert_path = SysconfDir + "/icinga2/pki/" + NodeName + ".crt"
-      key_path = SysconfDir + "/icinga2/pki/" + NodeName + ".key"
-      ca_path = SysconfDir + "/icinga2/pki/ca.crt"
-    }
+```
+object ApiListener "api" {
+  cert_path = LocalStateDir + "/lib/icinga2/certs/" + NodeName + ".crt"
+  key_path = LocalStateDir + "/lib/icinga2/certs/" + NodeName + ".key"
+  ca_path = LocalStateDir + "/lib/icinga2/certs/ca.crt"
 
+  ticket_salt = TicketSalt
+}
+```
 
 Configuration Attributes:
 
@@ -45,6 +48,7 @@ Configuration Attributes:
   cert\_path                |**Required.** Path to the public key.
   key\_path                 |**Required.** Path to the private key.
   ca\_path                  |**Required.** Path to the CA certificate file.
+  ticket\_salt              |**Optional.** Private key for auto-signing. **Required** for a signing master instance. Defaults to the `TicketSalt` constant defined in [constants.conf](04-configuring-icinga-2.md#constants-conf).
   crl\_path                 |**Optional.** Path to the CRL file.
   bind\_host                |**Optional.** The IP address the api listener should be bound to. Defaults to `0.0.0.0`.
   bind\_port                |**Optional.** The port the api listener should be bound to. Defaults to `5665`.