Ability to use TUN-interfaces under GNU/Linux

[govpn.git] / doc / example.texi

diff --git a/doc/example.texi b/doc/example.texi
index c2936a61414fb66484e3fd461f5d2c107f293355..688898a76bf350e646fac90b3ef7f702a5c40aa1 100644 (file)
--- a/doc/example.texi
+++ b/doc/example.texi
@@ -9,7 +9,7 @@ WiFi-reachable gateway.
 @item You want to create virtual encrypted and authenticated 172.16.0/24
 network and use it as a default transport.
 @item Assume that outgoing GoVPN packets can be fragmented, so we do not
-bother configuring MTU of TAP interfaces. For better performance just
+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
 
@@ -19,89 +19,77 @@ software: download, @ref{Integrity, check the signature}, compile.
 @strong{Prepare the client}. Generate client's verifier for Alice as an
 example:
 
+
 @verbatim
 client% ./utils/newclient.sh Alice
-Enter passphrase:
-Your client verifier is: $argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg
-
-Place the following JSON configuration entry on the server's side:
+Passphrase:
+Your client verifier is: $balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg
 
-    "Alice": {
-        "up": "/path/to/up.sh",
-        "iface": "or TAP interface name",
-        "verifier": "$argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10"
-    }
+Place the following YAML configuration entry on the server's side:
 
-Verifier was generated with:
-
-    ./utils/storekey.sh /tmp/passphrase
-    govpn-verifier -key /tmp/passphrase
+    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 @code{peers.json}
+@strong{Prepare the server}. Add this entry to @file{peers.yaml}
 configuration file:
 
 @verbatim
-{
-    "Alice": {
-        "iface": "tap10",
-        "verifier": "$argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10"
-    }
-}
+Alice:
+    iface: tap10
+    verifier: $balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10
 @end verbatim
 
 @strong{Prepare network on GNU/Linux IPv4 server}:
 
-@example
-server% umask 077
+@verbatim
 server% ip addr add 192.168.0.1/24 dev wlan0
-server% tunctl -t 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
-@end example
+@end verbatim
 
 @strong{Run server daemon itself}:
 
-@example
+@verbatim
 server% govpn-server -bind 192.168.0.1:1194
-@end example
+@end verbatim
 
 @strong{Prepare network on GNU/Linux IPv4 client}:
 
-@example
-client% umask 066
-client% utils/storekey.sh key.txt
+@verbatim
 client% ip addr add 192.168.0.2/24 dev wlan0
-client% tunctl -t 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
-@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}:
-@example
+@verbatim
 client% govpn-client \
-    -key key.txt \
-    -verifier '$argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg' \
+    -verifier '$balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg' \
     -iface tap10 \
     -remote 192.168.0.1:1194
-@end example
+@end verbatim
 
 @strong{FreeBSD IPv6 similar client-server example}:
 
-@example
+@verbatim
 server% ifconfig em0 inet6 fe80::1/64
 server% govpn-server -bind "fe80::1%em0"
-@end example
+@end verbatim
 
-@example
+@verbatim
 client% ifconfig me0 inet6 -ifdisabled auto_linklocal
 client% ifconfig tap10
 client% ifconfig tap10 inet6 fc00::2/96 up
 client% route -6 add default fc00::1
 client% govpn-client \
-    -key key.txt \
-    -verifier '$argon2d$m=4096,t=128,p=1$bwR5VjeCYIQaa8SeaI3rqg' \
+    -verifier '$balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg' \
     -iface tap10 \
     -remote "[fe80::1%me0]":1194
-@end example
+@end verbatim