glfs/connect/other/pppoe.xml
Igor Živković 60c380e383 RP-PPPoE: fixed some typos.
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3182 af4574ff-66df-0310-9fd7-8a98e5e911e0
2005-01-04 10:43:16 +00:00

199 lines
7.2 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY pppoe-download-http "http://www.roaringpenguin.com/products/rp-pppoe/rp-pppoe-&pppoe-version;.tar.gz">
<!ENTITY pppoe-download-ftp "ftp://ftp.rutgers.edu/pub/slackware/slackware_source/n/rp-pppoe/rp-pppoe-&pppoe-version;.tar.gz">
<!ENTITY pppoe-size "185 KB">
<!ENTITY pppoe-buildsize "2.2 MB">
<!ENTITY pppoe-time "0.05 SBU">
]>
<sect1 id="pppoe" xreflabel="RP-PPPoE-&pppoe-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="pppoe.html"?>
<title>RP-PPPoE-&pppoe-version;</title>
<sect2>
<title>Introduction to
<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
<para>The Roaring Penguin <application><acronym>PPPoE</acronym></application>
package contains both a client and a server component that works with the
client. The client allows you to connect to large networks that use the
<acronym>PPPoE</acronym> protocol, common among <acronym>ADSL</acronym>
providers. The server component runs alongside the client,
allowing you to configure other clients that send out a configuration
request.</para>
<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink
url="&pppoe-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink
url="&pppoe-download-ftp;"/></para></listitem>
<listitem><para>Download size: &pppoe-size;</para></listitem>
<listitem><para>Estimated disk space required:
&pppoe-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&pppoe-time;</para></listitem></itemizedlist>
</sect3>
<sect3><title><application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="ppp"/> and
<xref linkend="net-tools"/> (you may omit
<application>Net-tools</application> by using the following patch to
utilize <application><acronym>IP</acronym>Route2</application>: <ulink
url="&patch-root;/rp-pppoe-&pppoe-version;-iproute2-1.patch"/>)</para>
</sect4>
</sect3>
</sect2>
<sect2>
<title>Installation of
<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
<note><para>If you plan on using kernel-mode <acronym>PPPoE</acronym>,
this package is no longer explicitly needed, however, it is recomended
for ease of configuration. Additional information about kernel mode
<acronym>PPPoE</acronym> can be found in
<filename>rp-pppoe-&pppoe-version;/doc/KERNEL-MODE-PPPOE</filename>.</para></note>
<para>Install
<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application> by
running the following commands:</para>
<screen><userinput><command>cd src &amp;&amp;
./configure &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>
</sect2>
<sect2>
<title>Command explanations</title>
<para>These are the standard installation commands that will install into
the <filename>/usr</filename> prefix. You can optionally use the
<command>go</command> script in the root of the source tree, to
run the same commands, which are then immediately followed by the
<command>adsl-setup</command> script.</para>
</sect2>
<sect2>
<title>Configuring
<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
<sect3><title>Config files</title>
<para><filename>/etc/ppp/pppoe.conf</filename>,
<filename>/etc/ppp/firewall-standalone</filename>,
<filename>/etc/ppp/firewall-masq</filename>,
<filename>/etc/ppp/pppoe-server-options</filename>,
<filename>/etc/resolv.conf</filename>,
<filename>/etc/ppp/pap-seecrets</filename>,
<filename>/etc/ppp/chap-secrets</filename></para></sect3>
<sect3><title>Configuration Information</title>
<para>To configure
<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
after installation, you should run the <command>adsl-setup</command>
script.</para>
<para>When configuring your connection, you will need to have your
<acronym>ISP</acronym>'s nameserver information available, as well as your
username and password. You will also be asked whether to configure a
dial-on-demand or a constant connection. If your service provider does not
charge by the minute, it is usually good to have a bootscript handle the
connection for you. You can, of course, choose not to install the
following script, and start your connection manually with the
<command>adsl-start</command> script.</para>
<para><emphasis>Optionally</emphasis> install the
<filename>/etc/sysconfig/network-devices/services/pppoe</filename> service
script included with the <xref linkend="intro-important-bootscripts"/>
package.</para>
<screen><userinput><command>make install-service-pppoe</command></userinput></screen>
<para>Now create the config file for use with the <filename>pppoe</filename>
service script:</para>
<note><para>If you have previously configured the network interface that
will now use <acronym>PPPoE</acronym>, you should remove the interface
configuration files for that interface:</para>
<para><command><userinput>rm
/etc/sysconfig/network-devices/ifconfig.eth0/*</userinput></command></para>
</note>
<screen><userinput><command>install -d /etc/sysconfig/network-devices/ifconfig.eth0 &amp;&amp;
cat &gt; /etc/sysconfig/network-devices/ifconfig.eth0/pppoe &lt;&lt; "EOF"</command>
ONBOOT="yes"
SERVICE="pppoe"
<command>EOF</command></userinput></screen>
<!-- A TYPE="[user/kernel]" will be added at a later date when kernel
mode pppoe is described here. -->
</sect3>
</sect2>
<sect2>
<title>Contents</title>
<para>The
<application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
package contains <command>adsl-setup</command>, <command>adsl-start</command>,
<command>adsl-status</command>, <command>adsl-stop</command>, <command>
pppoe</command>, <command>pppoe-relay</command>, <command>pppoe-server
</command> and <command>pppoe-sniff</command>.</para>
</sect2>
<sect2><title>Description</title>
<sect3><title>adsl-setup</title>
<para>A script for configuring the client. Configuration is then stored
in <filename>/etc/ppp/pppoe.conf</filename>.</para></sect3>
<sect3><title>adsl-start</title>
<para><command>adsl-start</command> starts the client using the options
specified in <filename>/etc/ppp/pppoe.conf</filename>.</para></sect3>
<sect3><title>adsl-status</title>
<para><command>adsl-status</command> displays the status of the
<acronym>ADSL</acronym> connection.</para></sect3>
<sect3><title>adsl-stop</title>
<para><command>adsl-stop</command> stops the client.</para></sect3>
<sect3><title>pppoe</title>
<para>This is the client itself. Generally it should not be started on its
own.</para></sect3>
<sect3><title>pppoe-relay</title>
<para><command>pppoe-relay</command> starts the server relay
agent.</para></sect3>
<sect3><title>pppoe-server</title>
<para><command>pppoe-server</command> starts the server
component.</para></sect3>
<sect3><title>pppoe-sniff</title>
<para>A small network sniffer designed to assist in setting
<envar>PPPOE_EXTRA</envar> settings.</para></sect3>
</sect2>
</sect1>