[246c904] | 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;
|
---|
[def11b7] | 6 |
|
---|
[246c904] | 7 | <!ENTITY pppoe-download-http "http://www.roaringpenguin.com/products/rp-pppoe/rp-pppoe-&pppoe-version;.tar.gz">
|
---|
| 8 | <!ENTITY pppoe-download-ftp "ftp://ftp.rutgers.edu/pub/slackware/slackware_source/n/rp-pppoe/rp-pppoe-&pppoe-version;.tar.gz">
|
---|
| 9 | <!ENTITY pppoe-size "185 KB">
|
---|
| 10 | <!ENTITY pppoe-buildsize "2.2 MB">
|
---|
| 11 | <!ENTITY pppoe-time "0.05 SBU">
|
---|
| 12 | ]>
|
---|
| 13 |
|
---|
[3cfb81c] | 14 | <sect1 id="pppoe" xreflabel="RP-PPPoE-&pppoe-version;">
|
---|
[a0f03b0] | 15 | <sect1info>
|
---|
[5cd0959d] | 16 | <othername>$LastChangedBy$</othername>
|
---|
| 17 | <date>$Date$</date>
|
---|
[a0f03b0] | 18 | </sect1info>
|
---|
[00bb024c] | 19 | <?dbhtml filename="pppoe.html"?>
|
---|
[3cfb81c] | 20 | <title>RP-PPPoE-&pppoe-version;</title>
|
---|
[f45b1953] | 21 |
|
---|
[246c904] | 22 | <sect2>
|
---|
[def11b7] | 23 | <title>Introduction to
|
---|
| 24 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
|
---|
[246c904] | 25 |
|
---|
| 26 | <para>The Roaring Penguin <application><acronym>PPPoE</acronym></application>
|
---|
| 27 | package contains both a client and a server component that works with the
|
---|
| 28 | client. The client allows you to connect to large networks that use the
|
---|
| 29 | <acronym>PPPoE</acronym> protocol, common among <acronym>ADSL</acronym>
|
---|
| 30 | providers. The server component runs alongside the client,
|
---|
| 31 | allowing you to configure other clients that send out a configuration
|
---|
| 32 | request.</para>
|
---|
| 33 |
|
---|
| 34 | <sect3><title>Package information</title>
|
---|
| 35 | <itemizedlist spacing='compact'>
|
---|
| 36 | <listitem><para>Download (HTTP): <ulink
|
---|
| 37 | url="&pppoe-download-http;"/></para></listitem>
|
---|
| 38 | <listitem><para>Download (FTP): <ulink
|
---|
| 39 | url="&pppoe-download-ftp;"/></para></listitem>
|
---|
| 40 | <listitem><para>Download size: &pppoe-size;</para></listitem>
|
---|
[def11b7] | 41 | <listitem><para>Estimated disk space required:
|
---|
[246c904] | 42 | &pppoe-buildsize;</para></listitem>
|
---|
| 43 | <listitem><para>Estimated build time:
|
---|
| 44 | &pppoe-time;</para></listitem></itemizedlist>
|
---|
| 45 | </sect3>
|
---|
[def11b7] | 46 |
|
---|
| 47 | <sect3><title><application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
| 48 | dependencies</title>
|
---|
[246c904] | 49 | <sect4><title>Required</title>
|
---|
[60c380e] | 50 | <para><xref linkend="ppp"/> and
|
---|
| 51 | <xref linkend="net-tools"/> (you may omit
|
---|
| 52 | <application>Net-tools</application> by using the following patch to
|
---|
| 53 | utilize <application><acronym>IP</acronym>Route2</application>: <ulink
|
---|
| 54 | url="&patch-root;/rp-pppoe-&pppoe-version;-iproute2-1.patch"/>)</para>
|
---|
[def11b7] | 55 | </sect4>
|
---|
[246c904] | 56 | </sect3>
|
---|
| 57 |
|
---|
| 58 | </sect2>
|
---|
| 59 |
|
---|
| 60 | <sect2>
|
---|
[def11b7] | 61 | <title>Installation of
|
---|
| 62 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
|
---|
[246c904] | 63 |
|
---|
[def11b7] | 64 | <note><para>If you plan on using kernel-mode <acronym>PPPoE</acronym>,
|
---|
[fe5f3849] | 65 | this package is no longer explicitly needed, however, it is recomended
|
---|
[246c904] | 66 | for ease of configuration. Additional information about kernel mode
|
---|
| 67 | <acronym>PPPoE</acronym> can be found in
|
---|
[68dc29a7] | 68 | <filename>rp-pppoe-&pppoe-version;/doc/KERNEL-MODE-PPPOE</filename>.</para></note>
|
---|
[246c904] | 69 |
|
---|
[def11b7] | 70 | <para>Install
|
---|
| 71 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application> by
|
---|
| 72 | running the following commands:</para>
|
---|
[246c904] | 73 |
|
---|
| 74 | <screen><userinput><command>cd src &&
|
---|
| 75 | ./configure &&
|
---|
| 76 | make &&
|
---|
| 77 | make install</command></userinput></screen>
|
---|
| 78 |
|
---|
| 79 | </sect2>
|
---|
| 80 |
|
---|
| 81 | <sect2>
|
---|
| 82 | <title>Command explanations</title>
|
---|
| 83 |
|
---|
| 84 | <para>These are the standard installation commands that will install into
|
---|
| 85 | the <filename>/usr</filename> prefix. You can optionally use the
|
---|
| 86 | <command>go</command> script in the root of the source tree, to
|
---|
| 87 | run the same commands, which are then immediately followed by the
|
---|
| 88 | <command>adsl-setup</command> script.</para>
|
---|
| 89 |
|
---|
| 90 | </sect2>
|
---|
| 91 |
|
---|
| 92 | <sect2>
|
---|
[def11b7] | 93 | <title>Configuring
|
---|
| 94 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
|
---|
[246c904] | 95 |
|
---|
| 96 | <sect3><title>Config files</title>
|
---|
| 97 | <para><filename>/etc/ppp/pppoe.conf</filename>,
|
---|
| 98 | <filename>/etc/ppp/firewall-standalone</filename>,
|
---|
| 99 | <filename>/etc/ppp/firewall-masq</filename>,
|
---|
| 100 | <filename>/etc/ppp/pppoe-server-options</filename>,
|
---|
| 101 | <filename>/etc/resolv.conf</filename>,
|
---|
| 102 | <filename>/etc/ppp/pap-seecrets</filename>,
|
---|
| 103 | <filename>/etc/ppp/chap-secrets</filename></para></sect3>
|
---|
| 104 |
|
---|
| 105 | <sect3><title>Configuration Information</title>
|
---|
| 106 |
|
---|
[def11b7] | 107 | <para>To configure
|
---|
| 108 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
| 109 | after installation, you should run the <command>adsl-setup</command>
|
---|
| 110 | script.</para>
|
---|
[246c904] | 111 |
|
---|
| 112 | <para>When configuring your connection, you will need to have your
|
---|
| 113 | <acronym>ISP</acronym>'s nameserver information available, as well as your
|
---|
| 114 | username and password. You will also be asked whether to configure a
|
---|
| 115 | dial-on-demand or a constant connection. If your service provider does not
|
---|
| 116 | charge by the minute, it is usually good to have a bootscript handle the
|
---|
| 117 | connection for you. You can, of course, choose not to install the
|
---|
| 118 | following script, and start your connection manually with the
|
---|
| 119 | <command>adsl-start</command> script.</para>
|
---|
| 120 |
|
---|
| 121 | <para><emphasis>Optionally</emphasis> install the
|
---|
| 122 | <filename>/etc/sysconfig/network-devices/services/pppoe</filename> service
|
---|
| 123 | script included with the <xref linkend="intro-important-bootscripts"/>
|
---|
| 124 | package.</para>
|
---|
| 125 |
|
---|
| 126 | <screen><userinput><command>make install-service-pppoe</command></userinput></screen>
|
---|
| 127 |
|
---|
| 128 | <para>Now create the config file for use with the <filename>pppoe</filename>
|
---|
| 129 | service script:</para>
|
---|
| 130 |
|
---|
[802e6fe7] | 131 | <note><para>If you have previously configured the network interface that
|
---|
[def11b7] | 132 | will now use <acronym>PPPoE</acronym>, you should remove the interface
|
---|
| 133 | configuration files for that interface:</para>
|
---|
| 134 |
|
---|
| 135 | <para><command><userinput>rm
|
---|
| 136 | /etc/sysconfig/network-devices/ifconfig.eth0/*</userinput></command></para>
|
---|
| 137 | </note>
|
---|
[afa198d] | 138 |
|
---|
| 139 | <screen><userinput><command>install -d /etc/sysconfig/network-devices/ifconfig.eth0 &&
|
---|
| 140 | cat > /etc/sysconfig/network-devices/ifconfig.eth0/pppoe << "EOF"</command>
|
---|
| 141 | ONBOOT="yes"
|
---|
| 142 | SERVICE="pppoe"
|
---|
[246c904] | 143 | <command>EOF</command></userinput></screen>
|
---|
| 144 |
|
---|
[afa198d] | 145 | <!-- A TYPE="[user/kernel]" will be added at a later date when kernel
|
---|
| 146 | mode pppoe is described here. -->
|
---|
[246c904] | 147 | </sect3>
|
---|
| 148 |
|
---|
| 149 | </sect2>
|
---|
| 150 |
|
---|
| 151 | <sect2>
|
---|
| 152 | <title>Contents</title>
|
---|
| 153 |
|
---|
[def11b7] | 154 | <para>The
|
---|
| 155 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
| 156 | package contains <command>adsl-setup</command>, <command>adsl-start</command>,
|
---|
[246c904] | 157 | <command>adsl-status</command>, <command>adsl-stop</command>, <command>
|
---|
| 158 | pppoe</command>, <command>pppoe-relay</command>, <command>pppoe-server
|
---|
| 159 | </command> and <command>pppoe-sniff</command>.</para>
|
---|
| 160 |
|
---|
| 161 | </sect2>
|
---|
| 162 |
|
---|
| 163 | <sect2><title>Description</title>
|
---|
| 164 |
|
---|
| 165 | <sect3><title>adsl-setup</title>
|
---|
| 166 | <para>A script for configuring the client. Configuration is then stored
|
---|
| 167 | in <filename>/etc/ppp/pppoe.conf</filename>.</para></sect3>
|
---|
| 168 |
|
---|
| 169 | <sect3><title>adsl-start</title>
|
---|
| 170 | <para><command>adsl-start</command> starts the client using the options
|
---|
| 171 | specified in <filename>/etc/ppp/pppoe.conf</filename>.</para></sect3>
|
---|
| 172 |
|
---|
| 173 | <sect3><title>adsl-status</title>
|
---|
| 174 | <para><command>adsl-status</command> displays the status of the
|
---|
| 175 | <acronym>ADSL</acronym> connection.</para></sect3>
|
---|
| 176 |
|
---|
| 177 | <sect3><title>adsl-stop</title>
|
---|
| 178 | <para><command>adsl-stop</command> stops the client.</para></sect3>
|
---|
| 179 |
|
---|
| 180 | <sect3><title>pppoe</title>
|
---|
| 181 | <para>This is the client itself. Generally it should not be started on its
|
---|
| 182 | own.</para></sect3>
|
---|
| 183 |
|
---|
| 184 | <sect3><title>pppoe-relay</title>
|
---|
[def11b7] | 185 | <para><command>pppoe-relay</command> starts the server relay
|
---|
| 186 | agent.</para></sect3>
|
---|
[246c904] | 187 |
|
---|
| 188 | <sect3><title>pppoe-server</title>
|
---|
[def11b7] | 189 | <para><command>pppoe-server</command> starts the server
|
---|
| 190 | component.</para></sect3>
|
---|
[246c904] | 191 |
|
---|
| 192 | <sect3><title>pppoe-sniff</title>
|
---|
[def11b7] | 193 | <para>A small network sniffer designed to assist in setting
|
---|
| 194 | <envar>PPPOE_EXTRA</envar> settings.</para></sect3>
|
---|
[246c904] | 195 |
|
---|
| 196 | </sect2>
|
---|
[f45b1953] | 197 |
|
---|
| 198 | </sect1>
|
---|