summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README32
1 files changed, 32 insertions, 0 deletions
diff --git a/README b/README
index 72717c1..b529fc2 100644
--- a/README
+++ b/README
@@ -5,6 +5,7 @@ uAnytun can be built by using either libgcrypt or the openssl-crypto library.
The latter is more performant in most cases but there are some license
issues when using this library. It also needs more space when installed.
+
Linux
-----
@@ -18,6 +19,7 @@ using ssl crypto library:
build-essential
libssl-dev
+
OpenBSD/FreeBSD
---------------
@@ -32,6 +34,7 @@ using ssl crypto library:
gmake
+
Installation
============
@@ -41,6 +44,7 @@ Getting the source via subversion:
svn co https://svn.anytun.org/uanytun/trunk uanytun
cd uanytun
+
Building from source
--------------------
@@ -63,6 +67,7 @@ Notes:
version
- on OpenBSD/FreeBSD you have to use gmake instead of make
+
Installing
----------
@@ -70,6 +75,7 @@ Installing
This will install anytun under the --prefix defined with configure.
+
Uninstalling
------------
@@ -80,3 +86,29 @@ This removes everytthing except for the config files
# sudo make purge
This also removes the config files
+
+
+
+Usage:
+======
+
+init.d script
+-------------
+
+The init.d script can be used to start uanytun at boot time. It searches for
+configuration files which reside at $CONFIG_DIR. For each instance of uanytun
+which should be started there must be a directory containing at least a file
+named config. This file must contain all command line parameter which should
+be used when starting the daemon. One line for each parameter. Empty lines and
+lines starting with # are ignored. Besides the config file there may be a script
+named post-up.sh which will be called when the tun/tap device comes up.
+This is an example of how the init.d script can be used to start uanytun:
+
+# /etc/init.d/uanytun start client1 p2p-a
+
+In this case the script will start 2 instances of uanytun using the config files
+$CONFIG_DIR/client1/config and $CONFIG_DIR/p2p-a/config.
+If no instance name is specified the script will use the file $CONFIG_DIR/autostart
+to determine which instances to start or stop. This file must contain a list
+of instance names which should be used when no names are specified at the command
+line. One line for each name. Empty lines and lines starting with # are ignored.