doc: Ethernet provisioning support

diff --git a/doc/config-format.txt b/doc/config-format.txt
index d8146be231f4b584bba1e77589d1d473f14b98ca..7be6d05ebd40c1e2b21f8fb23a1c006aee54a321 100644 (file)
--- a/doc/config-format.txt
+++ b/doc/config-format.txt
@@ -34,7 +34,33 @@ Each provisioned service must start with the [service_*] tag. Replace * with
 an identifier unique to the config file.
 
 Allowed fields:
-- Type: Service type. We currently only support wifi.
+- Type: Service type. We currently only support wifi and ethernet.
+- IPv4: The IPv4 address, netmask and gateway. Format of the entry
+  is network/netmask/gateway. The mask length can be used instead
+  of netmask.
+  Example: 192.168.1.2/24/192.168.1.1
+           192.168.200.100/255.255.255.0/192.168.200.1
+- IPv6: The IPv6 address, prefix length and gateway. Format of the entry
+  is network/prefixlen/gateway. For IPv6 addresses only prefix length is
+  accepted.
+  Example: 2001:db8::2/64/2001:db8::1
+- IPv6.Privacy: IPv6 privacy option. Value can be either "disabled",
+  "enabled" or "prefered". See use_tempaddr variable description in Linux
+  kernel Documentation/networking/ip-sysctl.txt file.
+- MAC: MAC address of the interface where this setting should be applied.
+  The MAC address is optional and if it is missing, then the first found
+  interface is used. The byte values must have prefix 0 added,
+  the bytes must be separated by ":" char and its length must be
+  exactly 2 + 1 + 2 + 1 + 2 + 1 + 2 + 1 + 2 + 1 + 2 = 17 characters.
+- Nameservers: Comma separated list of nameservers
+- SearchDomains: Comma separated list of DNS search domains
+- Timeservers: Comma separated list of timeservers
+- Domain: Domain name to be used
+
+If IPv4 address is missing then DHCP is used. If IPv6 address is missing,
+then SLAAC or DHCPv6 is used.
+
+The following options are valid if Type is "wifi"
 - Name: A string representation of an 802.11 SSID. If the SSID field is
   present, the Name field is ignored.
 - SSID: A hexadecimal representation of an 802.11 SSID. If the SSID field is
@@ -99,3 +125,20 @@ EAP = peap
 CACertFile = /home/user/.cert/ca.pem
 Phase2 = MSCHAPV2
 Identity = user
+
+[service_home_ethernet]
+Type = ethernet
+IPv4 = 192.168.1.42/255.255.255.0/192.168.1.1
+IPv6 = 2001:db8::42/64/2001:db8::1
+MAC = 01:02:03:04:05:06
+Nameservers = 10.2.3.4,192.168.1.99
+SearchDomains = my.home,isp.net
+Timeservers = 10.172.2.1,ntp.my.isp.net
+Domain = my.home
+
+[service_home_wifi]
+Type = wifi
+Name = my_home_wifi
+Passphrase = secret
+IPv4 = 192.168.2.2/255.255.255.0/192.168.2.1
+MAC = 06:05:04:03:02:01