summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-12-21 19:26:41 +0100
committerChristian Poessinger <christian@poessinger.com>2019-12-21 19:26:41 +0100
commitd778d022b3f0ca4369b31b9717239e75219aa540 (patch)
treecc37fb895c170d2ea1c2f0f00abf2e6db202f8a3
parent554e5357b73dc5bae22aa6dc058587e2a1265236 (diff)
downloadvyos-documentation-d778d022b3f0ca4369b31b9717239e75219aa540.tar.gz
vyos-documentation-d778d022b3f0ca4369b31b9717239e75219aa540.zip
pppoe: use documented section style guide
-rw-r--r--docs/interfaces/pppoe.rst15
1 files changed, 8 insertions, 7 deletions
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 <interface>