root/trunk/README @ 71

Revision 71, 3.3 KB (checked in by andreu, 14 years ago)

changes in README

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