[pptp] T1284: accel-ppp: pptp implementation documention

1 files changed, 49 insertions, 0 deletions

diff --git a/docs/vpn.rst b/docs/vpn.rst
index ddf967b6..13eae32c 100644
--- a/docs/vpn.rst
+++ b/docs/vpn.rst
@@ -866,6 +866,54 @@ SPOKE2 Example Configuration
   set protocols static route 192.168.1.0/24 next-hop 10.0.0.1
   set protocols static route 192.168.2.0/24 next-hop 10.0.0.2
 
+
+PPTP-Server
+-----------
+
+The Point-to-Point Tunneling Protocol (PPTP_) has been implemented in VyOS only for backwards compatibility. 
+PPTP has many well known secrurity issues and you should use one of the many other new VPN implementations.
+
+As per default and if not otherwise defined, mschap-v2 is being used for authentication and mppe 128-bit (stateless) for encryption.
+If no gateway-address is set within the configuration, the lowest IP out of the /24 client-ip-pool is being used. For instance, in the example below it would be 192.168.0.1.
+
+server example
+^^^^^^^^^^^^^^
+
+.. code-block:: sh
+
+  set vpn pptp remote-access authentication local-users username test password 'test'
+  set vpn pptp remote-access authentication mode 'local'
+  set vpn pptp remote-access client-ip-pool start '192.168.0.10'
+  set vpn pptp remote-access client-ip-pool stop '192.168.0.15'
+  set vpn pptp remote-access gateway-address '10.100.100.1'
+  set vpn pptp remote-access outside-address '10.1.1.120'
+
+
+client example (debian 9)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Install the client software via apt and execute pptpsetup to generate the configuration.
+
+
+.. code-block:: sh
+
+  apt-get install pptp-linux
+  pptpsetup --create TESTTUNNEL --server 10.1.1.120 --username test --password test --encrypt
+  pon TESTTUNNEL
+
+The command pon TESTUNNEL establishes the PPTP tunnel to the remote system.
+  
+
+All tunnel sessions can be checked via:
+
+.. code-block:: sh
+
+  run sh pptp-server sessions 
+   ifname | username | calling-sid |      ip      | type | comp | state  |  uptime  
+  --------+----------+-------------+--------------+------+------+--------+----------
+   ppp0   | test     | 10.1.1.99   | 192.168.0.10 | pptp | mppe | active | 00:00:58
+  
+
 .. _`Google Public DNS`: https://developers.google.com/speed/public-dns
 .. _Quad9: https://quad9.net
 .. _CloudFlare: https://blog.cloudflare.com/announcing-1111
@@ -875,6 +923,7 @@ SPOKE2 Example Configuration
 .. _RFC2332: https://tools.ietf.org/html/rfc2332
 .. _RFC1702: https://tools.ietf.org/html/rfc1702
 .. _RFC4301: https://tools.ietf.org/html/rfc4301
+.. _PPTP: https://en.wikipedia.org/wiki/Point-to-Point_Tunneling_Protocol
 
 
 .. include:: interfaces/wireguard.rst