release: fix the list of generated files
[olsrd.git] / files / olsrd.conf.default.lq-fisheye
index 6a4fa9f..64e30d8 100644 (file)
 #
 # OLSR.org routing daemon config file
+# This file contains the usual options for an ETX based
+# stationary network with fisheye
+# (for other options see olsrd.conf.default.full)
 #
 # Lines starting with a # are discarded
 #
 
-# Debug level(0-9)
-# If set to 0 the daemon runs in the background
+#### ATTENTION for IPv6 users ####
+# Because of limitations in the parser IPv6 addresses must NOT
+# begin with a ":", so please add a "0" as a prefix.
 
-DebugLevel  1
+###########################
+### Basic configuration ###
+###########################
+# keep this settings at the beginning of your first configuration file
 
-# IP version to use (4 or 6)
-
-IpVersion 4
-
-# FIBMetric ("flat", "correct", or "approx")
-# Just use "flat", the others don't work very well
-
-# FIBMetric "flat"
-
-# Clear the screen each time the internal state changes
+# Debug level (0-9)
+# If set to 0 the daemon runs in the background, unless "NoFork" is set to true
+# (Default is 1)
 
-# ClearScreen     yes
+# DebugLevel  1
 
-# HNA IPv4 routes
-# syntax: netaddr netmask
-# Example Internet gateway:
-# 0.0.0.0 0.0.0.0
-
-Hna4
-{
-# Internet gateway
-#    0.0.0.0   0.0.0.0
+# IP version to use (4 or 6)
+# (Default is 4)
 
-# specific small networks reachable through this node
-#    15.15.0.0 255.255.255.0
-#    15.16.0.0 255.255.255.0
-}
+# IpVersion 4
 
-# HNA IPv6 routes
-# syntax: netaddr prefix
-# Example Internet gateway:
-#Hna6
-#{
-# Internet gateway
-#     ::              0
+#################################
+### OLSRd agent configuration ###
+#################################
+# this parameters control the settings of the routing agent which are not
+# related to the OLSR protocol and it's extensions
 
-# specific small networks reachable through this node
-#    fec0:2200:106:0:0:0:0:0 48
-#}
+# FIBMetric controls the metric value of the host-routes OLSRd sets.
+# - "flat" means that the metric value is always 2. 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")
 
-# Specify the routing Table olsr uses
-# currently only implemented in linux versions, (bsd planned)
-# useful for policyrouting, to ensure that olsr can use 
-# the table a policy rule with priority 65536 is auto-installed
-# by olsrd if an value < 253 ist specified!
-# value defaults to 253 (main table)
-# valid values are 1 .. 254
-# (freifunkfirmware uses 111 for its policy routing)
+# FIBMetric "flat"
 
-RtTable 111
+#######################################
+### Linux specific OLSRd extensions ###
+#######################################
+# these parameters are only working on linux at the moment, but might become
+# useful on BSD in the future
 
-#you may specify another table for the default route only
-#if used no policy route will get auto-installed for this table, 
-#but the default route gets also inserted into table 254 
-#(the last table used in default linux policy routing)
-#valid tables are the same as for RtTable
+# 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")
 
-RtTableDefault 112
+# SrcIpRoutes no
 
 # Specify the proto tag to be used for routes olsr inserts into kernel
-# currently only implemented for linux, defaults to 0 which gets replaced
-# by an OS-specific default value under linux 3 (BOOT) gets used as default
-# (for backward compatibility)
+# currently only implemented for linux
 # valid values under linux are 1 .. 254
 # 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 
 # 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)
 
 # RtProto 0
 
-# For testing purposes it may be nice to use another port for olsrd
-# for using another port than the IANA assigned one 
-# for a production network, there should be a good reason!!
-# defaults to 698 (IANA assigned olsr-port)
-# valid values are 698 or > 1000
+# Activates (in IPv6 mode) the automatic use of NIIT
+# (see README-Olsr-Extensions)
+# (default is "yes")
 
-# OlsrPort 698
+# UseNiit yes
 
-# Should olsrd keep on running even if there are
-# no interfaces available? This is a good idea
-# for a PCMCIA/USB hotswap environment.
-# "yes" OR "no"
+# Activates the smartgateway ipip tunnel feature.
+# See README-Olsr-Extensions for a description of smartgateways.
+# (default is "no")
 
-# AllowNoInt  yes
+# SmartGateway no
 
-# TOS(type of service) value for
-# the IP header of control traffic.
-# If not set it will default to 16
+# Signals that the server tunnel must always be removed on shutdown,
+# irrespective of the interface up/down state during startup.
+# (default is "no")
 
-#TosValue 16
+# SmartGatewayAlwaysRemoveServerTunnel no
 
-# The fixed willingness to use(0-7)
-# If not set willingness will be calculated
-# dynammically based on battery/power status
+# Determines the maximum number of gateways that can be in use at any given
+# time. This setting is used to mitigate the effects of breaking connections
+# (due to the selection of a new gateway) on a dynamic network.
+# (default is 1)
 
-# Willingness     3
+# SmartGatewayUseCount 1
 
-# Allow processes like the GUI front-end
-# to connect to the daemon.
+# Determines the take-down percentage for a non-current smart gateway tunnel.
+# If the cost of the current smart gateway tunnel is less than this percentage
+# of the cost of the non-current smart gateway tunnel, then the non-current smart
+# 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)
 
-IpcConnect
-{
-     # Determines how many simultaneously
-     # IPC connections that will be allowed
-     # Setting this to 0 disables IPC
+# SmartGatewayTakeDownPercentage 0
 
-     # MaxConnections  0
+# Determines the policy routing script that is executed during startup and
+# shutdown of olsrd. The script is only executed when SmartGatewayUseCount
+# is set to a value larger than 1. The script must setup policy routing
+# rules such that multi-gateway mode works. A sample script is included.
+# (default is not set)
 
-     # By default only 127.0.0.1 is allowed
-     # to connect. Here allowed hosts can
-     # be added
+# SmartGatewayPolicyRoutingScript ""
 
-     # Host            127.0.0.1
-     # Host            10.0.0.5
+# Determines the egress interfaces that are part of the multi-gateway setup and
+# therefore only relevant when SmartGatewayUseCount is larger than 1 (in which
+# case it must be explicitly set).
+# (default is not set)
 
-     # Specify entire net-ranges that are 
-     # allowed to connect
+# SmartGatewayEgressInterfaces ""
 
-     # Net             192.168.1.0 255.255.255.0     
-}
+# Determines the offset of the smart gateway egress interfaces mark that are
+# used in the policy routing rules in a multi-gateway setup. Only relevant
+# when a multi-gateway setup is used.
+# (default is 91)
 
-# Link quality level
-# 0 = do not use link quality
-# 1 = use link quality for MPR selection
-# 2 = use link quality for MPR selection and routing
-# Defaults to 2
+# SmartGatewayMarkOffsetEgress 91
 
-#LinkQualityLevel 2
+# Determines the offset of the smart gateway tunnel interfaces mark that are
+# used in the policy routing rules in a multi-gateway setup. Only relevant
+# when a multi-gateway setup is used.
+# The ranges [egress offset, egress offset + egress count] and
+# [tunnel offset, tunnel offset + use count] are not allowed to overlap.
+# (default is 101)
 
-# Link quality algorithm (only for lq level 1 or 2)
-# Defaults to "etx_ff", a etx variant developed at Freifunk
+# SmartGatewayMarkOffsetTunnels 101
 
-# LinkQualityAlgorithm    "etx_ff"
+# Allows the selection of a smartgateway with NAT (only for IPv4)
+# (default is "yes")
 
-# Link quality aging factor
-# Defaults to 0.05, smaller values mean larger LQ window size
-# Link quality aging does only apply to lq level 1 and 2
-# This parameter is not used for etx_ff
+# SmartGatewayAllowNAT yes
 
-# LinkQualityAging 0.1 
+# Determines the period (in milliseconds) on which a new smart gateway
+# selection is performed.
+# (default is 10000 milliseconds)
 
-# Fisheye mechanism for TC messages 0=off, 1=on
-# default is 1
+# SmartGatewayPeriod 10000
 
-# LinkQualityFishEye  1
+# Determines the number of times the link state database must be stable
+# before a new smart gateway is selected.
+# (default is 6)
 
-# Wether to use hysteresis or not
-# Hysteresis adds more robustness to the
-# link sensing but delays neighbor registration.
-# Used by default. 'yes' or 'no'
+# SmartGatewayStableCount 6
 
-# UseHysteresis no
+# 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)
 
-# Hysteresis parameters
-# 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!!
+# SmartGatewayThreshold 0
 
-#HystScaling  0.50
-#HystThrHigh  0.80
-#HystThrLow 0.30
+# The weighing factor for the gateway uplink bandwidth (exit link, uplink).
+# See README-Olsr-Extensions for a description of smart gateways.
+# (default is 1)
 
+# SmartGatewayWeightExitLinkUp 1
 
-# Polling rate in seconds(float). 
-# Default value 0.05 sec
+# The weighing factor for the gateway downlink bandwidth (exit link, downlink).
+# See README-Olsr-Extensions for a description of smart gateways.
+# (default is 1)
 
-# Pollrate  0.05
+# SmartGatewayWeightExitLinkDown 1
 
-# Interval to poll network interfaces for configuration 
-# changes. Defaults to 2.5 seconds
+# The weighing factor for the ETX costs.
+# See README-Olsr-Extensions for a description of smart gateways.
+# (default is 1)
 
-# NicChgsPollInt  2.5
+# SmartGatewayWeightEtx 1
 
+# The divider for the ETX costs.
+# See README-Olsr-Extensions for a description of smart gateways.
+# (default is 0)
 
-# TC redundancy
-# Specifies how much neighbor info should
-# be sent in TC messages
-# Possible values are:
-# 0 - only send MPR selectors
-# 1 - send MPR selectors and MPRs
-# 2 - send all neighbors
-#
-# defaults to 2
+# SmartGatewayDividerEtx 0
 
-# TcRedundancy  2
+# Defines what kind of Uplink this node will publish as a
+# smartgateway. The existence of the uplink is detected by
+# a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.
+# possible values are "none", "ipv4", "ipv6", "both"
+# (default is "both")
 
-#
-# 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 
-# compared to the new one. If the ETX difference is too small, the default 
-# route isn't changed. defaults to 1.0
-# The configured route gets multiplied by the treshhold, 
-# before comparing which route is better
+# SmartGatewayUplink "both"
 
-# NatThreshold  0.5
+# Specifies if the local ipv4 uplink use NAT
+# (default is "yes")
 
-#
-# MPR coverage
-# Specifies how many MPRs a node should
-# try select to reach every 2 hop neighbor
-#
-# Can be set to any integer >0
-# 
-# MPR selection is broken at the moment, just keep 7
+# SmartGatewayUplinkNAT yes
+
+# Specifies the speed of the uplink in kilobit/s.
+# First parameter is upstream, second parameter is downstream
+# (default is 128/1024)
+
+# SmartGatewaySpeed 128 1024
 
-# MprCoverage 7
+# Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix
+# length of more than 64 is not allowed.
+# (default is 0::/0
 
+# SmartGatewayPrefix 0::/0
 
+##############################
+### OLSR protocol settings ###
+##############################
+
+# HNA (Host network association) allows the OLSR to announce
+# additional IPs or IP subnets to the net that are reachable
+# through this node.
+# Syntax for HNA4 is "network-address    network-mask"
+# Syntax for HNA6 is "network-address    prefix-length"
+# (default is no HNA)
+Hna4
+{
+# Internet gateway
+# 0.0.0.0   0.0.0.0
+# specific small networks reachable through this node
+# 15.15.0.0 255.255.255.0
+}
+Hna6
+{
+# Internet gateway
+#   0::                     0
+# specific small networks reachable through this node
+#   fec0:2200:106:0:0:0:0:0 48
+}
+
+################################
+### OLSR protocol extensions ###
+################################
+
+# Link quality algorithm (only for lq level 2)
+# (see README-Olsr-Extensions)
+# - "etx_float", a floating point  ETX with exponential aging
+# - "etx_fpm", same as ext_float, but with integer arithmetic
+# - "etx_ff" (ETX freifunk), an etx variant which use all OLSR
+#   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")
+
+# LinkQualityAlgorithm    "etx_ff"
+
+# Fisheye mechanism for TCs (0 meansoff, 1 means on)
+# (default is 1)
+
+# LinkQualityFishEye  1
+
+#####################################
+### Example plugin configurations ###
+#####################################
 # Olsrd plugins to load
 # This must be the absolute path to the file
 # or the loader will use the following scheme:
@@ -236,185 +267,49 @@ IpcConnect
 #
 # the examples in this list are for linux, so check if the plugin is
 # available if you use windows/BSD.
-
-# 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"
-}
+# each plugin should have a README file in it's lib subfolder
 
 # LoadPlugin "olsrd_txtinfo.dll"
 LoadPlugin "olsrd_txtinfo.so.0.1"
 {
-    # port number the txtinfo plugin will be listening, default 2006
-#   PlParam     "port"   "81"
-    # ip address that can access the plugin, use "0.0.0.0"
-    # to allow everyone
-    PlParam     "Accept"   "127.0.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_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.4"
-#{
-    # Here parameters are set to be sent to the
-    # plugin. Theese are on the form "key" "value".
-    # Parameters ofcause, differs from plugin to plugin.
-    # Consult the documentation of your plugin for details.
-
-    # Example: dyn_gw params
-
-    # how often to check for Internet connectivity
-    # defaults to 5 secs
-#   PlParam     "Interval"   "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 internet 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
-#   PlParam     "Ping"       "141.1.1.1"
-#   PlParam     "Ping"       "194.25.2.129"
-#}
-
-# olsrd_dyn_gw_plain.so.0.4
-# {
-# }
-
-
-# Interfaces and their rules
-# Omitted options will be set to the
-# default values.
-# multiple interfaces can be speicified
-Interface "wlan0" "ath0"
-{
-    # Interface Mode is used to prevent unnecessary
-    # packet forwarding on switched ethernet interfaces
-    # valid Modes are "mesh" and "ether"
-    # The default value is mesh!
-
-    # Mode "mesh"
+#############################################
+### OLSRD default interface configuration ###
+#############################################
+# the default interface section can have the same values as the following
+# interface configuration. It will allow you so set common options for all
+# interfaces.
 
-    # IPv4 broadcast address to use. The
-    # one usefull example would be 255.255.255.255
-    # If not defined the broadcastaddress
-    # every card is configured with is used
-    # The second useful value would be to
-    # specify the peer adress of an ptp-tunnel.
-    # another name of this parameter is "IPv4Multicast"
-    # Ip4Broadcast      0.0.0.0  (use interface broadcast)
-
-    # IPv6 multicast address
-    # If not defined, FF02::1 is used
-
-    # IPv6Multicast    FF02::1
-
-               # IPv4 src address
-    # If not defined (0.0.0.0), the interface IP is used
-               
-               # IPv4Src 0.0.0.0
-               
-               # IPv6 src prefix.
-               # If not defined (::/0), a not-linklocal interface IP is used
-               
-               # IPv6Src ::/0
-               
-    # Emission intervals.
-    # If not defined, RFC proposed values will
-    # be used in most cases.
-
-    # Hello interval in seconds(float)
-    # HelloInterval    2.0
-
-    # HELLO validity time
-    # HelloValidityTime 20.0
-
-    # TC interval in seconds(float)
-    # TcInterval        5.0
-
-    # TC validity time
-    # TcValidityTime  300.0
-
-    # MID interval in seconds(float)
-    # MidInterval 5.0
-
-    # MID validity time
-    # MidValidityTime 300.0
-
-    # HNA interval in seconds(float)
-    # HnaInterval 5.0
-
-    # HNA validity time
-    # 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
-    # automatically calculated by olsrd based
-    # on the characteristics of the interface,
-    # but here you can specify a fixed value.
-    # Olsrd will choose links with the lowest value.
-    # Note:
-    # Interface weight is used only when LinkQualityLevel is set to 0.
-    # For any other value of LinkQualityLevel, the interface ETX
-    # 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 
-    # 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.
-
-    # Example 1: LinkQualityMult 192.168.0.1 0.5
-
-    # This multiplier applies to all other nodes 
-    # Example 2: LinkQualityMult default 0.8
+InterfaceDefaults {
+    # Ip4Broadcast      255.255.255.255
 }
 
-# another Interface (with different configs)
-#Interface "eth1"
-#{
-    # IPv4 broadcast address to use. 
-    # One usefull example would be 255.255.255.255
-    # If not defined the broadcastaddress of
-    # every interface which has one configured gets used
-    # The second useful value would be to 
-    # specify the peer adress of an ptp-tunnel
-
-#    IPv4Multicast     192.168.255.255
+######################################
+### OLSRd Interfaces configuration ###
+######################################
+# multiple interfaces can be specified for a single configuration block
+# multiple configuration blocks can be specified
 
+# WARNING, don't forget to insert your interface names here !
+Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
+{
     # Interface Mode is used to prevent unnecessary
-    # packet forwardin on switched ethernet interfaces
+    # packet forwarding on switched ethernet interfaces
     # valid Modes are "mesh" and "ether"
-    # The default value is mesh!
+    # (default is "mesh")
 
-#    Mode "ether"
-#}
+    # Mode "mesh"
+}