From 86bd5a1da5afcf02b45df2c8ea93c93f2e8676a2 Mon Sep 17 00:00:00 2001
From: Matthias Schiffer <mschiffer@universe-factory.net>
Date: Wed, 28 Oct 2015 19:59:51 +0100
Subject: [PATCH] docs: improve wired mesh documentation

Fixes #376
---
 docs/features/mesh-on-wan.rst | 18 ----------
 docs/features/wired-mesh.rst  | 65 +++++++++++++++++++++++++++++++++++
 docs/index.rst                |  2 +-
 3 files changed, 66 insertions(+), 19 deletions(-)
 delete mode 100644 docs/features/mesh-on-wan.rst
 create mode 100644 docs/features/wired-mesh.rst

diff --git a/docs/features/mesh-on-wan.rst b/docs/features/mesh-on-wan.rst
deleted file mode 100644
index 2f1a8a47..00000000
--- a/docs/features/mesh-on-wan.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-Mesh on WAN
-===========
-
-It's possible to enable the mesh on the WAN port like this::
-
-  uci set network.mesh_wan.auto=1
-  uci commit
-
-It may also be disabled again by running::
-
-  uci set network.mesh_wan.auto=0
-  uci commit
-
-site.conf
----------
-
-The optional option ``mesh_on_wan`` may be set to ``true`` (``false`` is the
-default) to enable meshing on the WAN port without further configuration.
diff --git a/docs/features/wired-mesh.rst b/docs/features/wired-mesh.rst
new file mode 100644
index 00000000..93021638
--- /dev/null
+++ b/docs/features/wired-mesh.rst
@@ -0,0 +1,65 @@
+Wired mesh (Mesh-on-WAN/LAN)
+============================
+
+In addition to meshing over WLAN and VPN, it is also possible to
+configured wired meshing over the LAN or WAN ports. This allows
+nodes to be connected directly or over wireless bridges.
+
+Mesh-on-WAN can be enabled in addition to the mesh VPN, so multiple nodes
+in the same local network that is used as VPN uplink can also mesh directly.
+Enabling Mesh-on-WAN should be avoided if the local network is also bridged with
+a WLAN access point, as meshing over batman-adv causes large amounts of
+multicast traffic, which will take up a lot of airtime.
+
+Enabling Mesh-on-LAN will replace the normal "client network" function
+of the LAN ports, as client network ports may never be connected (so care must be taken to always
+enable Mesh-on-LAN before connecting two nodes' LAN ports).
+
+Configuration
+~~~~~~~~~~~~~
+
+Both Mesh-on-WAN and Mesh-on-LAN can be configured on the "Network" page
+of the *Expert Mode* (if the package ``gluon-luci-portconfig`` is installed).
+
+It is also possible to enable Mesh-on-WAN and Mesh-on-LAN by default by
+adding ``mesh_on_wan = true`` and ``mesh_on_lan = true`` to ``site.conf``.
+
+Commandline configuration
+-------------------------
+
+Mesh-on-WAN
+...........
+
+It's possible to enable Mesh-on-WAN like this::
+
+  uci set network.mesh_wan.auto=1
+  uci commit
+
+It may be disabled by running::
+
+  uci set network.mesh_wan.auto=0
+  uci commit
+
+
+Mesh-on-LAN
+...........
+
+Configuring Mesh-on-LAN is a bit more complicated::
+
+  uci set network.mesh_lan.auto=1
+  for ifname in $(cat /lib/gluon/core/sysconfig/lan_ifname); do
+    uci del_list network.client.ifname=$ifname
+  done
+  uci commit
+
+It may be disabled by running::
+
+  uci set network.mesh_wan.auto=0
+  for ifname in $(cat /lib/gluon/core/sysconfig/lan_ifname); do
+    uci add_list network.client.ifname=$ifname
+  done
+  uci commit
+
+Please note that this configuration has changed in Gluon v2015.2. Using
+the old commands on v2015.2 will break the corresponding Export Mode
+settings.
diff --git a/docs/index.rst b/docs/index.rst
index 1719c239..692b2e50 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,7 +25,7 @@ Features
    features/configmode
    features/autoupdater
    features/private-wlan
-   features/mesh-on-wan
+   features/wired-mesh
    features/announce
    features/authorized-keys
    features/roles