1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY pppoe-download-http "http://www.roaringpenguin.com/penguin/pppoe/rp-pppoe-&pppoe-version;.tar.gz">
|
---|
8 | <!ENTITY pppoe-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/rp-pppoe-&pppoe-version;.tar.gz">
|
---|
9 | <!ENTITY pppoe-md5sum "97972f8f8f6a3ab9b7070333a6a29c4b">
|
---|
10 | <!ENTITY pppoe-size "185 KB">
|
---|
11 | <!ENTITY pppoe-buildsize "2.2 MB">
|
---|
12 | <!ENTITY pppoe-time "0.05 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="pppoe" xreflabel="RP-PPPoE-&pppoe-version;">
|
---|
16 | <sect1info>
|
---|
17 | <othername>$LastChangedBy$</othername>
|
---|
18 | <date>$Date$</date>
|
---|
19 | </sect1info>
|
---|
20 | <?dbhtml filename="pppoe.html"?>
|
---|
21 | <title>RP-PPPoE-&pppoe-version;</title>
|
---|
22 | <indexterm zone="pppoe">
|
---|
23 | <primary sortas="a-RP-PPPoE">RP-PPPoE</primary></indexterm>
|
---|
24 |
|
---|
25 | <sect2>
|
---|
26 | <title>Introduction to
|
---|
27 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
|
---|
28 |
|
---|
29 | <para>The Roaring Penguin <application><acronym>PPPoE</acronym></application>
|
---|
30 | package contains both a client and a server component that works with the
|
---|
31 | client. The client allows you to connect to large networks that use the
|
---|
32 | <acronym>PPPoE</acronym> protocol, common among <acronym>ADSL</acronym>
|
---|
33 | providers. The server component runs alongside the client,
|
---|
34 | allowing you to configure other clients that send out a configuration
|
---|
35 | request.</para>
|
---|
36 |
|
---|
37 | <sect3><title>Package information</title>
|
---|
38 | <itemizedlist spacing='compact'>
|
---|
39 | <listitem><para>Download (HTTP): <ulink
|
---|
40 | url="&pppoe-download-http;"/></para></listitem>
|
---|
41 | <listitem><para>Download (FTP): <ulink
|
---|
42 | url="&pppoe-download-ftp;"/></para></listitem>
|
---|
43 | <listitem><para>Download MD5 sum: &pppoe-md5sum;</para></listitem>
|
---|
44 | <listitem><para>Download size: &pppoe-size;</para></listitem>
|
---|
45 | <listitem><para>Estimated disk space required:
|
---|
46 | &pppoe-buildsize;</para></listitem>
|
---|
47 | <listitem><para>Estimated build time:
|
---|
48 | &pppoe-time;</para></listitem></itemizedlist>
|
---|
49 | </sect3>
|
---|
50 |
|
---|
51 | <sect3><title>
|
---|
52 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
53 | dependencies</title>
|
---|
54 | <sect4><title>Required</title>
|
---|
55 | <para><xref linkend="ppp"/> and
|
---|
56 | <xref linkend="net-tools"/> (you may omit
|
---|
57 | <application>Net-tools</application> by using the following patch to
|
---|
58 | utilize <application><acronym>IP</acronym>Route2</application>: <ulink
|
---|
59 | url="&patch-root;/rp-pppoe-&pppoe-version;-iproute2-1.patch"/>)</para>
|
---|
60 | </sect4>
|
---|
61 | </sect3>
|
---|
62 |
|
---|
63 | </sect2>
|
---|
64 |
|
---|
65 | <sect2 id="pppoe-kernel">
|
---|
66 | <title>Installation of
|
---|
67 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
68 | </title>
|
---|
69 |
|
---|
70 | <note><para>If you plan on using kernel-mode <acronym>PPPoE</acronym>,
|
---|
71 | this package is no longer explicitly needed, however, it is recomended
|
---|
72 | for ease of configuration. Additional information about kernel mode
|
---|
73 | <acronym>PPPoE</acronym> can be found in
|
---|
74 | <filename>rp-pppoe-&pppoe-version;/doc/KERNEL-MODE-PPPOE</filename>.</para></note>
|
---|
75 | <indexterm zone="pppoe pppoe-kernel">
|
---|
76 | <primary sortas="d-Kernel-mode-PPPoE">Kernel-mode PPPoE</primary></indexterm>
|
---|
77 |
|
---|
78 | <para>Install
|
---|
79 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application> by
|
---|
80 | running the following commands:</para>
|
---|
81 |
|
---|
82 | <screen><userinput><command>cd src &&
|
---|
83 | ./configure &&
|
---|
84 | make</command></userinput></screen>
|
---|
85 |
|
---|
86 | <para>Now, as the root user:</para>
|
---|
87 |
|
---|
88 | <screen><userinput role='root'><command>make install</command></userinput></screen>
|
---|
89 |
|
---|
90 | </sect2>
|
---|
91 |
|
---|
92 | <sect2>
|
---|
93 | <title>Command explanations</title>
|
---|
94 |
|
---|
95 | <para>These are the standard installation commands that will install into
|
---|
96 | the <filename>/usr</filename> prefix. You can optionally use the
|
---|
97 | <command>go</command> script in the root of the source tree, to
|
---|
98 | run the same commands, which are then immediately followed by the
|
---|
99 | <command>adsl-setup</command> script.</para>
|
---|
100 |
|
---|
101 | </sect2>
|
---|
102 |
|
---|
103 | <sect2>
|
---|
104 | <title>Configuring
|
---|
105 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
106 | </title>
|
---|
107 |
|
---|
108 | <sect3 id="pppoe-config"><title>Config files</title>
|
---|
109 | <para><filename>/etc/ppp/pppoe.conf</filename>,
|
---|
110 | <filename>/etc/ppp/firewall-standalone</filename>,
|
---|
111 | <filename>/etc/ppp/firewall-masq</filename>,
|
---|
112 | <filename>/etc/ppp/pppoe-server-options</filename>,
|
---|
113 | <filename>/etc/resolv.conf</filename>,
|
---|
114 | <filename>/etc/ppp/pap-secrets</filename>,
|
---|
115 | <filename>/etc/ppp/chap-secrets</filename></para>
|
---|
116 | <indexterm zone="pppoe pppoe-config"><primary
|
---|
117 | sortas="e-etc-ppp-pppoe.conf">/etc/ppp/pppoe.conf</primary>
|
---|
118 | </indexterm>
|
---|
119 | <indexterm zone="pppoe pppoe-config"><primary
|
---|
120 | sortas="e-etc-ppp-firewall-standalone">/etc/ppp/firewall-standalone</primary>
|
---|
121 | </indexterm>
|
---|
122 | <indexterm zone="pppoe pppoe-config"><primary
|
---|
123 | sortas="e-etc-ppp-firewall-masq">/etc/ppp/firewall-masq</primary>
|
---|
124 | </indexterm>
|
---|
125 | <indexterm zone="pppoe pppoe-config"><primary
|
---|
126 | sortas="e-etc-ppp-pppoe-server-options">/etc/ppp/pppoe-server-options</primary>
|
---|
127 | </indexterm>
|
---|
128 | <indexterm zone="pppoe pppoe-config"><primary
|
---|
129 | sortas="e-etc-resolv.conf">/etc/resolv.conf</primary>
|
---|
130 | </indexterm>
|
---|
131 | <indexterm zone="pppoe pppoe-config"><primary
|
---|
132 | sortas="e-etc-ppp-pap-secrets">/etc/ppp/pap-secrets</primary>
|
---|
133 | </indexterm>
|
---|
134 | <indexterm zone="pppoe pppoe-config"><primary
|
---|
135 | sortas="e-etc-ppp-chap-secrets">/etc/ppp/chap-secrets</primary>
|
---|
136 | </indexterm>
|
---|
137 | </sect3>
|
---|
138 |
|
---|
139 | <sect3><title>Configuration Information</title>
|
---|
140 |
|
---|
141 | <para>To configure
|
---|
142 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
143 | after installation, you should run the <command>adsl-setup</command>
|
---|
144 | script.</para>
|
---|
145 |
|
---|
146 | <para>When configuring your connection, you will need to have your
|
---|
147 | <acronym>ISP</acronym>'s nameserver information available, as well as your
|
---|
148 | username and password. You will also be asked whether to configure a
|
---|
149 | dial-on-demand or a constant connection. If your service provider does not
|
---|
150 | charge by the minute, it is usually good to have a bootscript handle the
|
---|
151 | connection for you. You can, of course, choose not to install the
|
---|
152 | following script, and start your connection manually with the
|
---|
153 | <command>adsl-start</command> script.</para>
|
---|
154 |
|
---|
155 | <para id="pppoe-init"><emphasis>Optionally</emphasis> install the
|
---|
156 | <filename>/etc/sysconfig/network-devices/services/pppoe</filename> service
|
---|
157 | script included with the <xref linkend="intro-important-bootscripts"/>
|
---|
158 | package (as user root).</para>
|
---|
159 | <indexterm zone="pppoe pppoe-init">
|
---|
160 | <primary sortas="f-pppoe-service-script">pppoe (service script)</primary>
|
---|
161 | </indexterm>
|
---|
162 |
|
---|
163 | <screen><userinput role='root'><command>make install-service-pppoe</command></userinput></screen>
|
---|
164 |
|
---|
165 | <para id="pppoe-config2">Now create the config file for use with the
|
---|
166 | <filename>pppoe</filename> service script (as user root):</para>
|
---|
167 | <indexterm zone="pppoe pppoe-config2">
|
---|
168 | <primary sortas="e-etc-sysconfig-pppoe">/etc/sysconfig/.../pppoe</primary>
|
---|
169 | </indexterm>
|
---|
170 |
|
---|
171 | <note><para>If you have previously configured the network interface that
|
---|
172 | will now use <acronym>PPPoE</acronym>, you should remove the interface
|
---|
173 | configuration files for that interface (as user root):</para>
|
---|
174 |
|
---|
175 | <para><command><userinput role='root'>rm
|
---|
176 | /etc/sysconfig/network-devices/ifconfig.eth0/*</userinput></command></para>
|
---|
177 | </note>
|
---|
178 |
|
---|
179 | <screen><userinput role='root'><command>install -d /etc/sysconfig/network-devices/ifconfig.eth0 &&
|
---|
180 | cat > /etc/sysconfig/network-devices/ifconfig.eth0/pppoe << "EOF"</command>
|
---|
181 | ONBOOT="yes"
|
---|
182 | SERVICE="pppoe"
|
---|
183 | <command>EOF</command></userinput></screen>
|
---|
184 |
|
---|
185 | <!-- A TYPE="[user/kernel]" will be added at a later date when kernel
|
---|
186 | mode pppoe is described here. -->
|
---|
187 | </sect3>
|
---|
188 |
|
---|
189 | </sect2>
|
---|
190 |
|
---|
191 | <sect2>
|
---|
192 | <title>Contents</title>
|
---|
193 |
|
---|
194 | <segmentedlist>
|
---|
195 | <segtitle>Installed Programs</segtitle>
|
---|
196 | <segtitle>Installed Libraries</segtitle>
|
---|
197 | <segtitle>Installed Directories</segtitle>
|
---|
198 |
|
---|
199 | <seglistitem>
|
---|
200 | <seg>adsl-connect, adsl-setup, adsl-start, adsl-status, adsl-stop, pppoe,
|
---|
201 | pppoe-relay, pppoe-server and pppoe-sniff</seg>
|
---|
202 | <seg>None</seg>
|
---|
203 | <seg>/etc/ppp/plugins and /usr/share/doc/rp-pppoe-&pppoe-version;</seg>
|
---|
204 | </seglistitem>
|
---|
205 | </segmentedlist>
|
---|
206 |
|
---|
207 | <variablelist>
|
---|
208 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
209 | <?dbfo list-presentation="list"?>
|
---|
210 |
|
---|
211 | <varlistentry id="adsl-connect">
|
---|
212 | <term><command>adsl-connect</command></term>
|
---|
213 | <listitem><para>is a shell script which manages an <acronym>ADSL</acronym>
|
---|
214 | connection using the user-space <acronym>PPPoE</acronym> client.</para>
|
---|
215 | <indexterm zone="pppoe adsl-connect">
|
---|
216 | <primary sortas="b-adsl-connect">adsl-connect</primary>
|
---|
217 | </indexterm></listitem>
|
---|
218 | </varlistentry>
|
---|
219 |
|
---|
220 | <varlistentry id="adsl-setup">
|
---|
221 | <term><command>adsl-setup</command></term>
|
---|
222 | <listitem><para>is a script for configuring the client. Configuration is
|
---|
223 | then stored in <filename>/etc/ppp/pppoe.conf</filename>.</para>
|
---|
224 | <indexterm zone="pppoe adsl-setup">
|
---|
225 | <primary sortas="b-adsl-setup">adsl-setup</primary>
|
---|
226 | </indexterm></listitem>
|
---|
227 | </varlistentry>
|
---|
228 |
|
---|
229 | <varlistentry id="adsl-start">
|
---|
230 | <term><command>adsl-start</command></term>
|
---|
231 | <listitem><para>starts the client using the options specified in
|
---|
232 | <filename>/etc/ppp/pppoe.conf</filename>.</para>
|
---|
233 | <indexterm zone="pppoe adsl-start">
|
---|
234 | <primary sortas="b-adsl-start">adsl-start</primary>
|
---|
235 | </indexterm></listitem>
|
---|
236 | </varlistentry>
|
---|
237 |
|
---|
238 | <varlistentry id="adsl-status">
|
---|
239 | <term><command>adsl-status</command></term>
|
---|
240 | <listitem><para>displays the status of the <acronym>ADSL</acronym>
|
---|
241 | connection.</para>
|
---|
242 | <indexterm zone="pppoe adsl-status">
|
---|
243 | <primary sortas="b-adsl-status">adsl-status</primary>
|
---|
244 | </indexterm></listitem>
|
---|
245 | </varlistentry>
|
---|
246 |
|
---|
247 | <varlistentry id="adsl-stop">
|
---|
248 | <term><command>adsl-stop</command></term>
|
---|
249 | <listitem><para>stops the client.</para>
|
---|
250 | <indexterm zone="pppoe adsl-stop">
|
---|
251 | <primary sortas="b-adsl-stop">adsl-stop</primary>
|
---|
252 | </indexterm></listitem>
|
---|
253 | </varlistentry>
|
---|
254 |
|
---|
255 | <varlistentry id="pppoe-prog">
|
---|
256 | <term><command>pppoe</command></term>
|
---|
257 | <listitem><para>is the client program. Generally it should not be started on
|
---|
258 | its own.</para>
|
---|
259 | <indexterm zone="pppoe pppoe-prog">
|
---|
260 | <primary sortas="b-pppoe">pppoe</primary>
|
---|
261 | </indexterm></listitem>
|
---|
262 | </varlistentry>
|
---|
263 |
|
---|
264 | <varlistentry id="pppoe-relay">
|
---|
265 | <term><command>pppoe-relay</command></term>
|
---|
266 | <listitem><para>starts the server relay agent.</para>
|
---|
267 | <indexterm zone="pppoe pppoe-relay">
|
---|
268 | <primary sortas="b-pppoe-relay">pppoe-relay</primary>
|
---|
269 | </indexterm></listitem>
|
---|
270 | </varlistentry>
|
---|
271 |
|
---|
272 | <varlistentry id="pppoe-server">
|
---|
273 | <term><command>pppoe-server</command></term>
|
---|
274 | <listitem><para>starts the server component.</para>
|
---|
275 | <indexterm zone="pppoe pppoe-server">
|
---|
276 | <primary sortas="b-pppoe-server">pppoe-server</primary>
|
---|
277 | </indexterm></listitem>
|
---|
278 | </varlistentry>
|
---|
279 |
|
---|
280 | <varlistentry id="pppoe-sniff">
|
---|
281 | <term><command>pppoe-sniff</command></term>
|
---|
282 | <listitem><para>is a small network sniffer designed to assist in setting
|
---|
283 | <envar>PPPOE_EXTRA</envar> settings.</para>
|
---|
284 | <indexterm zone="pppoe pppoe-sniff">
|
---|
285 | <primary sortas="b-pppoe-sniff">pppoe-sniff</primary>
|
---|
286 | </indexterm></listitem>
|
---|
287 | </varlistentry>
|
---|
288 | </variablelist>
|
---|
289 |
|
---|
290 | </sect2>
|
---|
291 |
|
---|
292 | </sect1>
|
---|