files: update the default effective configuration file to current state
[olsrd.git] / files / olsrd.conf.default.full.txt
index 2fd69b3..f5c1058 100644 (file)
@@ -1,4 +1,3 @@
-#
 # OLSR.org routing daemon config file
 # This file contains ALL available options and explanations about them
 #
 
 # Debug level (0-9)
 # If set to 0 the daemon runs in the background, unless "NoFork" is set to true
-# (Default is 1)
+# (default is 1)
 
 # DebugLevel  1
 
 # IP version to use (4 or 6)
-# (Default is 4)
+# (default is 4)
 
 # IpVersion 4
 
 # related to the OLSR protocol and it's extensions
 
 # Clear the screen each time the internal state changes
-# (Default is yes)
+# (default is yes)
 
 # ClearScreen     yes
 
 # Should olsrd keep on running even if there are
 # no interfaces available? This is a good idea
 # for a PCMCIA/USB hotswap environment.
-# (Default is yes)
+# (default is yes)
 
 # AllowNoInt  yes
 
 # The lockfile is used to prevent multiple OLSR instances running at the same
 # time.
 # (Linux/BSD default is "/var/run/olsrd-ipv(4/6).lock")
-# (Win32 default is "<configfile>-ipv(4/6).lock")
+# (Win32     default is "configfile-ipv(4/6).lock")
 
-# LockFile "olsrd.lock"
+# LockFile "/var/run/olsrd-ipv4.lock"
 
-# Polling rate for OLSR sockets in seconds (float). 
-# (Default is 0.05)
+# Polling rate for OLSR sockets in seconds (float).
+# (default is 0.05)
 
 # Pollrate  0.05
 
 # Interval to poll network interfaces for configuration changes (in seconds).
 # Linux systems can detect interface statechange via netlink sockets.
-# (Defaults is 2.5)
+# (default is 2.5)
 
 # NicChgsPollInt  2.5
 
-# TOS(type of service) byte value for the IP header of control traffic.
-# Must be multiple of 4, because OLSR doesn't use ECN
-# (Default is 192, CS6 - Network Control)
+# TOS(type of service) value for the IP header of control traffic.
+# (default is 192)
 
 # TosValue 192
 
 # FIBMetric controls the metric value of the host-routes OLSRd sets.
-# - "flat" means that the metric value is always 2 (or as configured 
-#   with FIBMetricDefault). This is the preferred value because it helps 
-#   the linux kernel routing to clean up older routes.
+# - "flat" means that the metric value is always 2 (or as configured
+#   with FIBMetricDefault). This is the preferred value because it helps
+#   the linux kernel routing to clean up older routes
 # - "correct" use the hopcount as the metric value.
 # - "approx" use the hopcount as the metric value too, but does only update the
 #   hopcount if the nexthop changes too
-# (Default is "flat")
+# (default is "flat")
 
 # FIBMetric "flat"
+
+# Default FIB metric.
+# The kernel FIB does not need to know the metric of a route.
+# This saves us from enqueuing/dequeueing hopcount only changes.
+# (default is 2)
+
 # FIBMetricDefault 2
 
 #######################################
@@ -89,7 +93,7 @@
 # SrcIpRoutes tells OLSRd to set the Src flag of host routes to the originator-ip
 # of the node. In addition to this an additional localhost device is created
 # to make sure the returning traffic can be received.
-# (Default is "no")
+# (default is "no")
 
 # SrcIpRoutes no
 
 # 1 gets remapped by olsrd to 0 UNSPECIFIED (1 is reserved for ICMP redirects)
 # 2 KERNEL routes (not very wise to use)
 # 3 BOOT (should in fact not be used by routing daemons)
-# 4 STATIC 
+# 4 STATIC
 # 8 .. 15 various routing daemons (gated, zebra, bird, & co)
-# (defaults to 0 which gets replaced by an OS-specific default value
-# under linux 3 (BOOT) (for backward compatibility)
+# (default is 0 which gets replaced by an OS-specific default value;
+# 3 (BOOT) under linux (for backward compatibility)
 
 # RtProto 0
 
 # internet gateway (2 in case of IPv6+NIIT) and RtTableTunnel is for
 # routes to the ipip tunnels, valid values are 1 to 254
 # There is a special parameter "auto" (choose default below)
-# (with smartgw: default is 254/223/224)
+# (with    smartgw: default is 254/223/224)
 # (without smartgw: default is 254/254/254, linux main table)
 
-# RtTable auto
+# RtTable        auto
 # RtTableDefault auto
-# RtTableTunnel auto
+# RtTableTunnel  auto
 
 # Specifies the policy rule priorities for the three routing tables and
 # a special rule for smartgateway routing (see README-Olsr-Extensions)
 # Priorities can only be set if three different routing tables are set.
 # if set the values must obey to condition
-# RtTablePriority < RtTableDefaultOlsrPriority
-# < RtTableTunnelPriority < RtTableDefaultPriority.
+# RtTablePriority less than RtTableDefaultOlsrPriority
+# less than RtTableTunnelPriority less than RtTableDefaultPriority
 # There are two special parameters, "auto" (choose fitting to SmartGW
 # mode) and "none" (do not set policy rule)
-# (with smartgw: default is none/32776/32776/32796)
-# (without smartgw: default is none/none/none/none)
+# (with    smartgw: default is  none/32776/32786/32796)
+# (without smartgw: default is  auto/auto /auto /auto )
 
-# RtTablePriority auto
+# RtTablePriority            auto
 # RtTableDefaultOlsrPriority auto
-# RtTableTunnelPriority auto
-# RtTableDefaultPriority auto
+# RtTableTunnelPriority      auto
+# RtTableDefaultPriority     auto
 
 # Activates (in IPv6 mode) the automatic use of NIIT
 # (see README-Olsr-Extensions)
-# (default is "yes")
+# (default is "no" in IPv4 mode, "yes" in IPv6 mode)
 
-# UseNiit yes
+# UseNiit no
 
 # Activates the smartgateway ipip tunnel feature.
 # See README-Olsr-Extensions for a description of smartgateways.
 # gateway tunnel is taken down because it is then presumed to be 'too expensive'.
 # This setting is only relevant when SmartGatewayUseCount is larger than 1;
 # a value of 0 will result in the tunnels not being taken down proactively.
-# (default is 0)
+# (default is 25)
 
-# SmartGatewayTakeDownPercentage 0
+# SmartGatewayTakeDownPercentage 25
 
 # Determines the policy routing script that is executed during startup and
 # shutdown of olsrd. The script is only executed when SmartGatewayUseCount
 
 # SmartGatewayEgressInterfaces ""
 
-# Declares the file that contains the bandwidth parameters of the egress
-# interfaces declared by SmartGatewayEgressInterfaces. Every line in the file
-# declares bandwidth parameters of an egress interface, with the format:
+# SmartGatewayEgressFile declares the file that contains the bandwidth
+# parameters of the egress interfaces declared by SmartGatewayEgressInterfaces.
+# Every line in the file declares bandwidth parameters of an egress interface,
+# with the format:
 #   # this is a comment
 #   interface=upstream,downstream,pathcost,network/prefix,gateway
+# Only the upstream and downstream fields are mandatory, the other fields are
+# optional. An empty field signifies that its default should be used.
+# The field defaults are:
+#   upstream           = 0 (Kbps)
+#   downstream         = 0 (Kbps)
+#   pathcost           = 0 (dimensionless, 1024 is equivalent to 1 hop)
+#   network/prefix     = no default / not set
+#                        - network is an IP address
+#                        - prefix is a number in the range [0, 24] for IPv4
+#                          and in the range [0, 128] for IPv6
+#   gateway            = no default / not set (IP address)
 # (default is /var/run/olsrd-sgw-egress.conf)
 
 # SmartGatewayEgressFile "/var/run/olsrd-sgw-egress.conf"
 # is checked for changes and processed if changed.
 # (default is 5000)
 
-# SmartGatewayEgressFilePeriod "5000"
+# SmartGatewayEgressFilePeriod 5000
 
 # Declares the file that is written by olsrd to contain the status of the smart
 # gateways and is only relevant when SmartGatewayUseCount is larger than 1.
-# The default setting is <not set>
+# (default is <not set>)
 
 # SmartGatewayStatusFile <not set>
 
 # puts this value at SmartGatewayTablesOffset - # egress interfaces -
 # # olsr interfaces)
 
-# SmartGatewayRulesOffset 87
+# SmartGatewayRulesOffset 0
 
 # Allows the selection of a smartgateway with NAT (only for IPv4)
 # (default is "yes")
 # When another gateway than the current one has a cost of less than the cost
 # of the current gateway multiplied by SmartGatewayThreshold then the smart
 # gateway is switched to the other gateway. The unit is percentage.
-# (defaults to 0)
+# (default is 0)
 
 # SmartGatewayThreshold 0
 
 
 # Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix
 # length of more than 64 is not allowed.
+# Only relevant when running in IPv6 mode.
 # (default is 0::/0)
 
-# SmartGatewayPrefix 0::/0
-
-# Set to yes will make OLSRd to set the file 
-# /proc/sys/net/ipv4/ip_forward to 1 during startup. It will be
-# restored to the original value during shutdown
-# Set this to no makes OLSRd check the value, if its not 1
-# OLSRd will exit with an error.
-# (default is yes)
-
-# SetIpForward yes
+# SmartGatewayPrefix ::/0
 
 ##############################
 ### OLSR protocol settings ###
 ##############################
 
 # For testing purposes it may be nice to use another port for olsrd
-# for using another port than the IANA assigned one 
+# for using another port than the IANA assigned one
 # for a production network, there should be a good reason!!
-# valid values are integers >1, please be careful with using reserved
-# port numbers
+# valid values are integers greater than 1, please be careful with
+# using reserved port numbers
 # (default is 698, the IANA assigned olsr-port)
 
 # OlsrPort 698
 # change during the uptime of olsrd.
 # (default is 0.0.0.0, which triggers usage of the IP of the first interface)
 
-# MainIp 10.0.0.1
+MainIp 192.168.181.102
 
 # The fixed willingness to use (0-7)
 # If not set willingness will be calculated
@@ -348,24 +356,23 @@ Hna6
 #   fec0:2200:106:0:0:0:0:0 48
 }
 
-
 # Hysteresis for link sensing (only for hopcount metric)
 # Hysteresis adds more robustness to the link sensing
 # but delays neighbor registration.
-# (defaults to yes)
+# (default is no)
 
-# UseHysteresis yes
+# UseHysteresis no
 
 # Hysteresis parameters (only for hopcount metric)
 # Do not alter these unless you know what you are doing!
 # Set to auto by default. Allowed values are floating point
 # values in the interval 0,1
 # THR_LOW must always be lower than THR_HIGH!!
-# (default is 0.5/0.8/0.3)
+# (default is 0.50/0.80/0.30)
 
 # HystScaling  0.50
 # HystThrHigh  0.80
-# HystThrLow 0.30
+# HystThrLow   0.30
 
 # TC redundancy
 # Specifies how much neighbor info should be sent in
@@ -378,8 +385,8 @@ Hna6
 
 # MPR coverage specifies how many MPRs a node should
 # try select to reach every 2 hop neighbor. Because of
-# a design problem in the 0.5.x lq mpr selection algorithm
-# this value should be set to 7.
+# a design problem in the 0.5.x dijkstra algorithm this
+# value should be set to 7.
 # (default is 7)
 
 # MprCoverage 7
@@ -388,7 +395,7 @@ Hna6
 ### OLSR protocol extensions ###
 ################################
 
-# Link quality level switch between hopcount and 
+# Link quality level switch between hopcount and
 # cost-based (mostly ETX) routing. Because of
 # a design problem in the 0.5.x dijkstra algorithm this
 # value should not be set to 1.
@@ -406,7 +413,7 @@ Hna6
 #   traffic (instead of only hellos) for ETX calculation
 # - "etx_ffeth", an incompatible variant of etx_ff that allows
 #   ethernet links with ETX 0.1.
-# (defaults to "etx_ff")
+# (default is "etx_ff")
 
 # LinkQualityAlgorithm    "etx_ff"
 
@@ -424,18 +431,18 @@ Hna6
 # LinkQualityFishEye  1
 
 #
-# NatThreshold 
+# NatThreshold
 #
 # (currently this is only in the freifunk firmware)
 # If the NAT-Endpoint (the preferred 0/0 HNA emitting node)
-# is to be changed, the ETX value of the current 0/0 is 
+# is to be changed, the ETX value of the current 0/0 is
 # multiplied with the NatThreshold value before being
 # compared to the new one.
 # The parameter can be a value between 0.1 and 1.0, but
 # should be close to 1.0 if changed.
 # WARNING: This parameter should not be used together with
 # the etx_ffeth metric !!
-# (defaults to 1.0)
+# (default is 1.0)
 
 # NatThreshold  1.0
 
@@ -457,7 +464,7 @@ IpcConnect
 
      # Host            127.0.0.1
      # Host            10.0.0.5
-     # Net             192.168.1.0 255.255.255.0     
+     # Net             192.168.1.0 255.255.255.0
 }
 
 #####################################
@@ -466,127 +473,21 @@ IpcConnect
 # Olsrd plugins to load
 # This must be the absolute path to the file
 # or the loader will use the following scheme:
-# - Try the paths in the LD_LIBRARY_PATH 
+# - Try the paths in the LD_LIBRARY_PATH
 #   environment variable.
 # - The list of libraries cached in /etc/ld.so.cache
 # - /lib, followed by /usr/lib
 #
-# the examples in this list are for linux, so check if the plugin is
-# available if you use windows/BSD.
-# each plugin should have a README file in it's lib subfolder
 
-# LoadPlugin "olsrd_httpinfo.dll"
-LoadPlugin "olsrd_httpinfo.so.0.1"
-{
-    # port number the httpinfo plugin will be listening, default 1978
-#   PlParam     "port"   "8000"
-    
-    # ip address that can access the plugin, use "0.0.0.0"
-    # to allow everyone
-    PlParam     "Host"   "127.0.0.1"
-#   PlParam     "Host"   "80.23.53.22"
-    
-    # networks that can access the plugin (ip/netmask)
-    # careful with 0.0.0.0/0, makes (ddos) attacks poss.
-#   PlParam     "Net"    "0.0.0.0 0.0.0.0"
-    PlParam     "Net"    "104.0.0.0 255.255.0.0"
-    PlParam     "Net"    "192.168.0.0 255.255.0.0"
-}
+# Check whether a plugin is available for your operating system.
+# Each plugin should have a README file in it's lib subfolder.
 
-# LoadPlugin "olsrd_txtinfo.dll"
-LoadPlugin "olsrd_txtinfo.so.0.1"
-{
-    # the default port is 2006 but you can change it like this:
-    #PlParam     "port"   "8080"
-
-    # You can set a "accept" single address to allow to connect to
-    # txtinfo. If no address is specified, then localhost (127.0.0.1)
-    # is allowed by default.  txtinfo will only use the first "accept"
-    # parameter specified and will ignore the rest.
-
-    # to allow a specific host:
-    #PlParam      "accept" "172.29.44.23"
-    # if you set it to 0.0.0.0, it will accept all connections
-    #PlParam      "accept" "0.0.0.0"
+LoadPlugin "olsrd_jsoninfo.so.0.0" {
 }
 
-# LoadPlugin "olsrd_jsoninfo.dll"
-LoadPlugin "olsrd_jsoninfo.so.0.0"
-{
-    # the default port is 2006 but you can change it like this:
-    #PlParam     "port"   "8080"
-
-    # You can set a "accept" single address to allow to connect to
-    # jsoninfo. If no address is specified, then localhost (127.0.0.1)
-    # is allowed by default.  jsoninfo will only use the first "accept"
-    # parameter specified and will ignore the rest.
-
-    # to allow a specific host:
-    #PlParam      "accept" "172.29.44.23"
-    # if you set it to 0.0.0.0, it will accept all connections
-    #PlParam      "accept" "0.0.0.0"
-
-    # specify a UUID for this node to track it for debugging
-    #PlParam      "UUIDFile" "/etc/olsrd/olsrd.uuid"
+LoadPlugin "olsrd_httpinfo.so.0.1" {
 }
 
-#LoadPlugin "olsrd_secure.so.0.3"
-#{
-    # define source of keyfile for secure plugin
-    # see lib/secure/README_SECURE for more information
-    
-#   PlParam     "Keyfile"   "/etc/olsr-keyfile.txt"
-#}
-
-#LoadPlugin "olsrd_dyn_gw.so.0.5"
-#{
-    # The plugin check interval can be set here in milliseconds.
-    # The default is 1000 ms (1 second).
-#    PlParam     "CheckInterval"  "5000"
-    
-    # The ping check interval in case there is any pinged host specified.
-    # The default is 5 seconds.
-#    PlParam     "PingInterval"   "40"
-    
-    # If one or more IPv4 addresses are given, do a ping on these in
-    # descending order to validate that there is not only an entry in
-    # routing table, but also a real network connection. If any of
-    # these addresses could be pinged successfully, the test was
-    # succesful, i.e. if the ping on the 1st address was successful,the
-    # 2nd won't be pinged.
-    #
-    # The Ping list applies to the group of HNAs specified above or to the 
-               # default internet gateway when no HNA is specified.
-               #
-               # Running the plugin without parameters acts as the 'old' dyn_gw_plain.
-    
-    #   The following ping entries for the internet gateway
-#    PlParam "Ping"   "141.1.1.1"
-#    PlParam "Ping"   "194.25.2.129"
-    
-    #   First group of HNAs with related ping host
-#    PlParam   "HNA"      "192.168.80.0 255.255.255.0"
-#    PlParam   "HNA"      "192.168.81.0 255.255.255.0"
-#    PlParam   "Ping"   "192.168.81.12"
-    
-    #   Second HNA group with multiple related ping hosts.
-    #   Specifying multiple ping hosts provides redundancy.
-#    PlParam "HNA"    "192.168.100.0 255.255.255.0"
-#    PlParam "HNA"    "192.168.101.0 255.255.255.0"
-#    PlParam "HNA"    "192.168.102.0 255.255.255.0"
-#    PlParam "Ping"   "192.168.100.10"
-#    PlParam "Ping"   "192.168.101.10"
-    
-    #   Third HNA group without ping check
-#    PlParam "HNA"    "192.168.200.0 255.255.255.0"
-#    PlParam "HNA"    "192.168.201.0 255.255.255.0"
-#    PlParam "HNA"    "192.168.202.0 255.255.255.0"
-#}
-
-#LoadPlugin "olsrd_dyn_gw_plain.so.0.4"
-#{
-#}
-
 #############################################
 ### OLSRD default interface configuration ###
 #############################################
@@ -594,18 +495,19 @@ LoadPlugin "olsrd_jsoninfo.so.0.0"
 # interface configuration. It will allow you so set common options for all
 # interfaces.
 
-InterfaceDefaults {
-    # Ip4Broadcast      255.255.255.255
+InterfaceDefaults
+{
 }
 
 ######################################
 ### OLSRd Interfaces configuration ###
 ######################################
-# multiple interfaces can be specified for a single configuration block
-# multiple configuration blocks can be specified
+# Multiple interfaces can be specified for a single configuration block, format:
+#   Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
+#
+# Multiple configuration blocks can be specified.
 
-# WARNING, don't forget to insert your interface names here !
-Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
+Interface "wlan0"
 {
     # Interface Mode is used to prevent unnecessary
     # packet forwarding on switched ethernet interfaces
@@ -621,13 +523,13 @@ Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
     # another name of this parameter is "IPv4Multicast"
     # (default is 0.0.0.0, which triggers the usage of the
     # interface broadcast IP)
-    
+
     # Ip4Broadcast      0.0.0.0
 
     # IPv6 multicast address
-    # (default is FF02::6D, the manet-router linklocal multicast)
+    # (default is ff02::6d, the manet-router linklocal multicast)
 
-    # IPv6Multicast    FF02::6D
+    # IPv6Multicast ff02::6d
 
     # IPv4 src address for outgoing OLSR packages
     # (default is 0.0.0.0, which triggers usage of the interface IP)
@@ -639,21 +541,22 @@ Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
     # (default is 0::/0, which triggers the usage
     # of a not-linklocal interface IP)
 
-    # IPv6Src 0::/0
-    
+    # IPv6Src ::/0
+
     # Emission intervals in seconds.
-    # If not defined, Freifunk network defaults are used
-    # (default is 2.0/20.0 for Hello and 5.0/300.0 for Tc/Mid/Hna)
+    # If not defined, Freifunk network defaults are used.
+    # (defaults: Hello = 2.0/20.0,  TC  = 5.0/300.0,
+    #            MID   = 5.0/300.0, HNA = 5.0/300.0)
 
     # HelloInterval       2.0
-    # HelloValidityTime  20.0
+    # HelloValidityTime   20.0
     # TcInterval          5.0
-    # TcValidityTime    300.0
+    # TcValidityTime      300.0
     # MidInterval         5.0
-    # MidValidityTime   300.0
+    # MidValidityTime     300.0
     # HnaInterval         5.0
-    # HnaValidityTime   300.0
-    
+    # HnaValidityTime     300.0
+
     # When multiple links exist between hosts
     # the weight of interface is used to determine
     # the link to use. Normally the weight is
@@ -667,17 +570,17 @@ Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
     # value is used instead.
     # Weight 0
 
-    # If a certain route should be preferred 
-    # or ignored by the mesh, the Link Quality 
-    # value of a node can be multiplied with a factor 
-    # entered here. In the example the route 
+    # If a certain route should be preferred
+    # or ignored by the mesh, the Link Quality
+    # value of a node can be multiplied with a factor
+    # entered here. In the example the route
     # using 192.168.0.1 would rather be ignored.
     # A multiplier of 0.5 will result in a small
     # (bad) LinkQuality value and a high (bad)
     # ETX value.
     # Note:
     # Link quality multiplier is used only when
-    # LinkQualityLevel is > 0.
+    # LinkQualityLevel is greater than 0.
 
     # example 1: reduce LQ to 192.168.0.1 by half
     # LinkQualityMult 192.168.0.1 0.5
@@ -685,3 +588,5 @@ Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
     # example 2: reduce LQ to all nodes on this interface by 20%
     # LinkQualityMult default 0.8
 }
+
+# END AUTOGENERATED CONFIG