Merge pull request #6 from kmpm/feature/wireless

added wireless interface example

1 files changed, 55 insertions, 0 deletions

diff --git a/docs/network-interfaces.rst b/docs/network-interfaces.rst
index 2ff615b6..cc0f100f 100644
--- a/docs/network-interfaces.rst
+++ b/docs/network-interfaces.rst
@@ -226,6 +226,61 @@ statistics`. Statistics available are driver dependent.
        tx_packets: 2179
   [...]
 
+Wireless Interfaces
+-------------------
+Wireless, for example WiFi 802.11 b/g/n, interfaces allow for connection to
+WiFi networks or act as an access-point.
+If your device is configurable it will appear as `wlan` in `show interfaces`.
+
+To be able to use the wireless interfaces you will first need to set a
+regulatory domain with the country code of your locaion.
+
+.. code-block:: sh
+
+  set system wifi-regulatory-domain SE
+
+An example on how to set it up as an access point:
+
+.. code-block:: sh
+
+  set interfaces wireless wlan0 address '192.168.99.1/24'
+  set interfaces wireless wlan0 type access-point
+  set interfaces wireless wlan0 channel 1
+  set interfaces wireless wlan0 ssid '<your ssid>'
+  set interfaces wireless wlan0 security wpa mode wpa2
+  set interfaces wireless wlan0 security wpa cipher CCMP
+  set interfaces wireless wlan0 security wpa passphrase '<your passphrase>'
+
+Resulting in
+
+.. code-block:: sh
+
+  interfaces {
+    [...]
+    wireless wlan0 {
+          address 192.168.99.1/24
+          channel 1
+          mode g
+          security {
+              wpa {
+                  cipher CCMP
+                  mode wpa2
+                  passphrase "<your passphrase>"
+              }
+          }
+          ssid "<your ssid>"
+          type access-point
+      }
+  }
+  system {
+    [...]
+    wifi-regulatory-domain SE
+  }
+
+To get it to work as a access point with this configuration you will need
+to set up a DHCP server to work with that network.
+
+
 VLAN Sub-Interfaces (802.1Q)
 ----------------------------