Browse Source

docs: user/site: add information on gluon-mesh-vpn-tunneldigger configuration

Matthias Schiffer 7 years ago
parent
commit
e6d0b58d91
1 changed files with 12 additions and 0 deletions
  1. 12 0
      docs/user/site.rst

+ 12 - 0
docs/user/site.rst

@@ -193,6 +193,14 @@ mesh_vpn
     configured peers support both the ``null`` method and methods with encryption.
 
     You can set syslog_level from verbose (default) to warn to reduce syslog output.
+
+    The `tunneldigger` section is used to define the *tunneldigger* broker list.
+
+    **Note:** It doesn't make sense to include both `fastd` and `tunneldigger`
+    sections in the same configuration file, as only one of the packages *gluon-mesh-vpn-fastd*
+    and *gluon-mesh-vpn-tunneldigger* should be installed with the current
+    implementation.
+
     ::
 
       mesh_vpn = {
@@ -238,6 +246,10 @@ mesh_vpn
           },
         },
 
+        tunneldigger = {
+          brokers = {'vpn1.alpha-centauri.freifunk.net'}
+        },
+
         bandwidth_limit = {
           -- The bandwidth limit can be enabled by default here.
           enabled = false,