]> Cypherpunks.ru repositories - govpn.git/blob - doc/installation.texi
[DOC] Download link for 5.3 release
[govpn.git] / 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, 1.4 is the minimal
22 sufficient): @code{lang/go} port in FreeBSD and @code{golang} package in
23 most GNU/Linux distributions. @emph{Make} (BSD and GNU ones are fine) is
24 recommended for convenient building.
25 @url{https://www.gnu.org/software/texinfo/, Texinfo} is used for
26 building documentation. Possibly you also need to install TUN/TAP
27 interface utilities (depending on your operating system):
28 @code{uml-utilities} package in most GNU/Linux distributions.
29
30 Included required libraries:
31
32 @multitable @columnfractions .40 .20 .40
33 @headitem Library @tab Platform @tab Licence
34 @item @code{github.com/agl/ed25519} @tab All @tab BSD 3-Clause
35 @item @code{github.com/bigeagle/water} @tab GNU/Linux @tab BSD 3-Clause
36 @item @code{github.com/dchest/blake2b} @tab All @tab CC0 1.0
37 @item @code{github.com/go-yaml/yaml} @tab All @tab LGPLv3 and MIT
38 @item @code{github.com/magical/argon2} @tab All @tab BSD 2-Clause
39 @item @code{golang.org/x/crypto} @tab All @tab BSD 3-Clause
40 @end multitable
41
42 Get @ref{Tarballs, the tarball}, check its
43 @ref{Integrity, integrity and authenticity} and run @code{make}.
44 @emph{govpn-client}, @emph{govpn-server}, @emph{govpn-verifier}
45 binaries will be built in the current directory:
46
47 @example
48 % wget http://www.cypherpunks.ru/govpn/download/govpn-2.3.tar.xz
49 % wget http://www.cypherpunks.ru/govpn/download/govpn-2.3.tar.xz.sig
50 % gpg --verify govpn-2.3.tar.xz.sig govpn-2.3.tar.xz
51 % tar xf govpn-2.3.tar.xz
52 % make -C govpn-2.3 all
53 @end example
54
55 There is @code{install} target respecting @code{DESTDIR}. It will
56 install binaries, info-documentation and utilities.
57
58 @menu
59 * Prepared tarballs: Tarballs.
60 * Tarballs integrity check: Integrity.
61 * Development source code: Sources.
62 @end menu
63
64 @include download.texi
65 @include integrity.texi
66 @include sources.texi