doc/user.texi

   1 @node User
   2 @unnumbered User manual
   3
   4 Announcements about updates and new releases can be found in @ref{Contacts}.
   5
   6 GoVPN is split into two pieces: @ref{Client} and @ref{Server}. Each of
   7 them work on top of @ref{Network, UDP/TCP} and TAP virtual network
   8 interfaces. GoVPN is just a tunnelling of Ethernet frames, nothing less,
   9 nothing more. All you IP-related network management is not touched by
  10 VPN at all. You can automate it using up and down shell scripts.
  11
  12 What network performance can user expect? For example single
  13 @emph{Intel i5-2450M 2.5 GHz} core on @emph{FreeBSD 10.2 amd64}
  14 with @emph{Go 1.5.1} gives 786 Mbps (UDP transport) throughput.
  15
  16 @menu
  17 * EGD:: Entropy gathering daemon
  18 * Identity::
  19 * PAKE:: Password Authenticated Key Agreement
  20 * Timeout::
  21 * Network transport: Network.
  22 * Proxy::
  23 * MTU:: Maximum Transmission Unit
  24 * Stats::
  25 * Noise::
  26 * CPR:: Constant Packet Rate
  27 * Verifier::
  28 * Client part: Client.
  29 * Server part: Server.
  30 * Example usage: Example.
  31 @end menu
  32
  33 @include egd.texi
  34 @include identity.texi
  35 @include pake.texi
  36 @include timeout.texi
  37 @include netproto.texi
  38 @include proxy.texi
  39 @include mtu.texi
  40 @include stats.texi
  41 @include noise.texi
  42 @include cpr.texi
  43 @include verifier.texi
  44 @include client.texi
  45 @include server.texi
  46 @include example.texi