README for Cflow ---------------- intro ----- Cflow is a perl module providing an API for reading and analyzing raw flow files written by freely-available software packages such as argus, cflowd, flow-tools, and lfapd. prerequisites ------------- - perl version 5 - one or more of the following collectors: * argus by Carter Bullard: http://www.qosient.com/argus/ * flow-tools by Mark Fullmer (with NetFlow v1, v5, v6, or v7): http://www.splintered.net/sw/flow-tools/ * CAIDA's cflowd 2.x by Daniel McRobb (with Cisco's NetFlow v5): http://www.caida.org/tools/measurement/cflowd/ http://net.doit.wisc.edu/~plonka/cflowd/ * lfapd by Steve Premeau (with Riverstone's LFAPv4): http://www.nmops.org/ installation ------------ 1) If not using argus, skip to step 2. When building for compatibility with argus-2.0.6, first do the following: Build and install argus normally (if you haven't already): $ cd argus-2.0.6 $ ./configure $ make # make install Build and install argus-clients normally (if you haven't already): $ cd argus-clients-2.0.6 $ ./configure $ make # make install Extract Cflow in "contrib" under argus-clients build directory: $ mkdir -p contrib $ cd contrib $ gunzip -c Cflow-1.xxx.tar.gz | tar xf - $ cd Cflow-1.xxx 2) If not using flow-tools, skip to step 3. When building for compatibility with flow-tools-0.56 (or perhaps a later version), first do the following: Build and install flow-tools normally (if you haven't already): $ cd flow-tools-0.56 $ ./configure $ make # make install Extract Cflow in "contrib" under flow-tools build directory: $ mkdir -p contrib $ cd contrib $ gunzip -c Cflow-1.xxx.tar.gz | tar xf - $ cd Cflow-1.xxx 3) Regardless of which flow file source software package you use, do this in the extracted Cflow-1.xxx directory: $ perl Makefile.PL If you are under the argus "contrib" directory, you should see this message, amongst other things: Found argus... using "-DARGUS ... " or, if you are under the flow-tools "contrib" directory, you should see this message: Found flow-tools... using "-DOSU ... " 4) Lastly, do: $ make # make install documentation ------------- Once installed, the following online documentation is available: $ perldoc Cflow $ perldoc flowdumper $ flowdumper -h -- $Id: README,v 1.11 2005/09/28 21:07:18 dplonka Exp $ Dave Plonka <plonka@doit.wisc.edu>