Read Me

ibmap
-----

Welcome to ibmap package
by Ibere Luiz Di Tizio Jr

(1st thing.... Sorry.. English is not my native language, and I know that I really need to learn..)

INTRODUCTION
------------

The original idea to make ibmap, came from weathermap (actually: http://netmon.grnet.gr/weathermap/), but 
when I start to use, I change several features and try to send to the original manteiner, but I had no response..
So I decide to do a frontend from scratch for a lot of other products, but with the same look and feel of weathermap.

This package contains perl scripts to generate html maps or images that represent collected data from several
sources in a nice way, a tools and a sample directory.
The package was developed to address the need for centralize status pages, views, and generate dynamic wall pannels.

FEATURES
--------

- ability to get status from several sources (SNMP, Nagios, RRD files, SQL Databases, Command Output)
- could use pictures to represent Hosts


REQUIREMENTS
------------

Perl modules:

- Getopt::Long  (used to parse command line parameters)
- GD            (Boutell Graphics Library)
- GD::Text      (Text support for Boutell Graphics Library)
- RRDs          (used to manipulate RRD files)
- Net::SNMP     (used to support SNMP)
- DBI           (used to support DBI abstraction layer)
- Time::HiRes   (used to give better time support)
- Data::Dumper  (used in debug mode)

all of these files could be installed by CPAN
...

INSTALLATION
------------

*) unzip and unpack files to some directory which you has write permissions

   tar xvfz ibmap.tgz -C /usr/local

*) change config files

   see CONFIGURATION

*) schedule ibmap in crontab

   */2  *  *   *   *  /usr/local/ibmap


USAGE
-----

./ibmap [parameters]

where:
     -c, --config=FILE    : configuration file (default /etc/ibmap/ibmap.conf or 
                                  /usr/local/ibmap/ibmap.conf or ./ibmap.conf)
     -v, --version        : print version
     -h, --help           : print this text
     -d, --debug          : enable debug output



TODO
----
* build support to notify email lists when some condition occurs in map generation
* export values and status to Nagios
* improve documentation


OBS
---

- If you want some new feature, send me a suggestion.
- If you can help-me, in documentation (for example), 'll be glad.
- Please, send me a sample and opinion of your maps / pages, I will like to know how people are 
  using ibmap, and if you allow, I will put in a gallery in ibmap page.
- If you had any question.. sent me.. I will do my best efforts to give you an answer.


COPYING
-------
This package is release under GPL. For more information read GPL.TXT file.



CONTACT
-------
Comments and bug reports to iberejr@ditizio.ecn.br
Enjoy and thanks for use ibmap.