===================================================================
SIP Residential Gateway README 
====================================================================
Tata Infotech SIP Residential Gateway (sip-rg)
Release 1.3.0
April 2002


====================================================================
LICENSE AND COPYRIGHT 
====================================================================
For information about licensing, please see the LICENSE file in the
'sip-1.3.0/sip/rg' directory, or,
http://www.cse.iitb.ac.in/~tirg/rg/license.html

====================================================================
INTRODUCTION
====================================================================
This directory contains the source code for a single line
residential gateway based on QuickNet LineJack-ISA and Vovida SIP
stack(sip-1.3.0).  
It is an IP Telephony Gateway based on SIP which allows a SIP User 
Agent to make/receive a SIP call to/from the Public Switched 
Telephone Network (PSTN).



====================================================================
KNOWN BUGS OR LIMITATIONS & WORKAROUNDS
====================================================================
Please refer to file LIMITATIONS_WORKAROUNDS.



====================================================================
GETTING STARTED
====================================================================

PLATFORM SUPPORT
--------------------------------------------------------------------
The SIP Residential Gateway will compile and run on Linux operating 
system. We have tested the SIP Residential Gateway on:
-- RedHat Linux 6.2 with gcc 2.91.66 (egcs-1.1.2 release)
   and glibc 2.1.3-15
-- RedHat Linux 7.2 with gcc 2.96



QUICKNET SUPPORT
--------------------------------------------------------------------
The SIP Residential Gateway can be used with the following 
Quicknet Card:
-- Internet LineJACK-ISA Card

You can connect a analog telephone line to the PSTN port of the
Internet LineJACK card and initiate a call to the PSTN from a SIP
user agent or receive a call from PSTN on a SIP user agent. The rg
requires the 1.2.0 version of the Quicknet drivers.

The drivers, and instructions for installing them, are available
from

	http://www.openh323.org/driver/build.html



Quicknet Driver Support
--------------------------------------------------------------------
In order to use the Quicknet cards in a Linux machine, you must
install Quicknet Linux drivers.  We have used the 1.2.0 drivers,
from 

	http://www.openh323.org/driver/build.html

##################
For convenience we have included them in the tarball as directory:
'ixj-1.2.0'

Please refer to section INSTALLING THE RESIDENTIAL GATEWAY below 
to find out how to use it.
##################




INSTALLING THE RESIDENTIAL GATEWAY
--------------------------------------------------------------------
The rg-1.3.0 tarball contains only RG software & Quicknet IXJ driver
software. It needs to be moved to appropiate locations inside the 
directory structure created by inflating the Vovida sip-1.3.0 tarball.

Please refer to SIP Download page for details on using sip-1.3.0.
Once the sip-1.3.0 directory structure is ready carry out the 
following steps to install the RG software:

[1] Inflate the tarball 'rg-1.3.0.tar.gz' in a temporary directory.

	tar -zxvf rg-1.3.0.tar.gz

   The following two directories would be created: 
	(i) rg-1.3.0/rg			--> RG software
	(ii) rg-1.3.0/ixj-1.2.0		--> Quicknet driver

[2] Move the rg & ixj-1.2.0 directories to the locations as shown:
	cd rg-1.3.0/
	mv rg sip-1.3.0/sip
	mv ixj-1.2.0 sip-1.3.0/contrib/quicknet

[3] Make the following change in the Makefile of the directory 
'sip-1.3.0/contrib/quicknet'.

    set IXJ = ixj-1.2.0 
to point to the newly created 'ixj-1.2.0' directory.

Now RG is ready for compilation.



Compiling & Installing the Quicknet Driver
--------------------------------------------------------------------
Carry out the following steps as root in the 'ixj-1.2.0' directory :

	./configure
	make install-headers
	make install
	/sbin/modprobe ixj




COMPILING THE RESIDENTIAL GATEWAY
--------------------------------------------------------------------
Carry out the following steps in the 'sip-1.3.0/sip/rg' directory :

To compile the residential gateway, type:
	make

To compile the residential gateway without debug information, type:
	make CODE_NODEBUG=1




====================================================================
CONFIGURING THE RESIDENTIAL GATEWAY
====================================================================
For instructions to configure RG please refer CONFIGURATION_MANUAL.


====================================================================
USING THE RESIDENTIAL GATEWAY
====================================================================
For Usage instructions please refer USAGE_MANUAL.


====================================================================
FOR MORE INFORMATION ON RESIDENTIAL GATEWAY
====================================================================
For further information on RG refer FAQ, TEST_CASES and
LIMITATIONS_WORKAROUNDS documents.