Code

sysdb(1), sysdbd(1): Document client authentication.
[sysdb.git] / doc / sysdbd.1.txt
1 sysdbd(1)
2 =========
3 :doctype: manpage
5 NAME
6 ----
7 sysdbd - system management and inventory collection service
9 SYNOPSIS
10 --------
11 *sysdbd* ['options']
13 DESCRIPTION
14 -----------
15 *sysdbd* is a multi-backend system management and inventory collection daemon.
16 It stores system and inventory information about hardware and software
17 systems. This information is (continuously) collected from various
18 configurable backends.
20 The main daemon itself is the central instance managing all collected
21 information and doing the correlation of objects provided by different
22 backends. It basically acts as a database server. All data retrieval, any
23 further processing, storing and exporting of data is done by plugins.
25 OPTIONS
26 -------
27 *sysdbd* accepts the following command-line options.
29 *-C* '<file>'::
30         The main configuration file. This file defines the behavior of *sysdbd* by
31         specifying default settings and the plugins to be loaded.
33 *-D*::
34         Do not daemonize on startup: Rather than starting *sysdbd* as a background
35         process detached from the current terminal and session (the default), run
36         the process in the foreground. This allows easy monitoring of *sysdbd*.
38 *-h*::
39         Display a usage and help summary and exit.
41 *-V*::
42         Display the version number and copyright information.
44 CLIENT AUTHENTICATION
45 ---------------------
47 include::sysdb-auth.txt[]
49 FILES
50 -----
52 */etc/sysdb/sysdbd.conf*::
53         The default main configuration file for the SysDB daemon.
55 */etc/sysdb/ssl/key.pem*::
56 */etc/sysdb/ssl/cert.pem*::
57         The default SSL private key and certificate files to use for SSL
58         connections.
60 SIGNALS
61 -------
63 *sysdbd* accepts and handles the following signals:
65 *SIGINT*, *SIGTERM*::
66         These signals initiate a clean shutdown and termination of the daemon.
68 *SIGHUP*::
69         This signal causes the daemon to re-read the configuration and reconfigure
70         all plugins. Plugins which are no longer in use will be disabled and
71         unloaded. Open client connections are not affected by this.
73 EXIT CODES
74 ----------
75 *0*::
76         Success.
78 *1*::
79         Failure (syntax or usage error).
81 BUGS
82 ----
83 None known.
85 SEE ALSO
86 --------
87 manpage:sysdbd.conf[5]
89 The SysDB homepage: https://sysdb.io/
91 AUTHOR
92 ------
93 SysDB was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
95 COPYRIGHT
96 ---------
97 Copyright (C) 2012-2014 Sebastian "tokkee" Harl <sh@tokkee.org>
99 This is free software under the terms of the BSD license, see the source for
100 copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
101 FITNESS FOR A PARTICULAR PURPOSE.
103 // vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :