From 548c70d170a66ce82058f53cb11d403439c7324c Mon Sep 17 00:00:00 2001
From: Matthias Schiffer <mschiffer@universe-factory.net>
Date: Thu, 14 May 2015 02:13:01 +0200
Subject: [PATCH] docs: mention fastd_mesh_vpn.enabled setting
---
docs/site-example/site.conf | 1 +
docs/user/site.rst | 5 ++++-
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/docs/site-example/site.conf b/docs/site-example/site.conf
index 845401c6a..310f8bc56 100644
--- a/docs/site-example/site.conf
+++ b/docs/site-example/site.conf
@@ -89,6 +89,7 @@
fastd_mesh_vpn = {
-- List of crypto-methods to use.
methods = {'salsa2012+umac'},
+ -- enabled = true,
-- configurable = true,
mtu = 1426,
diff --git a/docs/user/site.rst b/docs/user/site.rst
index a5b317453..acbcb8770 100644
--- a/docs/user/site.rst
+++ b/docs/user/site.rst
@@ -99,7 +99,9 @@ next_node : package
fastd_mesh_vpn
Remote server setup for the fastd-based mesh VPN.
- If `configurable` is false or unset, the method list will be replaced on updates
+ The `enabled` option can be set to true to enable the VPN by default.
+
+ 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
@@ -112,6 +114,7 @@ fastd_mesh_vpn
fastd_mesh_vpn = {
methods = {'salsa2012+umac'},
+ -- enabled = true,
-- configurable = true,
mtu = 1426,
groups = {
--
GitLab