mqtt plugin: Add TLS options to the example config and improve documentation.

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 61c01f9..30d536a 100644 (file)
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -683,6 +683,11 @@
 #              Prefix "collectd"
 #              StoreRates true
 #              Retain false
+#              CACert "/etc/ssl/ca.crt"
+#              CertificateFile "/etc/ssl/client.crt"
+#              CertificateKeyFile "/etc/ssl/client.pem"
+#              TLSProtocol "tlsv1.2"
+#              CipherSuite "ciphers"
 #      </Publish>
 #      <Subscribe "name">
 #              Host "localhost"

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 82fa4ce..78a130c 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -3352,26 +3352,31 @@ the B<collectd> branch.
 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
 port of the MQTT broker.
+A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
 
 =item B<CertificateFile> I<file>
 
 Path to the PEM-encoded certificate file to use as client certificate when
-connecting to the MQTT broker. Requires B<CertificateFile>
+connecting to the MQTT broker.
+A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
 
 =item B<CertificateKeyFile> I<file>
 
-Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>. 
+Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
+A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
 
 =item B<TLSProtocol> I<protocol>
 
-If configured, this specifies the string protocol version (e.g. tlsv1, tlsv1.2) to
-use for the TLS connection to the broker. If not set a default version is used which
-depends on the version of OpenSSL the Mosquitto library was linked against.
+If configured, this specifies the string protocol version (e.g. C<tlsv1>,
+C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
+version is used which depends on the version of OpenSSL the Mosquitto library
+was linked against.
 
 =item B<CipherSuite> I<ciphersuite>
 
-A string describing the ciphers available for use. See the "openssl ciphers" utility
-for more information. If unset, the default ciphers will be used.
+A string describing the ciphers available for use. See L<ciphers(1)> and the
+C<openssl ciphers> utility for more information. If unset, the default ciphers
+will be used.
 
 
 =back

diff --git a/src/mqtt.c b/src/mqtt.c
index cbffa67..b2d21b1 100644 (file)
--- a/src/mqtt.c
+++ b/src/mqtt.c
@@ -642,7 +642,7 @@ static int mqtt_config_publisher (oconfig_item_t *ci)
  *   User "guest"
  *   Password "secret"
  *   Topic "collectd/#"
- * </Publish>
+ * </Subscribe>
  */
 static int mqtt_config_subscriber (oconfig_item_t *ci)
 {