X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=doc%2Fsysdbd.conf.5.txt;h=5244576cb35ebca13a74075298be97eceb05036d;hp=131c75548d05a2e846a6c83f1c92979717652857;hb=56b97a180a53aecbfe9f7162b8ece3faae973cf9;hpb=095018687aa443dad20e9a0a5fbb7dd3d6315391 diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt index 131c755..5244576 100644 --- a/doc/sysdbd.conf.5.txt +++ b/doc/sysdbd.conf.5.txt @@ -1,7 +1,5 @@ sysdbd.conf(5) ============== -Sebastian "tokkee" Harl -version {package_version}, {build_date} :doctype: manpage NAME @@ -13,6 +11,8 @@ SYNOPSIS -------- Interval 300 + Listen "unix:/var/run/sysdbd.sock" + LoadPlugin "syslog" LoadBackend "collectd::unixsock" @@ -66,6 +66,11 @@ GLOBAL SETTINGS be used by any "active" backend, that is, those that actively query some external system rather than receiving some stream of events. +*Listen* '':: + 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:'. + *LoadBackend* '':: Loads the backend named ''. Backends are special plugins taking care of collecting values from external systems. This may optionally be a @@ -76,11 +81,24 @@ GLOBAL SETTINGS be used for this backend. See the global *Interval* option for more details. +*LoadPlugin* '':: + Loads the plugin named ''. Plugins provide additional functionality + for sysdbd. + +*PluginDir* '':: + Sets the base directory for plugins to ''. When loading a + plugin, it is expected to be found below this directory. This option + affects all following *LoadBackend* or *LoadPlugin* statements up to the + following *PluginDir* option. + PLUGINS ------- Some plugins support additional configuration options. Each of these are enclosed in a *Plugin* or *Backend* section. The following plugins are shipped -with SysDB. See *sysdb*-''(5) manpages for more details. +with SysDB. See *sysdbd*-''(5) manpages for more details. + +Backends: +~~~~~~~~~ *collectd::unixsock*:: This backend module accesses the system statistics collection daemon @@ -105,21 +123,38 @@ facter facts information storing the latter as host attributes. See also: http://puppetlabs.com/puppet, http://puppetlabs.com/puppet/related-projects/facter/ +Plugins: +~~~~~~~~ + +*cname::dns*:: +Canonicalize hostnames based on a reverse DNS query. + *syslog*:: This logging module sends log messages of the daemon and plugins to the local system's syslog service. SEE ALSO -------- -*sysdbd*(1) +manpage:sysdbd[1], manpage:sysdb[7] + +Backend documentation: +~~~~~~~~~~~~~~~~~~~~~~ + +manpage:sysdbd-collectd-unixsock[5], manpage:sysdbd-mk-livestatus[5], +manpage:sysdbd-puppet-store-configs[5] + +Plugin documentation: +~~~~~~~~~~~~~~~~~~~~~ + +manpage:sysdbd-cname-dns[5], manpage:sysdbd-syslog[5] AUTHOR ------ -sysdbd was written by Sebastian "tokkee" Harl . +SysDB was written by Sebastian "tokkee" Harl . COPYRIGHT --------- -Copyright (C) 2012-2013 Sebastian "tokkee" Harl +Copyright (C) 2012-2014 Sebastian "tokkee" Harl This is free software under the terms of the BSD license, see the source for copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or