From 0ee1f2ff0df97560ddf49e172812741c84ebc406 Mon Sep 17 00:00:00 2001 From: Erik Ekman Date: Sun, 13 Aug 2006 19:18:35 +0000 Subject: [PATCH] Updated docs --- CHANGELOG | 4 ++++ README | 19 +++++++++++++++++++ TODO | 5 +++++ 3 files changed, 28 insertions(+) diff --git a/CHANGELOG b/CHANGELOG index 5fae2b5..5b706d8 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -7,6 +7,10 @@ iodine - IP over DNS is now easy CHANGES: +xxxx-xx-xx: 0.4 + - New encoding, 25% more peak upstream throughput + - New -l option to set local ip to listen to on server + 2006-07-11: 0.3.1 - Add Mac OSX support - Add setting device name diff --git a/README b/README index 077c511..2083e77 100644 --- a/README +++ b/README @@ -10,6 +10,20 @@ server. This can be usable in different situations where internet access is firewalled, but DNS queries are allowed. +QUICKSTART: + +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) +- On the client, run: ./iodine -f 192.168.0.1 test.asdf + (Replace 192.168.0.1 with the server's ip address) +- 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! :) +To actually use it through a relaying nameserver, see below. + + HOW TO USE: Server side: @@ -73,6 +87,11 @@ The name iodine was chosen since it starts with IOD (IP Over DNS) and since iodine has atomic number 53, which happens to be the DNS port number. +THANKS: + +- To kuxien for FreeBSD and OS X testing + + AUTHORS & LICENSE: Copyright (c) 2006 Bjorn Andersson , Erik Ekman diff --git a/TODO b/TODO index bddf664..31467fd 100644 --- a/TODO +++ b/TODO @@ -12,3 +12,8 @@ STUFF TO DO: - Some kind of authentication? - Detect if EDNS0 can be used, probe MTU size + +- Port to more platforms (Solaris? Windows?) + +- More/better documentation (as always) +