root/trunk/README @ 166

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

new bin directory, README update and check.sh uodate

  • Property svn:eol-style set to native
Line 
1 -----------------------------
2|       Install resume        |
3 -----------------------------
4
5        $ tar xvzf renetcol-0.0.15beta.tar.gz
6        $ cd renetcol-0.0.15beta
7        {./configure  |  ./configure --enable-ipv4agg=no }
8        Steps 1&2 , see below
9        $ make
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 )
13
14 ----------------------
15| Step 1: before compil |
16 ----------------------
17
18OS requirements : Linux distribution (tested on Debian Etch,lenny and Ubuntu7.1)
19
20You must changed some values in renetcolParam.h, values are detailed in the file.
21
22IPC System V MUST be installed on your OS.
23
24Specials packages requirements:
25 - libc6-dev
26 - libc6-prof
27 - librrd{0|2}-dev (if aggregation enabled)
28 - libpcap-dev (if --enable-readfromfile=yes )
29 
30 -------------------------------------
31| Step 2: before start                |
32 -------------------------------------
33
34   - create your IPv4 prefix/subnet file (or keep the default for test:
35conf/IPv4_prefix.txt). If you don't need aggregation you can keed the default
36and select "--enable-ipv4agg=no" in configure procedure
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>
41
42Note: no comment lines in this two files.
43
44
45 ----------
46| Commands |
47 ----------
48
49        ./renetcol ... : launch the collector (you must be root)
50        ./renetcolSender ... : to use remote client
51        ./renetcolMsgCtl ... : to kill the IPC message queue if you kill renetcol
52
53We recommand to use the script *check.sh* (in tool/) to launch renetcol.
54This script required in parameters the path to renetcol.
55We can also put the script in your root crontab to verify the collector state,
56for exemple:
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/
58
59 --------------------------
60| Others Commands exemples |
61 --------------------------
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
71    on Linux:
72       cd tool
73       python renetcolGUI.py
74    on Win32:
75       copy the file renetcolGUI.py on your system
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
85     *REQUIRED* Collector (renetcolSender) and remote client communication:
86        you MUST change few values in the renetcolGUI.py file:
87                - line 28 : path to GTK
88                - line 47 to 53 : IP protocol choice and collector address
89
90    *REQUIRED* In this release the client tool host MUST be have a
91 reverse DNS for his name. If not the collector will not be able to
92communicate with the client. Explication: filters are registered on the
93collector in a file (rules.txt) in such way:
94        N 53.renater.fr
95        O socket 53.renater.fr 2222
96        C 60 = 6
97       
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
103used few clients instantiations (on differents remotes computers).
Note: See TracBrowser for help on using the browser.