add basic documentation for the config file api
[openwrt-10.03/.git] / docs / network.txt
1         Network configuration in buildroot-ng
2
3
4 The network configuration in buildroot-ng is stored in /etc/config/network
5 and is divided into interface configurations.
6 Each interface configuration either refers directly to an ethernet/wifi
7 interface (eth0, wl0, ..) or to a bridge containing multiple interfaces.
8 It looks like this:
9
10         config interface        "lan"
11                 option ifname   "eth0"
12                 option proto    "static"
13                 option ipaddr   "192.168.1.1"
14                 option netmask  "255.255.255.0"
15                 option gateway  "192.168.1.254"
16                 option dns              "192.168.1.254"
17
18 "ifname" specifies the Linux interface name.
19 If you want to use bridging on one or more interfaces, set "ifname" to a list
20 of interfaces and add:
21                 option type     "bridge"
22
23 It is possible to use VLAN tagging on an interface simply by adding the VLAN IDs
24 to it, e.g. "eth0.1". These can be nested as well.
25
26 This sets up a simple static configuration for eth0. "proto" specifies the
27 'protocol' used for the interface. The default image usually provides 'none'
28 'static', 'dhcp' and 'pppoe'. Others can be added by installing additional
29 packages.
30
31 When using the 'static' method like in the example, the  options "ipaddr" and 
32 "netmask" are mandatory, while "gateway" and "dns" are optional.
33 DHCP currently only accepts "ipaddr" (IP address to request from the server)
34 and "hostname" (client hostname identify as) - both are optional.
35
36 PPP based protocols (pppoe, pptp, ...) accept these options:
37         username:
38                 The PPP username (usually with PAP authentication)
39         password:
40                 The PPP password
41         keepalive:
42                 Ping the PPP server (using LCP). The value of this option
43                 specifies the maximum number of failed pings before reconnecting.
44                 The ping interval defaults to 5, but can be changed by appending 
45                 ",<interval>" to the keepalive value
46         demand:
47                 Use Dial on Demand (value specifies the maximum idle time)
48
49 For all protocol types, you can also specify the MTU by using the "mtu" option.
50