Update default configuration files
[olsrd.git] / files / olsrd.conf.default.lq
1 #
2 # OLSR.org routing daemon config file
3 #
4 # Lines starting with a # are discarded
5 #
6
7 # Debug level(0-9)
8 # If set to 0 the daemon runs in the background
9
10 DebugLevel      1
11
12 # IP version to use (4 or 6)
13
14 IpVersion       4
15
16 # FIBMetric ("flat", "correct", or "approx")
17 # Just use "flat", the others don't work very well
18
19 FIBMetric "flat"
20
21 # Clear the screen each time the internal state changes
22
23 ClearScreen     yes
24
25 # HNA IPv4 routes
26 # syntax: netaddr netmask
27 # Example Internet gateway:
28 # 0.0.0.0 0.0.0.0
29
30 Hna4
31 {
32 # Internet gateway
33 #    0.0.0.0   0.0.0.0
34
35 # specific small networks reachable through this node
36 #    15.15.0.0 255.255.255.0
37 #    15.16.0.0 255.255.255.0
38 }
39
40 # HNA IPv6 routes
41 # syntax: netaddr prefix
42 # Example Internet gateway:
43 #Hna6
44 #{
45 # Internet gateway
46 #     ::              0
47
48 # specific small networks reachable through this node
49 #    fec0:2200:106:0:0:0:0:0 48
50 #}
51
52 # Specify the routing Table olsr uses
53 # currently only implemented in linux versions, (bsd planned)
54 # useful for policyrouting, to ensure that olsr can use 
55 # the table a policy rule with priority 65536 is auto-installed
56 # by olsrd if an value < 253 ist specified!
57 # value defaults to 253 (main table)
58 # valid values are 1 .. 254
59 # (freifunkfirmware uses 111 for its policy routing)
60
61 # RtTable 111
62
63 #you may specify another table for the default route only
64 #if used no policy route will get auto-installed for this table, 
65 #but the default route gets also inserted into table 254 
66 #(the last table used in default linux policy routing)
67 #valid tables are the same as for RtTable
68
69 # RtTableDefault 112
70
71 # Specify the proto tag to be used for routes olsr inserts into kernel
72 # currently only implemented for linux, defaults to 0 which gets replaced
73 # by an OS-specific default value under linux 3 (BOOT) gets used as default
74 # (for backward compatibility)
75 # valid values under linux are 1 .. 254
76 # 1 gets remapped by olsrd to 0 UNSPECIFIED (1 is reserved for ICMP redirects)
77 # 2 KERNEL routes (not very wise to use)
78 # 3 BOOT (should in fact not be used by routing daemons)
79 # 4 STATIC 
80 # 8 .. 15 various routing daemons (gated, zebra, bird, & co)
81
82 # RtProto 111
83
84 # For testing purposes it may be nice to use another port for olsrd
85 # for using another port than the IANA assigned one 
86 # for a production network, there should be a good reason!!
87 # defaults to 698 (IANA assigned olsr-port)
88 # valid values are 698 or > 1000
89
90 # OlsrPort 698
91
92 # Should olsrd keep on running even if there are
93 # no interfaces available? This is a good idea
94 # for a PCMCIA/USB hotswap environment.
95 # "yes" OR "no"
96
97 AllowNoInt      yes
98
99 # TOS(type of service) value for
100 # the IP header of control traffic.
101 # If not set it will default to 16
102
103 #TosValue       16
104
105 # The fixed willingness to use(0-7)
106 # If not set willingness will be calculated
107 # dynammically based on battery/power status
108
109 #Willingness            4
110
111 # Allow processes like the GUI front-end
112 # to connect to the daemon.
113
114 IpcConnect
115 {
116      # Determines how many simultaneously
117      # IPC connections that will be allowed
118      # Setting this to 0 disables IPC
119
120      MaxConnections  0
121
122      # By default only 127.0.0.1 is allowed
123      # to connect. Here allowed hosts can
124      # be added
125
126      Host            127.0.0.1
127      # Host            10.0.0.5
128
129      # Specify entire net-ranges that are 
130      # allowed to connect
131
132      # Net             192.168.1.0 255.255.255.0     
133 }
134
135 # Link quality level
136 # 0 = do not use link quality
137 # 1 = use link quality for MPR selection
138 # 2 = use link quality for MPR selection and routing
139 # Defaults to 0
140
141 #LinkQualityLevel       2
142
143 # Link quality algorithm (only for lq level 1 or 2)
144 # Defaults to "etx_fpm" for fixpoint based etx algorithm
145
146 # LinkQualityAlgorithm    "etx_fpm"
147
148 # Link quality aging factor
149 # Defaults to 0.05, smaller values mean larger LQ window size
150 # Link quality aging does only apply to lq level 1 and 2
151
152 # LinkQualityAging 0.1 
153
154 # Fisheye mechanism for TC messages 0=off, 1=on
155 # default is 0
156
157 # LinkQualityFishEye    0
158
159 # Wether to use hysteresis or not
160 # Hysteresis adds more robustness to the
161 # link sensing but delays neighbor registration.
162 # Used by default. 'yes' or 'no'
163
164 UseHysteresis   no
165
166 # Hysteresis parameters
167 # Do not alter these unless you know 
168 # what you are doing!
169 # Set to auto by default. Allowed
170 # values are floating point values
171 # in the interval 0,1
172 # THR_LOW must always be lower than
173 # THR_HIGH!!
174
175 #HystScaling    0.50
176 #HystThrHigh    0.80
177 #HystThrLow     0.30
178
179
180 # Polling rate in seconds(float). 
181 # Default value 0.05 sec
182
183 # Pollrate      0.05
184
185 # Interval to poll network interfaces for configuration 
186 # changes. Defaults to 2.5 seconds
187
188 NicChgsPollInt  3.0
189
190
191 # TC redundancy
192 # Specifies how much neighbor info should
193 # be sent in TC messages
194 # Possible values are:
195 # 0 - only send MPR selectors
196 # 1 - send MPR selectors and MPRs
197 # 2 - send all neighbors
198 #
199 # defaults to 0
200
201 TcRedundancy    2
202
203 #
204 # NatThreshold 
205 #
206 # (currently this is only in the freifunk firmware)
207 # If the NAT-Endpoint (the preferred 0/0 HNA 
208 # emitting node) is to be changed, the ETX value of the current 0/0 is 
209 # compared to the new one. If the ETX difference is too small, the default 
210 # route isn't changed. defaults to 1.0
211 # The configured route gets multiplied by the treshhold, 
212 # before comparing which route is better
213
214 # NatThreshold  0.9
215
216 #
217 # MPR coverage
218 # Specifies how many MPRs a node should
219 # try select to reach every 2 hop neighbor
220 #
221 # Can be set to any integer >0
222 #
223 # defaults to 1
224
225 MprCoverage     3
226
227
228 # Olsrd plugins to load
229 # This must be the absolute path to the file
230 # or the loader will use the following scheme:
231 # - Try the paths in the LD_LIBRARY_PATH 
232 #   environment variable.
233 # - The list of libraries cached in /etc/ld.so.cache
234 # - /lib, followed by /usr/lib
235 #
236 # the examples in this list are for linux, so check if the plugin is
237 # available if you use windows/BSD.
238
239 LoadPlugin "olsrd_httpinfo.so.0.1"
240 # LoadPlugin "olsrd_httpinfo.dll"
241 {
242     # port number the txtinfo plugin will be listening
243     PlParam     "port"   "8000"
244     
245     # ip address that can access the plugin, use "0.0.0.0"
246     # to allow everyone
247 #   PlParam     "Host"   "127.0.0.1"
248 #   PlParam     "Host"   "80.23.53.22"
249     
250     # networks that can access the plugin (ip/netmask)
251     PlParam     "Net"    "0.0.0.0 0.0.0.0"
252 #   PlParam     "Net"    "192.168.0.0 255.255.0.0"
253 }
254
255 LoadPlugin "olsrd_txtinfo.so.0.1"
256 # LoadPlugin "olsrd_txtinfo.dll"
257 {
258     # port number the txtinfo plugin will be listening
259     PlParam     "port"   "81"
260     # ip address that can access the plugin, use "0.0.0.0"
261     # to allow everyone
262     PlParam     "Accept"   "127.0.0.1"
263 }
264
265 #LoadPlugin "olsrd_secure.so.0.3"
266 #{
267     # define source of keyfile for secure plugin
268     # see lib/secure/README_SECURE for more information
269     
270 #   PlParam     "Keyfile"   "/etc/olsr-keyfile.txt"
271 #}
272
273 #LoadPlugin "olsrd_dyn_gw.so.0.1"
274 #{
275     # Here parameters are set to be sent to the
276     # plugin. Theese are on the form "key" "value".
277     # Parameters ofcause, differs from plugin to plugin.
278     # Consult the documentation of your plugin for details.
279
280     # Example: dyn_gw params
281
282     # how often to check for Internet connectivity
283     # defaults to 5 secs
284 #   PlParam     "Interval"   "40"
285     
286     # if one or more IPv4 addresses are given, do a ping on these in
287     # descending order to validate that there is not only an entry in
288     # routing table, but also a real internet connection. If any of
289     # these addresses could be pinged successfully, the test was
290     # succesful, i.e. if the ping on the 1st address was successful,the
291     # 2nd won't be pinged
292 #   PlParam     "Ping"       "141.1.1.1"
293 #   PlParam     "Ping"       "194.25.2.129"
294 #}
295
296 # olsrd_dyn_gw_plain.so.0.4
297 # {
298 # }
299
300
301 # Interfaces and their rules
302 # Omitted options will be set to the
303 # default values.
304 # multiple interfaces can be speicified
305 Interface "eth0" "ath0"
306 {
307
308     # IPv4 broadcast address to use. The
309     # one usefull example would be 255.255.255.255
310     # If not defined the broadcastaddress
311     # every card is configured with is used
312     # The second useful value would be to
313     # specify the peer adress of an ptp-tunnel
314  
315     # Ip4Broadcast      255.255.255.255
316
317     # Interface Mode is used to prevent unnecessary
318     # packet forwarding on switched ethernet interfaces
319     # valid Modes are "mesh" and "ether"
320     # The default value is mesh!
321
322     # Mode "mesh"
323
324     # IPv6 address scope to use.
325     # Must be 'site-local' or 'global'
326
327     # Ip6AddrType               site-local
328
329     # IPv6 multicast address to use when
330     # using site-local addresses.
331     # If not defined, ff05::15 is used
332
333     # Ip6MulticastSite  ff05::11
334
335     # IPv6 multicast address to use when
336     # using global addresses
337     # If not defined, ff0e::1 is used
338
339     # Ip6MulticastGlobal        ff0e::1
340
341
342     # Emission intervals.
343     # If not defined, RFC proposed values will
344     # be used in most cases.
345
346     # Hello interval in seconds(float)
347     # HelloInterval    2.0
348
349     # HELLO validity time
350     # HelloValidityTime 20.0
351
352     # TC interval in seconds(float)
353     # TcInterval        5.0
354
355     # TC validity time
356     # TcValidityTime    30.0
357
358     # MID interval in seconds(float)
359     # MidInterval       5.0
360
361     # MID validity time
362     # MidValidityTime   30.0
363
364     # HNA interval in seconds(float)
365     # HnaInterval       5.0
366
367     # HNA validity time
368     # HnaValidityTime   30.0
369     
370     # When multiple links exist between hosts
371     # the weight of interface is used to determine
372     # the link to use. Normally the weight is
373     # automatically calculated by olsrd based
374     # on the characteristics of the interface,
375     # but here you can specify a fixed value.
376     # Olsrd will choose links with the lowest value.
377     # Note:
378     # Interface weight is used only when LinkQualityLevel is set to 0.
379     # For any other value of LinkQualityLevel, the interface ETX
380     # value is used instead.
381     # Weight 0
382
383
384     # If a certain route should be preferred 
385     # or ignored by the mesh, the Link Quality 
386     # value of a node can be multiplied with a factor 
387     # entered here. In the example the route 
388     # using 192.168.0.1 would rather be ignored.
389     # A multiplier of 0.5 will result in a small
390     # (bad) LinkQuality value and a high (bad)
391     # ETX value.
392     # Note:
393     # Link quality multiplier is used only when
394     # LinkQualityLevel is > 0.
395
396     # LinkQualityMult 192.168.0.1 0.5
397
398     # This multiplier applies to all other nodes 
399     # LinkQualityMult default 0.8
400 }
401
402 # another Interface (with different configs)
403 Interface "eth1"
404 {
405     # IPv4 broadcast address to use. 
406     # One usefull example would be 255.255.255.255
407     # If not defined the broadcastaddress of
408     # every interface which has one configured gets used
409     # The second useful value would be to 
410     # specify the peer adress of an ptp-tunnel
411
412     Ip4Broadcast        192.168.255.255
413
414     # Interface Mode is used to prevent unnecessary
415     # packet forwardin on switched ethernet interfaces
416     # valid Modes are "mesh" and "ether"
417     # The default value is mesh!
418
419     Mode "ether"
420 }