From 2e5c8f39ccc3583ae39382e60cdfe0bd9d54f152 Mon Sep 17 00:00:00 2001
From: Matthias Schiffer <mschiffer@universe-factory.net>
Date: Sun, 3 May 2015 21:11:12 +0200
Subject: [PATCH] docs: add some explanations regarding the fastd_mesh_vpn
"configurable" setting
---
docs/site-example/site.conf | 2 ++
docs/user/site.rst | 13 ++++++++++++-
2 files changed, 14 insertions(+), 1 deletion(-)
diff --git a/docs/site-example/site.conf b/docs/site-example/site.conf
index a25857a95..845401c6a 100644
--- a/docs/site-example/site.conf
+++ b/docs/site-example/site.conf
@@ -89,6 +89,8 @@
fastd_mesh_vpn = {
-- List of crypto-methods to use.
methods = {'salsa2012+umac'},
+ -- configurable = true,
+
mtu = 1426,
groups = {
backbone = {
diff --git a/docs/user/site.rst b/docs/user/site.rst
index 689dd51d8..113514519 100644
--- a/docs/user/site.rst
+++ b/docs/user/site.rst
@@ -97,11 +97,22 @@ next_node : package
fastd_mesh_vpn
- Remote server setup for vpn.
+ Remote server setup for the fastd-based mesh VPN.
+
+ If `configurable` is false or unset, the method list will be replaced on updates
+ with the list in the site configuration. Setting `configurable` to `true` will allow the user to
+ add the method ``null`` to the front of the method list or remove ``null`` from it,
+ and make this change survive updates. Settings configurable is necessary for the
+ package `gluon-luci-mesh-vpn-fastd`, which adds a UI for this configuration.
+
+ In any case, the ``null`` method should always be the first method in the list
+ if it is supported at all. You should only set `configurable` to `true` if the
+ configured peers support both the ``null`` method and methods with encryption.
::
fastd_mesh_vpn = {
methods = {'salsa2012+umac'},
+ -- configurable = true,
mtu = 1426,
groups = {
backbone = {
--
GitLab