README

   1 Dependencies
   2 ============
   3
   4 uAnytun can be built by using either libgcrypt or the openssl-crypto library.
   5 The latter is more performant in most cases but there are some license
   6 issues when using this library. It also needs more space when installed.
   7
   8
   9 Linux
  10 -----
  11 (this includes Debian with FreeBSD Kernel)
  12
  13 using libgcrypt:
  14
  15  build-essential
  16  libgcrypt11-dev
  17
  18 using ssl crypto library:
  19
  20  build-essential
  21  libssl-dev
  22
  23 if you want to rebuild the manpage:
  24
  25  asciidoc
  26
  27
  28 OpenBSD/FreeBSD
  29 ---------------
  30
  31 using libgcrypt:
  32
  33  devel/gmake
  34  security/libgcrypt
  35
  36 using ssl crypto library:
  37
  38  devel/gmake
  39
  40 if you want to rebuild the manpage:
  41
  42  textproc/asciidoc
  43  textproc/libxslt
  44  textproc/docbook-xsl
  45  sysutils/readlink
  46  misc/getopt
  47
  48
  49
  50 Installation
  51 ============
  52
  53 Getting the source via subversion:
  54 ----------------------------------
  55
  56 svn co https://svn.anytun.org/uanytun/trunk uanytun
  57 cd uanytun
  58
  59
  60 Building from source
  61 --------------------
  62
  63 using libgcrypt:
  64
  65 # cd src
  66 # ./configure
  67 # make
  68
  69 using ssl crypto library:
  70
  71 # cd src
  72 # ./configure --use-ssl-crypto
  73 # make
  74
  75 Notes:
  76   - try './configure --help' for further information
  77   - if using openssl pre 0.9.8 you have to disable passphrase
  78     because openssl had no SHA256 implementation prior to this
  79     version
  80   - on OpenBSD/FreeBSD you have to use gmake instead of make
  81
  82
  83 Installing
  84 ----------
  85
  86 # sudo make install
  87
  88 This will install anytun under the --prefix defined with configure.
  89
  90
  91 Uninstalling
  92 ------------
  93
  94 # sudo make remove
  95
  96 This removes everytthing except for the config files
  97
  98 # sudo make purge
  99
 100 This also removes the config files
 101
 102
 103
 104 Usage:
 105 ======
 106
 107 init.d script
 108 -------------
 109
 110 The init.d script can be used to start uanytun at boot time. It searches for
 111 configuration files which reside at $CONFIG_DIR. For each instance of uanytun
 112 which should be started there must be a directory containing at least a file
 113 named config. This file must contain all command line parameter which should
 114 be used when starting the daemon. One line for each parameter. Empty lines and
 115 lines starting with # are ignored. Besides the config file there may be a script
 116 named post-up.sh which will be called when the tun/tap device comes up.
 117 This is an example of how the init.d script can be used to start uanytun:
 118
 119 # /etc/init.d/uanytun start client1 p2p-a
 120
 121 In this case the script will start 2 instances of uanytun using the config files
 122 $CONFIG_DIR/client1/config and $CONFIG_DIR/p2p-a/config.
 123 If no instance name is specified the script will use the file $CONFIG_DIR/autostart
 124 to determine which instances to start or stop. This file must contain a list
 125 of instance names which should be used when no names are specified at the command
 126 line. One line for each name. Empty lines and lines starting with # are ignored.