diff --git a/README b/README index 93ae350..e32f543 100644 --- a/README +++ b/README @@ -14,13 +14,15 @@ Every time 'monitorix' is started it reads the configuration file from the path specified in the command line (using the -c option), and once checked, it creates the 'index.html' file that will act as the Monitorix main page. -It also creates a file called '$BASE_DIR/cgi-bin/monitorix.conf.path' that +It also creates a file called '/cgi-bin/monitorix.conf.path' that includes the absolute path of the configuration file. This file will be read by 'monitorix.cgi' to determine the exact location of the configuration file. If for any reason it is unable to locate this file, Monitorix will try two alternative locations: '/etc/monitorix.conf' and '/usr/local/etc/monitorix.conf'. +Please, see the monitorix.conf(5) and monitorix(8) man pages. + HISTORY =============================================================================== @@ -50,14 +52,16 @@ hands to work. Since the release 2.6.0 Monitorix includes support for NetBSD systems. +With the release of the 3.0.0 version, Monitorix suffered another big rewrite +which became it into a complete modular code structure reducing notably its +memory footprint. That new version also included a number of new features and +graphs, cleaned up all the code, fixed a lot of bugs and had a safest code as +it used 'strict' in all its modules. -IMPORTANT NOTE -=============================================================================== -The configuration file is a Perl file where values are directly assigned to -variables that Monitorix uses during normal operation; you should take care to -conform to basic Perl syntax. - -Please, see the monitorix.conf(5) and monitorix(8) man pages. +With this new modular structure, Monitorix can now be packaged either into a +single one package requiring all its dependences to be satisfied during the +installation, or into several small packages one for each graph which is more +suitable for embedded systems. REQUIREMENTS @@ -87,13 +91,14 @@ The file tree for the Monitorix application is: File Recommended location Description ------------------------------------------------------------------------------- monitorix /usr/bin/ main program (daemon) -monitorix.cgi $BASE_DIR/cgi-bin/ CGI (viewer) +monitorix.cgi /cgi-bin/ CGI (viewer) monitorix.conf /etc/ configuration file +lib/*.pm Changes /usr/share/doc/ changes log file COPYING /usr/share/doc/ license -logo_bot.png $BASE_DIR bottom logo -logo_top.png $BASE_DIR top logo -monitorixico.png $BASE_DIR favicon +logo_bot.png bottom logo +logo_top.png top logo +monitorixico.png favicon monitorix-alert.sh /usr/share/doc/ alert example script monitorix-apache.conf /etc/httpd/conf.d/ apache configuration monitorix.init /etc/init.d/ redhat init script @@ -109,8 +114,7 @@ README.OpenBSD /usr/share/doc/ documentation README.NetBSD /usr/share/doc/ documentation man/man5/monitorix.conf.5 /usr/share/man/man5/ monitorix.conf manpage man/man8/monitorix.8 /usr/share/man/man8/ monitorix manpage -reports/*.html $BASE_LIB/reports/ monthly reports i18n -reports/send_reports $BASE_LIB/reports/ script to send reports +reports/*.html /reports/ monthly reports i18n Once succesfully installed, please take a look into the configuration file to @@ -140,6 +144,7 @@ Many people further contributed by reporting problems, suggesting various improvements, sharing ideas or submitting actual code. Since the list might be incomplete, please see the 'Changes' file for a detailed description of all the contributions. + My special thanks to all of them! @@ -165,6 +170,6 @@ LICENSE AND COPYRIGHT Monitorix is distributed under the terms of the GNU General Public License. See the included file "COPYING". -Copyright (C) 2005-2012 Jordi Sanfeliu. +Copyright (C) 2005-2013 Jordi Sanfeliu. http://www.monitorix.org diff --git a/README.FreeBSD b/README.FreeBSD index 167dc51..c4ac047 100644 --- a/README.FreeBSD +++ b/README.FreeBSD @@ -6,13 +6,13 @@ option. Make sure that the default ipfw(8) rule numbers defined in the monitorix.conf file doesn't conflict with any other rule number in your firewall: - - $PORT_RULE = "24000"; - - $NGINX_RULE = "24100"; + - In configuration section: rule = 24000 + - In configuration section: rule = 24100 This is the list of things that still need attention: - - [PCLAN] - PC LAN Internet activity is not supported yet. Help needed! - - [SERV] - Some services may not work. - - [HPTEMP] - HP Temperatures may not work because of the lack of HP software. - - [NFSS] - NFS server is not supported yet. - - [NFSC] - NFS client is not supported yet. + [TRAFFACCT] - Network activity is not supported yet. Help is needed! + [SERV] - Some services may not work. + [HPTEMP] - Temperatures may not work because of the lack of HP support. + [NFSS] - NFS server is not supported yet. + [NFSC] - NFS client is not supported yet. diff --git a/README.NetBSD b/README.NetBSD index a0fa97d..649bc17 100644 --- a/README.NetBSD +++ b/README.NetBSD @@ -5,15 +5,15 @@ See the monitorix.conf(5) man page for a detailed help of each configuration option. This is the list of things that still need attention: - - IP filter not supported yet, hence some network activity graphs won't work. - - File usage in 'VFS usage' graph doesn't work. - - [PROC] - Per processor kernel usage graph is not available because the - command 'sysctl kern.cp_time2' doesn't work yet. - - [PORT] - Network port activity not supported yet. - - [PCLAN] - PC LAN Internet activity is not supported yet. Help needed! - - [SERV] - Some services may not work. - - [HPTEMP] - HP Temperatures may not work because of the lack of HP software. - - [NFSS] - NFS server is not supported yet. - - [NFSC] - NFS client is not supported yet. - - [INT] - Device interrupt activity not supported yet. + IP filter not supported yet, hence some network activity graphs won't work. + File usage in 'VFS usage' graph doesn't work. + [PROC] - Per processor kernel usage graph is not available because the + command 'sysctl kern.cp_time2' doesn't work yet. + [PORT] - Network port activity not supported yet. + [TRAFFACCT] - Network activity is not supported yet. Help is needed! + [SERV] - Some services may not work. + [HPTEMP] - Temperatures may not work because of the lack of HP support. + [NFSS] - NFS server is not supported yet. + [NFSC] - NFS client is not supported yet. + [INT] - Device interrupt activity not supported yet. diff --git a/README.OpenBSD b/README.OpenBSD index da135f5..1457c03 100644 --- a/README.OpenBSD +++ b/README.OpenBSD @@ -6,15 +6,15 @@ option. Make sure that the default ipfw(8) rule numbers defined in the monitorix.conf file doesn't conflict with any other rule number in your firewall: - - $PORT_RULE = "24000"; - - $NGINX_RULE = "24100"; + - In configuration section: rule = 24000 + - In configuration section: rule = 24100 This is the list of things that still need attention: - - [PROC] - Per processor kernel usage graph is not available because the - command 'sysctl kern.cp_time2' doesn't work yet. - - [PCLAN] - PC LAN Internet activity is not supported yet. Help needed! - - [SERV] - Some services may not work. - - [HPTEMP] - HP Temperatures may not work because of the lack of HP software. - - [NFSS] - NFS server is not supported yet. - - [NFSC] - NFS client is not supported yet. + [PROC] - Per processor kernel usage graph is not available because the + command 'sysctl kern.cp_time2' doesn't work yet. + [TRAFFACCT] - Network activity is not supported yet. Help is needed! + [SERV] - Some services may not work. + [HPTEMP] - Temperatures may not work because of the lack of HP support. + [NFSS] - NFS server is not supported yet. + [NFSC] - NFS client is not supported yet.