summaryrefslogtreecommitdiff
path: root/docs/services
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-01-23 07:01:34 +0100
committerChristian Poessinger <christian@poessinger.com>2020-01-23 07:02:14 +0100
commitc00dae8d72f575f83aa7076fe53d02520238ab43 (patch)
treec81215889a8973a9d3e0a8ae39a3c4a2ce3dbd85 /docs/services
parentaf806a910f1477a91a283491085dbee5ef6afbbf (diff)
downloadvyos-documentation-c00dae8d72f575f83aa7076fe53d02520238ab43.tar.gz
vyos-documentation-c00dae8d72f575f83aa7076fe53d02520238ab43.zip
ipoe: use documented section style guide
Diffstat (limited to 'docs/services')
-rw-r--r--docs/services/ipoe-server.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/services/ipoe-server.rst b/docs/services/ipoe-server.rst
index a1144301..69682217 100644
--- a/docs/services/ipoe-server.rst
+++ b/docs/services/ipoe-server.rst
@@ -1,5 +1,8 @@
-IPoE server
-------------
+.. _ipoe_server:
+
+###########
+IPoE Server
+###########
VyOS utilizes `accel-ppp`_ to provide IPoE server functionality. It can be
used with local authentication (mac-address) or a connected RADIUS server.
@@ -9,7 +12,7 @@ used with local authentication (mac-address) or a connected RADIUS server.
in order to become effective.
Configuration
-^^^^^^^^^^^^^
+=============
IPoE can be configure on different interfaces, it will depend on each specific situation which interface will provide IPoE to clients.
The clients mac address and the incoming interface is being used as control parameter, to authenticate a client.
@@ -39,7 +42,7 @@ Connected sessions can be checked via the ``show ipoe-server sessions`` command.
IPv6 SLAAC and IA-PD
-====================
+--------------------
To configure IPv6 assignments for clients, two options need to be configured. A global prefix which is terminated on the clients cpe and a delegated prefix, the client can use
for devices routed via the clients cpe.
@@ -70,7 +73,7 @@ globally communicate without the need of any NAT rules.
Automatic VLAN creation
-=======================
+-----------------------
To create VLANs per user during runtime, the following settings are required on a per interface basis. VLAN ID and VLAN range can be present in the configuration at the same time.
@@ -84,7 +87,7 @@ To create VLANs per user during runtime, the following settings are required on
RADIUS Setup
-^^^^^^^^^^^^
+------------
To use a RADIUS server for authentication and bandwidth-shaping, the following example configuration can be used.
@@ -114,7 +117,6 @@ The rate-limit is set in kbit/sec.
set service ipoe-server dns-server server-2 '8.8.4.4'
set service ipoe-server interface eth2 client-subnet '192.168.0.0/24'
-
.. code-block:: none
vyos@vyos# run show ipoe-server sessions