Changeset 8 for trunk/README

Timestamp:

10/20/05 15:05:40 (17 years ago)

Author:

andreu

Message:

second RENETCOL CVS Integration

Files:

• trunk/README (modified) (2 diffs)

trunk/README

@@ -1 @@
-Install the collector:
-        tar xvzf renetcol_0_0_1.tar.gz
-        cd renetcol_0_0_1
+ ----------------------
+|       Install        |
+ ----------------------
+
+        tar xvzf renetcol-0.0.2.tar.gz
+        cd renetcol-0.0.2
         ./configure
+        (before the make command you MUST change some values in renetcol.h, see below)
         make
         make install (if you want)
 
-Collector requirements:
-        create your IPv4 prefix file (or keep the default for test: IPv4_prefix.txt)
-        create your router list file
-        change the line 29 and 30 of renetcol.h file (your collector address:port)
+ --------------------------------------
+| Collector requirements before compil |
+ --------------------------------------
 
-Commands:
-        ./renetcol ... : launch the collector (if no message, it's good)
-                        during execution you can see the /var/log/message file
-        ./renetcolSender ... : to use the remote client
-        ./renetcolMsgCtl ... : to kill the message queue 
+Change the following values in renetcol.h *REQUIRED*:
+#define RECEPTION_ADDRESS "10.0.0.1" 
+#define RECEPTION_PORT 9999
+(this two values are the values configured on your routers to export Netflow
+datagrams)
 
-Use the client tool (python+GTK):
+ --------------------------------------
+| Collector requirements before start  |
+ --------------------------------------
+
+        - create your IPv4 prefix file (or keep the default for test: 
+IPv4_prefix.txt, in this release the file must be present with a good syntax,
+but data are not important)
+        - create your router list file *REQUIRED* (exemple in src/routers.txt):
+syntax: <id> <name> <first IPv4 address> <second IPv4 or NULL>
+keep this first line: 0 null 0.0.0.0 null
+
+Note: no comment line in this two files.
+
+
+ ----------
+| Commands |
+ ----------
+
+        ./renetcol ... : launch the collector (you must be root)
+        ./renetcolSender ... : to use remote client
+        ./renetcolMsgCtl ... : to kill the message queue if you kill renetcol  
+
+ -------------------
+| Commands exemples |
+ -------------------
+
+colnet:/tmp/renetcol_user/src# ./renetcol routers.txt IPv4_prefix.txt rules.txt
+
+colnet:/tmp/renetcol_user/src# ./renetcolSender renetcol 1 rules.txt
+
+colnet:/tmp/renetcol_user/src# killall renetcol
+colnet:/tmp/renetcol_user/src# killall renetcolSender
+colnet:/tmp/renetcol_user/src# ./renetcolMsgCtl renetcol
+
+ ----------------------------------
+| Use the client tool (python+GTK) |
+ ----------------------------------
+
     on Linux:
        cd tool
-       python renetcolGUI_0_0_1.py
+       python renetcolGUI_0_0_2.py
     on Win32:
-       copy the file on your box
+       copy the file renetcolGUI_0_0_2.py on your system
        install python, GTK and requirements:
                for python:
@@ -35 +75 @@
                    last release 2.6.8 (Runtime Environment Installer 2.6.8-rc1)
 
+    Collector (renetcolSender) and remote client communication *REQUIRED*:
+        you MUST change few values in the renetcolGUI_0_0_2.py file:
+                - line 28 : path to GTK
+                - line 47 to 53 : IP protocol choice and collector address
 
+    *REQUIRED* In this release (0.0.2) the client tool host MUST be have a
+ reverse DNS for his name. If not the collector will not be able to 
+communicate with the client. Explication: the rules are registered on the 
+collector in the conf file (rules.txt) in such way:
+        N 53.renater.fr
+        O socket 53.renater.fr 2222
+        C 60 = 6
+It's not a requirement for rules applied directly in this file (with an 
+editor).
         
+    Note: For your first action from the client to the collector it's 
+possible to have a delay (>20s, it depends on the delay between two template
+definition). This delay desappears after.