PREREQUISITE
-------------

To use Weathermap4rrd you need :

    * Perl
	* libgd and GD perl modules
	* RRDtool

Notes : wget is not needed for weathermap4RRD when it was for Network WeatherMap


Weathermap4RRD installation
---------------------------

Follow instructions below to install and use Weathermap4RRD :
	- download last version of weathermap4rrd at http://weathermap4rrd.tropicalex.net
	- untar archive somewhere in your machine (for example : /usr/local/weathermap4rrd)
	- create weathermap.conf file (an example is available : weathermap.conf.example)
	- configure weathermap.conf for your own network (see creating config file below for details)
	- run "./weathermap" to generate graph called weathermap.png

	For example, you can add an entry in your crontab like :
	*/5 * * * * /path/to/weathermap > /dev/null  2>&1


Creating config file
--------------------

Weathermap4rrd is using only 1 configuration file : weathermap.conf

By default, perl script is looking for configuration file in current directory. You can specify in weathermap.conf where to look for configuration file thanks to directive "CONFIGFILE".

The configuration of the network weathermap is defined in weathermap.conf. It includes the definition of :

    * nodes:
		o name (NODE xxx)
		o position on the image (POSITION x y)
		o label (LABEL zzz)
	* links:
		o name (LINK xxx),
		o start and end nodes (NODES xxx yyy),
		o RRDTool file name and path (TARGET /xxx/yyy/zzz.rrd),
		o position of current in value in RRD database (INPOS x)
		o position of current out value in RRD database (OUTPOS y)
		o unit of rrd values (UNIT bytes or Kbytes or Mbytes or bits or Kbits or Mbits)
		o bandwidth of the link (BANDWIDTH y) in Kbps.
		o display bandwidth used (DISPLAYVALUE 1 or 0)
	* image used as background (BACKGROUND /xxx/yyy/zzz.gif) or alternatively the size of the resulted image (WIDTH x and HEIGHT y).
	* position of the key in the image (KEYPOS x y )
	* color scale used for the link utilization (SCALE low hight rrr ggg bbb)
	* title of graph (TITLE "title of graph")
	* position of title (TITLEPOS x y)
	* height of generated graph (HEIGHT xxx)
	* width of generated graph (WIDTH yyy)
	* config filename and path (CONFIGFILE /path/filename)

An example is present with weathermap4rrd and is called weathermap.conf.example

Alexandre Fontelle <afontelle AT free.fr>
