Merge branch 'master' of homeproj.cesnet.cz:warden

src/warden-server/doc/README

@@ -18,35 +18,46 @@ Content
 --------------------------------------------------------------------------------
 A. Overall Information
 
- /*TODO*/Upravit pro kontext warden serveru
-
  1. About Warden Client
  
     Warden is a client-based architecture service designed to share detected
     security issues (events) among CSIRT and CERT teams in a simple and fast way.
     
-    This package offers full client functionality to both report events to
-    server and to retreive batch of new events from server. It is composed from
-    several perl modules/libraries which should be included into local
-    application of detection of reaction type. 
- 
+    This package offers full server functionality to both install and maintain
+    Warden server and to register and/or unregister particular clients.
+
  2. Version
   
-    1.0.0 (2011-11-16)
+    1.0.0 (2012-01-31)
     
  3. Package structure
  
-    warden-client/
+    warden-server/
+      bin/
+        getClients.pl
+	getStatus.pl
+	registerReceiver.pl
+	registerSender.pl
+	unregisterClients.pl
+	warden-alive
+	wardend
+	warden-server.pl
       doc/
-        example-sender.pl.txt
-        example-receiver.pl.txt
+        CHANGELOG
+	INSTALL
+	LICENSE
+	README
       etc/
         warden-client.conf
-      var/
+	warden-server.conf
       lib/
-        WardenClientSend.pm
-        WardenClientReceive.pm
-        WardenConf.pm  
+        WardenConf.pm
+        WardenReg.pm
+        WardenStatus.pm  
+      sh/
+        create_table
+	install
+	update
 
 --------------------------------------------------------------------------------
 B. Installation Dependencies
@@ -182,7 +193,20 @@ G. Registration of Clients
 
  1. Register Sender
 
-    /*TODO*/Doplnit...
+    New sender clients are registered in Warden system via
+    warden-server/bin/registerSender.pl.
+    
+    Following attributes must be provided in order to register new client
+    successfully:
+    
+    hostname          - hostname of the client,
+    requestor         - organization or authorized person who demands new
+                        client registration, 
+    service           - name of the service of a new registered client,
+    description_tags  - tags describing the nature of the service,
+    ip_net_client     - CIDR the client is only allowed to communicate from.
+
+    One can always run registerSender.pl with -h argument to see a help.
 
  2. Register Receiver
 
@@ -208,9 +232,8 @@ H. Status Info
 --------------------------------------------------------------------------------
 I. Nagios Integration
 
-  /*TODO*/Doplnit...
-
-  Is available via Nagios plugin /opt/warden-server/bin/warden-alive.
+  Nagios controll is available via Nagios plugin located in
+  /opt/warden-server/bin/warden-alive.
 
 --------------------------------------------------------------------------------
 J. Authors