From: Sergey Matveev <stargrave@stargrave.org>
Date: Thu, 14 May 2015 13:22:53 +0000 (+0300)
Subject: [DOC] Update user examples, making it more understandable
X-Git-Tag: 3.3^2~3
X-Git-Url: http://www.git.cypherpunks.ru/?p=govpn.git;a=commitdiff_plain;h=530cdffccf0c60a0daa8cc7e0be49aae4c44701b

[DOC] Update user examples, making it more understandable

Signed-off-by: Sergey Matveev <stargrave@stargrave.org>
---

diff --git a/doc/example.texi b/doc/example.texi
index 217513e..129b10f 100644
--- a/doc/example.texi
+++ b/doc/example.texi
@@ -14,6 +14,9 @@ GoVPN is 1500 - 20 - 8 = 1472.
 is 1432.
 @end itemize
 
+@strong{Install}. At first you must @ref{Installation, install} this
+software: download, check the signature, compile.
+
 Do not forget about setting @code{GOMAXPROC} environment variable for
 using more than one CPU on both sides:
 
@@ -21,28 +24,39 @@ using more than one CPU on both sides:
 % export GOMAXPROC=4
 @end example
 
-As a preparation you have to generate peer directory (register new
-client) on the server side using @code{utils/newsclient.sh}, generate
-@ref{Verifier} on client side and place it on the server:
+@strong{Prepare the server}. Create the new client, named (for example)
+"Alice":
 
 @example
-server% ./utils/newclient.sh Alice
+% ./utils/newclient.sh Alice
 Place verifier to peers/6d4ac605ce8dc37c2f0bf21cb542a713/verifier
+@end example
+
+"6d4ac605ce8dc37c2f0bf21cb542a713" -- is the new client's identity.
 
-client% ./utils/storekey.sh /tmp/passphrase
+@strong{Prepare the client}. Generate @ref{Verifier} for known client
+identity:
+
+@example
+% ./utils/storekey.sh /tmp/passphrase
 Enter passphrase:[my secure passphrase is here]
-client% govpn-verifier -id 6d4ac605ce8dc37c2f0bf21cb542a713 -key /tmp/passphrase
+% govpn-verifier -id 6d4ac605ce8dc37c2f0bf21cb542a713 -key /tmp/passphrase
 562556cc9ecf0019b4cf45bcdf42706944ae9b3ac7c73ad299d83f2d5a169c55
-client% rm /tmp/passphrase
+% rm /tmp/passphrase
+@end example
+
+"562556cc9ecf0019b4cf45bcdf42706944ae9b3ac7c73ad299d83f2d5a169c55" --
+this is verifier itself.
 
-server% cat > peers/6d4ac605ce8dc37c2f0bf21cb542a713/verifier <<EOF
+@strong{Save verifier on server}.
+
+@example
+% cat > peers/6d4ac605ce8dc37c2f0bf21cb542a713/verifier <<EOF
 562556cc9ecf0019b4cf45bcdf42706944ae9b3ac7c73ad299d83f2d5a169c55
 EOF
 @end example
 
-@code{6d4ac605ce8dc37c2f0bf21cb542a713} is your CLIENTID.
-
-GNU/Linux IPv4 client-server example:
+@strong{Prepare network on GNU/Linux IPv4 server}:
 
 @example
 server% echo "echo tap10" >> peers/6d4ac605ce8dc37c2f0bf21cb542a713/up.sh
@@ -51,9 +65,16 @@ server% tunctl -t tap10
 server% ip link set mtu 1432 dev tap10
 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
 
+@strong{Run server daemon itself}:
+
+@example
+server% govpn-server -bind 192.168.0.1:1194 -mtu 1472
+@end example
+
+@strong{Prepare network on GNU/Linux IPv4 client}:
+
 @example
 client% umask 066
 client% utils/storekey.sh key.txt
@@ -63,18 +84,23 @@ client% ip link set mtu 1432 dev tap10
 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 6d4ac605ce8dc37c2f0bf21cb542a713 -iface tap10 \
-        -remote 192.168.0.1:1194 -mtu 1472
-done
 @end example
 
-FreeBSD IPv6 client-server example:
+@strong{Run client daemon itself}:
+@example
+client% govpn-client \
+    -key key.txt \
+    -id 6d4ac605ce8dc37c2f0bf21cb542a713 \
+    -iface tap10 \
+    -remote 192.168.0.1:1194 \
+    -mtu 1472
+@end example
+
+@strong{FreeBSD IPv6 similar client-server example}:
 
 @example
 server% ifconfig em0 inet6 fe80::1/64
-server% GOMAXPROC=4 govpn-server -bind "fe80::1%em0"
+server% govpn-server -bind "fe80::1%em0"
 @end example
 
 @example
@@ -82,9 +108,9 @@ client% ifconfig me0 inet6 -ifdisabled auto_linklocal
 client% ifconfig tap10
 client% ifconfig tap10 inet6 fc00::2/96 mtu 1412 up
 client% route -6 add default fc00::1
-client% export GOMAXPROC=4
-client% while :; do
-    govpn-client -key key.txt -id 6d4ac605ce8dc37c2f0bf21cb542a713 -iface tap10 \
-        -remote [fe80::1%me0]:1194
-done
+client% govpn-client \
+    -key key.txt \
+    -id 6d4ac605ce8dc37c2f0bf21cb542a713 \
+    -iface tap10 \
+    -remote "[fe80::1%me0]":1194
 @end example
diff --git a/doc/installation.texi b/doc/installation.texi
index 6d3cf7d..3f5bde6 100644
--- a/doc/installation.texi
+++ b/doc/installation.texi
@@ -19,6 +19,15 @@ Get the tarball and run @code{make}.
 @emph{govpn-client}, @emph{govpn-server}, @emph{govpn-verifier}
 binaries will be build in the current directory.
 
+As a prerequisite you must install Go compiler and possibly TUN/TAP
+interfaces utilities:
+
+@itemize @bullet
+@item @code{lang/go} port in FreeBSD.
+@item @code{golang} and @code{uml-utilities} packages in GNU/Linux
+distributions.
+@end itemize
+
 @example
 % wget http://www.cypherpunks.ru/govpn/download/govpn-2.3.tar.xz
 % wget http://www.cypherpunks.ru/govpn/download/govpn-2.3.tar.xz.sig