X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=doc%2Fsysdbd.conf.5.txt;h=e3af5daadc5f52156a980e1fe009dd3acdeadae0;hp=c742cc8213b827510117f802bc31632f6b44ed7f;hb=0a3dd5b9b97e25156412a95bcecf25f8d75c72fc;hpb=de02a150937998ce92f38c66043514aea5c8dacb

diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt
index c742cc8..e3af5da 100644
--- a/doc/sysdbd.conf.5.txt
+++ b/doc/sysdbd.conf.5.txt
@@ -12,12 +12,18 @@ SYNOPSIS
   Interval 300
 
   Listen "unix:/var/run/sysdbd.sock"
+  <Listen "tcp:some.host.name:12345">
+      SSLCertificate "/etc/sysdb/ssl/cert.pem"
+      SSLCertificateKey "/etc/sysdb/ssl/key.pem"
+  </Listen>
 
   LoadPlugin "syslog"
 
   LoadBackend "collectd::unixsock"
   LoadBackend "mk-livestatus"
 
+  LoadPlugin "timeseries::rrdtool"
+
   <LoadBackend "puppet::store-configs">
       Interval 1800
   </LoadBackend>
@@ -36,12 +42,12 @@ any real (user-facing) functionality, the most important part of the
 configuration is loading and configuring plugins.
 
 The syntax of this configuration file is similar to that of the Apache
-webserver. It is made up of _options_ and _sections_. Each option contains a
+webserver. It is made up of _options_ and _blocks_. Each option contains a
 _key_ and one or more _values_ separated by spaces and terminated by a newline
-character. Sections are enclosed in a start- and end-tag, each on a line of
+character. Blocks are enclosed in a start- and end-tag, each on a line of
 their own. These tags are enclosed in angle brackets and also contain a key
-and value. Section end-tags only contain the key of the start-tag prepended by
-a forward-slash ("/"). Empty lines are ignored as well as any unquoted hash
+and value. A block's end-tag only contain the key of the start-tag prepended
+by a forward-slash ("/"). Empty lines are ignored as well as any unquoted hash
 symbol ("#") including anything following up to the following newline. Keys
 are unquoted strings consisting only of alphanumeric characters and the
 underscore character ("_"). Values may either be unquoted strings, quoted
@@ -68,13 +74,28 @@ GLOBAL SETTINGS
 
 *Listen* '<socket>'::
 	Sets the address on which sysdbd is to listen for client connections. It
-	supports UNIX domain sockets. The path name needs to be prefixed by
-	'unix:'.
+	supports UNIX domain sockets and TCP sockets using TLS encryption. UNIX
+	socket addresses are specified by the path name of the socket, optionally
+	prefixed with 'unix:'. TCP listen addresses may be specified as
+	'<host>:<port>', optionally prefixed with 'tcp:'. The host may be a
+	hostname, an IPv4 address or and IPv6 address. It may be empty or
+	'0.0.0.0' / '::' to listen on all local addresses. *Listen* may optionally
+	be a block containing any of the following options:
+
+	*SSLCertificate* '<filename>';;
+		Specify the SSL server certificate file to use for SSL connections.
+
+	*SSLCertificateKey* '<filename>';;
+		Specify the SSL server private key file to use for SSL connections.
+
+	*SSLCACertificates* '<filename>';;
+		Specify the file containing certificate authority (CA) certificates
+		for client verification purposes to use for SSL connnections.
 
 *LoadBackend* '<name>'::
 	Loads the backend named '<name>'. Backends are special plugins taking care
-	of collecting values from external systems. This may optionally be a
-	section containing any of the following options:
+	of collecting values from external systems. This may optionally be a block
+	containing any of the following options:
 
 	*Interval* '<seconds>';;
 		Overwrite the global interval setting by setting a custom interval to
@@ -103,10 +124,16 @@ Backends:
 *collectd::unixsock*::
 This backend module accesses the system statistics collection daemon
 *collectd* through its UNIX socket interface. It periodically queries all host
-and service information.
+and metric information.
 +
 See also: http://collectd.org
 
+*facter*::
+This backend module retrieves local facter fact values and submits them as
+host attributes.
++
+See also: https://github.com/puppetlabs/cfacter
+
 *mk-livestatus*::
 This backend modules accesses monitoring systems supporting the *livestatus*
 addon (e.g., *Nagios*, *Icinga*, and *Shinken*). It periodically queries all
@@ -123,6 +150,14 @@ facter facts information storing the latter as host attributes.
 See also: http://puppetlabs.com/puppet,
 http://puppetlabs.com/puppet/related-projects/facter/
 
+Time-series fetcher:
+~~~~~~~~~~~~~~~~~~~~
+
+*timeseries::rrdtool*::
+This plugin adds support for fetching time-series data from RRD files.
++
+See also: http://oss.oetiker.ch/rrdtool
+
 Plugins:
 ~~~~~~~~
 
@@ -137,13 +172,18 @@ SEE ALSO
 --------
 manpage:sysdbd[1], manpage:sysdb[7]
 
-The SysDB homepage: http://sysdb.io/
+The SysDB homepage: https://sysdb.io/
 
 Backend documentation:
 ~~~~~~~~~~~~~~~~~~~~~~
 
-manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-mk-livestatus[5],
-manpage:sysdbd-puppet-store-configs[5]
+manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-facter[5],
+manpage:sysdbd-mk-livestatus[5], manpage:sysdbd-puppet-store-configs[5]
+
+Time-series fetcher documentation:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+manpage:sysdbd-timeseries-rrdtool[5]
 
 Plugin documentation:
 ~~~~~~~~~~~~~~~~~~~~~