Debian Codegraph @

README

raw
1 INTRODUCTION
2 ===============================================================================
3 Monitorix is a free, open source, lightweight system monitoring tool designed
4 to monitor as many services and system resources as possible. It has been
5 created to be used under production Linux/UNIX servers, but due to its
6 simplicity and small size may also be used to monitor embedded devices as
7 well.
8
9 It consists mainly of two programs: a collector, called monitorix, which
10 is a Perl daemon that is started automatically like any other system service,
11 and a CGI script called monitorix.cgi. Since 3.0 version Monitorix includes its
12 own HTTP server built in, so you don't need to install any web server to use it.
13
14 Every time 'monitorix' is started it reads the configuration file from the path
15 specified in the command line (using the -c option), and once checked, it
16 creates the 'index.html' file that will act as the Monitorix main page.
17
18 It also creates a file called '<base_dir>/cgi/monitorix.conf.path' that
19 includes the absolute path of the configuration file. This file will be read
20 by 'monitorix.cgi' to determine the exact location of the configuration file.
21
22 Please, see the monitorix.conf(5) and monitorix(8) man pages.
23
24
25 HISTORY
26 ===============================================================================
27 All of its development was initially created for monitoring Red Hat, Fedora and
28 CentOS Linux systems, so this project was made keeping in mind these type of
29 distributions. Today it runs on different GNU/Linux distributions and even in
30 other UNIX systems, like FreeBSD, OpenBSD and NetBSD.
31
32 On March 2006, Monitorix included minimal support to run on FreeBSD systems. My
33 special thanks to twenty4help Knowledge Service and to Roger "Rocky" Vetterberg
34 for their support and help, and for being good friends during the porting
35 process.
36
37 Since the release of 1.3.2 though, Monitorix has almost full support for
38 FreeBSD. My special thanks to Pavlin Vatev who generously offered his support
39 during all of the process.
40
41 With the release 2.0.0 Monitorix suffered a complete rewrite, including new
42 features and graphs, cleaned up all the code, updated and enhanced a number of
43 aspects in some graphs, and fixed a lot of bugs. The most important change was
44 that it no longer required 'crond' to work, instead Monitorix became a complete
45 standalone Perl daemon being started and stopped like any other system service.
46
47 Since the release 2.2.0 Monitorix includes support for OpenBSD systems. My
48 special thanks to Devio.us team for giving me a free shell account where to put
49 hands to work.
50
51 Since the release 2.6.0 Monitorix includes support for NetBSD systems.
52
53 With the release of the 3.0.0 version, Monitorix suffered another large rewrite
54 which became into a complete modular code structure reducing in some cases
55 its memory footprint. That new version also included a number of new features,
56 cleaned up all the code, fixed a lot of bugs and had a safer code as it used
57 'strict' and 'warnings' in all its modules.
58
59 With this new modular structure, Monitorix can now be packaged either into a
60 single one package requiring all its dependences to be satisfied during the
61 installation, or into several small packages one for each graph which should
62 reduce notably its memory footprint.
63
64 Another interesting new feature in 3.0.0 version is that Monitorix comes with
65 its own HTTP server built in. This should satisfy all the people that don't want
66 to install an HTTP server (Apache, Nginx, lighttpd, etc.) to see the Monitorix
67 graphs.
68
69
70 REQUIREMENTS
71 ===============================================================================
72 Monitorix requires some others packages to be installed that your GNU/Linux
73 distribution may or may not have:
74
75 - Perl
76 - Perl-CGI
77 - Perl-libwww
78 - Perl-MailTools
79 - Perl-MIME-Lite
80 - Perl-DBI
81 - Perl-XML-Simple
82 - Perl-XML-LibXML
83 - Perl-Config-General
84 - Perl-HTTP-Server-Simple
85 - perl-IO-Socket-SSL
86 - RRDtool and its Perl bindings (perl-rrdtool or rrdtool-perl)
87 - (Optional) a CGI capable Web server (Apache, Nginx, lighttpd, etc.)
88
89
90 INSTALLATION
91 ===============================================================================
92 Running a `make install-xxx` as root will distribute the files to the file
93 system. Most users will want to select from three options depending on target
94 init system (do not run all four)!
95
96 # make install-systemd-all
97 # make install-upstart-all
98 # make install-debian-all
99 # make install-redhat-all
100
101 Alternatively, users may override any of the in make targets. For example:
102
103 $ make DESTDIR=~/pub BASEDIR=/srv/http/monitorix install-systemd-all
104
105 The file tree for the Monitorix application is:
106
107 File Recommended location Description
108 -------------------------------------------------------------------------------
109 monitorix /usr/bin/ main program (daemon)
110 monitorix.cgi <base_dir>/cgi/ CGI (viewer)
111 monitorix.conf /etc/monitorix/ configuration file
112 docs/debian.conf /etc/monitorix/conf.d/00-debian.conf extra configuration file
113 lib/*.pm /usr/lib/monitorix/ modules
114 Changes /usr/share/doc/monitorix/ changes log file
115 COPYING /usr/share/doc/monitorix/ license
116 logo_bot.png <base_dir> bottom logo
117 logo_top.png <base_dir> top logo
118 monitorixico.png <base_dir> favicon
119 /docs/monitorix-alert.sh /usr/share/doc/monitorix/ alert example script
120 /docs/monitorix-apache.conf /etc/httpd/conf.d/ apache configuration
121 /docs/monitorix.service /usr/lib/systemd/system/ systemd service template
122 /docs/monitorix.init /etc/init.d/ Redhat SysV init script
123 /docs/monitorix-deb.init /etc/init.d/ Debian SysV init script
124 /docs/monitorix.logrotate /etc/logrotate.d/ logrotate script
125 /docs/monitorix.spec /usr/share/doc/monitorix/ RPM spec file
126 /docs/monitorix.sysconfig /etc/sysconfig/ pre-run config file
127 /docs/monitorix.lighttpd.conf /etc/lighttpd/ lighttpd configuration
128 /docs/htpasswd.pl /usr/share/doc/monitorix/ documentation
129 README /usr/share/doc/monitorix/ documentation
130 README.BSD /usr/share/doc/monitorix/ documentation
131 README.nginx /usr/share/doc/monitorix/ documentation
132 man/man5/monitorix.conf.5 /usr/share/man/man5/ monitorix.conf manpage
133 man/man8/monitorix.8 /usr/share/man/man8/ monitorix manpage
134 reports/*.html <base_lib>/reports/ traffacct reports i18n
135 css/*.css <base_dir>/css/ CSS theme files
136 usage/ <base_lib>/usage/ traffacct usage data
137
138 Once succesfully installed, please take a look into the configuration file to
139 setup the options according your system and enable or disable graphs.
140
141 Finally start Monitorix using the system init script:
142
143 # service monitorix start
144
145 or with:
146
147 # /etc/init.d/monitorix start
148
149 At this point, Monitorix will start gathering the system information based on
150 the configuration setup in 'monitorix.conf', and after some minutes, you should
151 be able to see the results from your favorite browser pointing at:
152
153 http://localhost:8080/monitorix/
154
155
156 AUTHORS
157 ===============================================================================
158 Monitorix is written and actively maintained by Jordi Sanfeliu.
159
160 Many people further contributed by reporting problems, suggesting various
161 improvements, sharing ideas or submitting actual code. Since the list might be
162 incomplete, please see the 'Changes' file for a detailed description of all the
163 contributions.
164
165 My special thanks to all of them!
166
167
168 CONTACT
169 ===============================================================================
170 In case of help, bugs, ideas or suggestions please contact using any of the
171 following ways:
172
173 - IRC at Libera.Chat: #monitorix
174 - Mailing List: https://lists.sourceforge.net/lists/listinfo/monitorix-general
175 - Direct Email: Jordi Sanfeliu <[email protected]>
176
177
178 DONATIONS
179 ===============================================================================
180 If you or your company make regular use of this software, please consider
181 making a donation to the author to support open source effort.
182 Any donation is greatly appreciated!
183
184
185 LICENSE AND COPYRIGHT
186 ===============================================================================
187 Monitorix is distributed under the terms of the GNU General Public License.
188 See the included file "COPYING".
189
190 Copyright (C) 2005-2024 Jordi Sanfeliu.
191 https://www.monitorix.org
192