Brandeis University Netflow processing system
Copyright 2008 Brandeis University

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

== How it works ==

You must already have flow-capture from the flow-tools package running (see
below). It writes captured netflow data into files. From there, a cron job
runs regularly to extract data from those files and store it in a database.

A web frontend provides access to the data, optionally including a public
view.

== Requirements ==

* UNIX-like system (developed on RedHat Linux)
* flow-tools (see http://www.splintered.net/sw/flow-tools/)
* PHP
* JpGraph (http://www.aditus.nu/jpgraph/)

== Setup ==

1. Create a MySQL database to hold the data. Load the schema from
etc/netflow.sql into it.

2. Copy sbin/flow2db.php and sbin/make-static-images.sh somewhere, like
/usr/local/sbin/

3. Edit lib/flow-config.php and lib/bandwidth-config.php.

4. Copy the files from htdocs somewhere under your web server's document
root that parses PHP.

5. Copy the files from lib/* somewhere in the PHP include path. I like to
create /usr/local/lib/php and add that to the path in php.ini. You'll
probably also want to put the following jpgraph library files there:

jpgraph.php jpgraph_line.php jpgraph_bar.php