-@node Example usage
+@node Example
@section Example usage
Let's assume that there is some insecure link between your computer and
WiFi-reachable gateway.
-@itemize @bullet
+@itemize
@item You have got @code{wlan0} NIC with 192.168.0/24 network on it.
@item You want to create virtual encrypted and authenticated 172.16.0/24
network and use it as a default transport.
-@item @code{wlan0} MTU is 1500, 20 bytes overhead per IPv4. So MTU for
-GoVPN is 1500 - 20 - 8 = 1472.
-@item During startup client and server will say that TAP interface MTU
-is 1432.
+@item Assume that outgoing GoVPN packets can be fragmented, so we do not
+bother configuring MTU of TUN/TAP interfaces. For better performance just
+lower it and check that no fragmentation of outgoing UDP packets occurs.
@end itemize
-Do not forget about setting @code{GOMAXPROC} environment variable for
-using more than one CPU.
+@strong{Install}. At first you must @ref{Installation, install} this
+software: download, @ref{Integrity, check the signature}, compile.
-GNU/Linux IPv4 client-server example:
+@strong{Prepare the client}. Generate client's verifier for Alice as an
+example:
-@example
-server% echo "echo tap10" >> peers/CLIENTID/up.sh
+
+@verbatim
+client% ./utils/newclient.sh Alice
+Passphrase:
+Your client verifier is: $balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg
+
+Place the following YAML configuration entry on the server's side:
+
+ Alice:
+ up: /path/to/up.sh
+ iface: or TUN/TAP interface name
+ verifier: $balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10
+@end verbatim
+
+@strong{Prepare the server}. Add this entry to @file{peers.yaml}
+configuration file:
+
+@verbatim
+Alice:
+ iface: tap10
+ verifier: $balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10
+@end verbatim
+
+@strong{Prepare network on GNU/Linux IPv4 server}:
+
+@verbatim
server% ip addr add 192.168.0.1/24 dev wlan0
-server% tunctl -t tap10
-server% ip link set mtu 1432 dev tap10
+server% ip tuntap add dev tap10 mode tap
server% ip addr add 172.16.0.1/24 dev tap10
server% ip link set up dev tap10
-server% GOMAXPROC=4 govpn-server -bind 192.168.0.1:1194 -mtu 1472
-@end example
+@end verbatim
+
+@strong{Run server daemon itself}:
+
+@verbatim
+server% govpn-server -bind 192.168.0.1:1194
+@end verbatim
-@example
-client% umask 066
-client% echo MYLONG64HEXKEY > key.txt
+@strong{Prepare network on GNU/Linux IPv4 client}:
+
+@verbatim
client% ip addr add 192.168.0.2/24 dev wlan0
-client% tunctl -t tap10
-client% ip link set mtu 1432 dev tap10
+client% ip tuntap add dev tap10 mode tap
client% ip addr add 172.16.0.2/24 dev tap10
client% ip link set up dev tap10
-client% ip route add default via 172.16.0.1
-client% export GOMAXPROC=4
-client% while :; do
- govpn-client -key key.txt -id CLIENTID -iface tap10 \
- -remote 192.168.0.1:1194 -mtu 1472
-done
-@end example
+client% ip route add 0/1 via 172.16.0.1
+client% ip route add 128/1 via 172.16.0.1
+@end verbatim
+
+@strong{Run client daemon itself}:
+@verbatim
+client% govpn-client \
+ -verifier '$balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg' \
+ -iface tap10 \
+ -remote 192.168.0.1:1194
+@end verbatim
-FreeBSD IPv6 client-server example:
+@strong{FreeBSD IPv6 similar client-server example}:
-@example
+@verbatim
server% ifconfig em0 inet6 fe80::1/64
-server% GOMAXPROC=4 govpn-server -bind "fe80::1%em0"
-@end example
+server% govpn-server -bind "fe80::1%em0"
+@end verbatim
-@example
+@verbatim
client% ifconfig me0 inet6 -ifdisabled auto_linklocal
client% ifconfig tap10
-client% ifconfig tap10 inet6 fc00::2/96 mtu 1412 up
+client% ifconfig tap10 inet6 fc00::2/96 up
client% route -6 add default fc00::1
-client% export GOMAXPROC=4
-client% while :; do
- govpn-client -key key.txt -id CLIENTID -iface tap10 \
- -remote [fe80::1%me0]:1194
-done
-@end example
+client% govpn-client \
+ -verifier '$balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg' \
+ -iface tap10 \
+ -remote "[fe80::1%me0]":1194
+@end verbatim