www/building.xml

   1 <PAGE>
   2         <VAR match="VAR_ORIGIN" replace="" />
   3         <VAR match="VAR_CVSID" replace=""/>
   4         <INCLUDE file="inc/header.tmpl" />
   5
   6         <VAR match="VAR_SEL_STARTED" replace="selected" />
   7         <VAR match="VAR_SEL_BUILDING" replace="selected" />
   8         <PARSE file="menu1.xml" />
   9         <PARSE file="menu2-started.xml" />
  10
  11         <INCLUDE file="inc/content.tmpl" />
  12
  13         <h1>Building OpenConnect</h1>
  14
  15 <p>Unless you need to test the very latest version, you should not
  16 need to build OpenConnect for yourself. Your operating system should
  17 have a <a href="packages.html">prepackaged</a> version which you can
  18 install; if it does not then file a bug or enhancement request asking for
  19 one.</p>
  20
  21 <h2>Requirements</h2>
  22 <p>To build OpenConnect from its source code, you will need the following
  23 libraries and tools installed:</p>
  24
  25 <ul>
  26   <li><b><tt>libxml2</tt></b></li>
  27   <li><b><tt>zlib</tt></b></li>
  28   <li>Either <b><tt>OpenSSL</tt></b> or <b><tt>GnuTLS</tt></b></li>
  29   <li><b><tt>pkg-config</tt></b></li>
  30 </ul>
  31 And <em>optionally</em> also:
  32 <ul>
  33   <li><b><tt><a href="http://code.google.com/p/libproxy/">libproxy</a></tt></b></li>
  34   <li><b><tt><a href="http://trousers.sourceforge.net/">trousers</a></tt></b> <i>(for TPM support if using GnuTLS)</i></li>
  35   <li><b><tt><a href="http://stoken.sourceforge.net/">libstoken</a></tt></b> <i>(for SecurID software token support)</i></li>
  36 </ul>
  37 <p>OpenConnect supports the use of HTTP and SOCKS proxies to connect to the
  38 AnyConnect service, even without using libproxy. You may wish to use libproxy
  39 if you want OpenConnect to automatically use the appropriate proxies for your
  40 environment, without having to manually give it the <tt>--proxy</tt> argument
  41 on the command line.</p>
  42
  43 <h2>Install vpnc-script</h2>
  44  <p>Since version 3.17, The <a href="vpnc-script.html">vpnc-script</a> that OpenConnect
  45  uses to configure the network is no longer optional, so it needs to be told at compile
  46  time where to find that script.</p>
  47  <p>The <tt>configure</tt> script will check whether <tt>/etc/vpnc/vpnc-script</tt>
  48  exists and can be executed, and will fail if not. If you don't already have
  49  a copy then you should install one. It might be in a separate <tt>vpnc-script</tt>
  50  package for your operating system, it might be part of their <tt>vpnc</tt> package,
  51  and there's one linked from from the <a href="vpnc-script.html">vpnc-script page</a>,
  52  if you need to download it manually. Install it as <tt>/etc/vpnc/vpnc-script</tt>.</p>
  53
  54 <p>If you do not want to use the standard location, you can configure OpenConnect to
  55  use a different location by default. When running the <tt>./configure</tt> script
  56  in the instructions below, you can append an argument such as <tt>--with-vpnc-script=<i>/where/I/put/vpnc-script</i></tt> to its command line. Note that the path you give will not be checked; the script doesn't have to be present when you <b>build</b> OpenConnect. But of course OpenConnect won't work very
  57 well without it, so you'll still have to install it later.</p>
  58
  59
  60 <h2>Building OpenConnect</h2>
  61
  62 <p>If you checked the source code out from git rather from a release tarball
  63   then run this command first to prepare the build system:</p>
  64   <ul>
  65     <li><tt>./autogen.sh</tt></li>
  66   </ul>
  67   <p>Then to build it, run the following commands:</p>
  68   <ul>
  69     <li><tt>./configure</tt></li>
  70     <li><tt>make</tt></li>
  71     <li><tt>make install</tt> <i>(If you want to install it)</i></li>
  72   </ul>
  73
  74 <p>Note that OpenConnect will attempt to use the OpenSSL library by default.
  75 If you want it to use GnuTLS instead, then add <tt>--with-gnutls</tt> to the
  76 <tt>./configure</tt> command above.</p>
  77
  78 <p>If compilation fails, please make sure you have a working compiler and the
  79 <b>development</b> packages for all the required libraries mentioned above. If
  80 it still doesn't build, please send the full output in a plain-text mail to the
  81 <a href="mail.html">mailing list</a>.</p>
  82
  83 <h2>TUN/TAP driver</h2>
  84
  85 <p>Mac OS X users will also need to install the
  86 <a href="http://tuntaposx.sourceforge.net/">Mac OS X tun/tap driver</a>, and Solaris/OpenIndiana users will need the <a href="http://www.whiteboard.ne.jp/~admin2/tuntap/">Solaris one</a>. Note that for IPv6 support, the Solaris tun/tap driver from 16th Nov 2009 or newer is required.</p>
  87
  88         <INCLUDE file="inc/footer.tmpl" />
  89 </PAGE>
  90