Update default configuration files
[olsrd.git] / files / olsrd.conf.default.rfc
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       0
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   yes
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  0
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     1
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 # For windows try the "dll" versions of LoadPlugin examples
239
240 LoadPlugin "olsrd_httpinfo.so.0.1"
241 # LoadPlugin "olsrd_httpinfo.dll"
242 {
243     # port number the txtinfo plugin will be listening
244     PlParam     "port"   "8000"
245     
246     # ip address that can access the plugin, use "0.0.0.0"
247     # to allow everyone
248 #   PlParam     "Host"   "127.0.0.1"
249 #   PlParam     "Host"   "80.23.53.22"
250     
251     # networks that can access the plugin (ip/netmask)
252     PlParam     "Net"    "0.0.0.0 0.0.0.0"
253 #   PlParam     "Net"    "192.168.0.0 255.255.0.0"
254 }
255
256 LoadPlugin "olsrd_txtinfo.so.0.1"
257 # LoadPlugin "olsrd_txtinfo.dll"
258 {
259     # port number the txtinfo plugin will be listening
260     PlParam     "port"   "81"
261     # ip address that can access the plugin, use "0.0.0.0"
262     # to allow everyone
263     PlParam     "Accept"   "127.0.0.1"
264 }
265
266 #LoadPlugin "olsrd_secure.so.0.3"
267 #{
268     # define source of keyfile for secure plugin
269     # see lib/secure/README_SECURE for more information
270     
271 #   PlParam     "Keyfile"   "/etc/olsr-keyfile.txt"
272 #}
273
274 #LoadPlugin "olsrd_dyn_gw.so.0.1"
275 #{
276     # Here parameters are set to be sent to the
277     # plugin. Theese are on the form "key" "value".
278     # Parameters ofcause, differs from plugin to plugin.
279     # Consult the documentation of your plugin for details.
280
281     # Example: dyn_gw params
282
283     # how often to check for Internet connectivity
284     # defaults to 5 secs
285 #   PlParam     "Interval"   "40"
286     
287     # if one or more IPv4 addresses are given, do a ping on these in
288     # descending order to validate that there is not only an entry in
289     # routing table, but also a real internet connection. If any of
290     # these addresses could be pinged successfully, the test was
291     # succesful, i.e. if the ping on the 1st address was successful,the
292     # 2nd won't be pinged
293 #   PlParam     "Ping"       "141.1.1.1"
294 #   PlParam     "Ping"       "194.25.2.129"
295 #}
296
297 # olsrd_dyn_gw_plain.so.0.4
298 # {
299 # }
300
301
302 # Interfaces and their rules
303 # Omitted options will be set to the
304 # default values.
305 # multiple interfaces can be speicified
306 Interface "eth0" "ath0"
307 {
308
309     # IPv4 broadcast address to use. The
310     # one usefull example would be 255.255.255.255
311     # If not defined the broadcastaddress
312     # every card is configured with is used
313     # The second useful value would be to
314     # specify the peer adress of an ptp-tunnel
315  
316     # Ip4Broadcast      255.255.255.255
317
318     # Interface Mode is used to prevent unnecessary
319     # packet forwarding on switched ethernet interfaces
320     # valid Modes are "mesh" and "ether"
321     # The default value is mesh!
322
323     # Mode "mesh"
324
325     # IPv6 address scope to use.
326     # Must be 'site-local' or 'global'
327
328     # Ip6AddrType               site-local
329
330     # IPv6 multicast address to use when
331     # using site-local addresses.
332     # If not defined, ff05::15 is used
333
334     # Ip6MulticastSite  ff05::11
335
336     # IPv6 multicast address to use when
337     # using global addresses
338     # If not defined, ff0e::1 is used
339
340     # Ip6MulticastGlobal        ff0e::1
341
342
343     # Emission intervals.
344     # If not defined, RFC proposed values will
345     # be used in most cases.
346
347     # Hello interval in seconds(float)
348     # HelloInterval    2.0
349
350     # HELLO validity time
351     # HelloValidityTime 6.0
352
353     # TC interval in seconds(float)
354     # TcInterval        5.0
355
356     # TC validity time
357     # TcValidityTime    15.0
358
359     # MID interval in seconds(float)
360     # MidInterval       5.0
361
362     # MID validity time
363     # MidValidityTime   15.0
364
365     # HNA interval in seconds(float)
366     # HnaInterval       5.0
367
368     # HNA validity time
369     # HnaValidityTime   15.0
370     
371     # When multiple links exist between hosts
372     # the weight of interface is used to determine
373     # the link to use. Normally the weight is
374     # automatically calculated by olsrd based
375     # on the characteristics of the interface,
376     # but here you can specify a fixed value.
377     # Olsrd will choose links with the lowest value.
378     # Note:
379     # Interface weight is used only when LinkQualityLevel is set to 0.
380     # For any other value of LinkQualityLevel, the interface ETX
381     # value is used instead.
382     # Weight 0
383
384
385     # If a certain route should be preferred 
386     # or ignored by the mesh, the Link Quality 
387     # value of a node can be multiplied with a factor 
388     # entered here. In the example the route 
389     # using 192.168.0.1 would rather be ignored.
390     # A multiplier of 0.5 will result in a small
391     # (bad) LinkQuality value and a high (bad)
392     # ETX value.
393     # Note:
394     # Link quality multiplier is used only when
395     # LinkQualityLevel is > 0.
396
397     # LinkQualityMult 192.168.0.1 0.5
398
399     # This multiplier applies to all other nodes 
400     # LinkQualityMult default 0.8
401 }
402
403 # another Interface (with different configs)
404 Interface "eth1"
405 {
406     # IPv4 broadcast address to use. 
407     # One usefull example would be 255.255.255.255
408     # If not defined the broadcastaddress of
409     # every interface which has one configured gets used
410     # The second useful value would be to 
411     # specify the peer adress of an ptp-tunnel
412
413     Ip4Broadcast        192.168.255.255
414
415     # Interface Mode is used to prevent unnecessary
416     # packet forwardin on switched ethernet interfaces
417     # valid Modes are "mesh" and "ether"
418     # The default value is mesh!
419
420     Mode "ether"
421 }