docs/network.tex

   1 The network configuration is stored in \texttt{/etc/config/network}
   2 and is divided into interface configurations.
   3 Each interface configuration either refers directly to an ethernet/wifi
   4 interface (\texttt{eth0}, \texttt{wl0}, ..) or to a bridge containing multiple interfaces.
   5 It looks like this:
   6
   7 \begin{Verbatim}
   8 config interface     "lan"
   9     option ifname    "eth0"
  10     option proto     "static"
  11     option ipaddr    "192.168.1.1"
  12     option netmask   "255.255.255.0"
  13     option gateway   "192.168.1.254"
  14     option dns       "192.168.1.254"
  15 \end{Verbatim}
  16
  17 \texttt{ifname} specifies the Linux interface name.
  18 If you want to use bridging on one or more interfaces, set \texttt{ifname} to a list
  19 of interfaces and add:
  20 \begin{Verbatim}
  21     option type     "bridge"
  22 \end{Verbatim}
  23
  24 It is possible to use VLAN tagging on an interface simply by adding the VLAN IDs
  25 to it, e.g. \texttt{eth0.1}. These can be nested as well. See the switch section for
  26 this.
  27
  28 \begin{Verbatim}
  29 config inter
  30 \end{Verbatim}
  31
  32 This sets up a simple static configuration for \texttt{eth0}. \texttt{proto} specifies the
  33 protocol used for the interface. The default image usually provides \texttt{'none'}
  34 \texttt{'static'}, \texttt{'dhcp'} and \texttt{'pppoe'}. Others can be added by installing additional
  35 packages.
  36
  37 When using the \texttt{'static'} method like in the example, the  options \texttt{ipaddr} and
  38 \texttt{netmask} are mandatory, while \texttt{gateway} and \texttt{dns} are optional.
  39 You can specify more than one DNS server, separated with spaces:
  40
  41 \begin{Verbatim}
  42 config interface     "lan"
  43     option ifname    "eth0"
  44     option proto     "static"
  45     ...
  46     option dns       "192.168.1.254 192.168.1.253" (optional)
  47 \end{Verbatim}
  48
  49 DHCP currently only accepts \texttt{ipaddr} (IP address to request from the server)
  50 and \texttt{hostname} (client hostname identify as) - both are optional.
  51
  52 \begin{Verbatim}
  53 config interface     "lan"
  54     option ifname    "eth0"
  55     option proto     "dhcp"
  56     option ipaddr    "192.168.1.1" (optional)
  57     option hostname  "openwrt"     (optional)
  58 \end{Verbatim}
  59
  60 PPP based protocols (\texttt{pppoe}, \texttt{pptp}, ...) accept these options:
  61 \begin{itemize}
  62     \item{username} \\
  63         The PPP username (usually with PAP authentication)
  64     \item{password} \\
  65         The PPP password
  66     \item{keepalive} \\
  67         Ping the PPP server (using LCP). The value of this option
  68         specifies the maximum number of failed pings before reconnecting.
  69         The ping interval defaults to 5, but can be changed by appending
  70         ",<interval>" to the keepalive value
  71     \item{demand} \\
  72         Use Dial on Demand (value specifies the maximum idle time.
  73     \item{server: (pptp)} \\
  74         The remote pptp server IP
  75 \end{itemize}
  76
  77 For all protocol types, you can also specify the MTU by using the \texttt{mtu} option.
  78 A sample PPPoE config would look like this:
  79
  80 \begin{Verbatim}
  81 config interface     "lan"
  82     option ifname    "eth0"
  83     option proto     "pppoe"
  84     option username  "username"
  85     option password  "openwrt"
  86     option mtu       "1492"      (optional)
  87 \end{Verbatim}
  88
  89 \subsubsection{Setting up static routes}
  90
  91 You can set up static routes for a specific interface that will be brought up
  92 after the interface is configured.
  93
  94 Simply add a config section like this:
  95
  96 \begin{Verbatim}
  97 config route foo
  98         option interface  "lan"
  99         option target     "1.1.1.0"
 100         option netmask    "255.255.255.0"
 101         option gateway    "192.168.1.1"
 102 \end{Verbatim}
 103
 104 The name for the route section is optional, the \texttt{interface}, \texttt{target} and
 105 \texttt{gateway} options are mandatory.
 106 Leaving out the \texttt{netmask} option will turn the route into a host route.
 107
 108 \subsubsection{Setting up the switch (currently broadcom only)}
 109
 110 The switch configuration is set by adding a \texttt{'switch'} config section.
 111 Example:
 112
 113 \begin{Verbatim}
 114 config switch       "eth0"
 115     option vlan0    "1 2 3 4 5*"
 116     option vlan1    "0 5"
 117 \end{Verbatim}
 118
 119 On Broadcom hardware the section name needs to be eth0, as the switch driver
 120 does not detect the switch on any other physical device.
 121 Every vlan option needs to have the name vlan<n> where <n> is the VLAN number
 122 as used in the switch driver.
 123 As value it takes a list of ports with these optional suffixes:
 124
 125 \begin{itemize}
 126     \item{\texttt{'*'}:}
 127         Set the default VLAN (PVID) of the Port to the current VLAN
 128     \item{\texttt{'u'}:}
 129         Force the port to be untagged
 130     \item{\texttt{'t'}:}
 131         Force the port to be tagged
 132 \end{itemize}
 133
 134 The CPU port defaults to tagged, all other ports to untagged.
 135 On Broadcom hardware the CPU port is always 5. The other ports may vary with
 136 different hardware.
 137
 138 For instance, if you wish to have 3 vlans, like one 3-port switch, 1 port in a
 139 DMZ, and another one as your WAN interface, use the following configuration :
 140
 141 \begin{Verbatim}
 142 config switch       "eth0"
 143     option vlan0    "1 2 3 5*"
 144     option vlan1    "0 5"
 145     option vlan2    "4 5"
 146 \end{Verbatim}
 147
 148 Three interfaces will be automatically created using this switch layout :
 149 \texttt{eth0.0} (vlan0), \texttt{eth0.1} (vlan1) and \texttt{eth0.2} (vlan2).
 150 You can then assign those interfaces to a custom network configuration name
 151 like \texttt{lan}, \texttt{wan} or \texttt{dmz} for instance.
 152
 153 \subsubsection{Setting up IPv6 connectivity}
 154
 155 OpenWrt supports IPv6 connectivity using PPP, Tunnel brokers or static
 156 assignment.
 157
 158 If you use PPP, IPv6 will be setup using IP6CP and there is nothing to
 159 configure.
 160
 161 To setup an IPv6 tunnel to a tunnel broker, you can install the
 162 \texttt{6scripts} package and edit the \texttt{/etc/config/6tunnel}
 163 file and change the settings accordingly :
 164
 165 \begin{Verbatim}
 166 config 6tunnel
 167         option tnlifname     'sixbone'
 168         option remoteip4     '1.0.0.1'
 169         option localip4      '1.0.0.2'
 170         option localip6      '2001::DEAD::BEEF::1'
 171 \end{Verbatim}
 172
 173 \begin{itemize}
 174     \item{\texttt{'tnlifname'}:}
 175         Set the interface name of the IPv6 in IPv4 tunnel
 176     \item{\texttt{'remoteip4'}:}
 177         IP address of the remote end to establish the 6in4 tunnel.
 178         This address is given by the tunnel broker
 179     \item{\texttt{'localip4'}:}
 180         IP address of your router to establish the 6in4 tunnel.
 181         It will usually match your WAN IP address.
 182     \item{\texttt{'localip6'}:}
 183         IPv6 address to setup on your tunnel side
 184         This address is given by the tunnel broker
 185 \end{itemize}
 186
 187 Using the same package you can also setup an IPv6 bridged connection:
 188
 189 \begin{Verbatim}
 190 config 6bridge
 191         option bridge   'br6'
 192 \end{Verbatim}
 193
 194 By default the script bridges the WAN interface with the LAN interface
 195 and uses ebtables to filter anything that is not IPv6 on the bridge.
 196 This configuration is particularly useful if your router is not
 197 IPv6 ND proxy capable (see: http://www.rfc-archive.org/getrfc.php?rfc=4389).
 198
 199 IPv6 static addressing is also supported using a similar setup as
 200 IPv4 but with the \texttt{ip6} prefixing (when applicable).
 201
 202 \begin{Verbatim}
 203 config interface     "lan"
 204     option ifname    "eth0"
 205     option proto     "static"
 206     option ip6addr   "fe80::200:ff:fe00:0/64"
 207     option ip6gw     "2001::DEAF:BEE:1"
 208 \end{Verbatim}