Merge branch 'stable' into pud
[olsrd.git] / files / olsrd.conf.default.full
1 #
2 # OLSR.org routing daemon config file
3 # This file contains ALL available options and explanations about them
4 #
5 # Lines starting with a # are discarded
6 #
7
8 #### ATTENTION for IPv6 users ####
9 # Because of limitations in the parser IPv6 addresses must NOT
10 # begin with a ":", so please add a "0" as a prefix.
11
12 ###########################
13 ### Basic configuration ###
14 ###########################
15 # keep this settings at the beginning of your first configuration file
16
17 # Debug level (0-9)
18 # If set to 0 the daemon runs in the background, unless "NoFork" is set to true
19 # (Default is 1)
20
21 # DebugLevel  1
22
23 # IP version to use (4 or 6)
24 # (Default is 4)
25
26 # IpVersion 4
27
28 #################################
29 ### OLSRd agent configuration ###
30 #################################
31 # this parameters control the settings of the routing agent which are not
32 # related to the OLSR protocol and it's extensions
33
34 # Clear the screen each time the internal state changes
35 # (Default is yes)
36
37 # ClearScreen     yes
38
39 # Should olsrd keep on running even if there are
40 # no interfaces available? This is a good idea
41 # for a PCMCIA/USB hotswap environment.
42 # (Default is yes)
43
44 # AllowNoInt  yes
45
46 # LockFile
47 # The lockfile is used to prevent multiple OLSR instances running at the same
48 # time.
49 # (Linux/BSD default is "/var/run/olsrd-ipv(4/6).lock")
50 # (Win32 default is "<configfile>-ipv(4/6).lock")
51
52 # LockFile "olsrd.lock"
53
54 # Polling rate for OLSR sockets in seconds (float). 
55 # (Default is 0.05)
56
57 # Pollrate  0.05
58
59 # Interval to poll network interfaces for configuration changes (in seconds).
60 # Linux systems can detect interface statechange via netlink sockets.
61 # (Defaults is 2.5)
62
63 # NicChgsPollInt  2.5
64
65 # TOS(type of service) value for the IP header of control traffic.
66 # (Default is 16)
67
68 # TosValue 16
69
70 # FIBMetric controls the metric value of the host-routes OLSRd sets.
71 # - "flat" means that the metric value is always 2. This is the preferred value
72 #   because it helps the linux kernel routing to clean up older routes
73 # - "correct" use the hopcount as the metric value.
74 # - "approx" use the hopcount as the metric value too, but does only update the
75 #   hopcount if the nexthop changes too
76 # (Default is "flat")
77
78 # FIBMetric "flat"
79
80 #######################################
81 ### Linux specific OLSRd extensions ###
82 #######################################
83 # these parameters are only working on linux at the moment, but might become
84 # useful on BSD in the future
85
86 # SrcIpRoutes tells OLSRd to set the Src flag of host routes to the originator-ip
87 # of the node. In addition to this an additional localhost device is created
88 # to make sure the returning traffic can be received.
89 # (Default is "no")
90
91 # SrcIpRoutes no
92
93 # Specify the proto tag to be used for routes olsr inserts into kernel
94 # currently only implemented for linux
95 # valid values under linux are 1 .. 254
96 # 1 gets remapped by olsrd to 0 UNSPECIFIED (1 is reserved for ICMP redirects)
97 # 2 KERNEL routes (not very wise to use)
98 # 3 BOOT (should in fact not be used by routing daemons)
99 # 4 STATIC 
100 # 8 .. 15 various routing daemons (gated, zebra, bird, & co)
101 # (defaults to 0 which gets replaced by an OS-specific default value
102 # under linux 3 (BOOT) (for backward compatibility)
103
104 # RtProto 0
105
106 # Specifies the routing Table olsr uses
107 # RtTable is for host routes, RtTableDefault for the route to the default
108 # internet gateway (2 in case of IPv6+NIIT) and RtTableTunnel is for
109 # routes to the ipip tunnels, valid values are 1 to 254
110 # There is a special parameter "auto" (choose default below)
111 # (with smartgw: default is 254/223/224)
112 # (without smartgw: default is 254/254/254, linux main table)
113
114 # RtTable auto
115 # RtTableDefault auto
116 # RtTableTunnel auto
117
118 # Specifies the policy rule priorities for the three routing tables and
119 # a special rule for smartgateway routing (see README-Olsr-Extensions)
120 # Priorities can only be set if three different routing tables are set.
121 # if set the values must obey to condition
122 # RtTablePriority < RtTableDefaultOlsrPriority
123 # < RtTableTunnelPriority < RtTableDefaultPriority.
124 # There are two special parameters, "auto" (choose fitting to SmartGW
125 # mode) and "none" (do not set policy rule)
126 # (with smartgw: default is none/32776/32776/32796)
127 # (without smartgw: default is none/none/none/none)
128
129 # RtTablePriority auto
130 # RtTableDefaultOlsrPriority auto
131 # RtTableTunnelPriority auto
132 # RtTableDefaultPriority auto
133
134 # Activates (in IPv6 mode) the automatic use of NIIT
135 # (see README-Olsr-Extensions)
136 # (default is "yes")
137
138 # UseNiit yes
139
140 # Activates the smartgateway ipip tunnel feature.
141 # See README-Olsr-Extensions for a description of smartgateways.
142 # (default is "no")
143
144 # SmartGateway no
145
146 # Allows the selection of a smartgateway with NAT (only for IPv4)
147 # (default is "yes")
148
149 # SmartGatewayAllowNAT yes
150
151 # Defines what kind of Uplink this node will publish as a
152 # smartgateway. The existence of the uplink is detected by
153 # a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.
154 # possible values are "none", "ipv4", "ipv6", "both"
155 # (default is "both")
156
157 # SmartGatewayUplink "both"
158
159 # Specifies if the local ipv4 uplink use NAT
160 # (default is "yes")
161
162 # SmartGatewayUplinkNAT yes
163
164 # Specifies the speed of the uplink in kilobit/s.
165 # First parameter is upstream, second parameter is downstream
166 # (default is 128/1024)
167
168 # SmartGatewaySpeed 128 1024
169
170 # Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix
171 # length of more than 64 is not allowed.
172 # (default is 0::/0
173
174 # SmartGatewayPrefix 0::/0
175
176 ##############################
177 ### OLSR protocol settings ###
178 ##############################
179
180 # For testing purposes it may be nice to use another port for olsrd
181 # for using another port than the IANA assigned one 
182 # for a production network, there should be a good reason!!
183 # valid values are integers >1, please be careful with using reserved
184 # port numbers
185 # (default is 698, the IANA assigned olsr-port)
186
187 # OlsrPort 698
188
189 # Sets the main IP (originator ip) of the router. This IP will NEVER
190 # change during the uptime of olsrd.
191 # (default is 0.0.0.0, which triggers usage of the IP of the first interface)
192
193 # MainIp 10.0.0.1
194
195 # The fixed willingness to use (0-7)
196 # If not set willingness will be calculated
197 # dynamically based on battery/power status
198 # (default is 3)
199
200 # Willingness     3
201
202 # HNA (Host network association) allows the OLSR to announce
203 # additional IPs or IP subnets to the net that are reachable
204 # through this node.
205 # Syntax for HNA4 is "network-address    network-mask"
206 # Syntax for HNA6 is "network-address    prefix-length"
207 # (default is no HNA)
208 Hna4
209 {
210 # Internet gateway
211 # 0.0.0.0   0.0.0.0
212 # specific small networks reachable through this node
213 # 15.15.0.0 255.255.255.0
214 }
215 Hna6
216 {
217 # Internet gateway
218 #   0::                     0
219 # specific small networks reachable through this node
220 #   fec0:2200:106:0:0:0:0:0 48
221 }
222
223
224 # Hysteresis for link sensing (only for hopcount metric)
225 # Hysteresis adds more robustness to the link sensing
226 # but delays neighbor registration.
227 # (defaults to yes)
228
229 # UseHysteresis yes
230
231 # Hysteresis parameters (only for hopcount metric)
232 # Do not alter these unless you know what you are doing!
233 # Set to auto by default. Allowed values are floating point
234 # values in the interval 0,1
235 # THR_LOW must always be lower than THR_HIGH!!
236 # (default is 0.5/0.8/0.3)
237
238 # HystScaling  0.50
239 # HystThrHigh  0.80
240 # HystThrLow 0.30
241
242 # TC redundancy
243 # Specifies how much neighbor info should be sent in
244 # TC messages. Because of a design problem in the 0.5.x
245 # dijkstra implementation this value must be set to 2.
246 # 2 - send all neighbors
247 # (default is 2)
248
249 # TcRedundancy  2
250
251 # MPR coverage specifies how many MPRs a node should
252 # try select to reach every 2 hop neighbor. Because of
253 # a design problem in the 0.5.x lq mpr selection algorithm
254 # this value should be set to 7.
255 # (default is 7)
256
257 # MprCoverage 7
258
259 ################################
260 ### OLSR protocol extensions ###
261 ################################
262
263 # Link quality level switch between hopcount and 
264 # cost-based (mostly ETX) routing. Because of
265 # a design problem in the 0.5.x dijkstra algorithm this
266 # value should not be set to 1.
267 # 0 = do not use link quality
268 # 2 = use link quality for MPR selection and routing
269 # (default is 2)
270
271 # LinkQualityLevel 2
272
273 # Link quality algorithm (only for lq level 2)
274 # (see README-Olsr-Extensions)
275 # - "etx_float", a floating point  ETX with exponential aging
276 # - "etx_fpm", same as ext_float, but with integer arithmetic
277 # - "etx_ff" (ETX freifunk), an etx variant which use all OLSR
278 #   traffic (instead of only hellos) for ETX calculation
279 # - "etx_ffeth", an incompatible variant of etx_ff that allows
280 #   ethernet links with ETX 0.1.
281 # (defaults to "etx_ff")
282
283 # LinkQualityAlgorithm    "etx_ff"
284
285 # Link quality aging factor (only for lq level 2)
286 # Tuning parameter for etx_float and etx_fpm, smaller values
287 # mean slower changes of ETX value. (allowed values are
288 # between 0.01 and 1.0)
289 # (default is 0.05)
290
291 # LinkQualityAging 0.05
292
293 # Fisheye mechanism for TCs (0 meansoff, 1 means on)
294 # (default is 1)
295
296 # LinkQualityFishEye  1
297
298 #
299 # NatThreshold 
300 #
301 # (currently this is only in the freifunk firmware)
302 # If the NAT-Endpoint (the preferred 0/0 HNA emitting node)
303 # is to be changed, the ETX value of the current 0/0 is 
304 # multiplied with the NatThreshold value before being
305 # compared to the new one.
306 # The parameter can be a value between 0.1 and 1.0, but
307 # should be close to 1.0 if changed.
308 # WARNING: This parameter should not be used together with
309 # the etx_ffeth metric !!
310 # (defaults to 1.0)
311
312 # NatThreshold  1.0
313
314 #############################################################
315 ### Configuration of the IPC to the windows GUI interface ###
316 #############################################################
317
318 IpcConnect
319 {
320      # Determines how many simultaneously
321      # IPC connections that will be allowed
322      # Setting this to 0 disables IPC
323
324      # MaxConnections  0
325
326      # By default only 127.0.0.1 is allowed
327      # to connect. Here allowed hosts and networks can
328      # be added
329
330      # Host            127.0.0.1
331      # Host            10.0.0.5
332      # Net             192.168.1.0 255.255.255.0     
333 }
334
335 #####################################
336 ### Example plugin configurations ###
337 #####################################
338 # Olsrd plugins to load
339 # This must be the absolute path to the file
340 # or the loader will use the following scheme:
341 # - Try the paths in the LD_LIBRARY_PATH 
342 #   environment variable.
343 # - The list of libraries cached in /etc/ld.so.cache
344 # - /lib, followed by /usr/lib
345 #
346 # the examples in this list are for linux, so check if the plugin is
347 # available if you use windows/BSD.
348 # each plugin should have a README file in it's lib subfolder
349
350 # LoadPlugin "olsrd_httpinfo.dll"
351 LoadPlugin "olsrd_httpinfo.so.0.1"
352 {
353     # port number the httpinfo plugin will be listening, default 1978
354 #   PlParam     "port"   "8000"
355     
356     # ip address that can access the plugin, use "0.0.0.0"
357     # to allow everyone
358     PlParam     "Host"   "127.0.0.1"
359 #   PlParam     "Host"   "80.23.53.22"
360     
361     # networks that can access the plugin (ip/netmask)
362     # careful with 0.0.0.0/0, makes (ddos) attacks poss.
363 #   PlParam     "Net"    "0.0.0.0 0.0.0.0"
364     PlParam     "Net"    "104.0.0.0 255.255.0.0"
365     PlParam     "Net"    "192.168.0.0 255.255.0.0"
366 }
367
368 # LoadPlugin "olsrd_txtinfo.dll"
369 LoadPlugin "olsrd_txtinfo.so.0.1"
370 {
371     # port number the txtinfo plugin will be listening, default 2006
372 #   PlParam     "port"   "81"
373     # ip address that can access the plugin, use "0.0.0.0"
374     # to allow everyone
375     PlParam     "Accept"   "127.0.0.1"
376 }
377
378 #LoadPlugin "olsrd_secure.so.0.3"
379 #{
380     # define source of keyfile for secure plugin
381     # see lib/secure/README_SECURE for more information
382     
383 #   PlParam     "Keyfile"   "/etc/olsr-keyfile.txt"
384 #}
385
386 #LoadPlugin "olsrd_dyn_gw.so.0.5"
387 #{
388     # The plugin check interval can be set here in milliseconds.
389     # The default is 1000 ms (1 second).
390 #    PlParam     "CheckInterval"  "5000"
391     
392     # The ping check interval in case there is any pinged host specified.
393     # The default is 5 seconds.
394 #    PlParam     "PingInterval"   "40"
395     
396     # If one or more IPv4 addresses are given, do a ping on these in
397     # descending order to validate that there is not only an entry in
398     # routing table, but also a real network connection. If any of
399     # these addresses could be pinged successfully, the test was
400     # succesful, i.e. if the ping on the 1st address was successful,the
401     # 2nd won't be pinged.
402     #
403     # The Ping list applies to the group of HNAs specified above or to the 
404                 # default internet gateway when no HNA is specified.
405                 #
406                 # Running the plugin without parameters acts as the 'old' dyn_gw_plain.
407     
408     #   The following ping entries for the internet gateway
409 #    PlParam "Ping"   "141.1.1.1"
410 #    PlParam "Ping"   "194.25.2.129"
411     
412     #   First group of HNAs with related ping host
413 #    PlParam    "HNA"      "192.168.80.0 255.255.255.0"
414 #    PlParam    "HNA"      "192.168.81.0 255.255.255.0"
415 #    PlParam    "Ping"   "192.168.81.12"
416     
417     #   Second HNA group with multiple related ping hosts.
418     #   Specifying multiple ping hosts provides redundancy.
419 #    PlParam "HNA"    "192.168.100.0 255.255.255.0"
420 #    PlParam "HNA"    "192.168.101.0 255.255.255.0"
421 #    PlParam "HNA"    "192.168.102.0 255.255.255.0"
422 #    PlParam "Ping"   "192.168.100.10"
423 #    PlParam "Ping"   "192.168.101.10"
424     
425     #   Third HNA group without ping check
426 #    PlParam "HNA"    "192.168.200.0 255.255.255.0"
427 #    PlParam "HNA"    "192.168.201.0 255.255.255.0"
428 #    PlParam "HNA"    "192.168.202.0 255.255.255.0"
429 #}
430
431 #LoadPlugin "olsrd_dyn_gw_plain.so.0.4"
432 #{
433 #}
434
435 #############################################
436 ### OLSRD default interface configuration ###
437 #############################################
438 # the default interface section can have the same values as the following
439 # interface configuration. It will allow you so set common options for all
440 # interfaces.
441
442 InterfaceDefaults {
443     # Ip4Broadcast      255.255.255.255
444 }
445
446 ######################################
447 ### OLSRd Interfaces configuration ###
448 ######################################
449 # multiple interfaces can be specified for a single configuration block
450 # multiple configuration blocks can be specified
451
452 # WARNING, don't forget to insert your interface names here !
453 Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
454 {
455     # Interface Mode is used to prevent unnecessary
456     # packet forwarding on switched ethernet interfaces
457     # valid Modes are "mesh" and "ether"
458     # (default is "mesh")
459
460     # Mode "mesh"
461
462     # IPv4 broadcast address for outgoing OLSR packets.
463     # One usefull example would be 255.255.255.255
464     # The second useful value would be to
465     # specify the peer adress of an ptp-tunnel.
466     # another name of this parameter is "IPv4Multicast"
467     # (default is 0.0.0.0, which triggers the usage of the
468     # interface broadcast IP)
469     
470     # Ip4Broadcast      0.0.0.0
471
472     # IPv6 multicast address
473     # (default is FF02::6D, the manet-router linklocal multicast)
474
475     # IPv6Multicast     FF02::6D
476
477     # IPv4 src address for outgoing OLSR packages
478     # (default is 0.0.0.0, which triggers usage of the interface IP)
479
480     # IPv4Src 0.0.0.0
481
482     # IPv6 src prefix. OLSRd will choose one of the interface IPs
483     # which matches the prefix of this parameter.
484     # (default is 0::/0, which triggers the usage
485     # of a not-linklocal interface IP)
486
487     # IPv6Src 0::/0
488     
489     # Emission intervals in seconds.
490     # If not defined, Freifunk network defaults are used
491     # (default is 2.0/20.0 for Hello and 5.0/300.0 for Tc/Mid/Hna)
492
493     # HelloInterval       2.0
494     # HelloValidityTime  20.0
495     # TcInterval          5.0
496     # TcValidityTime    300.0
497     # MidInterval         5.0
498     # MidValidityTime   300.0
499     # HnaInterval         5.0
500     # HnaValidityTime   300.0
501     
502     # When multiple links exist between hosts
503     # the weight of interface is used to determine
504     # the link to use. Normally the weight is
505     # automatically calculated by olsrd based
506     # on the characteristics of the interface,
507     # but here you can specify a fixed value.
508     # Olsrd will choose links with the lowest value.
509     # Note:
510     # Interface weight is used only when LinkQualityLevel is set to 0.
511     # For any other value of LinkQualityLevel, the interface ETX
512     # value is used instead.
513     # Weight 0
514
515     # If a certain route should be preferred 
516     # or ignored by the mesh, the Link Quality 
517     # value of a node can be multiplied with a factor 
518     # entered here. In the example the route 
519     # using 192.168.0.1 would rather be ignored.
520     # A multiplier of 0.5 will result in a small
521     # (bad) LinkQuality value and a high (bad)
522     # ETX value.
523     # Note:
524     # Link quality multiplier is used only when
525     # LinkQualityLevel is > 0.
526
527     # example 1: reduce LQ to 192.168.0.1 by half
528     # LinkQualityMult 192.168.0.1 0.5
529
530     # example 2: reduce LQ to all nodes on this interface by 20%
531     # LinkQualityMult default 0.8
532 }