Changeset 71 for trunk/README

Timestamp:

05/16/08 10:32:42 (15 years ago)

Author:

andreu

Message:

changes in README

Files:

• trunk/README (modified) (4 diffs)

trunk/README

@@ +1 @@
+ -----------------------------
+|       Install resume        |
+ -----------------------------
+
+        $ tar xvzf renetcol-0.0.12.tar.gz
+        $ cd renetcol-0.0.12
+        {./configure  |  ./configure --enable-ipv4agg=no }
+        Steps 1&2 , see below
+        $ make
+        $ make install (optional)
+
  ----------------------
-|       Install        |
+| Step 1: before compil |
  ----------------------
 
-        tar xvzf renetcol-0.0.12.tar.gz
-        cd renetcol-0.0.12
-        ./configure
-        (./configure --help)
-        (before the make command you MUST change some values in renetcolParam.h, see below)
-        make
-        make install (if you want)
+OS requirements : Linux distribution (tested on Debian Etch and Ubuntu7.1)
 
- --------------------------------------
-| Collector requirements before compil |
- --------------------------------------
+You must changed some values in renetcolParam.h, values are detailed in the file.
 
-You must changed some values in renetcolParam.h *REQUIRED*:
+IPC System V MUST be installed on your OS.
 
- -----------------------------------------------------
-| Collector requirements before start / Configuration |
- -----------------------------------------------------
+Specials packages requirements:
+ - libc6-dev
+ - libc6-prof
+ - librrd{0|2}-dev (if aggregation enabled)
+ 
+ -------------------------------------
+| Step 2: before configuration & start |
+ -------------------------------------
 
    - create your IPv4 prefix/subnet file (or keep the default for test: 
-IPv4_prefix.txt. If you don't need aggregation you can keed the default and select "--enable-ipv4agg=no" in configure procedure
+IPv4_prefix.txt). If you don't need aggregation you can keed the default 
+and select "--enable-ipv4agg=no" in configure procedure
    
    - create your router list file *REQUIRED* 
           (exemple in conf/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 lines in this two files.
@@ -38 +46 @@
         ./renetcol ... : launch the collector (you must be root)
         ./renetcolSender ... : to use remote client
-        ./renetcolMsgCtl ... : to kill the message queue if you kill renetcol  
+        ./renetcolMsgCtl ... : to kill the IPC message queue if you kill renetcol  
 
-We recommand to use the script check.sh (in tool/) to launch renetcol. This script required in parameters the path to renetcol. We can also put the script in your root crontab to verify the collector state:
-5,10,15,20,25,30,35,40,45,50,55 * * * * /bin/sh <path>/renetcol-0.0.12/tool/check.sh <path>/renetcol-0.0.12/
+We recommand to use the script *check.sh* (in tool/) to launch renetcol. 
+This script required in parameters the path to renetcol. This file MUST be edited.
+We can also put the script in your root crontab to verify the collector state, 
+for exemple:
+5,10,15,20,25,30,35,40,45,50,55 * * * * \
+ /bin/sh <path>/renetcol-0.0.12/tool/check.sh <path>/renetcol-0.0.12/
 
  -------------------
@@ -69 +81 @@
                    http://gladewin32.sourceforge.net/
 
-    Collector (renetcolSender) and remote client communication *REQUIRED*:
-        you MUST change few values in the renetcolGUI_0_0_7.py file:
+     *REQUIRED* Collector (renetcolSender) and remote client communication:
+        you MUST change few values in the renetcolGUI.py file:
                 - line 28 : path to GTK
                 - line 47 to 53 : IP protocol choice and collector address
@@ -82 +94 @@
         C 60 = 6
         
-    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 routers 
-template definition). 
+For your first action from the client to the collector it's possible to have a
+ delay before the first flow view (>20s, it depends on the delay between two 
+routers template definition) 
+
+The client tool can be used on the collector box or in remote mode. You can 
+used few clients instantiations (on differents remotes PCs).