                                README

                Information about the rsipd package

RSIPD	A RSIP server, intended to be compliant with RFC 3103 "RSIP
        protocol specification".

	RSIP was designed as an alternative of the NAT/PAT, with
	the additional requirement to preserve end-to-end packet
	integrity.

This package includes the source files of a RSIP server.
Please include the output of "rsipd -V" when reporting bugs.

---------------------------------------------------------------------
MAKE SURE TO CORRECTLY CONFIGURE THE ADDRESS POOL AND THE INTERFACES
BEFORE STARTING THE SERVER ! SEE FILE /etc/rsip/rsipd.conf.
---------------------------------------------------------------------

Quick installation
------------------
    make; make install   (as Root)

Usage
-----
    rsipd [ -pdVhcDa ]

    Options
       -p port  -- Specify RSIP port (default: 4555)
       -d       -- Dump packets received
       -V       -- Print version and exit
       -h       -- Print usage information and exit
       -c file  -- Specify configuration file (default: /etc/rsipd.conf)
       -D       -- Debug mode (no daemon process)
       -a       -- Add ARP entry for each leased RSIP address

Features:
---------
    - RSIP compliant
    - Supports UDP and TCP protocols
    - Supports RSA-IP and RSAP-IP
    - Supports IP/IP and IP/GRE tunnels
    - Supports all mandatory RSIP messages
    - Manage timeouts for resource allocation
    - Manage UDP retransmssion
    - SLP support
    - Configuration file : /etc/rsip/rsipd.conf

Contents:
---------
  
    README			This file.
    INSTALLING			Installation instructions.
    COPYING			Your free copy of the GNU Public License.
    TODO			Future work that need to be done.
    AUTHORS			To contact the author
    ChangeLog			History of the development process
    Makefile			To compile this program
    rsipd.conf			The configuration file for the server
    rsipd                       A script to query and init the RSIP server

    /src			The directory containing all the source files
				and the compiled binairies

Files :
-------

    /usr/sbin/rsipd		The binary server file
    /usr/sbin/rsipdctl		The script which starts and stops rsipd
    /etc/init.d/rsipd		The starting script for rsipd
    /etc/rsip/rsipd.conf	The configuration file
    /var/lib/rsip/rsipd.stat	File generated when the status of rsipd is 
				 dumped (by using 'rsipdctl dump')

Notes
-----

This is a RSIP Server. This version is a beta one. Help is welcome !

You need kernel 2.4 or above to use this program.  This program
should compile cleanly with gcc versions 2.96, 2.95.3, 3.0.3, 3.1 and 3.1.1.
You also need the iptables package.

MAKE SURE TO CORRECTLY CONFIGURE THE ADDRESS POOL AND THE INTERFACES
BEFORE STARTING THE SERVER ! SEE FILE /etc/rsip/rsipd.conf.

The RSIP protocol is Copyright (C) The Internet Society (2001). All rights
reserved.

The implementation is distributed under the GNU GENERAL PUBLIC LICENSE,
Version 2, June 1991. You should have received a copy of the license with
this package.

Author & contact :

Cedric de Launois
delaunois at info dot ucl dot ac dot be

Universite Catholique de Louvain
Department of Computing Science and Engineering
2, Place Sainte-Barbe
B-1348 Louvain-la-Neuve (Belgium)

