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