doc/installation.texi

   1 @node Installation
   2 @unnumbered Installation
   3
   4 Possibly GoVPN already exists in your distribution:
   5
   6 @itemize
   7 @item @url{https://aur.archlinux.org/packages/govpn/, AUR}
   8 @item @url{http://www.freshports.org/security/govpn/, FreeBSD ports}
   9 @end itemize
  10
  11 GoVPN is written on Go programming language and you have to install Go
  12 compiler (1.5+ version is highly recommended): @code{lang/go} port in
  13 FreeBSD and @code{golang} package in most GNU/Linux distributions.
  14 @emph{Make} is recommended for convenient building.
  15 @url{https://www.gnu.org/software/texinfo/, Texinfo} is used for
  16 building documentation.
  17 Possibly you also need to install TUN/TAP interface utilities (depending
  18 on your operating system): @code{uml-utilities} package in most
  19 GNU/Linux distributions.
  20
  21 Included required libraries:
  22
  23 @multitable @columnfractions .40 .20 .40
  24 @headitem Library @tab Platform @tab Licence
  25 @item @code{golang.org/x/crypto} @tab All @tab BSD 3-Clause
  26 @item @code{github.com/agl/ed25519} @tab All @tab BSD 3-Clause
  27 @item @code{github.com/bigeagle/water} @tab GNU/Linux @tab BSD 3-Clause
  28 @end multitable
  29
  30 Get @ref{Tarballs, the tarball}, check its
  31 @ref{Integrity, integrity and authenticity} and run @code{make}.
  32 @emph{govpn-client}, @emph{govpn-server}, @emph{govpn-verifier}
  33 binaries will be built in the current directory:
  34
  35 @example
  36 % wget http://www.cypherpunks.ru/govpn/download/govpn-2.3.tar.xz
  37 % wget http://www.cypherpunks.ru/govpn/download/govpn-2.3.tar.xz.sig
  38 % gpg --verify govpn-2.3.tar.xz.sig govpn-2.3.tar.xz
  39 % tar xf govpn-2.3.tar.xz
  40 % make -C govpn-2.3 all
  41 @end example
  42
  43 There is @code{install} target respecting @code{DESTDIR}. It will
  44 install binaries, info-documentation and utilities.
  45
  46 @menu
  47 * Prepared tarballs: Tarballs.
  48 * Tarballs integrity check: Integrity.
  49 * Development source code: Sources.
  50 @end menu
  51
  52 @include download.texi
  53 @include integrity.texi
  54 @include sources.texi