From b7970426e9e2d08cc51110fd9f2a882afcfed7a2 Mon Sep 17 00:00:00 2001
From: Nils Schneider <nils@nilsschneider.net>
Date: Wed, 16 Jul 2014 14:59:26 +0200
Subject: [PATCH] gluon-batman-on-wan: docs
---
docs/features/mesh-on-wan.rst | 20 ++++++++++++++++++++
docs/index.rst | 1 +
docs/user/site.rst | 3 +++
3 files changed, 24 insertions(+)
create mode 100644 docs/features/mesh-on-wan.rst
diff --git a/docs/features/mesh-on-wan.rst b/docs/features/mesh-on-wan.rst
new file mode 100644
index 000000000..2c6b0bb0f
--- /dev/null
+++ b/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.
diff --git a/docs/index.rst b/docs/index.rst
index 732fb26a4..603474d3f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -41,6 +41,7 @@ Features
features/batman-adv
features/alfred
features/autoupdater
+ features/mesh-on-wan
Developer Documentation
-----------------------
diff --git a/docs/user/site.rst b/docs/user/site.rst
index 700b8ad2d..f4f61de6a 100644
--- a/docs/user/site.rst
+++ b/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.
::
--
GitLab