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