README: Extended installation instructions a bit.
[sysdb.git] / README
1         SysDB -- a system management and inventory collection service
2        ===============================================================
4   “System DataBase” (SysDB) is a multi-backend system management and inventory
5   collection service. It stores system and inventory information about
6   hardware and software systems. This information is (continuously) collected
7   from various configurable backends (inventory services, monitoring services,
8   etc.) and stored in a graph-like hierarchy of generic objects. The store may
9   be queried through a generic interface independent of the active backends.
10   Object names are canonicalized before they are added to the store to ensure
11   a consistent view of your infrastructure.
13   The central object type is a host, which generally represents a physical or
14   virtual machine or any other type of physical resource. Hosts, in turn, may
15   reference a list of services which represent any kind of logical resource
16   like a software system. Both, hosts and services, may reference a list of
17   attributes which represent further information about the respective host or
18   service object. For example, attributes may specify static information like
19   a host's architecture or the software version or reference performance data
20   like the current memory utilization or much more.
22   SysDB is free and open source software, licensed under the 2-clause BSD
23   license. See COPYING for details. Changes between all SysDB releases can be
24   found in the file ReleaseNotes.
26 Configure and install SysDB
27 ---------------------------
29   To configure, build and install SysDB with the default settings, run
30   ‘./configure && make && make install’. For detailed, generic instructions
31   see INSTALL. For a complete list of configure options and their description,
32   run ‘./configure --help’.
34   Various third-party packages are required for a full installation of SysDB.
35   See the section ‘Prerequisites’ below for details. A summary of
36   user-supplied and auto-detected build settings is displayed at the end of
37   each ‘configure’ run. Consult this first for trouble-shooting.
39   By default, SysDB will be installed into ‘/opt/sysdb’. You can adjust this
40   setting by specifying the ‘--prefix’ configure option - see INSTALL for
41   details. If you pass DESTDIR=<path> to ‘make install’, <path> will be
42   prefixed to all installation directories. This might be useful when creating
43   packages for SysDB.
45 Prerequisites
46 -------------
48   To compile the SysDB package from source you need:
50   * A build environment: autotools, libtool, C compiler, ...
52     <>
53     <>
54     <>
55     <>
56     <>
58   * When building from Git, you also need the flex lexical analyzer generator
59     and bison parser generator (other lex and yacc compatible tools might work
60     as well if you are lucky).
62     <>
63     <>
65   * A POSIX + Single UNIX Specification compatible C library.
67     <>
69   * asciidoc, xsltproc, xmlto:
70     The AsciiDoc text document format is used to write the manpages.
72     <>
73     <>
74     <>
76   * libedit or libreadline:
77     A readline compatible command line editor and history library is used for
78     handling input in the sysdb client program.
80     <>
81     <>
83   The following optional libraries may be used by various plugins:
85   * libdbi:
86     The database independent abstraction layer is used for database access by
87     the puppet::store-configs plugin.
89     <>
91 Testing
92 -------
94   Unit and integration tests for SysDB are shipped along with the source code
95   in the ‘t’ subdirectory. Run ‘make test’ to run all available tests.
97   Some tests require the ‘fopencookie’ function as provided by the GNU libc
98   library. It used used to mock I/O related functions. In case this function
99   is not available, the respective tests will be disabled automatically.
101   The integration tests require valgrind. If it is not available, integration
102   tests will be disabled automatically.
104   For the latest build status, see:
105   <>
107   Code coverage testing using Gcov may be enabled when using the
108   ‘--enable-gcov’ configure option.
110   For the latest coverage report, see:
111   <>
113 Author
114 ------
116   Sebastian “tokkee” Harl <>