Code

56dde37d9365cbc8ac73939635b6880844140992
[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 may be used to (continuously) collect information
6   about your systems from various backends (inventory services, monitoring
7   services, etc.) and provides a unique interface to access the information
8   independent of the active backends. This is done by storing and mapping the
9   backend objects to generic objects and correlating the attributes to create
10   a single hierarchical view of your infrastructure.
12   SysDB is free and open source software, licensed under the 2-clause BSD
13   license. See COPYING for details.
15 Prerequisites
16 -------------
18   To compile the SysDB package from source you need:
20   * A build environment: autotools, libtool, C compiler, ...
22   * When building from Git, you also need the flex lexical analyzer generator
23     and bison parser generator (other lex and yacc compatible tools might work
24     as well if you are lucky).
26   * A POSIX + Single UNIX Specification compatible C library.
28   * asciidoc, xsltproc, xmlto:
29     The AsciiDoc text document format is used to write the manpages.
31 Configuring / Compiling / Installing
32 ------------------------------------
34   To configure, build and install SysDB with the default settings, run
35   `./configure && make && make install'. For detailed, generic instructions
36   see INSTALL. For a complete list of configure options and their description,
37   run `./configure --help'.
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 Author
46 ------
48   Sebastian "tokkee" Harl <sh@tokkee.org>