diff --git a/docs/services/index.rst b/docs/services/index.rst index e0773090..ed00a29b 100644 --- a/docs/services/index.rst +++ b/docs/services/index.rst @@ -17,7 +17,6 @@ This chapter describes the available system/network services provided by VyOS. mdns-repeater ipoe-server pppoe-server - sstp-server udp-broadcast-relay snmp ssh diff --git a/docs/vpn/index.rst b/docs/vpn/index.rst index d0e440b0..42a90a3f 100644 --- a/docs/vpn/index.rst +++ b/docs/vpn/index.rst @@ -7,10 +7,11 @@ VPN .. toctree:: :maxdepth: 2 - openvpn - l2tp - site2site_ipsec - gre-ipsec dmvpn + gre-ipsec + l2tp + openvpn pptp + site2site_ipsec + sstp wireguard diff --git a/docs/services/sstp-server.rst b/docs/vpn/sstp.rst similarity index 59% rename from docs/services/sstp-server.rst rename to docs/vpn/sstp.rst index 6e311e19..c5eb5dbf 100644 --- a/docs/services/sstp-server.rst +++ b/docs/vpn/sstp.rst @@ -62,17 +62,33 @@ commands can be used. Configuration ============= -.. cfgcmd:: set service sstp-server authentication local-users username password +.. cfgcmd:: set vpn sstp authentication local-users username password Create `` for local authentication on this system. The users password will be set to ``. -.. cfgcmd:: set service sstp-server authentication protocols +.. cfgcmd:: set vpn sstp authentication local-users username disable + + Disable `` account. + +.. cfgcmd:: set vpn sstp authentication local-users username static-ip
+ + Assign static IP address to `` account. + +.. cfgcmd:: set vpn sstp authentication local-users username rate-limit download + + Download bandwidth limit in kbit/s for ``. + +.. cfgcmd:: set vpn sstp authentication local-users username rate-limit upload + + Upload bandwidth limit in kbit/s for ``. + +.. cfgcmd:: set vpn sstp authentication protocols Require the peer to authenticate itself using one of the following protocols: pap, chap, mschap, mschap-v2. -.. cfgcmd:: set service sstp-server authentication mode +.. cfgcmd:: set vpn sstp authentication mode Set authentication backend. The configured authentication backend is used for all queries. @@ -82,61 +98,58 @@ Configuration * **local**: All authentication queries are handled locally. -.. cfgcmd:: set service sstp-server network-settings client-ip-settings gateway-address +.. cfgcmd:: set vpn sstp network-settings client-ip-settings gateway-address Specifies single `` IP address to be used as local address of PPP interfaces. -.. cfgcmd:: set service sstp-server network-settings client-ip-settings subnet +.. cfgcmd:: set vpn sstp network-settings client-ip-settings subnet Use `` as the IP pool for all connecting clients. -.. cfgcmd:: set service sstp-server network-settings dns-server primary-dns
+.. cfgcmd:: set vpn sstp network-settings name-server
- Connected client should use `
` as their primary DNS server. + Connected client should use `
` as their DNS server. Up to two IPv4 + nameservers can be configured. -.. cfgcmd:: set service sstp-server network-settings dns-server secondary-dns
- - Connected client should use `
` as their secondary DNS server. - SSL Certificates ---------------- -.. cfgcmd:: set service sstp-server sstp-settings ssl-certs ca +.. cfgcmd:: set vpn sstp ssl ca-cert-file Path to `` pointing to the certificate authority certificate. -.. cfgcmd:: set service sstp-server sstp-settings ssl-certs server-cert +.. cfgcmd:: set vpn sstp ssl cert-file Path to `` pointing to the servers certificate (public portion). -.. cfgcmd:: set service sstp-server sstp-settings ssl-certs server-key +.. cfgcmd:: set vpn sstp ssl key-file Path to `` pointing to the servers certificate (private portion). PPP Settings ------------ -.. cfgcmd:: set service sstp-server ppp-settings lcp-echo-failure +.. cfgcmd:: set vpn sstp ppp-settings lcp-echo-failure Defines the maximum `` of unanswered echo requests. Upon reaching the value ``, the session will be reset. -.. cfgcmd:: set service sstp-server ppp-settings lcp-echo-interval +.. cfgcmd:: set vpn sstp ppp-settings lcp-echo-interval If this option is specified and is greater than 0, then the PPP module will send LCP pings of the echo request every `` seconds. -.. cfgcmd:: set service sstp-server ppp-settings lcp-echo-timeout +.. cfgcmd:: set vpn sstp ppp-settings lcp-echo-timeout Specifies timeout in seconds to wait for any peer activity. If this option specified it turns on adaptive lcp echo functionality and "lcp-echo-failure" is not used. -.. cfgcmd:: set service sstp-server ppp-settings mppe +.. cfgcmd:: set vpn sstp ppp-settings mppe Specifies :abbr:`MPPE (Microsoft Point-to-Point Encryption)` negotioation preference. @@ -156,107 +169,98 @@ RADIUS Server ^^^^^^ -.. cfgcmd:: set service sstp-server authentication radius-server secret +.. cfgcmd:: set vpn sstp authentication radius server port + + Configure RADIUS `` and its required port for authentication requests. + +.. cfgcmd:: set vpn sstp authentication radius server key Configure RADIUS `` and its required shared `` for communicating with the RADIUS server. -.. cfgcmd:: set service sstp-server authentication radius-server secret - - Configure RADIUS `` and its required shared `` for - communicating with the RADIUS server. - -.. cfgcmd:: set service sstp-server authentication radius-server fail-time