[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>
|
---|
[def11b7] | 50 | <para><xref linkend="ppp"/> and <xref linkend="net-tools"/></para>
|
---|
| 51 | </sect4>
|
---|
[246c904] | 52 | </sect3>
|
---|
| 53 |
|
---|
| 54 | </sect2>
|
---|
| 55 |
|
---|
| 56 | <sect2>
|
---|
[def11b7] | 57 | <title>Installation of
|
---|
| 58 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
|
---|
[246c904] | 59 |
|
---|
[def11b7] | 60 | <note><para>If you plan on using kernel-mode <acronym>PPPoE</acronym>,
|
---|
[246c904] | 61 | this package is no longer explicitly needed. However, it is recomended
|
---|
| 62 | for ease of configuration. Additional information about kernel mode
|
---|
| 63 | <acronym>PPPoE</acronym> can be found in
|
---|
[68dc29a7] | 64 | <filename>rp-pppoe-&pppoe-version;/doc/KERNEL-MODE-PPPOE</filename>.</para></note>
|
---|
[246c904] | 65 |
|
---|
[def11b7] | 66 | <para>Install
|
---|
| 67 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application> by
|
---|
| 68 | running the following commands:</para>
|
---|
[246c904] | 69 |
|
---|
| 70 | <screen><userinput><command>cd src &&
|
---|
| 71 | ./configure &&
|
---|
| 72 | make &&
|
---|
| 73 | make install</command></userinput></screen>
|
---|
| 74 |
|
---|
| 75 | </sect2>
|
---|
| 76 |
|
---|
| 77 | <sect2>
|
---|
| 78 | <title>Command explanations</title>
|
---|
| 79 |
|
---|
| 80 | <para>These are the standard installation commands that will install into
|
---|
| 81 | the <filename>/usr</filename> prefix. You can optionally use the
|
---|
| 82 | <command>go</command> script in the root of the source tree, to
|
---|
| 83 | run the same commands, which are then immediately followed by the
|
---|
| 84 | <command>adsl-setup</command> script.</para>
|
---|
| 85 |
|
---|
| 86 | </sect2>
|
---|
| 87 |
|
---|
| 88 | <sect2>
|
---|
[def11b7] | 89 | <title>Configuring
|
---|
| 90 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application></title>
|
---|
[246c904] | 91 |
|
---|
| 92 | <sect3><title>Config files</title>
|
---|
| 93 | <para><filename>/etc/ppp/pppoe.conf</filename>,
|
---|
| 94 | <filename>/etc/ppp/firewall-standalone</filename>,
|
---|
| 95 | <filename>/etc/ppp/firewall-masq</filename>,
|
---|
| 96 | <filename>/etc/ppp/pppoe-server-options</filename>,
|
---|
| 97 | <filename>/etc/resolv.conf</filename>,
|
---|
| 98 | <filename>/etc/ppp/pap-seecrets</filename>,
|
---|
| 99 | <filename>/etc/ppp/chap-secrets</filename></para></sect3>
|
---|
| 100 |
|
---|
| 101 | <sect3><title>Configuration Information</title>
|
---|
| 102 |
|
---|
[def11b7] | 103 | <para>To configure
|
---|
| 104 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
| 105 | after installation, you should run the <command>adsl-setup</command>
|
---|
| 106 | script.</para>
|
---|
[246c904] | 107 |
|
---|
| 108 | <para>When configuring your connection, you will need to have your
|
---|
| 109 | <acronym>ISP</acronym>'s nameserver information available, as well as your
|
---|
| 110 | username and password. You will also be asked whether to configure a
|
---|
| 111 | dial-on-demand or a constant connection. If your service provider does not
|
---|
| 112 | charge by the minute, it is usually good to have a bootscript handle the
|
---|
| 113 | connection for you. You can, of course, choose not to install the
|
---|
| 114 | following script, and start your connection manually with the
|
---|
| 115 | <command>adsl-start</command> script.</para>
|
---|
| 116 |
|
---|
| 117 | <para><emphasis>Optionally</emphasis> install the
|
---|
| 118 | <filename>/etc/sysconfig/network-devices/services/pppoe</filename> service
|
---|
| 119 | script included with the <xref linkend="intro-important-bootscripts"/>
|
---|
| 120 | package.</para>
|
---|
| 121 |
|
---|
| 122 | <screen><userinput><command>make install-service-pppoe</command></userinput></screen>
|
---|
| 123 |
|
---|
| 124 | <para>Now create the config file for use with the <filename>pppoe</filename>
|
---|
| 125 | service script:</para>
|
---|
| 126 |
|
---|
[802e6fe7] | 127 | <note><para>If you have previously configured the network interface that
|
---|
[def11b7] | 128 | will now use <acronym>PPPoE</acronym>, you should remove the interface
|
---|
| 129 | configuration files for that interface:</para>
|
---|
| 130 |
|
---|
| 131 | <para><command><userinput>rm
|
---|
| 132 | /etc/sysconfig/network-devices/ifconfig.eth0/*</userinput></command></para>
|
---|
| 133 | </note>
|
---|
[afa198d] | 134 |
|
---|
| 135 | <screen><userinput><command>install -d /etc/sysconfig/network-devices/ifconfig.eth0 &&
|
---|
| 136 | cat > /etc/sysconfig/network-devices/ifconfig.eth0/pppoe << "EOF"</command>
|
---|
| 137 | ONBOOT="yes"
|
---|
| 138 | SERVICE="pppoe"
|
---|
[246c904] | 139 | <command>EOF</command></userinput></screen>
|
---|
| 140 |
|
---|
[afa198d] | 141 | <!-- A TYPE="[user/kernel]" will be added at a later date when kernel
|
---|
| 142 | mode pppoe is described here. -->
|
---|
[246c904] | 143 | </sect3>
|
---|
| 144 |
|
---|
| 145 | </sect2>
|
---|
| 146 |
|
---|
| 147 | <sect2>
|
---|
| 148 | <title>Contents</title>
|
---|
| 149 |
|
---|
[def11b7] | 150 | <para>The
|
---|
| 151 | <application><acronym>RP</acronym>-<acronym>PPPoE</acronym></application>
|
---|
| 152 | package contains <command>adsl-setup</command>, <command>adsl-start</command>,
|
---|
[246c904] | 153 | <command>adsl-status</command>, <command>adsl-stop</command>, <command>
|
---|
| 154 | pppoe</command>, <command>pppoe-relay</command>, <command>pppoe-server
|
---|
| 155 | </command> and <command>pppoe-sniff</command>.</para>
|
---|
| 156 |
|
---|
| 157 | </sect2>
|
---|
| 158 |
|
---|
| 159 | <sect2><title>Description</title>
|
---|
| 160 |
|
---|
| 161 | <sect3><title>adsl-setup</title>
|
---|
| 162 | <para>A script for configuring the client. Configuration is then stored
|
---|
| 163 | in <filename>/etc/ppp/pppoe.conf</filename>.</para></sect3>
|
---|
| 164 |
|
---|
| 165 | <sect3><title>adsl-start</title>
|
---|
| 166 | <para><command>adsl-start</command> starts the client using the options
|
---|
| 167 | specified in <filename>/etc/ppp/pppoe.conf</filename>.</para></sect3>
|
---|
| 168 |
|
---|
| 169 | <sect3><title>adsl-status</title>
|
---|
| 170 | <para><command>adsl-status</command> displays the status of the
|
---|
| 171 | <acronym>ADSL</acronym> connection.</para></sect3>
|
---|
| 172 |
|
---|
| 173 | <sect3><title>adsl-stop</title>
|
---|
| 174 | <para><command>adsl-stop</command> stops the client.</para></sect3>
|
---|
| 175 |
|
---|
| 176 | <sect3><title>pppoe</title>
|
---|
| 177 | <para>This is the client itself. Generally it should not be started on its
|
---|
| 178 | own.</para></sect3>
|
---|
| 179 |
|
---|
| 180 | <sect3><title>pppoe-relay</title>
|
---|
[def11b7] | 181 | <para><command>pppoe-relay</command> starts the server relay
|
---|
| 182 | agent.</para></sect3>
|
---|
[246c904] | 183 |
|
---|
| 184 | <sect3><title>pppoe-server</title>
|
---|
[def11b7] | 185 | <para><command>pppoe-server</command> starts the server
|
---|
| 186 | component.</para></sect3>
|
---|
[246c904] | 187 |
|
---|
| 188 | <sect3><title>pppoe-sniff</title>
|
---|
[def11b7] | 189 | <para>A small network sniffer designed to assist in setting
|
---|
| 190 | <envar>PPPOE_EXTRA</envar> settings.</para></sect3>
|
---|
[246c904] | 191 |
|
---|
| 192 | </sect2>
|
---|
[f45b1953] | 193 |
|
---|
| 194 | </sect1>
|
---|
[3cfb81c] | 195 |
|
---|