d2ebb1dc47c00f25aef2cc26462db7094e87bc5a
[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 # (default is 254/112/113, the first is the "main" table in linux)
111
112 # RtTable 254
113 # RtTableDefault 112
114 # RtTableTunnel 113
115
116 # Specifies the policy rule priorities for the three routing tables and
117 # a special rule for smartgateway routing (see README-Olsr-Extensions)
118 # Priorities can only be set if three different routing tables are set.
119 # 0 means "set no policy rule", if set the values must obey to condition
120 # RtTablePriority < RtTableDefaultOlsrPriority
121 # < RtTableTunnelPriority < RtTableDefaultPriority
122 # (default is 32766/32776/32786/32796)
123
124 # RtTablePriority 32766
125 # RtTableDefaultOlsrPriority 32776
126 # RtTableTunnelPriority 32786
127 # RtTableDefaultPriority 32796
128
129 # Activates (in IPv6 mode) the automatic use of NIIT
130 # (see README-Olsr-Extensions)
131 # (default is "yes")
132
133 # UseNiit yes
134
135 # Activates the smartgateway ipip tunnel feature.
136 # See README-Olsr-Extensions for a description of smartgateways.
137 # (default is "yes")
138
139 # SmartGateway yes
140
141 # Allows the selection of a smartgateway with NAT (only for IPv4)
142 # (default is "yes")
143
144 # SmartGatewayAllowNAT yes
145
146 # Defines what kind of Uplink this node will publish as a
147 # smartgateway. The existence of the uplink is detected by
148 # a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.
149 # possible values are "none", "ipv4", "ipv6", "both"
150 # (default is "both")
151
152 # SmartGatewayUplink "both"
153
154 # Specifies if the local ipv4 uplink use NAT
155 # (default is "yes")
156
157 # SmartGatewayUplinkNAT yes
158
159 # Specifies the speed of the uplink in kilobit/s.
160 # First parameter is upstream, second parameter is downstream
161 # (default is 128/1024)
162
163 # SmartGatewaySpeed 128 1024
164
165 # Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix
166 # length of more than 64 is not allowed.
167 # (default is 0::/0
168
169 # SmartGatewayPrefix 0::/0
170
171 ##############################
172 ### OLSR protocol settings ###
173 ##############################
174
175 # For testing purposes it may be nice to use another port for olsrd
176 # for using another port than the IANA assigned one 
177 # for a production network, there should be a good reason!!
178 # valid values are integers >1, please be careful with using reserved
179 # port numbers
180 # (default is 698, the IANA assigned olsr-port)
181
182 # OlsrPort 698
183
184 # Sets the main IP (originator ip) of the router. This IP will NEVER
185 # change during the uptime of olsrd.
186 # (default is 0.0.0.0, which triggers usage of the IP of the first interface)
187
188 # MainIp 10.0.0.1
189
190 # The fixed willingness to use (0-7)
191 # If not set willingness will be calculated
192 # dynamically based on battery/power status
193 # (default is 3)
194
195 # Willingness     3
196
197 # HNA (Host network association) allows the OLSR to announce
198 # additional IPs or IP subnets to the net that are reachable
199 # through this node.
200 # Syntax for HNA4 is "network-address    network-mask"
201 # Syntax for HNA6 is "network-address    prefix-length"
202 # (default is no HNA)
203 Hna4
204 {
205 # Internet gateway
206 # 0.0.0.0   0.0.0.0
207 # specific small networks reachable through this node
208 # 15.15.0.0 255.255.255.0
209 }
210 Hna6
211 {
212 # Internet gateway
213 #   0::                     0
214 # specific small networks reachable through this node
215 #   fec0:2200:106:0:0:0:0:0 48
216 }
217
218
219 # Hysteresis for link sensing (only for hopcount metric)
220 # Hysteresis adds more robustness to the link sensing
221 # but delays neighbor registration.
222 # (defaults to yes)
223
224 # UseHysteresis yes
225
226 # Hysteresis parameters (only for hopcount metric)
227 # Do not alter these unless you know what you are doing!
228 # Set to auto by default. Allowed values are floating point
229 # values in the interval 0,1
230 # THR_LOW must always be lower than THR_HIGH!!
231 # (default is 0.5/0.8/0.3)
232
233 # HystScaling  0.50
234 # HystThrHigh  0.80
235 # HystThrLow 0.30
236
237 # TC redundancy
238 # Specifies how much neighbor info should be sent in
239 # TC messages. Because of a design problem in the 0.5.x
240 # dijkstra implementation this value must be set to 2.
241 # 2 - send all neighbors
242 # (default is 2)
243
244 # TcRedundancy  2
245
246 # MPR coverage specifies how many MPRs a node should
247 # try select to reach every 2 hop neighbor. Because of
248 # a design problem in the 0.5.x dijkstra algorithm this
249 # value should be set to 7.
250 # (default is 7)
251
252 # MprCoverage 7
253
254 ################################
255 ### OLSR protocol extensions ###
256 ################################
257
258 # Link quality level switch between hopcount and 
259 # cost-based (mostly ETX) routing. Because of
260 # a design problem in the 0.5.x dijkstra algorithm this
261 # value should not be set to 1.
262 # 0 = do not use link quality
263 # 2 = use link quality for MPR selection and routing
264 # (default is 2)
265
266 # LinkQualityLevel 2
267
268 # Link quality algorithm (only for lq level 2)
269 # (see README-Olsr-Extensions)
270 # - "etx_float", a floating point  ETX with exponential aging
271 # - "etx_fpm", same as ext_float, but with integer arithmetic
272 # - "etx_ff" (ETX freifunk), an etx variant which use all OLSR
273 #   traffic (instead of only hellos) for ETX calculation
274 # - "etx_ffeth", an incompatible variant of etx_ff that allows
275 #   ethernet links with ETX 0.1.
276 # (defaults to "etx_ff")
277
278 # LinkQualityAlgorithm    "etx_ff"
279
280 # Link quality aging factor (only for lq level 2)
281 # Tuning parameter for etx_float and etx_fpm, smaller values
282 # mean slower changes of ETX value. (allowed values are
283 # between 0.01 and 1.0)
284 # (default is 0.05)
285
286 # LinkQualityAging 0.05
287
288 # Fisheye mechanism for TCs (0 meansoff, 1 means on)
289 # (default is 1)
290
291 # LinkQualityFishEye  1
292
293 #
294 # NatThreshold 
295 #
296 # (currently this is only in the freifunk firmware)
297 # If the NAT-Endpoint (the preferred 0/0 HNA emitting node)
298 # is to be changed, the ETX value of the current 0/0 is 
299 # multiplied with the NatThreshold value before being
300 # compared to the new one.
301 # The parameter can be a value between 0.1 and 1.0, but
302 # should be close to 1.0 if changed.
303 # WARNING: This parameter should not be used together with
304 # the etx_ffeth metric !!
305 # (defaults to 1.0)
306
307 # NatThreshold  1.0
308
309 #############################################################
310 ### Configuration of the IPC to the windows GUI interface ###
311 #############################################################
312
313 IpcConnect
314 {
315      # Determines how many simultaneously
316      # IPC connections that will be allowed
317      # Setting this to 0 disables IPC
318
319      # MaxConnections  0
320
321      # By default only 127.0.0.1 is allowed
322      # to connect. Here allowed hosts and networks can
323      # be added
324
325      # Host            127.0.0.1
326      # Host            10.0.0.5
327      # Net             192.168.1.0 255.255.255.0     
328 }
329
330 #####################################
331 ### Example plugin configurations ###
332 #####################################
333 # Olsrd plugins to load
334 # This must be the absolute path to the file
335 # or the loader will use the following scheme:
336 # - Try the paths in the LD_LIBRARY_PATH 
337 #   environment variable.
338 # - The list of libraries cached in /etc/ld.so.cache
339 # - /lib, followed by /usr/lib
340 #
341 # the examples in this list are for linux, so check if the plugin is
342 # available if you use windows/BSD.
343 # each plugin should have a README file in it's lib subfolder
344
345 # LoadPlugin "olsrd_httpinfo.dll"
346 LoadPlugin "olsrd_httpinfo.so.0.1"
347 {
348     # port number the httpinfo plugin will be listening, default 1978
349 #   PlParam     "port"   "8000"
350     
351     # ip address that can access the plugin, use "0.0.0.0"
352     # to allow everyone
353     PlParam     "Host"   "127.0.0.1"
354 #   PlParam     "Host"   "80.23.53.22"
355     
356     # networks that can access the plugin (ip/netmask)
357     # careful with 0.0.0.0/0, makes (ddos) attacks poss.
358 #   PlParam     "Net"    "0.0.0.0 0.0.0.0"
359     PlParam     "Net"    "104.0.0.0 255.255.0.0"
360     PlParam     "Net"    "192.168.0.0 255.255.0.0"
361 }
362
363 # LoadPlugin "olsrd_txtinfo.dll"
364 LoadPlugin "olsrd_txtinfo.so.0.1"
365 {
366     # port number the txtinfo plugin will be listening, default 2006
367 #   PlParam     "port"   "81"
368     # ip address that can access the plugin, use "0.0.0.0"
369     # to allow everyone
370     PlParam     "Accept"   "127.0.0.1"
371 }
372
373 #LoadPlugin "olsrd_secure.so.0.3"
374 #{
375     # define source of keyfile for secure plugin
376     # see lib/secure/README_SECURE for more information
377     
378 #   PlParam     "Keyfile"   "/etc/olsr-keyfile.txt"
379 #}
380
381 #LoadPlugin "olsrd_dyn_gw.so.0.5"
382 #{
383     # The plugin check interval can be set here in milliseconds.
384     # The default is 1000 ms (1 second).
385 #    PlParam     "CheckInterval"  "5000"
386     
387     # The ping check interval in case there is any pinged host specified.
388     # The default is 5 seconds.
389 #    PlParam     "PingInterval"   "40"
390     
391     # If one or more IPv4 addresses are given, do a ping on these in
392     # descending order to validate that there is not only an entry in
393     # routing table, but also a real network connection. If any of
394     # these addresses could be pinged successfully, the test was
395     # succesful, i.e. if the ping on the 1st address was successful,the
396     # 2nd won't be pinged.
397     #
398     # The Ping list applies to the group of HNAs specified above or to the 
399                 # default internet gateway when no HNA is specified.
400                 #
401                 # Running the plugin without parameters acts as the 'old' dyn_gw_plain.
402     
403     #   The following ping entries for the internet gateway
404 #    PlParam "Ping"   "141.1.1.1"
405 #    PlParam "Ping"   "194.25.2.129"
406     
407     #   First group of HNAs with related ping host
408 #    PlParam    "HNA"      "192.168.80.0 255.255.255.0"
409 #    PlParam    "HNA"      "192.168.81.0 255.255.255.0"
410 #    PlParam    "Ping"   "192.168.81.12"
411     
412     #   Second HNA group with multiple related ping hosts.
413     #   Specifying multiple ping hosts provides redundancy.
414 #    PlParam "HNA"    "192.168.100.0 255.255.255.0"
415 #    PlParam "HNA"    "192.168.101.0 255.255.255.0"
416 #    PlParam "HNA"    "192.168.102.0 255.255.255.0"
417 #    PlParam "Ping"   "192.168.100.10"
418 #    PlParam "Ping"   "192.168.101.10"
419     
420     #   Third HNA group without ping check
421 #    PlParam "HNA"    "192.168.200.0 255.255.255.0"
422 #    PlParam "HNA"    "192.168.201.0 255.255.255.0"
423 #    PlParam "HNA"    "192.168.202.0 255.255.255.0"
424 #}
425
426 #LoadPlugin "olsrd_dyn_gw_plain.so.0.4"
427 #{
428 #}
429
430 #############################################
431 ### OLSRD default interface configuration ###
432 #############################################
433 # the default interface section can have the same values as the following
434 # interface configuration. It will allow you so set common options for all
435 # interfaces.
436
437 InterfaceDefaults {
438     # Ip4Broadcast      255.255.255.255
439 }
440
441 ######################################
442 ### OLSRd Interfaces configuration ###
443 ######################################
444 # multiple interfaces can be specified for a single configuration block
445 # multiple configuration blocks can be specified
446
447 # WARNING, don't forget to insert your interface names here !
448 Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
449 {
450     # Interface Mode is used to prevent unnecessary
451     # packet forwarding on switched ethernet interfaces
452     # valid Modes are "mesh" and "ether"
453     # (default is "mesh")
454
455     # Mode "mesh"
456
457     # IPv4 broadcast address for outgoing OLSR packets.
458     # One usefull example would be 255.255.255.255
459     # The second useful value would be to
460     # specify the peer adress of an ptp-tunnel.
461     # another name of this parameter is "IPv4Multicast"
462     # (default is 0.0.0.0, which triggers the usage of the
463     # interface broadcast IP)
464     
465     # Ip4Broadcast      0.0.0.0
466
467     # IPv6 multicast address
468     # (default is FF02::6D, the manet-router linklocal multicast)
469
470     # IPv6Multicast     FF02::6D
471
472     # IPv4 src address for outgoing OLSR packages
473     # (default is 0.0.0.0, which triggers usage of the interface IP)
474
475     # IPv4Src 0.0.0.0
476
477     # IPv6 src prefix. OLSRd will choose one of the interface IPs
478     # which matches the prefix of this parameter.
479     # (default is 0::/0, which triggers the usage
480     # of a not-linklocal interface IP)
481
482     # IPv6Src 0::/0
483     
484     # Emission intervals in seconds.
485     # If not defined, Freifunk network defaults are used
486     # (default is 2.0/20.0 for Hello and 5.0/300.0 for Tc/Mid/Hna)
487
488     # HelloInterval       2.0
489     # HelloValidityTime  20.0
490     # TcInterval          5.0
491     # TcValidityTime    300.0
492     # MidInterval         5.0
493     # MidValidityTime   300.0
494     # HnaInterval         5.0
495     # HnaValidityTime   300.0
496     
497     # When multiple links exist between hosts
498     # the weight of interface is used to determine
499     # the link to use. Normally the weight is
500     # automatically calculated by olsrd based
501     # on the characteristics of the interface,
502     # but here you can specify a fixed value.
503     # Olsrd will choose links with the lowest value.
504     # Note:
505     # Interface weight is used only when LinkQualityLevel is set to 0.
506     # For any other value of LinkQualityLevel, the interface ETX
507     # value is used instead.
508     # Weight 0
509
510     # If a certain route should be preferred 
511     # or ignored by the mesh, the Link Quality 
512     # value of a node can be multiplied with a factor 
513     # entered here. In the example the route 
514     # using 192.168.0.1 would rather be ignored.
515     # A multiplier of 0.5 will result in a small
516     # (bad) LinkQuality value and a high (bad)
517     # ETX value.
518     # Note:
519     # Link quality multiplier is used only when
520     # LinkQualityLevel is > 0.
521
522     # example 1: reduce LQ to 192.168.0.1 by half
523     # LinkQualityMult 192.168.0.1 0.5
524
525     # example 2: reduce LQ to all nodes on this interface by 20%
526     # LinkQualityMult default 0.8
527 }