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