Liu Song’s Projects


~/Projects/dsvpn

git clone https://code.lsong.org/dsvpn

Commit

Commit
181c926a9a7f98429b1397e18aa6ce049e3228c1
Author
Frank Denis <[email protected]>
Date
2019-07-19 17:31:42 +0200 +0200
Diffstat
 README.md | 40 ++++++++++++++++++++--------------------

Put examples first


diff --git a/README.md b/README.md
index 9bb9644343a827ccbb8afe906d2010a24c679e31..568cca6e47bad5583bfb414fef1b8849223cfa25 100644
--- a/README.md
+++ b/README.md
@@ -45,8 +45,26 @@ ```
 
 And copy it on the server and the client.
 
+[client device] ---- (untrusted/restricted network) ---- [vpn server] ---- [the Internet]
 
-* Secure. Doesn't perform any heap memory allocations. Uses modern cryptography.
+
+```sh
+sudo ./dsvpn server vpn.key auto 1959
+```
+
+Here, I use port `1959`. Everything else is set to the default values. If you want to use the default port (`443`), it doesn't even have to be specified.
+
+## Example usage on the client
+
+```sh
+sudo ./dsvpn client vpn.key 34.216.127.34 1959
+```
+
+This is a MacOS client, connecting to the VPN server `34.216.127.34` on port `1959`.
+
+On MacOS, the VPN server can be specified as a host name. Linux currently requires an IP address.
+
+## Advanced configuration
 
 ```text
 dsvpn   "server"
@@ -65,7 +83,7 @@         |"auto"
         <tun interface>|"auto"
         <local tun ip>|"auto"
         <remote tun ip>|"auto"
-        <gateway ip>"auto"
+        <gateway ip>|"auto"
 ```
 
 * `server`|`client`: use `server` on the server, and `client` on clients.
@@ -79,24 +97,6 @@ * `` (server only): the external IP address of the server. Can be left to `"auto"`.
 * `<gateway ip>` (client only): the internal router IP address. Once again, the first line printed by `netstat -rn` will tell you (`gateway`).
 
 If all the remaining parameters of a command would be `auto`, they don't have to be specified.
-
-## Example usage on the server
-
-```sh
-sudo ./dsvpn server vpn.key auto 1959
-```
-
-Here, I use port `1959`. Everything else is set to the default values. If you want to use the default port (`443`), it doesn't even have to be specified.
-
-## Example usage on the client
-
-```sh
-sudo ./dsvpn client vpn.key 34.216.127.34 1959
-```
-
-This is a MacOS client, connecting to the VPN server `34.216.127.34` on port `1959`.
-
-On MacOS, the VPN server can be specified as a host name. Linux currently requires an IP address.
 
 ## That's it