jsoninfo: simplify parsing by removing the "data": [] array surrounding the data
[olsrd.git] / README-Olsr-Extensions
index 55cb7d3..a6e9d13 100644 (file)
@@ -221,6 +221,8 @@ More information on NIIT can be found at: http://wiki.freifunk.net/Niit
     5.) Smart gateways (asymmetric gateway tunnels)
 *******************************************************
 
+    5.1) Introduction
+
 The smart gateway mechanism was written by Markus Kittenberger and
 Henning Rogge to allow an OLSR user to directly choose their default
 Internet gateway instead of relying on the hop by hop decisions on
@@ -246,22 +248,26 @@ SmartGateway <yes/no>
 All other parameters will be ignored if SmartGateway is set to "no"
 (the default is "no").
 
-On the client side there are two additional parameters.
-The first parameter controls whether you want to allow the selection
-of an outgoing ipv4 gateway with NAT (Network Address Translation).
-The default setting is "yes".
 
-SmartGatewayAllowNAT <yes/no>
+    5.2) Client Side
+
+1- SmartGatewayAllowNAT controls whether you want to allow the selection
+   of an outgoing ipv4 gateway with NAT (Network Address Translation).
+   The default setting is "yes".
+2- SmartGatewayPeriod determines the period (in milliseconds) on which
+   a new smart gateway selection is performed.
+   The default setting is 10000 milliseconds.
+3- SmartGatewayStableCount determines the number of times the link state
+   database must be stable before a new smart gateway is selected.
+   The default setting is 6.
+4- SmartGatewayThreshold controls whether you want to allow re-selection
+   of a new outgoing gateway if its routing cost is lower or equal to the
+   configured percentage of the routing cost of the current gateway.
+   The default setting is 0, which disables it.
 
-The second parameter controls whether you want to allow re-selection
-of a new outgoing gateway if its routing cost is lower or equal to the
-configured percentage of the routing cost of the current gateway.
-The default setting is 0, which disables it.
 
-SmartGatewayThreshold <threshold>
+    5.3) Uplink Side
 
-The uplink side of the smart gateway code has four parameters to
-set up the type of the uplink:
 1- SmartGatewayUplink defines which kind of uplink is exported to the
    other mesh nodes. The existence of the uplink is detected by looking
    for a local HNA of 0.0.0.0/0, ::ffff:0:0/96 or 2000::/3. The default
@@ -277,10 +283,8 @@ set up the type of the uplink:
    translation. The maximum prefix length is 64 bits,
    the default is ::/0 (no prefix).
 
-SmartGatewayUplink <none/ipv4/ipv6/both>
-SmartGatewayUplinkNAT <yes/no>
-SmartGatewaySpeed <uplink> <downlink>
-SmartGatewayPrefix <prefix>
+
+    5.4) Architecture & Notes
 
 On the smart gateway server (the OLSR instance announcing 'Internet here!' via
 HNA 0/0 or similar) the implicit tunl0 interface is used to forward incoming