Skip to content

NymbleTechnology/collectw

Repository files navigation

CollectW - Modern Web UI for Collectd

* Build Dependencies

  librrd-dev    - RRD Tool API, needed for compilation core code.
  libfcgi-dev   - FCGX API, needed for compiling FastCGI SAPI.


* Installation Dependencies

  collectd	- CollectD engine for producing needed RRD databases.


* Configuration options

--prefix=/usr/local				- Global installation prefix
--bin-dir=/bin					- Directory (from prefix) for installation FastCGI data traversing engine.
--web-dir=/share/collectw			- Base Directory for installation Web UI files (also from prefix).
--with-interface=fcgx				- SAPI Interface, which will be used for build (now only fcgx available).
--with-rrd-basedir=/var/lib/collectd/rrd	- Where will be located RRD databases (by default).
--with-user-config=/etc/collectw.json		- Where will be located User Config for Web UI.

--with-libfcgi-include-dir=/path/to/fcgiapp.h
--with-libfcgi-lib-dir=/path/to/libfcgi.so
--with-librrd-include-dir=/path/to/rrd.h
--with-librrd-lib-dir=/path/to/librrd.so


* User's config

Format of this file is very simple. It represented hierarchical data structure in JSON (http://json.org/) format,
like this:

{
  'View Tab 1':{
    'Chart 1':{ // Graph
      'host/group1/element1':{ // Stroke
        title:'Value 1', color:'#F00', ....
      },
      'host/group2/element2:value':{},
      ....
    },
    'Chart 2': ....
  }
  'View Tab 2': ....
  ....
}


* Copyright notes

  jQuery - JavaScript Library
  http://jquery.com/
  Copyright (c) 2009 John Resig
  Dual licensed under the MIT and GPL licenses.
  http://docs.jquery.com/License
	
  Raphael - JavaScript Vector Library
  http://raphaeljs.com/
  Copyright (c) 2008 - 2009 Dmitry Baranovskiy
  Licensed under the MIT (http://www.opensource.org/licenses/mit-license.php) license.

  g.Raphael - Charting library, based on Raphaël
  http://g.raphaeljs.com/
  Copyright (c) 2009 Dmitry Baranovskiy
  Licensed under the MIT (http://www.opensource.org/licenses/mit-license.php) license.

  Date picker - JavaScript date selector
  http://www.eyecon.ro/
  Copyright (c) 2008 Stefan Petre
  Dual licensed under the MIT and GPL licenses

  CollectW - CollectD Web UI
  http://collectw.sf.net/
  Copyright (c) 2009 Phoenix Kayo
  Licensed under GPLv3.