diff --git a/docs/site-example/site.conf b/docs/site-example/site.conf index 845401c6a4086e333024e16ce7e11415abc50fc6..310f8bc567cb6caa1b99809491c5036b2a3560e0 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 a5b31745374ba5028a6e1e8e79a886a288167e44..acbcb8770179c8f8913c541334f3dc960c45b795 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 = {