X-Git-Url: https://git.syn-net.org/?p=debian%2Fuanytun.git;a=blobdiff_plain;f=README;h=2cc3ad83a7f342b7dfab3228fbe6fed985dec20b;hp=a5bc7ee829ec507e0c472afd784ba5c838ac7626;hb=cdb24b629ee2962b8d02cd7d0cf5d11a9b9bd59f;hpb=b81b2c1954fe3e3317e6fa260c5ffdc9eeee966c diff --git a/README b/README index a5bc7ee..2cc3ad8 100644 --- a/README +++ b/README @@ -1,15 +1,17 @@ Dependencies ============ -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 +uAnytun can be built by using either libgcrypt, libnettle 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 ----- +(this includes Debian with FreeBSD Kernel) using libgcrypt: - + build-essential libgcrypt11-dev @@ -18,27 +20,50 @@ using ssl crypto library: build-essential libssl-dev +using nettle crypto library: + + build-essential + nettle-dev + +if you want clang as compiler + + clang + +if you want to rebuild the manpage: + + asciidoc + OpenBSD/FreeBSD --------------- using libgcrypt: - gmake - libgcrypt - libgpg-error + devel/gmake + security/libgcrypt using ssl crypto library: - gmake + devel/gmake + +if you want to rebuild the manpage: + + textproc/asciidoc + textproc/libxslt + textproc/docbook-xsl + sysutils/readlink + misc/getopt + Installation ============ -Getting the source via subversion: ----------------------------------- -svn co https://svn.chaos-at-home.org/uanytun/trunk uanytun +Getting the source via GIT: +--------------------------- + +git clone https://git.spreadspace.org/anytun/uanytun.git +cd uanytun Building from source -------------------- @@ -56,7 +81,7 @@ using ssl crypto library: # make -Notes: +Notes: - try './configure --help' for further information - if using openssl pre 0.9.8 you have to disable passphrase because openssl had no SHA256 implementation prior to this @@ -70,17 +95,41 @@ Installing # sudo make install This will install anytun under the --prefix defined with configure. -It also creates a user with name --username with home --userhome -which can be changed by configure as well. + Uninstalling ------------ # sudo make remove -This removes everytthing except for the config files +This removes everything except for the config files # sudo make purge -This also removes the config files and deletes the user and it's -home directory. +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.