doc/installation.texi

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