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