Add extra baud rates >= 1Mbaud.
[ppp.git] / README.pppoe
1                 PPPoE Support
2                 -------------
3
4                 Michal Ostrowski
5                 8 August 2001
6
7                 for ppp-2.4.2
8
9 1. Introduction
10 ---------------
11
12 This document describes the support for PPP over Ethernet (PPPoE)
13 included with this packages.  It is assumed that the reader is
14 familiar with Linux PPP (as it pertains to tty/modem-based
15 connections).  In particular, users of PPP in the Linux 2.2 series
16 kernels should ensure they are familiar with the changes to the PPP
17 implementation in the 2.4 series kernels before attempting to use
18 PPPoE features.
19
20 If you are not familiar with PPP, I recommend looking at other
21 packages which include end-user configuration tools, such as Roaring
22 Penguin (http://www.roaringpenguin.com/pppoe)
23
24 PPPoE is a protocol typically used by *DSL providers to manage IP
25 addresses and authenticate users.  Essentially, PPPoE provides for a
26 PPP connection to be established not over a physical serial-line or
27 modem, but over a logical connection between two unique MAC-addresses
28 on an ethernet network.  Once the PPPoE layer discovers the end-points
29 to be used in the link and negotiates it, frames may be sent to and
30 received from the PPPoE layer just as if the link was a serial line
31 (or that is how it's supposed to be).
32
33 With this in mind, the goal of the implementation of PPPoE support in
34 Linux is to allow users to simply specify that the device they intend
35 to use for the PPP connection is an ethernet device (i.e. "eth0") and
36 the rest of the system should function as usual.
37
38 2. Using PPPoE
39 --------------
40
41 This section is a quick guide for getting PPPoE working, to allow one
42 to connect to their ISP who is providing PPPoE based services.
43
44 1.  Enable "Prompt for development and/or incomplete code/drivers" and
45     "PPP over Ethernet" in your kernel configuration.  If you choose to
46     use the PPP over Ethernet driver as a module adding "alias
47     net-pf-24 pppoe" to /etc/modules.conf will enable auto-loading
48     of the modules.
49
50 2.  Compile and install your kernel.
51
52 3.  Install the ppp package.
53
54 4.  Add the following line to /etc/ppp/options:
55
56     plugin rp-pppoe.so
57
58     The effect of this line is simply to make "eth0", "eth1",
59     ....,"ethx" all valid device names for pppd (just like ttyS0,
60     ttyS1).
61
62 5.  Add the necessary authentication options to your pppd
63     configuration (i.e. PAP/CHAP information).  If you wish to
64     maintain seperate configurations for different devices you may
65     place configuration options in device-specific configuration
66     files: /etc/ppp/options.devname (devname=ttyS0, ttyS1, eth0, eth1
67     or any other valid device name).
68
69 6.  Invoke pppd with the appropriate device name: e.g. "pppd eth0"
70
71
72 Do not include any compression or flow control options in your PPPoE
73 configuration.  They will be ignored.
74
75 Again, here it is assumed that the reader is familiar with the general
76 process of configuring PPP.  The steps outlined here refer only to the
77 steps and configuration options which are PPPoE specific, and it is
78 assumed that the reader will also configure other aspects of the system
79 (e.g. PAP authentication parameters).
80
81 3.  Advanced Functionality
82 --------------------------
83
84 For more advanced functionality (such as providing PPPoE services) and
85 user configuration tools, look to the Roaring Penguin PPPoE software
86 package (http://www.roaringpenguin.com/pppoe).
87
88 4.  Credits
89 -----------
90
91 The PPPoE plugin included in this package is a component of the
92 Roaring Penguin PPPoE package, included in this package courtesy of
93 Roaring Penguin Software. (http://www.roaringpenguin.com).
94