1 Web User-Interface for SysDB
2 ==============================
4 The SysDB web user-interface provides a graphical client application for
5 browsing and querying the system database.
7 What is SysDB?
8 --------------
10 “System DataBase” (SysDB) is a multi-backend system management and inventory
11 collection service. It stores system and inventory information about
12 hardware and software systems. This information is (continuously) collected
13 from various configurable backends (inventory services, monitoring services,
14 etc.) and stored in a graph-like hierarchy of generic objects. The store may
15 be queried through a generic interface independent of the active backends.
16 Object names are canonicalized before they are added to the store to ensure
17 a consistent view of your infrastructure.
19 The central object type is a host, which generally represents a physical or
20 virtual machine or any other type of physical resource. Hosts, in turn, may
21 reference a list of services which represent any kind of logical resource
22 like a software system. Both, hosts and services, may reference a list of
23 attributes which represent further information about the respective host or
24 service object. For example, attributes may specify static information like
25 a host's architecture or the software version. A host may also reference a
26 list of metrics which are references to performance data stored about the
27 host. SysDB supports querying the respective time-series from a backend's
28 data store.
30 SysDB is free and open source software, licensed under the 2-clause BSD
31 license. See COPYING for details.
33 <https://sysdb.io/>
35 Install the web-interface
36 -------------------------
38 The SysDB webui is written in Go. It can be installed along with all of its
39 dependencies as easy as running the following command:
41 go get github.com/sysdb/webui/...
43 This will download and install the packages and all of their dependencies
44 into GOPATH. See ‘go help get’ for more details.
46 Running the web-interface
47 -------------------------
49 The SysDB webui is a standalone web application. It can run all on its own
50 but it can also be put behind a reverse proxy (e.g. using Apache or nginx).
51 It is composed of a dynamic application and a set of static files (images
52 and style-sheets) which are shipped along with the source distribution. You
53 can start the application using the following command, using the --address
54 option to point it at a running SysDB daemon:
56 ./webui \
57 --address=/var/run/sysdbd.sock \
58 --listen=:8080 \
59 --static-path=$GOPATH/src/github.com/sysdb/webui/static \
60 --template-path=$GOPATH/src/github.com/sysdb/webui/templates
62 You can then access the interface by pointing your browser at
63 http://localhost:8080
65 Packages
66 --------
68 While the webui is a standalone application, most of its functionality is
69 implemented in a reusable library allowing to integrate it into other
70 software written in Go.
72 * github.com/sysdb/webui/server: The core of the SysDB web server.
74 It makes use of the following packages:
76 * github.com/sysdb/go/client (and related packages): A SysDB client
77 implementation.
79 Documentation
80 -------------
82 The documentation for all Go packages is included with the source code in a
83 way compatible with the godoc tool. As such, it can be viewed and browsed
84 online at <https://godoc.org/github.com/sysdb/webui>.
86 Getting Help
87 ------------
89 Various channels for asynchronous and real-time communication with
90 developers and users are available. See <https://sysdb.io/contact/> for
91 details about the mailing list, IRC channel, and social media.
93 Author
94 ------
96 Sebastian “tokkee” Harl <sh@tokkee.org>
98 Want to contribute? Check out the website <https://sysdb.io> for details.