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