document NatThreshold (even though it is only a freifunk fw patch at the moment)
[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
41 # Should olsrd keep on running even if there are
42 # no interfaces available? This is a good idea
43 # for a PCMCIA/USB hotswap environment.
44 # "yes" OR "no"
45
46 AllowNoInt      yes
47
48 # TOS(type of service) value for
49 # the IP header of control traffic.
50 # If not set it will default to 16
51
52 #TosValue       16
53
54 # The fixed willingness to use(0-7)
55 # If not set willingness will be calculated
56 # dynammically based on battery/power status
57
58 #Willingness            4
59
60 # Allow processes like the GUI front-end
61 # to connect to the daemon.
62
63 IpcConnect
64 {
65      # Determines how many simultaneously
66      # IPC connections that will be allowed
67      # Setting this to 0 disables IPC
68
69      MaxConnections  1
70
71      # By default only 127.0.0.1 is allowed
72      # to connect. Here allowed hosts can
73      # be added
74
75      Host            127.0.0.1
76      Host            10.0.0.5
77
78      # Specify entire net-ranges that are 
79      # allowed to connect
80
81      Net             192.168.1.0 255.255.255.0     
82 }
83
84 # Wether to use hysteresis or not
85 # Hysteresis adds more robustness to the
86 # link sensing but delays neighbor registration.
87 # Used by default. 'yes' or 'no'
88
89 UseHysteresis   yes
90
91 # Hysteresis parameters
92 # Do not alter these unless you know 
93 # what you are doing!
94 # Set to auto by default. Allowed
95 # values are floating point values
96 # in the interval 0,1
97 # THR_LOW must always be lower than
98 # THR_HIGH!!
99
100 #HystScaling    0.50
101 #HystThrHigh    0.80
102 #HystThrLow     0.30
103
104
105 # Polling rate in seconds(float). 
106 # Default value 0.05 sec
107
108 Pollrate        0.05
109
110
111 # TC redundancy
112 # Specifies how much neighbor info should
113 # be sent in TC messages
114 # Possible values are:
115 # 0 - only send MPR selectors
116 # 1 - send MPR selectors and MPRs
117 # 2 - send all neighbors
118 #
119 # defaults to 0
120
121 TcRedundancy    0
122
123 #
124 # NatThreshold 
125 #
126 # (currently this is only in the freifunk firmware)
127 # If the NAT-Endpoint (the preferred 0/0 HNA 
128 # emitting node) is to be changed, the ETX value of the current 0/0 is 
129 # compared to the new one. If the ETX difference is too small, the default 
130 # route isn't changed. 
131 #NatThreshold  0.9
132
133 #
134 # MPR coverage
135 # Specifies how many MPRs a node should
136 # try select to reach every 2 hop neighbor
137 #
138 # Can be set to any integer >0
139 #
140 # defaults to 1
141
142 MprCoverage     1
143
144
145 # Olsrd plugins to load
146 # This must be the absolute path to the file
147 # or the loader will use the following scheme:
148 # - Try the paths in the LD_LIBRARY_PATH 
149 #   environment variable.
150 # - The list of libraries cached in /etc/ld.so.cache
151 # - /lib, followed by /usr/lib
152 LoadPlugin "olsrd_secure.so.0.3"
153 {
154     PlParam     "key1"   "value1"
155     # Might be possible to set options here in
156     # future versions
157 }
158
159 LoadPlugin "olsrd_dyn_gw.so.0.1"
160 {
161     PlParam     "key4"   "value3"
162     # Might be possible to set options here in
163     # future versions
164 }
165
166 # olsrd_dyn_gw.so.0.1
167 # olsrd_power.so.0.1
168
169
170
171
172 # Interfaces and their rules
173 # Omitted options will be set to the
174 # default values.
175 Interface "eth0"
176 {
177
178     # IPv4 broadcast address to use. The
179     # one usefull example would be 255.255.255.255
180     # If not defined the broadcastaddress
181     # every card is configured with is used
182
183     Ip4Broadcast        255.255.255.255
184
185     # IPv6 address scope to use.
186     # Must be 'site-local' or 'global'
187
188     # Ip6AddrType               site-local
189
190     # IPv6 multicast address to use when
191     # using site-local addresses.
192     # If not defined, ff05::15 is used
193
194     Ip6MulticastSite    ff05::11
195
196     # IPv6 multicast address to use when
197     # using global addresses
198     # If not defined, ff0e::1 is used
199
200     # Ip6MulticastGlobal        ff0e::1
201
202
203     # Emission intervals.
204     # If not defined, RFC proposed values will
205     # be used in most cases.
206
207     # Hello interval in seconds(float)
208     # HelloInterval    2.0
209
210     # HELLO validity time
211     # HelloValidityTime 6.0
212
213     # TC interval in seconds(float)
214     TcInterval        5.0
215
216     # TC validity time
217     # TcValidityTime    15.0
218
219     # MID interval in seconds(float)
220     # MidInterval       5.0
221
222     # MID validity time
223     # MidValidityTime   15.0
224
225     # HNA interval in seconds(float)
226     # HnaInterval       5.0
227
228     # HNA validity time
229     # HnaValidityTime   15.0
230 }
231
232 Interface "eth1"
233 {
234     # IPv4 broadcast address to use. The
235     # one usefull example would be 255.255.255.255
236     # If not defined the broadcastaddress
237     # every card is configured with is used
238
239     # Ip4Broadcast      255.255.255.255
240
241     # IPv6 address scope to use.
242     # Must be 'site-local' or 'global'
243
244     Ip6AddrType         site-local
245
246     # IPv6 multicast address to use when
247     # using site-local addresses.
248     # If not defined, ff05::15 is used
249
250     Ip6MulticastSite    ff05::15
251
252     # IPv6 multicast address to use when
253     # using global addresses
254     # If not defined, ff0e::1 is used
255
256     Ip6MulticastGlobal  ff0e::1
257
258
259     # Emission intervals.
260     # If not defined, RFC proposed values will
261     # be used in most cases.
262
263     # Hello interval in seconds(float)
264     HelloInterval    1.0
265
266     # HELLO validity time
267     HelloValidityTime   3.0
268
269     # TC interval in seconds(float)
270     TcInterval        4.0
271
272     # TC validity time
273     TcValidityTime      14.0
274
275     # MID interval in seconds(float)
276     MidInterval 5.0
277
278     # MID validity time
279     MidValidityTime     15.0
280
281     # HNA interval in seconds(float)
282     HnaInterval 5.0
283
284     # HNA validity time
285     HnaValidityTime     15.0
286
287 }