[svn-upgrade] Integrating new upstream version, iodine (0.4.0)

[debian/iodine.git] / README

diff --git a/README b/README
index 0803fc12ba625f8484ed02694632d90761d6cf5f..f52ed4f370762f6cd5d9f517f42c2debe7c650f0 100644 (file)
--- a/README
+++ b/README
@@ -16,8 +16,10 @@ Try it out within your own LAN! Follow these simple steps:
 - On your server, run: ./iodined -f 10.0.0.1 test.asdf
   (If you already use the 10.0.0.0 network, use another internal net like 
   172.16.0.0)
+- Enter a password
 - On the client, run: ./iodine -f 192.168.0.1 test.asdf
   (Replace 192.168.0.1 with the server's ip address)
+- Enter the same password
 - Now the client has the tunnel ip 10.0.0.2 and the server has 10.0.0.1
 - Try pinging each other through the tunnel
 - Done! :)
@@ -40,8 +42,9 @@ to your server. Start iodined on the server. The first argument is the tunnel
 IP address (like 192.168.99.1) and the second is the assigned domain (in this
 case tunnel1.mytunnel.com). The -f argument will keep iodined running in the
 foreground, which helps when testing. iodined will start a virtual interface,
-and also start listening for DNS queries on UDP port 53. Now everything is
-ready for the client.
+and also start listening for DNS queries on UDP port 53. Either enter a
+password on the commandline (-P pass) or after the server has started. Now 
+everything is ready for the client.
 
 Client side: 
 All the setup is done, just start iodine. It also takes two
@@ -49,8 +52,10 @@ arguments, the first is the local relaying DNS server and the second is the
 domain used (tunnel1.mytunnnel.com). If DNS queries are allowed to any
 computer, you can use the tunnel endpoint (example: 10.15.213.99 or
 tunnel1host.mytunnel.com) as the first argument. The tunnel interface will get
-an IP close to the servers (in this case 192.168.99.2) and a suitable MTU. Now
-you should be able to ping the other end of the tunnel from either side.  
+an IP close to the servers (in this case 192.168.99.2) and a suitable MTU. 
+Enter the same password as on the server either by argument or after the client
+has started. Now you should be able to ping the other end of the tunnel from 
+either side.  
 
 
 MISC. INFO:
@@ -84,8 +89,8 @@ iptables -t nat -A PREROUTING -i eth0 -p udp --dport 53 -j DNAT --to :5353
 
 PORTABILITY:
 
-iodine has been tested on Linux (x86, AMD64 and SPARC64), FreeBSD (x86), 
-OpenBSD (x86), NetBSD (x86) and MacOS X (10.3, ppc, with 
+iodine has been tested on Linux (arm, ia64, x86, AMD64 and SPARC64), FreeBSD 
+(ia64, x86), OpenBSD (x86), NetBSD (x86) and MacOS X (10.3, ppc, with 
 http://www-user.rhrk.uni-kl.de/~nissler/tuntap/). It should work on other 
 unix-like systems as well that has TUN/TAP tunneling support (after some 
 patching). Let us know if you get it to run on other platforms. 
@@ -105,7 +110,7 @@ THANKS:
 
 AUTHORS & LICENSE:
 
-Copyright (c) 2006 Bjorn Andersson <flex@kryo.se>, Erik Ekman <yarrick@kryo.se>
+Copyright (c) 2006-2007 Bjorn Andersson <flex@kryo.se>, Erik Ekman <yarrick@kryo.se>
 
 Permission to use, copy, modify, and distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice
@@ -118,3 +123,7 @@ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
+
+
+MD5 implementation by L. Peter Deutsch (license and source in src/md5.[ch])
+Copyright (C) 1999, 2000, 2002 Aladdin Enterprises.  All rights reserved.