obsolete-buildroot/README.pppoe

   1 OPENWRT PPPOECD NOTES
   2 =====================
   3
   4 1. GENERAL
   5 ----------
   6
   7 This package is used to estabilish basic connection to the
   8 Internet via DSL/ADSL modems. This is also known as the
   9 PPPoE or PPP-over-Ethernet connection.
  10
  11 The PPPOECD program included in the OpenWrt distribution is a
  12 modified version of the PPPOECD that is present in the original
  13 Linksys firmware.
  14
  15 This modified version is directly supported by the OpenWrt
  16 startup scripts.
  17
  18 2. BUILDING
  19 -----------
  20
  21 If you have a pre-compiled PPPOECD package, skip this section.
  22
  23 PPPOECD can be built in two ways. As an integrated part
  24 of the OpenWrt FLASH image or as an .ipk package that can
  25 be installed separately.
  26
  27 To build PPPOECD as an embedded component, add "pppoecd" to the
  28 TARGETS variable in the main OpenWrt Makefile before the
  29 "openwrt-bin" value.
  30
  31 To build as a standalone package, add "pppoecd" to the
  32 PACKAGES variable in the main OpenWrt Makefile.
  33
  34 3. NVRAM variables
  35 ------------------
  36
  37 In order for the PPPoE link to be established by the networking
  38 scripts the following NVRAM variables must be present:
  39
  40 wan_ifname      Should be set to: ppp0
  41
  42 wan_proto       Should be set to: pppoe
  43
  44 pppoe_ifname    Set it to the WAN interface on which the PPPoE
  45                 is to function. On a 2.0 or a GS model it is
  46                 usually vlan1. The 1.0 and 1.1 models used vlan2.
  47
  48 ppp_username    User name for your PPPoE connection.
  49
  50 ppp_passwd      Password for the connection.
  51
  52 ppp_redialperiod Time between reconnect attempts.
  53                  Usualy set to 30.
  54
  55 ppp_idletime    Time the link has to stay dead before reconnecting.
  56                 Usually set to 5.
  57
  58 wan_mtu         The Maxumum Transfer Unit for the PPPoE connection.
  59                 Typically 1492.
  60
  61 Please consult the OpenWrt WIKI or the forum for more
  62 information on NVRAM variables.
  63
  64
  65 4. STARTUP / SHUTDOWN
  66 ---------------------
  67
  68 OpenWrt will attempt to connect using PPPOECD when starting up.
  69 The script responsible for that is /etc/init.d/S40network.
  70
  71 You can also manually start the PPPOECD by doing:
  72
  73   ifup wan
  74
  75 Similarly you can shutdown the PPPOECD by doing:
  76
  77   ifdown wan
  78
  79
  80 5. CONFIGURATION
  81 ----------------
  82
  83 PPPoE firewall configuration is the standard OpenWrt configuration
  84 in /etc/init.d/S45firewall that applies to all the other types
  85 of connections to the Internet.
  86
  87 Additional actions can be performed when connecting or disconnecting
  88 by modifying "ip-up" and "ip-down" scripts in the /etc/ppp directory.
  89
  90 When connecting, PPPOECD creates /tmp/resolv.conf file that contains
  91 DNS server entries as supplied by the ISP. The standard ip-up
  92 script will also add a default route leading via the PPPoE link.
  93
  94 6. DIFFERENCES FROM THE ORIGINAL PPPOECD
  95 ----------------------------------------
  96
  97 The main difference is the location of files. Original Linksys
  98 PPPOECD operated almost exclusively in the /tmp/ppp directory. This
  99 however prevents any persistent configuration of the program via
 100 ip-up or ip-down scripts. Also the program itself was located in
 101 /usr/sbin whereas OpenWrt scripts expect it to be in /sbin directory.
 102
 103