INTRODUCTION
============
Monitorix is a free, open source, lightweight system monitoring tool designed
to monitorize as many services as possible. At this time it monitors from the
CPU load and temperatures to the users using the system. Network devices
activity, network services demand and even the devices' interrupt activity are
also monitored, and more. The current status of any corporate Linux server with
Monitorix installed can be accessed via a web browser.

It has been designed to be used under production Linux servers, but due its
simplicity and small size you can use it to monitor embedded devices.

All its development was initially created for monitoring Red Hat, Fedora and
CentOS Linux systems, so this project was made keeping in mind these
distributions. Today it is easy to port it to other Linux distributions and
even to other UNIX systems like FreeBSD.

On March 2006, Monitorix included a minimal support to run on FreeBSD systems.
My special thanks to twenty4help Knowledge Service (http://www.twenty4help.com)
and to Roger "Rocky" Vetterberg for their support, help and for to be a good
friends during all the portability process.

Since the release 1.3.2 though, Monitorix has almost full support for FreeBSD.
My special thanks to Pavlin Vatev <anex@smrad.net> who generoulsy offered his
support during all the process.

Besides the above mentioned systems there are supported too the following
Linux distributions. Some of they covered by the install.sh script:
	- Arch
	- Debian (Ubuntu)
	- Gentoo
	- Slackware
	- openSuSE

For people coming from other Linux distributions the same install.sh comes with
the "Generic" option. You can adjust the paths before using it.

IMPORTANT NOTE: The installation script is NOT the recommened method of installing Monitorix in your system. You *must* check first if your distribution has already packaged Monitorix and if it's downloadable from a repository near you or directly from the Monitorix web site.

Monitorix has a configuration file called "monitorix.conf" to adapt your server
to it. Each configuration option is commented in the same file, although for a
complete description you may read the monitorix.conf(5) man page included in
the package.


NOTE
-------------------------------------------------------------------------------
The configuration file is a Perl file where you set the value directly to the
variables that Monitorix will use during its normal operation. So you must take
special attention to not break some Perl basic syntax. I mean, every variable
need to terminate with a semicolon ";", etc.

Please, see the monitorix.conf(5) man page.

-------------------------------------------------------------------------------
You may always find information about the latest version in the Monitorix
Project web page:
 
        http://www.monitorix.org
 
In case of bugs and/or suggestions please contact to:
Jordi Sanfeliu <jordi@fibranet.cat>.


REQUIREMENTS
============
This package requires some others packages to be installed that maybe your
Linux distribution does not comes with them:

rrdtool and perl-rrdtool
------------------------
You can download it from lot of places:
	http://apt.sw.be/
	http://download.fedora.redhat.com/pub/fedora/linux/extras/
	http://oss.oetiker.ch/rrdtool/

metamail
--------
To be removed in near future, but needed right now only for monthly reports:
You can search for it on http://www.rpmfind.net.


Optionally you may need the lm_sensors and hddtemp tools to enable the
temperature graphs.


INSTALLATION UNDER REDHAT/FEDORA/CENTOS LINUX
=============================================
Once downloaded the RPM file, you can install it using:

rpm -ivh monitorix-n.n.n.noarch.rpm (where n.n.n is the current version)

This will install Monitorix on your system in this way:

/etc/cron.d/monitorix			(is the shell-script based daemon,
					 created/removed on the fly)
/etc/init.d/monitorix			(to start and stop monitorix)
/etc/httpd/conf.d/monitorix.conf	(for special httpd configurations)
/etc/monitorix.conf			(configuration file)
/usr/sbin/monitorix.pl			(main program called by daemon)
/usr/share/doc/monitorix-n.n.n		(documentation)
/usr/share/man/man5/monitorix.conf.5	(man pages)
/var/lib/monitorix/reports/		(language reports)
/var/www/cgi-bin/monitorix.cgi		(monitorix cgi)
/var/www/html/monitorix/		(html and images stuff of monitorix)

Once succesfully installed, you may need to take some adaptations in the
configuration file.

Once you finalize these modifications, you'll be able to Monitorix with:

service monitorix start

At this point, Monitorix will start to collect the system information, and
you'll be able to see it from your favorite browser at:

http://localhost/monitorix
(don't forget to start the Apache webserver)


INSTALLATION UNDER SLES/openSuSE LINUX
======================================
Once downloaded the RPM file, you can install it using:

rpm -ivh monitorix-n.n.n.noarch.rpm (where n.n.n is the current version)

This will install Monitorix on your system in this way:

/etc/cron.d/monitorix			(is the shell-script based daemon,
					 created/removed on the fly)
/etc/init.d/monitorix			(to start and stop monitorix)
/etc/apache2/conf.d/monitorix.conf	(for special httpd configurations)
/etc/sysconfig/monitorix		(Not used, for future use only)
/etc/monitorix.conf			(configuration file)
/usr/sbin/monitorix.pl			(main program called by daemon)
/usr/share/doc/packages/monitorix	(documentation)
/var/lib/monitorix/reports/		(language reports)
/srv/www/cgi-bin/monitorix.cgi		(monitorix cgi)
/srv/www/htdocs/monitorix/		(html and images stuff of monitorix)

Once succesfully installed, you need to take some adaptations in the
configuration file.

Once you finalize these modifications, you'll be able to start the Monitorix
shell-script based daemon with:

rcmonitorix start

At this point, Monitorix will start to collect the system information, and
you'll be able to see it from your favorite browser using:

http://localhost/monitorix
(don't forget to start the Apache webserver)


INSTALLATION UNDER A GENERIC UNIX/LINUX SYSTEM
==============================================
Once downloaded the tar.gz file, you can install it using:

cd monitorix-n.n.n
./install.sh


NOTES AFTER INSTALLATION
========================
- If your system have SELinux enabled by default it is possible your Monitorix
  graphs won't be visible and you get lot of messages in dmesg and in
  /var/log/messages about access denied to the RRD database files. I dont know
  enough SELinux to adapt Monitorix to it, so in that case my only
  recommendation is to disable SELinux, adding the line "SELINUX=disabled" in
  /etc/selinux/config or with the kernel parameter "selinux=0".

- Check that the /var/log/httpd directory have enough read permissions for the
  user running the Apache server. In the newer Fedora Core versions this
  directory have the permissions restricted to only the root user.


AUTHORS
=======
Monitorix is currently maintained by Jordi Sanfeliu <jordi@fibranet.cat>.
See the "Contact" page in the web site for the list of the most recent
contributors.


DONATIONS
=========
If you or your company make regular use of this software, please consider
supporting Open Source development by donating to the authors or inquire
about hiring them to consult on other projects.


LICENSE AND COPYRIGHT
=====================
Monitorix is distributed under the terms of the GNU General Public License.
See the included file "COPYING".

Copyright (C) 2002-2010 Fibranet NSP, SL
http://www.fibranet.cat

