doc/example.texi

   1 @node Example usage
   2 @section Example usage
   3
   4 Let's assume that there is some insecure link between your computer and
   5 WiFi-reachable gateway.
   6
   7 @itemize @bullet
   8 @item You have got @code{wlan0} NIC with 192.168.0/24 network on it.
   9 @item You want to create virtual encrypted and authenticated 172.16.0/24
  10 network and use it as a default transport.
  11 @item @code{wlan0} MTU is 1500, 20 bytes overhead per IPv4. So MTU for
  12 GoVPN is 1500 - 20 - 8 = 1472.
  13 @item During startup client and server will say that TAP interface MTU
  14 is 1432.
  15 @end itemize
  16
  17 Do not forget about setting @code{GOMAXPROC} environment variable for
  18 using more than one CPU.
  19
  20 As a preparation you have to generate peer directory (register new
  21 client) on the server side using @code{utils/newsclient.sh}, generate
  22 @ref{Verifier} on client side and place it on the server. Assume that
  23 you made those steps.
  24
  25 GNU/Linux IPv4 client-server example:
  26
  27 @example
  28 server% echo "echo tap10" >> peers/CLIENTID/up.sh
  29 server% ip addr add 192.168.0.1/24 dev wlan0
  30 server% tunctl -t tap10
  31 server% ip link set mtu 1432 dev tap10
  32 server% ip addr add 172.16.0.1/24 dev tap10
  33 server% ip link set up dev tap10
  34 server% GOMAXPROC=4 govpn-server -bind 192.168.0.1:1194 -mtu 1472
  35 @end example
  36
  37 @example
  38 client% umask 066
  39 client% utils/storekey.sh key.txt
  40 client% ip addr add 192.168.0.2/24 dev wlan0
  41 client% tunctl -t tap10
  42 client% ip link set mtu 1432 dev tap10
  43 client% ip addr add 172.16.0.2/24 dev tap10
  44 client% ip link set up dev tap10
  45 client% ip route add default via 172.16.0.1
  46 client% export GOMAXPROC=4
  47 client% while :; do
  48     govpn-client -key key.txt -id CLIENTID -iface tap10 \
  49         -remote 192.168.0.1:1194 -mtu 1472
  50 done
  51 @end example
  52
  53 FreeBSD IPv6 client-server example:
  54
  55 @example
  56 server% ifconfig em0 inet6 fe80::1/64
  57 server% GOMAXPROC=4 govpn-server -bind "fe80::1%em0"
  58 @end example
  59
  60 @example
  61 client% ifconfig me0 inet6 -ifdisabled auto_linklocal
  62 client% ifconfig tap10
  63 client% ifconfig tap10 inet6 fc00::2/96 mtu 1412 up
  64 client% route -6 add default fc00::1
  65 client% export GOMAXPROC=4
  66 client% while :; do
  67     govpn-client -key key.txt -id CLIENTID -iface tap10 \
  68         -remote [fe80::1%me0]:1194
  69 done
  70 @end example