root/trunk/README @ 155

Revision 155, 3.5 KB (checked in by andreu, 11 years ago)

new bin directory, README update and check.sh uodate

  • Property svn:eol-style set to native
RevLine 
[71]1 -----------------------------
2|       Install resume        |
3 -----------------------------
4
[155]5        $ tar xvzf renetcol-0.0.15beta.tar.gz
6        $ cd renetcol-0.0.15beta
[71]7        {./configure  |  ./configure --enable-ipv4agg=no }
8        Steps 1&2 , see below
9        $ make
[155]10        $ make install (to install binary files in bin/ you must use the following
11option in configure command : ./configure --prefix=<path to renetcol> , example
12 ./configure --prefix=/home/me/renetcol-0.0.15 )
[71]13
[8]14 ----------------------
[71]15| Step 1: before compil |
[8]16 ----------------------
17
[155]18OS requirements : Linux distribution (tested on Debian Etch,lenny and Ubuntu7.1)
[2]19
[71]20You must changed some values in renetcolParam.h, values are detailed in the file.
[2]21
[71]22IPC System V MUST be installed on your OS.
[2]23
[71]24Specials packages requirements:
25 - libc6-dev
26 - libc6-prof
27 - librrd{0|2}-dev (if aggregation enabled)
[155]28 - libpcap-dev (if --enable-readfromfile=yes )
[71]29 
30 -------------------------------------
[73]31| Step 2: before start                |
[71]32 -------------------------------------
[8]33
[64]34   - create your IPv4 prefix/subnet file (or keep the default for test:
[97]35conf/IPv4_prefix.txt). If you don't need aggregation you can keed the default
[71]36and select "--enable-ipv4agg=no" in configure procedure
[64]37   
38   - create your router list file *REQUIRED*
39          (exemple in conf/routers.txt):
40     syntax: <id> <name> <first IPv4 address> <second IPv4 or NULL>
[8]41
[34]42Note: no comment lines in this two files.
[8]43
44
45 ----------
46| Commands |
47 ----------
48
49        ./renetcol ... : launch the collector (you must be root)
50        ./renetcolSender ... : to use remote client
[108]51        ./renetcolMsgCtl ... : to kill the IPC message queue if you kill renetcol
[8]52
[71]53We recommand to use the script *check.sh* (in tool/) to launch renetcol.
[108]54This script required in parameters the path to renetcol.
[71]55We can also put the script in your root crontab to verify the collector state,
56for exemple:
[155]575,10,15,20,25,30,35,40,45,50,55 * * * * /bin/sh <path>/renetcol-0.0.15beta/tool/check.sh <path>/renetcol-0.0.15beta/
[64]58
[108]59 --------------------------
60| Others Commands exemples |
61 --------------------------
[8]62
63colnet:/tmp/renetcol_user/src# killall renetcol
64colnet:/tmp/renetcol_user/src# killall renetcolSender
65colnet:/tmp/renetcol_user/src# ./renetcolMsgCtl renetcol
66
67 ----------------------------------
68| Use the client tool (python+GTK) |
69 ----------------------------------
70
[2]71    on Linux:
72       cd tool
[64]73       python renetcolGUI.py
[2]74    on Win32:
[64]75       copy the file renetcolGUI.py on your system
[2]76       install python, GTK and requirements:
77               for python:
78                   http://www.python.org/ download section
79               for pyGTK:
80                   http://www.pcpm.ucl.ac.be/~gustin/win32_ports/
81                   section pygtk on win32
82               for GTK+:
83                   http://gladewin32.sourceforge.net/
84
[71]85     *REQUIRED* Collector (renetcolSender) and remote client communication:
86        you MUST change few values in the renetcolGUI.py file:
[8]87                - line 28 : path to GTK
88                - line 47 to 53 : IP protocol choice and collector address
[2]89
[64]90    *REQUIRED* In this release the client tool host MUST be have a
[8]91 reverse DNS for his name. If not the collector will not be able to
[108]92communicate with the client. Explication: filters are registered on the
93collector in a file (rules.txt) in such way:
[8]94        N 53.renater.fr
95        O socket 53.renater.fr 2222
96        C 60 = 6
97       
[71]98For your first action from the client to the collector it's possible to have a
99 delay before the first flow view (>20s, it depends on the delay between two
100routers template definition)
101
102The client tool can be used on the collector box or in remote mode. You can
[108]103used few clients instantiations (on differents remotes computers).
Note: See TracBrowser for help on using the browser.