PUD: add SmartGatewaySpeedFile{,Period} to config
[olsrd.git] / lib / pud / doc / olsrd.conf.default.pud
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  0
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 "/tmp/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 "yes")
143
144 SmartGateway yes
145
146 # Allows the selection of a smartgateway with NAT (only for IPv4)
147 # (default is "yes")
148
149 # SmartGatewayAllowNAT yes
150
151 # Determines the period (in milliseconds) on which a new smart gateway
152 # selection is performed.
153 # (default is 10000 milliseconds)
154
155 # SmartGatewayPeriod 10000
156
157 # Determines the number of times the link state database must be stable
158 # before a new smart gateway is selected.
159 # (default is 6)
160
161 # SmartGatewayStableCount 6
162
163 # When another gateway than the current one has a cost of less than the cost
164 # of the current gateway multiplied by SmartGatewayThreshold then the smart
165 # gateway is switched to the other gateway. The unit is percentage.
166 # (defaults to 0)
167
168 # SmartGatewayThreshold 0
169 SmartGatewayThreshold   67
170
171 # Defines what kind of Uplink this node will publish as a
172 # smartgateway. The existence of the uplink is detected by
173 # a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.
174 # possible values are "none", "ipv4", "ipv6", "both"
175 # (default is "both")
176
177 # SmartGatewayUplink "both"
178
179 # Specifies if the local ipv4 uplink use NAT
180 # (default is "yes")
181
182 # SmartGatewayUplinkNAT yes
183
184 # Specifies the speed of the uplink in kilobit/s.
185 # First parameter is upstream, second parameter is downstream
186 # (default is 128/1024)
187
188 # SmartGatewaySpeed 128 1024
189 SmartGatewaySpeed 128 1024
190
191 # Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix
192 # length of more than 64 is not allowed.
193 # (default is 0::/0
194
195 # SmartGatewayPrefix 0::/0
196
197 # Specifies the file to watch for (dynamic) values for SmartGatewaySpeed.
198 # If not specified then no watching is performed.
199 # (default is unspecified)
200
201 # SmartGatewaySpeedFile ""
202
203 # Specifies the period in milliseconds on which to read the
204 # SmartGatewaySpeedFile (if it changed) and activate its new setting for
205 # SmartGatewaySpeed. This setting is only relevant if SmartGatewaySpeedFile
206 # has been configured.
207 # (default is 10000 milliseconds)
208
209 # SmartGatewaySpeedFilePeriod 10000
210
211 ##############################
212 ### OLSR protocol settings ###
213 ##############################
214
215 # For testing purposes it may be nice to use another port for olsrd
216 # for using another port than the IANA assigned one 
217 # for a production network, there should be a good reason!!
218 # valid values are integers >1, please be careful with using reserved
219 # port numbers
220 # (default is 698, the IANA assigned olsr-port)
221
222 # OlsrPort 698
223
224 # Sets the main IP (originator ip) of the router. This IP will NEVER
225 # change during the uptime of olsrd.
226 # (default is 0.0.0.0, which triggers usage of the IP of the first interface)
227
228 # MainIp 10.0.0.1
229
230 # The fixed willingness to use (0-7)
231 # If not set willingness will be calculated
232 # dynamically based on battery/power status
233 # (default is 3)
234
235 # Willingness     3
236
237 # HNA (Host network association) allows the OLSR to announce
238 # additional IPs or IP subnets to the net that are reachable
239 # through this node.
240 # Syntax for HNA4 is "network-address    network-mask"
241 # Syntax for HNA6 is "network-address    prefix-length"
242 # (default is no HNA)
243 Hna4
244 {
245 # Internet gateway
246 0.0.0.0   0.0.0.0
247 # specific small networks reachable through this node
248 # 15.15.0.0 255.255.255.0
249 }
250 Hna6
251 {
252 # Internet gateway
253 #   0::                     0
254 # specific small networks reachable through this node
255 #   fec0:2200:106:0:0:0:0:0 48
256 }
257
258
259 # Hysteresis for link sensing (only for hopcount metric)
260 # Hysteresis adds more robustness to the link sensing
261 # but delays neighbor registration.
262 # (defaults to yes)
263
264 # UseHysteresis yes
265
266 # Hysteresis parameters (only for hopcount metric)
267 # Do not alter these unless you know what you are doing!
268 # Set to auto by default. Allowed values are floating point
269 # values in the interval 0,1
270 # THR_LOW must always be lower than THR_HIGH!!
271 # (default is 0.5/0.8/0.3)
272
273 # HystScaling  0.50
274 # HystThrHigh  0.80
275 # HystThrLow 0.30
276
277 # TC redundancy
278 # Specifies how much neighbor info should be sent in
279 # TC messages. Because of a design problem in the 0.5.x
280 # dijkstra implementation this value must be set to 2.
281 # 2 - send all neighbors
282 # (default is 2)
283
284 # TcRedundancy  2
285
286 # MPR coverage specifies how many MPRs a node should
287 # try select to reach every 2 hop neighbor. Because of
288 # a design problem in the 0.5.x lq mpr selection algorithm
289 # this value should be set to 7.
290 # (default is 7)
291
292 # MprCoverage 7
293 MprCoverage     1
294
295 ################################
296 ### OLSR protocol extensions ###
297 ################################
298
299 # Link quality level switch between hopcount and 
300 # cost-based (mostly ETX) routing. Because of
301 # a design problem in the 0.5.x dijkstra algorithm this
302 # value should not be set to 1.
303 # 0 = do not use link quality
304 # 2 = use link quality for MPR selection and routing
305 # (default is 2)
306
307 # LinkQualityLevel 2
308
309 # Link quality algorithm (only for lq level 2)
310 # (see README-Olsr-Extensions)
311 # - "etx_float", a floating point  ETX with exponential aging
312 # - "etx_fpm", same as ext_float, but with integer arithmetic
313 # - "etx_ff" (ETX freifunk), an etx variant which use all OLSR
314 #   traffic (instead of only hellos) for ETX calculation
315 # - "etx_ffeth", an incompatible variant of etx_ff that allows
316 #   ethernet links with ETX 0.1.
317 # (defaults to "etx_ff")
318
319 LinkQualityAlgorithm    "etx_ffeth"
320
321 # Link quality aging factor (only for lq level 2)
322 # Tuning parameter for etx_float and etx_fpm, smaller values
323 # mean slower changes of ETX value. (allowed values are
324 # between 0.01 and 1.0)
325 # (default is 0.05)
326
327 # LinkQualityAging 0.05
328
329 # Fisheye mechanism for TCs (0 meansoff, 1 means on)
330 # (default is 1)
331
332 # LinkQualityFishEye  1
333 LinkQualityFishEye      0
334
335 #
336 # NatThreshold 
337 #
338 # (currently this is only in the freifunk firmware)
339 # If the NAT-Endpoint (the preferred 0/0 HNA emitting node)
340 # is to be changed, the ETX value of the current 0/0 is 
341 # multiplied with the NatThreshold value before being
342 # compared to the new one.
343 # The parameter can be a value between 0.1 and 1.0, but
344 # should be close to 1.0 if changed.
345 # WARNING: This parameter should not be used together with
346 # the etx_ffeth metric !!
347 # (defaults to 1.0)
348
349 # NatThreshold  1.0
350
351 #############################################################
352 ### Configuration of the IPC to the windows GUI interface ###
353 #############################################################
354
355 IpcConnect
356 {
357      # Determines how many simultaneously
358      # IPC connections that will be allowed
359      # Setting this to 0 disables IPC
360
361      # MaxConnections  0
362
363      # By default only 127.0.0.1 is allowed
364      # to connect. Here allowed hosts and networks can
365      # be added
366
367      # Host            127.0.0.1
368      # Host            10.0.0.5
369      # Net             192.168.1.0 255.255.255.0     
370 }
371
372 #####################################
373 ### Example plugin configurations ###
374 #####################################
375 # Olsrd plugins to load
376 # This must be the absolute path to the file
377 # or the loader will use the following scheme:
378 # - Try the paths in the LD_LIBRARY_PATH 
379 #   environment variable.
380 # - The list of libraries cached in /etc/ld.so.cache
381 # - /lib, followed by /usr/lib
382 #
383 # the examples in this list are for linux, so check if the plugin is
384 # available if you use windows/BSD.
385 # each plugin should have a README file in it's lib subfolder
386
387 # LoadPlugin "olsrd_httpinfo.dll"
388 LoadPlugin "./lib/httpinfo/olsrd_httpinfo.so.0.1"
389 {
390     # port number the httpinfo plugin will be listening, default 1978
391     PlParam     "port"   "8000"
392     
393     # ip address that can access the plugin, use "0.0.0.0"
394     # to allow everyone
395 #    PlParam     "Host"   "127.0.0.1"
396 #   PlParam     "Host"   "80.23.53.22"
397     
398     # networks that can access the plugin (ip/netmask)
399     # careful with 0.0.0.0/0, makes (ddos) attacks poss.
400 #    PlParam     "Net"    "127.0.0.1 255.0.0.0"
401     PlParam     "Net"    "0.0.0.0 0.0.0.0"
402 #    PlParam     "Net"    "104.0.0.0 255.255.0.0"
403 #    PlParam     "Net"    "192.168.0.0 255.255.0.0"
404 }
405
406 # LoadPlugin "olsrd_txtinfo.dll"
407 LoadPlugin "./lib/txtinfo/olsrd_txtinfo.so.0.1"
408 {
409     # port number the txtinfo plugin will be listening, default 2006
410 #   PlParam     "port"   "81"
411     # ip address that can access the plugin, use "0.0.0.0"
412     # to allow everyone
413     PlParam     "Accept"   "127.0.0.1"
414 }
415
416 #LoadPlugin "olsrd_secure.so.0.3"
417 #{
418     # define source of keyfile for secure plugin
419     # see lib/secure/README_SECURE for more information
420     
421 #   PlParam     "Keyfile"   "/etc/olsr-keyfile.txt"
422 #}
423
424 LoadPlugin "./lib/dyn_gw/olsrd_dyn_gw.so.0.5"
425 {
426     # The plugin check interval can be set here in milliseconds.
427     # The default is 1000 ms (1 second).
428 #    PlParam     "CheckInterval"  "5000"
429     
430     # The ping check interval in case there is any pinged host specified.
431     # The default is 5 seconds.
432 #    PlParam     "PingInterval"   "40"
433     
434     # If one or more IPv4 addresses are given, do a ping on these in
435     # descending order to validate that there is not only an entry in
436     # routing table, but also a real network connection. If any of
437     # these addresses could be pinged successfully, the test was
438     # succesful, i.e. if the ping on the 1st address was successful,the
439     # 2nd won't be pinged.
440     #
441     # The Ping list applies to the group of HNAs specified above or to the 
442     # default internet gateway when no HNA is specified.
443     #
444     # Running the plugin without parameters acts as the 'old' dyn_gw_plain.
445     
446     #   The following ping entries for the internet gateway
447 #    PlParam "Ping"   "141.1.1.1"
448 #    PlParam "Ping"   "194.25.2.129"
449     
450     #   First group of HNAs with related ping host
451 #    PlParam    "HNA"    "192.168.80.0 255.255.255.0"
452 #    PlParam    "HNA"    "192.168.81.0 255.255.255.0"
453 #    PlParam    "Ping"   "192.168.81.12"
454     
455     #   Second HNA group with multiple related ping hosts.
456     #   Specifying multiple ping hosts provides redundancy.
457 #    PlParam "HNA"    "192.168.100.0 255.255.255.0"
458 #    PlParam "HNA"    "192.168.101.0 255.255.255.0"
459 #    PlParam "HNA"    "192.168.102.0 255.255.255.0"
460 #    PlParam "Ping"   "192.168.100.10"
461 #    PlParam "Ping"   "192.168.101.10"
462     
463     #   Third HNA group without ping check
464 #    PlParam "HNA"    "192.168.200.0 255.255.255.0"
465 #    PlParam "HNA"    "192.168.201.0 255.255.255.0"
466 #    PlParam "HNA"    "192.168.202.0 255.255.255.0"
467
468 PlParam "HNA"   "0.0.0.0 0.0.0.0"
469 PlParam "HNA"   "0.0.0.0 128.0.0.0"
470 PlParam "HNA"   "128.0.0.0 128.0.0.0"
471 PlParam "HNA"   "0.0.0.0 192.0.0.0"
472 PlParam "HNA"   "64.0.0.0 192.0.0.0"
473 PlParam "HNA"   "128.0.0.0 192.0.0.0"
474 PlParam "HNA"   "192.0.0.0 192.0.0.0"
475 }
476
477 #LoadPlugin "olsrd_dyn_gw_plain.so.0.4"
478 #{
479 #}
480
481 LoadPlugin "./lib/p2pd/olsrd_p2pd.so.0.1.0"
482 {
483   PlParam     "NonOlsrIf"    "lo"
484   PlParam     "P2pdTtl"      "5"
485   PlParam     "UdpDestPort"  "255.255.255.255 1211"
486 }
487
488 LoadPlugin "./lib/bmf/olsrd_bmf.so.1.7.0"
489 {
490   PlParam     "NonOlsrIf"  "lo"
491 }
492
493 LoadPlugin "./lib/watchdog/olsrd_watchdog.so.0.1"
494 {
495   PlParam "file" "/tmp/olsrd.watchdog"
496   PlParam "interval" "5"
497 }
498
499 LoadPlugin "./lib/pud/olsrd_pud.so.1.1.0"
500 {
501     # nodeIdType is used to indicate the type of the nodeId field and is a
502     #            number in the range 0-255, with the following meaning:
503     #
504     #        0 : MAC address of sending interface
505     #            (nodeId is not relevant)
506     #        1 : an MSISDN number with 15 digits
507     #        2 : a Tetra number with 17 digits
508     #        3 : a DNS name
509     #        4 : IPv4 address (OLSR main address) of the sending node
510     #            (nodeId is not relevant)
511     #        6 : IPv6 address (OLSR main address) of the sending node
512     #            (nodeId is not relevant)
513     #        7 : an AIS MMSI number with 9 digits
514     #        8 : a URN number with 8 digits
515     #      192 : a 7 digit number conforming to 'Nationaal Nummerplan
516     #            Brandweer Nederland'
517     #      193 : a 6 digit number conforming to 'Nationaal Nummerplan
518     #            Ambulancezorg Nederland'
519     #      194 : a 4 digit number in the range [1, 8191]
520     #
521     #      other numbers are reserved 
522     #
523     # Note: setting 4 or 6 is the same for olsrd: both mean 'use the main
524     #       IP address, which is either an IPv4 or an IPv6 address, depending
525     #       on the IP version under which olsrd is run.
526     #
527     # Default: 4 or 6, depending on the IP version olsrd is using
528     #
529     #PlParam     "nodeIdType"                   "4"
530
531     # nodeId is the node identification with the meaning as indicated by the
532     #        nodeIdType parameter. When not set AND the nodeIdType is 3 (DNS
533     #        name) then the hostname is used.
534     #
535     # Note: Both the nodeIdType and nodeId fields are transported over
536     #       OLSR, so care must be taken to keep the size of the nodeId
537     #       parameter down.
538     #
539     # Default: none
540     #
541     #PlParam     "nodeId"                       "host.example.com"
542
543
544     #
545     # RX Parameters
546     #
547
548     # rxNonOlsrIf is a network interface on the host on which the plugin will
549     #             listen for GPS multicasts. Multiple such interfaces can be
550     #             specified by specifying the parameter multiple times.
551     #
552     # Default: none
553     #
554     PlParam     "rxNonOlsrIf"                  "lo"
555
556     # rxAllowedSourceIpAddress is an IP address from which the plugin is
557     #                          allowed to process/parse GPS sentences. When
558     #                          this parameter is not configured then GPS
559     #                          sentences from ALL IP addresses are processed.
560     #                          Multiple IP addresses can be specified by
561     #                          specifying the parameter multiple times.
562     #
563     # Default: none
564     #
565     PlParam     "rxAllowedSourceIpAddress"     "127.0.0.1"
566
567     # rxMcAddr is the multicast address on which the plugin will listen for GPS
568     #          multicasts.
569     #
570     # Default: 224.0.0.224 (IPv4) or FF02:0:0:0:0:0:0:1 (IPv6)
571     #
572     #PlParam     "rxMcAddr"                     "224.0.0.224"
573
574     # rxMcPort is the UDP port on which the plugin will listen for GPS
575     #          multicasts.
576     #
577     # Default: 2240
578     #
579     #PlParam     "rxMcPort"                     "2240"
580
581     # positionFile is the file that contains the position information that the
582     #              plugin should use. When this parameter is set then the
583     #              file is read during olsrd startup.
584     #PlParam     "positionFile"                 "/etc/olsrd.pud.position.conf"
585
586     #
587     # TX Parameters
588     #
589
590     # txNonOlsrIf is a network interface on the host on which the plugin will
591     #             transmit GPS multicasts that were received through the OLSR
592     #             network. Multiple such interfaces can be specified by
593     #             specifying the parameter multiple times.
594     #
595     # Default: none
596     #
597     PlParam     "txNonOlsrIf"                  "lo"
598
599     # txMcAddr is the multicast address on which the plugin will transmit GPS
600     #          multicasts that were received through the OLSR network.
601     #
602     # Default: 224.0.0.224 (IPv4) or FF02:0:0:0:0:0:0:1 (IPv6)
603     #
604     #PlParam     "txMcAddr"                     "224.0.0.224"
605
606     # txMcPort is the UDP port on which the plugin will transmit GPS multicasts
607     #          that were received through the OLSR network.
608     #
609     # Default: 2240
610     #
611     #PlParam     "txMcPort"                     "2240"
612
613     # txTtl is the TTL that is used when transmitting GPS multicasts that were
614     #       received through the OLSR network
615     #
616     # Default: 1
617     #
618     #PlParam     "txTtl"                        "1"
619
620     # txNmeaMessagePrefix is the NMEA message prefix of GPS multicasts that the
621     #                     plugin transmits. It must be exactly 4 characters
622     #                     long.
623     #
624     # Default: NBSX
625     #
626     #PlParam     "txNmeaMessagePrefix"          "NBSX"
627
628
629     #
630     # Uplink Parameters
631     #
632
633     # uplinkAddr is the IP address to which the plugin will transmit GPS
634     #            position updates. When not set, no uplink messages will be
635     #            sent.
636     #
637     # Default: none
638     #
639     PlParam     "uplinkAddr"                   "127.0.0.1"
640
641     # uplinkPort is the UDP port to which the plugin will transmit GPS position
642     #            updates. Can't be the same as the downlink port.
643     #
644     # Default: 2241
645     #
646     #PlParam     "uplinkPort"                   "2241"
647
648     # downlinkPort is the UDP port on which the plugin will receive GPS position
649     #              updates. Can't be the same as the uplink port.
650     #              The downlink is only active when a proper uplink has been
651     #              configured.
652     #
653     # Default: 2242
654     #
655     #PlParam     "downlinkPort"                 "2242"
656
657
658     #
659     # OLSR Parameters
660     #
661
662     # olsrTtl is the TTL that is used when sending messages over the OLSR
663     #         networks
664     #
665     # Default: 64
666     #
667     #PlParam     "olsrTtl"                      "64"
668
669
670     #
671     # Update Parameters
672     #
673
674     # updateIntervalStationary is the interval (in seconds) between position
675     #                          updates sent over the OLSR network when the
676     #                          node is stationary
677     #
678     # Default: 60
679     #
680     #PlParam     "updateIntervalStationary"     "60"
681
682     # updateIntervalMoving is the interval (in seconds) between position
683     #                      updates sent over the OLSR network when the
684     #                      node is moving
685     #
686     # Default: 5
687     #
688     #PlParam     "updateIntervalMoving"         "5"
689
690     # uplinkUpdateIntervalStationary is the interval (in seconds) between
691     #                                position updates sent over the uplink when
692     #                                the node is stationary
693     #
694     # Default: 180
695     #
696     #PlParam     "uplinkUpdateIntervalStationary"  "180"
697
698     # uplinkUpdateIntervalMoving is the interval (in seconds) between position
699     #                            updates sent over the OLSR network when the
700     #                            node is moving
701     #
702     # Default: 15
703     #
704     #PlParam     "uplinkUpdateIntervalMoving"      "15"
705
706     # gatewayDeterminationInterval is the interval (in seconds) on which
707     #                              determination of the best gateway is
708     #                              performed
709     #
710     # Default: 1
711     #
712     #PlParam     "gatewayDeterminationInterval"    "1"
713
714     # movingSpeedThreshold is the speed from which we consider the node is
715     #                      moving
716     #
717     # Default: 9
718     #
719     #PlParam     "movingSpeedThreshold"         "9"
720
721     # movingDistanceThreshold is the distance from the previous position from
722     #                         which we consider the node is moving
723     #
724     # Default: 50
725     #
726     #PlParam     "movingDistanceThreshold"      "50"
727
728     # dopMultiplier One of the situations that is seen as movement is when the
729     #               current position with its uncertainty circle no longer
730     #               overlaps the last transmitted position with its uncertainty
731     #               circle. This parameter is used to adjust the sizes of these
732     #               uncertainty circles: setting it to a value less than 1.0
733     #               will make both uncertainty circles smaller by this factor,
734     #               resulting in earlier movement detection. Setting it to a
735     #               value larger than 1.0 will detect movement later.
736     #
737     # Default: 2.5
738     #
739     #PlParam     "dopMultiplier"                "2.5"
740
741     # defaultHdop is the default value that is taken for HDOP (in meters) in
742     #             determining whether we are moving when there is a position
743     #             available but no HDOP.
744     #
745     # Default: 50
746     #
747     #PlParam     "defaultHdop"                  "50"
748
749     # defaultVdop is the default value that is taken for VDOP (in meters) in
750     #             determining whether we are moving when there is a position
751     #             available but no VDOP.
752     #
753     # Default: 50
754     #
755     #PlParam     "defaultVdop"                  "50"
756
757     # averageDepth is the depth of the position average list, or the number
758     #              of positions that are averaged to obtain the average
759     #              position
760     #
761     # Default: 5
762     #
763     #PlParam     "averageDepth"                 "5"
764
765     # hysteresisCountToStationary is the number of position updates that
766     #                             effectuate a state transition from moving to
767     #                             stationary that must be received before the
768     #                             actual transition is taken
769     #
770     # Default: 17
771     #
772     #PlParam     "hysteresisCountToStationary"  "17"
773
774     # hysteresisCountToMoving is the number of position updates that effectuate
775     #                         a state transition from stationary to moving that
776     #                         must be received before the actual transition is
777     #                         taken
778     #
779     # Default: 5
780     #
781     #PlParam     "hysteresisCountToMoving"      "5"
782
783     # gatewayHysteresisCountToStationary is the number of times the gateway
784     #                             must be the same that effectuate a state transition from
785     #                             moving to stationary that must be received
786     #                             before the actual transition is taken
787     #
788     # Default: 17
789     #
790     #PlParam     "gatewayHysteresisCountToStationary"  "17"
791
792     # gatewayHysteresisCountToMoving is the number of gateway updates that
793     #                         effectuate a state transition from stationary to
794     #                         moving that must be received before the actual
795     #                         transition is taken
796     #
797     # Default: 5
798     #
799     #PlParam     "gatewayHysteresisCountToMoving"      "5"
800
801
802     #
803     # Other Plugin Parameters
804     #
805
806     # useDeDup determines whether duplicate message detection is to be
807     #          performed. When 0 then no such detection is performed, when 1
808     #          then the detection is performed 
809     #
810     # Default: 1
811     #
812     #PlParam     "useDeDup"                     "1"
813
814     # deDupDepth the number of messages that are tracked to detect duplucates
815     #            messages received from the OLSR network
816     #
817     # Default: 256
818     #
819     #PlParam     "deDupDepth"                   "256"
820
821     # useLoopback determines whether the message that is sent over the OLSR
822     #             network should be immediately looped back, thus pretending
823     #             that the message (that is sent by this node) is received from
824     #             the OLSR network. When 0 then no loopback is performed, when
825     #             1 then the loopback is performed
826     #
827     # Default: 0
828     #
829     PlParam     "useLoopback"                  "1"
830 }
831
832 #############################################
833 ### OLSRD default interface configuration ###
834 #############################################
835 # the default interface section can have the same values as the following
836 # interface configuration. It will allow you so set common options for all
837 # interfaces.
838
839 InterfaceDefaults {
840     # Ip4Broadcast      255.255.255.255
841 }
842
843 ######################################
844 ### OLSRd Interfaces configuration ###
845 ######################################
846 # multiple interfaces can be specified for a single configuration block
847 # multiple configuration blocks can be specified
848
849 # WARNING, don't forget to insert your interface names here !
850 Interface "em1"
851 {
852     # Interface Mode is used to prevent unnecessary
853     # packet forwarding on switched ethernet interfaces
854     # valid Modes are "mesh" and "ether"
855     # (default is "mesh")
856
857     # Mode "mesh"
858
859     # IPv4 broadcast address for outgoing OLSR packets.
860     # One usefull example would be 255.255.255.255
861     # The second useful value would be to
862     # specify the peer adress of an ptp-tunnel.
863     # another name of this parameter is "IPv4Multicast"
864     # (default is 0.0.0.0, which triggers the usage of the
865     # interface broadcast IP)
866     
867     # Ip4Broadcast      0.0.0.0
868
869     # IPv6 multicast address
870     # (default is FF02::6D, the manet-router linklocal multicast)
871
872     # IPv6Multicast FF02::6D
873
874     # IPv4 src address for outgoing OLSR packages
875     # (default is 0.0.0.0, which triggers usage of the interface IP)
876
877     # IPv4Src 0.0.0.0
878
879     # IPv6 src prefix. OLSRd will choose one of the interface IPs
880     # which matches the prefix of this parameter.
881     # (default is 0::/0, which triggers the usage
882     # of a not-linklocal interface IP)
883
884     # IPv6Src 0::/0
885     
886     # Emission intervals in seconds.
887     # If not defined, Freifunk network defaults are used
888     # (default is 2.0/20.0 for Hello and 5.0/300.0 for Tc/Mid/Hna)
889
890     # HelloInterval       2.0
891     # HelloValidityTime  20.0
892     # TcInterval          5.0
893     # TcValidityTime    300.0
894     # MidInterval         5.0
895     # MidValidityTime   300.0
896     # HnaInterval         5.0
897     # HnaValidityTime   300.0
898 HelloInterval     2.00
899 HelloValidityTime 20.00
900 TcInterval        5.00
901 TcValidityTime    30.00
902 MidInterval       5.00
903 MidValidityTime   50.00
904 HnaInterval       5.00
905 HnaValidityTime   15.00
906     
907     # When multiple links exist between hosts
908     # the weight of interface is used to determine
909     # the link to use. Normally the weight is
910     # automatically calculated by olsrd based
911     # on the characteristics of the interface,
912     # but here you can specify a fixed value.
913     # Olsrd will choose links with the lowest value.
914     # Note:
915     # Interface weight is used only when LinkQualityLevel is set to 0.
916     # For any other value of LinkQualityLevel, the interface ETX
917     # value is used instead.
918     # Weight 0
919
920     # If a certain route should be preferred 
921     # or ignored by the mesh, the Link Quality 
922     # value of a node can be multiplied with a factor 
923     # entered here. In the example the route 
924     # using 192.168.0.1 would rather be ignored.
925     # A multiplier of 0.5 will result in a small
926     # (bad) LinkQuality value and a high (bad)
927     # ETX value.
928     # Note:
929     # Link quality multiplier is used only when
930     # LinkQualityLevel is > 0.
931
932     # example 1: reduce LQ to 192.168.0.1 by half
933     # LinkQualityMult 192.168.0.1 0.5
934
935     # example 2: reduce LQ to all nodes on this interface by 20%
936     # LinkQualityMult default 0.8
937 }