==== Tunnelblick 3.0b6 for Mac OS X 10.3 or higher ====

Tunnelblick is a simple graphical user interface for the great VPN software
OpenVPN 2.0 and higher. It is written in Cocoa and comes in a ready to use
distribution with all necessary binaries and drivers.

==== Simple Installation ====

Download the disk image from: http://tunnelblick.net/, mount it and move the
Tunnelblick application package to your Applications folder.

==== Configuration and Use ====

 Now you are ready to start Tunnelblick by doubleclicking on it. A menu item
that looks like the entrance to a tunnel will appear in the upper right corner
of the menu bar. Clicking on that item will provide a drop-down menu.

 When starting Tunnelblick for the first time, you will be warned that no
valid configuration file for OpenVPN exists in the openvpn directory. To
provide Tunnelblick with the lacking file, click 'Continue' and a sample
configuration text file will open. Simply replace its contents with the
contents of your personal openvpn configuration file and save the file.

 If you have received key files together with your personal configuration
file, please make sure to put them in the openvpn directory (located in
~/Library/openvpn/ - the openvpn folder is a subfolder of the Library folder
located in your home directory). OpenVPN will try to locate the key files in
this directory, unless the paths to them are specified in the configuration
file in absolute terms.

==== Using more than one OpenVPN connection ==== 
You can put more than one .conf file together with its key files into the 
~/Library/openvpn directory and the different OpenVPN configurations will 
become available in the drop down menu.

==== Starting and Stopping VPN Connections ====
Select "Connect" from the drop-down menu to establish the pre-configured VPN
connection. To illustrate the connection being established, three dots will
appear in the tunnel menu item. If the connection was successfully created,
you will see light at the end of the tunnel.

You may be asked for a passphrase or username/password combination. You can
save your passphrase or password in Apple's Keychain by checking the
appropriate checkbox.

The connection will be active as long as you do not end it or log out of your
computer. Putting your computer to sleep or losing contact to the server (by
lack of wlan signal, for example) will result in Tunnelblick's attempt to
re-establish the connection.

If a connection error occurs, or in the unlikely event of an interface crash,
Tunnelblick will terminate the VPN tunnel and record the error in your
computer's syslog.

Use "Disconnect" from the drop-down menu to end the VPN connection; use "Quit"
to leave the program and to prevent Tunnelblick from starting itself at your
next login at your computer.

==== Uninstalling ====

To uninstall Tunnelblick, simply move Tunnelblick.app into the trash.

==== Building Tunnelblick from Source ====

To check out the source from the repository, you need subversion. If you have
fink (http://fink.sourceforge.net), this can be easily done by typing:

apt-get install svn-client

Check out the source code from our subversion repository by typing:

svn checkout svn://tunnelblick.net/openvpngui tunnelblick

Then type:

cd tunnelblick/trunk/ 
make

This will automatically build Tunnelblick and all dependancies and generate a
.dmg file out of it.

==== Credits ====

The Tunnelblick Crew would like to thank the following people:

* Andreas Prusak for the japanese localization 
* Jens Ohlig for the korean localization 
* Waldemar Brodkorb for the build script and first version of documentation 
* Daniel Lehmann for the beer he did not provide and his quick and wonderful OpenVPN Support. 
* MacHackers Bonn and the famous Netzladen for ClubMate and room for thought 
* The Metalab Vienna for Mate and room for thought

==== Feedback ====

Please contact us with suggestions about Tunnelblick or if you find any bugs
not listed here.

Have fun!

Dirk Theisen, Objectpark Group <d.theisen@objectpark.org> 
Angelo Laub <al@rechenknecht.net>