CONTENTS
REQUIREMENTS Tobias Oetiker's "rrdtool" is needed to let this script work. It is used to manage the databases and generate the graphics. At this point i would like to congratulate Tobi, he did a very good job writing this magnificent tool! Since I mainly use Perl5 to sample the data and update the databases, of course this has to be installed on your system. But this should not be an issue since most systems already come with full Perl5 support. But please be sure to install the perl-libraries of "rrdtool" using "make site-perl-install" afer you install "rrdtool." "convert" from the "ImageMagick" package has to be installed to get full functionality. "iptables" or "ipchains" has to be installed if you want to use the "network" module. Maybe you have to build a new kernel which has the corrosponding firewalling capabilities (packet filter) CONFIGURATION For version 0.3.6 first of all you should run setup.pl to generate the start/stop script (this will be rrdgraph) and the main "settings" file. The setup-script also calle each module's setup script to generate all module-specific settings. After that you should check if the "settings" file in the main directory contains the correct configuration to fit your system. Then you should check the settings files in each module directory and edit the generated "settings" files to fit your system. The "settings" files are (well, ok, at least they should be) quite self-explaining, so i guess it isn't needed to explain them here - though some day I might list every single module on this page along with a short explanation of what they do and which features they have. STARTING AND STOPPING THE DAEMON To run the auto-update daemon the best thing would be to get yourself root-permissions and enter: ./rrdgraph start rrdgraph will begin sampling data vor every plugin installed every 10 seconds. To stop the daemon enter ./rrdgraph stop Most modules will run as non-root, too, but if you want full functionality it is absolutely necessary to let the whole thing run as root. For example the PING module uses ICMP stuff that is only working if you are running it as root. GENERATING WEB-STATISTICS Well, you should not have to worry about anything except the output-directory which has to be configured correctly (you will have to enter the full path!) in the main settings file. The images on the statistics pages will be built automatically by HotSaNIC every configured timespan (which will be 15min. by default) If you like to build the graphs more often, you are welcome to decrease the time-base as you like by editing the main settings file. But be sure that decreasing the time-span will eat up more CPU time (which may be needed for more important tasks ... ). To build the index.html files just start makeindex.pl and all shall be well. The script will gather every plugin-directory and build the necessary index-files for your webpage. In case you install a new plugin, just let HotSaNIC run a couple of minutes inititalize the plugin's databases. Then you just call makeindex.pl again and it will do the rather nasty update-job for you. New plugins can be installed on the fly, the only thing to do is to copy the module-directory to the main directory and maybe you have to add the new module to the RUN and SHOW entries in the main settings. If you use the "traffic" plugin, please let rrdgraph run at least some 30 seconds to allow the plugin to scan your local interfaces before you run the index-maker. "rrdtimer" will call "convert.sh" about every 24h (timebase may be configured in main settings file). This script will generate pictograms on the main index page of your webstats from the actual weekly graphs. This will require "convert" from "ImageMagick" to be installed. It is used to resize the weekly graph images. TROUBLESHOOTING
|