]> granicus.if.org Git - icinga2/commitdiff
Docs: Update ApiListener object type
authorMichael Friedrich <michael.friedrich@icinga.com>
Thu, 7 Sep 2017 15:06:11 +0000 (17:06 +0200)
committerGunnar Beutner <gunnar.beutner@icinga.com>
Tue, 12 Sep 2017 10:52:49 +0000 (12:52 +0200)
refs #5450

doc/09-object-types.md

index e278baaee0b5ca245d59e2ccf3547d5afb118781..0aba518ffdf71a6cd223b34c1b6c8e1988af6985 100644 (file)
@@ -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`.