Welcome to the multicast Tunnel - mTunnel README!

The mTunnel is an application that tunnels multicast packets over an unicast
UDP channel. Several multicast streams can be sent over the same tunnel while
the tunnel will still only use one port. This is useful if tunneling through
a firewall.

The applications primary goal is to allow for easy tunneling of multicast
over for instance a modem and/or an ISDN connection. 

The mTunnel has a built in Web-server allowing for easy access to information
about current tunnels. This server listens by default on port 9000 on the
machine where started.

The mTunnel also listens on session announcements for easier tunneling of
known sessions. 

The latest version of this package can always be found at
<URL:http://www.cdt.luth.se/~peppar/progs/mTunnel/>.

If you download and install this package please send me an email! :-)
(peppar@cdt.luth.se)

***  Warning!!  Warning!!  Warning!!  Warning!!  Warning!!  Warning!!  ***

Do NOT start tunneling with both end-points on the same network.

Do NOT start tunneling with both end-points on two hosts that already
have MBone connectivity with each other.

mTunnel currently does NOT detect loops in the traffic!!!!!!!

***  INSTALL 

1) Make sure you have JDK1.1 (or newer) installed

2) Edit the two variables at the top of the file mTunnel or mTunnel.bat
   to reflect where you have installed JDK and where you have unpacked
   this package.

3) Copy the file mTunnel to a convenient place, such as
   /usr/local/bin or c:\bin

4) The file libAudio.so is only used on Sun/Solaris hosts. It can
   be removed on all other platforms (not even included in the Windows
   release)

***  Example usage

1) Decide which 2 hosts that are going to be end-points for the tunnel (say one
   at home and one at work). For instance, workhost and homehost.

2) On workhost start the mTunnel with:
	mTunnel -S -v homehost/10000

3) On homehost start the mTunnel with:
	mTunnel -S -v workhost/10000

4) Now connect to the mTunnel using a Web-browser.

	http://workhost:9000/
		or
	http://homehost:9000/

   Choose the one closest to your Web-browsers present location.

***  Files and ports

The mTunnel caches announced sessions in ~/.msd/cache/ for faster
updates when restarted.

The httpd-port is default 9000 and can be changed using '-p' option
when starting mTunnel.

The tunneler uses two unicast ports for the control traffic. In the
example above, ports 10000 and 10001 will be used.

*** mTunnel options

-v	verbose

-V 	very verbose

-h	print a short help message

-S	tunnel sap.mcast.net for MBone sessions announcements

-T ttl	use TTL 'ttl' for retransmissions of announcements instead of the TTL
	of the original announcement

-p port Use port 'port' for HTTP interface

-P 	start mTunnel i passive mode meaning that it will not actively try
	to connect to the other side of the tunnel. This allows the user
	to have one end of the tunnel running and only starting the other
	end when needed. Note, that if both sides are started with -P, the
	tunnel ends will not find each other.

-I multicast_interface
	Use 'multicast_interface' for sending local multicast traffic. To be
	used by hosts with multiple multicast capable interfaces.

***  Contact

Send bug-reports, feature-requests or just a nice hi to me at
peppar@cdt.luth.se.

My home-page can be found at <URL:http://www.cdt.luth.se/~peppar/>.

You might also be interested in joining the mStar mail-list. See
http://www.cdt.luth.se/~peppar/docs/mStar-announce.txt
	
***  ***

$Id: README,v 1.4 1998/02/01 19:18:54 peppar Exp $