1 collection3 - Web frontend for collectd
2 =========================================
3 http://collectd.org/
5 About
6 -----
8 collection3 is a graphing front-end for the RRD files created by and filled
9 with collectd. It is written in Perl and should be run as an CGI-script.
10 Graphs are generated on-the-fly, so no cron job or similar is necessary.
12 Layout
13 ------
15 The files used by collection3 are organized in a typical UNIX fashion: The
16 configuration resides in etc/, executable scripts are in bin/, supplementary
17 Perl modules are in lib/ and static data for displaying the web page are in
18 share/.
20 All files in all subdirectories except bin/ should NOT be executable.
21 Ideally, the webserver should not serve them either. Consider using
22 `.htaccess' files or other means to configure the web server to deny access
23 to these directories.
25 Dependencies
26 ------------
28 collection3 depends on the following Perl modules not included in the Perl
29 distribution itself:
31 * Config::General
32 * Regexp::Common
33 * HTML::Entities
34 * RRDs
36 Copyright and License
37 ---------------------
39 Copyright (C) 2008 Florian octo Forster <octo at verplant.org>
41 collection3 is provided under the terms of the GNU General Public License,
42 version 2 (GPLv2).