From d778d022b3f0ca4369b31b9717239e75219aa540 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Dec 2019 19:26:41 +0100 Subject: pppoe: use documented section style guide --- docs/interfaces/pppoe.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'docs/interfaces/pppoe.rst') diff --git a/docs/interfaces/pppoe.rst b/docs/interfaces/pppoe.rst index ef595b97..f96beb50 100644 --- a/docs/interfaces/pppoe.rst +++ b/docs/interfaces/pppoe.rst @@ -1,7 +1,8 @@ .. _pppoe-interface: +##### PPPoE -===== +##### :abbr:`PPPoE (Point-to-Point Protocol over Ethernet)` is a network protocol for encapsulating PPP frames inside Ethernet frames. It appeared in 1999, @@ -14,14 +15,14 @@ PPP facilities for authenticating the user with a username and password, predominately via the PAP protocol and less often via CHAP. Operating Modes ---------------- +=============== VyOS supports setting up PPPoE in two different ways to a PPPoE internet connection. This is due to most ISPs provide a modem that is also a wireless router. Home Users -********** +---------- In this method, the DSL Modem/Router connects to the ISP for you with your credentials preprogrammed into the device. This gives you an :rfc:`1918` @@ -34,7 +35,7 @@ few extra layers of complexity, particularly if you use some NAT or tunnel features. Business Users -************** +-------------- In order to have full control and make use of multiple static public IP addresses, your VyOS will have to initiate the PPPoE connection and control @@ -51,7 +52,7 @@ configure it to open the PPPoE session for you and your DSL Transceiver vDSL/aDSL understands. Configuration Example -~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^ Requirements: @@ -95,7 +96,7 @@ assigning it to the pppoe0 itself as shown here: set interfaces ethernet eth0 pppoe 0 firewall out name NET-OUT VLAN Example -++++++++++++ +"""""""""""" Some recent ISPs require you to build the PPPoE connection through a VLAN interface. One of those ISPs is e.g. Deutsche Telekom in Germany. VyOS @@ -116,7 +117,7 @@ which is the default VLAN for Deutsche Telekom: set interfaces ethernet eth0 vif 7 pppoe 0 password 'secret' Troubleshooting ---------------- +^^^^^^^^^^^^^^^ .. opcmd:: disconnect interface -- cgit v1.2.3 From 52f5d4f1d9400a28d5ab4f8f2e5e45d84d657357 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Dec 2019 19:29:49 +0100 Subject: pppoe: indent opcmd explanations by 3 --- docs/interfaces/pppoe.rst | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) (limited to 'docs/interfaces/pppoe.rst') diff --git a/docs/interfaces/pppoe.rst b/docs/interfaces/pppoe.rst index f96beb50..9888d682 100644 --- a/docs/interfaces/pppoe.rst +++ b/docs/interfaces/pppoe.rst @@ -51,8 +51,8 @@ configure it to open the PPPoE session for you and your DSL Transceiver (Modem/Router) just acts to translate your messages in a way that vDSL/aDSL understands. -Configuration Example -^^^^^^^^^^^^^^^^^^^^^ +Example +======= Requirements: @@ -96,7 +96,7 @@ assigning it to the pppoe0 itself as shown here: set interfaces ethernet eth0 pppoe 0 firewall out name NET-OUT VLAN Example -"""""""""""" +------------ Some recent ISPs require you to build the PPPoE connection through a VLAN interface. One of those ISPs is e.g. Deutsche Telekom in Germany. VyOS @@ -117,30 +117,31 @@ which is the default VLAN for Deutsche Telekom: set interfaces ethernet eth0 vif 7 pppoe 0 password 'secret' Troubleshooting -^^^^^^^^^^^^^^^ +=============== .. opcmd:: disconnect interface -Test disconnecting given connection-oriented interface. `` can be -``pppoe0`` as example. + Test disconnecting given connection-oriented interface. `` can be + ``pppoe0`` as example. .. opcmd:: connect interface -Test connecting given connection-oriented interface. `` can be -``pppoe0`` as example. + Test connecting given connection-oriented interface. `` can be + ``pppoe0`` as example. .. opcmd:: show interfaces pppoe -Check PPPoE connection logs with the following command which shows the current -statistics, status and some of the settings (i.e. MTU) for the current -connection on (e.g. ``pppoe0``) + Check PPPoE connection logs with the following command which shows the + current statistics, status and some of the settings (i.e. MTU) for the + current connection on (e.g. ``pppoe0``) .. opcmd:: show interfaces pppoe log -Show entire log for the PPPoE connection starting with the oldest data. Scroll -down with the key to reach the end where the current data is. + Show entire log for the PPPoE connection starting with the oldest data. + Scroll down with the key to reach the end where the current data is. .. opcmd:: show interfaces pppoe log tail -Shows the same log as without the 'tail' option but start with the last few -lines and continues to show added lines until you exit with ``Ctrl + x`` + Shows the same log as without the 'tail' option but start with the last few + lines and continues to show added lines until you exit with ``Ctrl + x`` + -- cgit v1.2.3