Browse Source

gluon-batman-on-wan: docs

Nils Schneider 9 years ago
parent
commit
b7970426e9
3 changed files with 24 additions and 0 deletions
  1. 20 0
      docs/features/mesh-on-wan.rst
  2. 1 0
      docs/index.rst
  3. 3 0
      docs/user/site.rst

+ 20 - 0
docs/features/mesh-on-wan.rst

@@ -0,0 +1,20 @@
+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.

+ 1 - 0
docs/index.rst

@@ -41,6 +41,7 @@ Features
    features/batman-adv
    features/alfred
    features/autoupdater
+   features/mesh-on-wan
 
 Developer Documentation
 -----------------------

+ 3 - 0
docs/user/site.rst

@@ -100,6 +100,9 @@ fastd_mesh_vpn
         }
       }
 
+mesh_on_wan : optional
+    Enables the mesh on the WAN port (``true`` or ``false``).
+
 autoupdater : package
     Configuration for the autoupdater feature of Gluon.
     ::