Introduction
============

NSIS (Next Steps In Signaling) is a modular framework developed at the IETF
NSIS working group. It provides means to establish and manage network control
state along a data path between two nodes communicating on the Internet.

NSIS builds upon the General Internet Signaling Transport (GIST) protocol.
(Note: GIST was formerly known as the General Internet Messaging Protocol for Signaling
(GIMPS) but was renamed in the 63th IETF meeting)
GIST provides the basic transport functionality that is common to all signaling
applications (e.g. signaling aware node discovery and transport layer connections).
Above GIST, a number of signaling protocols, known as NSIS Signaling Layer 
Protocols (NSLPs), can be run. Examples are QoS NSLP and NAT/FW NSLP.

This release provides NSIS for the OpenWRT platform.


OpenWRT
=======

For more information about OpenWRT, please see the their official webpage at
http://www.openwrt.org.
There you will find a list of supported hardware, the recent firmware images
and a lot of documentation.
This release is based on OpenWRT White Russian (RC5).


NSIS on OpenWRT - Quick Guide
=============================

This is an experimental release of NSIS for OpenWRT. It comes with no warranty
of any kind. Just like OpenWRT itself, NSIS on OpenWRT might render your router 
unuseable. Thus, you use it ON YOUR OWN RISK.

To install the NSIS package, please follow these intructions:
1. Edit /etc/ipkg.conf and add the line 
   "src nsis http://user.informatik.uni-goettingen.de/~nsis/files/nsis/openwrt"
   PLEASE NOTE: As with most files on OpenWRT, /etc/ipkg.conf will be a symlink
   to a read-only file. Use the intructions given in the OpenWRT wiki.
   (e.g. "rm /etc/ipkg.conf && cp /rom/etc/ipkg.conf /etc/ipkg.conf")
2. Run "ipkg update" to update your list of packages
3. Run "ipkg install nsis"
4. Create a nsis.conf (or take the one that ships with our standard source code
   release) in /tmp
5. Run "nsis" with /tmp as your working directory (otherwise, NSIS will not find
   the configuration).
   
NSIS works in the same way as it does on standard linux. Therefore, all NSLPs
and command line options etc. might be used. Please see the configuration 
available in our standard release for more information.
PLEASE NOTE: If you intend to use QoS NSLP with the SimpleRMF and therefore
want to reserve resources with Traffic Control, you will need to install
TC (i.e. "ipkg install tc") and load the appropriate kernel modules for 
SCH_HTB, SCH_SFQ and CLS_FW (e.g. "insmod /lib/modules/2.4.30/cls_fw.o").



Further information
===================

Further information can be obtained from our website:
http://user.informatik.uni-goettingen.de/~nsis/
On the "Getting help" page you will find a mailing list. Please feel free
to ask any questions regarding NSIS on OpenWRT or general NSIS questions
on this mailing list.

Have fun!