root/trunk/README @ 132

Revision 132, 3.3 KB (checked in by andreu, 12 years ago)

README update

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