source: connect/other/pppoe.xml@ 68dcb2dd

10.0 10.1 11.0 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 68dcb2dd was 68dcb2dd, checked in by Manuel Canales Esparcia <manuel@…>, 16 years ago

Finished connect.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3893 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 12.3 KB
Line 
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 "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 <?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>: <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 recomended 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 ADSL scripts:</para>
87
88<screen><userinput>sed -i s%/usr/bin/logger%/bin/logger% scripts/adsl-{connect,setup,stop}.in</userinput></screen>
89
90 <para>Install <application>RP-PPPoE</application> by running the following
91 commands:</para>
92
93<screen><userinput>cd src &amp;&amp;
94./configure &amp;&amp;
95make</userinput></screen>
96
97 <para>This package does not come with a test suite.</para>
98
99 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
100
101<screen role="root"><userinput>make install</userinput></screen>
102
103 </sect2>
104
105 <sect2 role="commands">
106 <title>Command Explanations</title>
107
108 <para>These are the standard installation commands that will install into
109 the <filename class="directory">/usr</filename> prefix. You can optionally use the
110 <command>go</command> script in the root of the source tree, to
111 run the same commands, which are then immediately followed by the
112 <command>adsl-setup</command> script.</para>
113
114 </sect2>
115
116 <sect2 role="configuration">
117 <title>Configuring RP-PPPoE</title>
118
119 <sect3 id="pppoe-config">
120 <title>Config Files</title>
121
122 <para><filename>/etc/ppp/pppoe.conf</filename>,
123 <filename>/etc/ppp/firewall-standalone</filename>,
124 <filename>/etc/ppp/firewall-masq</filename>,
125 <filename>/etc/ppp/pppoe-server-options</filename>,
126 <filename>/etc/resolv.conf</filename>,
127 <filename>/etc/ppp/pap-secrets</filename>,
128 <filename>/etc/ppp/chap-secrets</filename></para>
129
130 <indexterm zone="pppoe pppoe-config">
131 <primary sortas="e-etc-ppp-pppoe.conf">/etc/ppp/pppoe.conf</primary>
132 </indexterm>
133
134 <indexterm zone="pppoe pppoe-config">
135 <primary sortas="e-etc-ppp-firewall-standalone">/etc/ppp/firewall-standalone</primary>
136 </indexterm>
137
138 <indexterm zone="pppoe pppoe-config">
139 <primary sortas="e-etc-ppp-firewall-masq">/etc/ppp/firewall-masq</primary>
140 </indexterm>
141
142 <indexterm zone="pppoe pppoe-config">
143 <primary sortas="e-etc-ppp-pppoe-server-options">/etc/ppp/pppoe-server-options</primary>
144 </indexterm>
145
146 <indexterm zone="pppoe pppoe-config">
147 <primary sortas="e-etc-resolv.conf">/etc/resolv.conf</primary>
148 </indexterm>
149
150 <indexterm zone="pppoe pppoe-config">
151 <primary sortas="e-etc-ppp-pap-secrets">/etc/ppp/pap-secrets</primary>
152 </indexterm>
153
154 <indexterm zone="pppoe pppoe-config">
155 <primary sortas="e-etc-ppp-chap-secrets">/etc/ppp/chap-secrets</primary>
156 </indexterm>
157
158 </sect3>
159
160 <sect3>
161 <title>Configuration Information</title>
162
163 <para>To configure <application>RP-PPPoE</application> after installation,
164 you should run the <command>adsl-setup</command> script.</para>
165
166 <para>When configuring your connection, you will need to have your
167 ISP's nameserver information available, as well as your
168 username and password. You will also be asked whether to configure a
169 dial-on-demand or a constant connection. If your service provider does not
170 charge by the minute, it is usually good to have a bootscript handle the
171 connection for you. You can, of course, choose not to install the
172 following script, and start your connection manually with the
173 <command>adsl-start</command> script.</para>
174
175 <para id="pppoe-init"><emphasis>Optionally</emphasis> install the
176 <filename>/etc/sysconfig/network-devices/services/pppoe</filename> service
177 script included with the <xref linkend="intro-important-bootscripts"/>
178 package (as user <systemitem class="username">root</systemitem>).</para>
179
180 <indexterm zone="pppoe pppoe-init">
181 <primary sortas="f-pppoe-service-script">pppoe (service script)</primary>
182 </indexterm>
183
184<screen role='root'><userinput>make install-service-pppoe</userinput></screen>
185
186 <para id="pppoe-config2">Now create the config file for use with the
187 <filename>pppoe</filename> service script (as user <systemitem
188 class="username">root</systemitem>):</para>
189
190 <indexterm zone="pppoe pppoe-config2">
191 <primary sortas="e-etc-sysconfig-pppoe">/etc/sysconfig/.../pppoe</primary>
192 </indexterm>
193
194 <note>
195 <para>If you have previously configured the network interface that
196 will now use PPPoE, you should remove the interface
197 configuration files for that interface (as user <systemitem
198 class="username">root</systemitem>):</para>
199
200<screen role='root'><userinput>rm /etc/sysconfig/network-devices/ifconfig.eth0/*</userinput></screen>
201 </note>
202
203<screen role='root'><userinput>install -d /etc/sysconfig/network-devices/ifconfig.eth0 &amp;&amp;
204cat &gt; /etc/sysconfig/network-devices/ifconfig.eth0/pppoe &lt;&lt; "EOF"
205<literal>ONBOOT="yes"
206SERVICE="pppoe"</literal>
207EOF</userinput></screen>
208
209 <!-- A TYPE="[user/kernel]" will be added at a later date when kernel
210 mode pppoe is described here. -->
211
212 </sect3>
213
214 </sect2>
215
216 <sect2 role="content">
217 <title>Contents</title>
218
219 <segmentedlist>
220 <segtitle>Installed Programs</segtitle>
221 <segtitle>Installed Libraries</segtitle>
222 <segtitle>Installed Directories</segtitle>
223
224 <seglistitem>
225 <seg>adsl-connect, adsl-setup, adsl-start, adsl-status, adsl-stop, pppoe,
226 pppoe-relay, pppoe-server and pppoe-sniff</seg>
227 <seg>None</seg>
228 <seg>/etc/ppp/plugins and /usr/share/doc/rp-pppoe-&pppoe-version;</seg>
229 </seglistitem>
230 </segmentedlist>
231
232 <variablelist>
233 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
234 <?dbfo list-presentation="list"?>
235 <?dbhtml list-presentation="table"?>
236
237 <varlistentry id="adsl-connect">
238 <term><command>adsl-connect</command></term>
239 <listitem>
240 <para>is a shell script which manages an ADSL
241 connection using the user-space PPPoE client.</para>
242 <indexterm zone="pppoe adsl-connect">
243 <primary sortas="b-adsl-connect">adsl-connect</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="adsl-setup">
249 <term><command>adsl-setup</command></term>
250 <listitem>
251 <para>is a script for configuring the client. Configuration is
252 then stored in <filename>/etc/ppp/pppoe.conf</filename>.</para>
253 <indexterm zone="pppoe adsl-setup">
254 <primary sortas="b-adsl-setup">adsl-setup</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="adsl-start">
260 <term><command>adsl-start</command></term>
261 <listitem>
262 <para>starts the client using the options specified in
263 <filename>/etc/ppp/pppoe.conf</filename>.</para>
264 <indexterm zone="pppoe adsl-start">
265 <primary sortas="b-adsl-start">adsl-start</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 <varlistentry id="adsl-status">
271 <term><command>adsl-status</command></term>
272 <listitem>
273 <para>displays the status of the ADSL
274 connection.</para>
275 <indexterm zone="pppoe adsl-status">
276 <primary sortas="b-adsl-status">adsl-status</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="adsl-stop">
282 <term><command>adsl-stop</command></term>
283 <listitem>
284 <para>stops the client.</para>
285 <indexterm zone="pppoe adsl-stop">
286 <primary sortas="b-adsl-stop">adsl-stop</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="pppoe-prog">
292 <term><command>pppoe</command></term>
293 <listitem>
294 <para>is the client program. Generally it should not be started on
295 its own.</para>
296 <indexterm zone="pppoe pppoe-prog">
297 <primary sortas="b-pppoe">pppoe</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="pppoe-relay">
303 <term><command>pppoe-relay</command></term>
304 <listitem>
305 <para>starts the server relay agent.</para>
306 <indexterm zone="pppoe pppoe-relay">
307 <primary sortas="b-pppoe-relay">pppoe-relay</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="pppoe-server">
313 <term><command>pppoe-server</command></term>
314 <listitem>
315 <para>starts the server component.</para>
316 <indexterm zone="pppoe pppoe-server">
317 <primary sortas="b-pppoe-server">pppoe-server</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="pppoe-sniff">
323 <term><command>pppoe-sniff</command></term>
324 <listitem>
325 <para>is a small network sniffer designed to assist in setting
326 <envar>PPPOE_EXTRA</envar> settings.</para>
327 <indexterm zone="pppoe pppoe-sniff">
328 <primary sortas="b-pppoe-sniff">pppoe-sniff</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 </variablelist>
334
335 </sect2>
336
337</sect1>
Note: See TracBrowser for help on using the repository browser.