use constants for default values of RtTable and RtProto and improvements in sample...
[olsrd.git] / src / cfgparser / olsrd.conf.example
1 #
2 # UniK OLSR 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 # HNA IPv4 routes
17 # syntax: netaddr netmask
18 # Example Internet gateway:
19 # 0.0.0.0 0.0.0.0
20
21 Hna4
22 {
23     0.0.0.0   0.0.0.0
24     15.15.0.0 255.255.255.0
25     15.16.0.0 255.255.255.0
26 }
27
28 # HNA IPv6 routes
29 # syntax: netaddr prefix
30 # Example Internet gateway:
31 Hna6
32 {
33      ::              0
34     fecb:ab:ed:: 48
35     fecb:ff:dd::dd:d 48
36     fec0:2200:106:: 48
37     fec0:2200:106:0:0:0:0:0 48
38 }
39
40 # Specify the routing Table olsr uses
41 # currently only implemented in linux versions, (bsd planned)
42 # useful for policyrouting, to ensure that olsr can use 
43 # the table a policy rule with priority 65536 is auto-installed
44 # by olsrd if an value < 253 ist specified!
45 # value defaults to 253 (main table)
46 # valid values are 1 .. 254
47 # (freifunkfirmware uses 111 for its policy routing)
48
49 # RtTable 111
50
51 #you may specify another table for the default route only
52 #if used no policy route will get auto-installed for this table, 
53 #but the default route gets also inserted into table 254 
54 #(the last table used in default linux policy routing)
55 #valid tables are the same as for RtTable
56
57 # RtTableDefault 112
58
59 # Specify the proto tag to be used for routes olsr inserts into kernel
60 # currently only implemented for linux, (bsd is planned)
61 # defaults to 0 which gets replaced by an OS-specific default value
62 # under linux 3 (BOOT) gets used as default (for backward compatibility)
63 # under bsd 1 will get used
64 # valid values under linux are 1 .. 254
65 # 1 gets remapped by olsrd to 0 UNSPECIFIED (1 is reserved for ICMP redirects)
66 # 2 KERNEL routes (not very wise to use)
67 # 3 BOOT (should in fact not be used by routing daemons)
68 # 4 STATIC 
69 # 8 .. 15 various routing daemons (gated, zebra, bird, & co)
70
71 # RtProto 111
72
73 # For testing purposes it may be nice to use another port for olsrd
74 # defaults to port 698 (IANA assigned olsr-port!)
75
76 # OlsrPort 698
77
78 # Should olsrd keep on running even if there are
79 # no interfaces available? This is a good idea
80 # for a PCMCIA/USB hotswap environment.
81 # "yes" OR "no"
82
83 AllowNoInt      yes
84
85 # TOS(type of service) value for
86 # the IP header of control traffic.
87 # If not set it will default to 16
88
89 #TosValue       16
90
91 # The fixed willingness to use(0-7)
92 # If not set willingness will be calculated
93 # dynammically based on battery/power status
94
95 #Willingness            4
96
97 # Allow processes like the GUI front-end
98 # to connect to the daemon.
99
100 IpcConnect
101 {
102      # Determines how many simultaneously
103      # IPC connections that will be allowed
104      # Setting this to 0 disables IPC
105
106      MaxConnections  1
107
108      # By default only 127.0.0.1 is allowed
109      # to connect. Here allowed hosts can
110      # be added
111
112      Host            127.0.0.1
113      Host            10.0.0.5
114
115      # Specify entire net-ranges that are 
116      # allowed to connect
117
118      Net             192.168.1.0 255.255.255.0     
119 }
120
121 # Wether to use hysteresis or not
122 # Hysteresis adds more robustness to the
123 # link sensing but delays neighbor registration.
124 # Used by default. 'yes' or 'no'
125
126 UseHysteresis   yes
127
128 # Hysteresis parameters
129 # Do not alter these unless you know 
130 # what you are doing!
131 # Set to auto by default. Allowed
132 # values are floating point values
133 # in the interval 0,1
134 # THR_LOW must always be lower than
135 # THR_HIGH!!
136
137 #HystScaling    0.50
138 #HystThrHigh    0.80
139 #HystThrLow     0.30
140
141
142 # Polling rate in seconds(float). 
143 # Default value 0.05 sec
144
145 # Pollrate      0.05
146
147
148 # TC redundancy
149 # Specifies how much neighbor info should
150 # be sent in TC messages
151 # Possible values are:
152 # 0 - only send MPR selectors
153 # 1 - send MPR selectors and MPRs
154 # 2 - send all neighbors
155 #
156 # defaults to 0
157
158 # TcRedundancy  0
159
160 #
161 # NatThreshold 
162 #
163 # (currently this is only in the freifunk firmware)
164 # If the NAT-Endpoint (the preferred 0/0 HNA 
165 # emitting node) is to be changed, the ETX value of the current 0/0 is 
166 # compared to the new one. If the ETX difference is too small, the default 
167 # route isn't changed. defaults to 1.0
168 # The configured route gets multiplied by the treshhold, 
169 # before comparing which route is better
170
171 # NatThreshold  0.9
172
173 #
174 # MPR coverage
175 # Specifies how many MPRs a node should
176 # try select to reach every 2 hop neighbor
177 #
178 # Can be set to any integer >0
179 #
180 # defaults to 1
181
182 MprCoverage     1
183
184
185 # Olsrd plugins to load
186 # This must be the absolute path to the file
187 # or the loader will use the following scheme:
188 # - Try the paths in the LD_LIBRARY_PATH 
189 #   environment variable.
190 # - The list of libraries cached in /etc/ld.so.cache
191 # - /lib, followed by /usr/lib
192 LoadPlugin "olsrd_httpinfo.so.0.1"
193 {
194         PlParam     "port"   "8000"
195         PlParam     "Net"    "0.0.0.0 0.0.0.0"
196 }
197 LoadPlugin "olsrd_txtinfo.so.0.1"
198 {
199         PlParam     "port"   "81"
200         PlParam     "Accept"   "127.0.0.1"
201 }
202 LoadPlugin "olsrd_secure.so.0.3"
203 #{
204 #    PlParam     "key1"   "value1"
205      # Might be possible to set options here in
206      # future versions
207 #}
208 #LoadPlugin "olsrd_dyn_gw.so.0.1"
209 #{
210     # Might be possible to set options here in
211     # future versions
212 #}
213
214 # olsrd_dyn_gw_plain.so.0.4
215 # olsrd_power.so.0.1
216
217
218
219 # Interfaces and their rules
220 # Omitted options will be set to the
221 # default values.
222 # multiple interfaces can be speicified
223 Interface "eth0" "eth1"
224 {
225
226     # IPv4 broadcast address to use. The
227     # one usefull example would be 255.255.255.255
228     # If not defined the broadcastaddress
229     # every card is configured with is used
230     # The second useful value would be to
231     # specify the peer adress of an ptp-tunnel
232  
233     # Ip4Broadcast      255.255.255.255
234
235     # Interface Mode is used to prevent unnecessary
236     # packet forwardin on switched ethernet interfaces
237     # valid Modes are mesh and ether
238     # The default value is mesh!
239
240     Mode ether
241
242     # IPv6 address scope to use.
243     # Must be 'site-local' or 'global'
244
245     # Ip6AddrType               site-local
246
247     # IPv6 multicast address to use when
248     # using site-local addresses.
249     # If not defined, ff05::15 is used
250
251     Ip6MulticastSite    ff05::11
252
253     # IPv6 multicast address to use when
254     # using global addresses
255     # If not defined, ff0e::1 is used
256
257     # Ip6MulticastGlobal        ff0e::1
258
259
260     # Emission intervals.
261     # If not defined, RFC proposed values will
262     # be used in most cases.
263
264     # Hello interval in seconds(float)
265     # HelloInterval    2.0
266
267     # HELLO validity time
268     # HelloValidityTime 6.0
269
270     # TC interval in seconds(float)
271     TcInterval        5.0
272
273     # TC validity time
274     # TcValidityTime    15.0
275
276     # MID interval in seconds(float)
277     # MidInterval       5.0
278
279     # MID validity time
280     # MidValidityTime   15.0
281
282     # HNA interval in seconds(float)
283     # HnaInterval       5.0
284
285     # HNA validity time
286     # HnaValidityTime   15.0
287 }
288
289 Interface "ath1"
290 {
291     # IPv4 broadcast address to use. 
292     # One usefull example would be 255.255.255.255
293     # If not defined the broadcastaddress of
294     # every interface which has one configured gets used
295     # The second useful value would be to 
296     # specify the peer adress of an ptp-tunnel
297
298     # Ip4Broadcast      255.255.255.255
299
300     # Interface Mode is used to prevent unnecessary
301     # packet forwardin on switched ethernet interfaces
302     # valid Modes are mesh and ether
303     # The default value is mesh!
304
305     # Mode ether
306
307     # IPv6 address scope to use.
308     # Must be 'site-local' or 'global'
309
310     Ip6AddrType         site-local
311
312     # IPv6 multicast address to use when
313     # using site-local addresses.
314     # If not defined, ff05::15 is used
315
316     Ip6MulticastSite    ff05::15
317
318     # IPv6 multicast address to use when
319     # using global addresses
320     # If not defined, ff0e::1 is used
321
322     Ip6MulticastGlobal  ff0e::1
323
324
325     # Emission intervals.
326     # If not defined, RFC proposed values will
327     # be used in most cases.
328
329     # Hello interval in seconds(float)
330     HelloInterval    1.0
331
332     # HELLO validity time
333     HelloValidityTime   3.0
334
335     # TC interval in seconds(float)
336     TcInterval        4.0
337
338     # TC validity time
339     TcValidityTime      14.0
340
341     # MID interval in seconds(float)
342     MidInterval 5.0
343
344     # MID validity time
345     MidValidityTime     15.0
346
347     # HNA interval in seconds(float)
348     HnaInterval 5.0
349
350     # HNA validity time
351     HnaValidityTime     15.0
352
353 }