doc: completed man pages by adding plugins to olsrd.conf(5)
[olsrd.git] / files / olsrd.conf.default.rfc
1 #
2 # olsr.org OLSR daemon config file
3 #
4 # Lines starting with a # are discarded
5 #
6 # This file was shipped with olsrd 0.X.X
7 #
8
9 # Debug level(0-9)
10 # If set to 0 the daemon runs in the background
11
12 DebugLevel      1
13
14 # IP version to use (4 or 6)
15
16 IpVersion       4
17
18 # FIBMetric ("flat", "correct", or "approx")
19
20 FIBMetric "flat"
21
22 # Clear the screen each time the internal state changes
23
24 ClearScreen     yes
25
26 # HNA IPv4 routes
27 # syntax: netaddr netmask
28 # Example Internet gateway:
29 # 0.0.0.0 0.0.0.0
30
31 Hna4
32 {
33 #   Internet gateway:
34 #   0.0.0.0      0.0.0.0
35 #   more entries can be added:
36 #   192.168.1.0  255.255.255.0
37 }
38
39 # HNA IPv6 routes
40 # syntax: netaddr prefix
41 # Example Internet gateway:
42 Hna6
43 {
44 #   Internet gateway:
45 #   ::              0
46 #   more entries can be added:
47 #   fec0:2200:106:: 48
48 }
49
50
51 # Should olsrd keep on running even if there are
52 # no interfaces available? This is a good idea
53 # for a PCMCIA/USB hotswap environment.
54 # "yes" OR "no"
55
56 AllowNoInt      yes
57
58 # TOS(type of service) value for
59 # the IP header of control traffic.
60 # If not set it will default to 16
61
62 #TosValue       16
63
64 # The fixed willingness to use(0-7)
65 # If not set willingness will be calculated
66 # dynamically based on battery/power status
67 # if such information is available
68
69 #Willingness            4
70
71 # Allow processes like the GUI front-end
72 # to connect to the daemon.
73
74 IpcConnect
75 {
76      # Determines how many simultaneously
77      # IPC connections that will be allowed
78      # Setting this to 0 disables IPC
79
80      MaxConnections  0
81
82      # By default only 127.0.0.1 is allowed
83      # to connect. Here allowed hosts can
84      # be added
85
86      Host            127.0.0.1
87      #Host            10.0.0.5
88
89      # You can also specify entire net-ranges 
90      # that are allowed to connect. Multiple
91      # entries are allowed
92
93      #Net             192.168.1.0 255.255.255.0     
94 }
95
96 # Link quality aging factor
97 # Defaults to 0.05, smaller values mean larger LQ window size
98 # LinkQualityAging 0.1 
99
100 # Polling rate in seconds(float). 
101 # Default value 0.05 sec
102
103 Pollrate        0.05
104
105 # Interval to poll network interfaces for configuration 
106 # changes. Defaults to 2.5 seconds
107
108 NicChgsPollInt  3.0
109
110 # TC redundancy
111 # Specifies how much neighbor info should
112 # be sent in TC messages
113 # Possible values are:
114 # 0 - only send MPR selectors
115 # 1 - send MPR selectors and MPRs
116 # 2 - send all neighbors
117 #
118 # defaults to 0
119
120 #TcRedundancy   0
121
122
123 #
124 # MPR coverage
125 # Specifies how many MPRs a node should
126 # try select to reach every 2 hop neighbor
127 #
128 # Can be set to any integer >0
129 #
130 # defaults to 1
131
132 #MprCoverage    1
133
134
135 # Olsrd plugins to load
136 # This must be the absolute path to the file
137 # or the loader will use the following scheme:
138 # - Try the paths in the LD_LIBRARY_PATH 
139 #   environment variable.
140 # - The list of libraries cached in /etc/ld.so.cache
141 # - /lib, followed by /usr/lib
142
143 # Example plugin entry with parameters:
144
145 #LoadPlugin "olsrd_dyn_gw.so.0.3"
146 #{
147     # Here parameters are set to be sent to the
148     # plugin. Theese are on the form "key" "value".
149     # Parameters ofcause, differs from plugin to plugin.
150     # Consult the documentation of your plugin for details.
151
152     # Example: dyn_gw params
153
154     # how often to check for Internet connectivity
155     # defaults to 5 secs
156 #   PlParam     "Interval"   "40"
157     
158     # if one or more IPv4 addresses are given, do a ping on these in
159     # descending order to validate that there is not only an entry in
160     # routing table, but also a real internet connection. If any of
161     # these addresses could be pinged successfully, the test was
162     # succesful, i.e. if the ping on the 1st address was successful,the
163     # 2nd won't be pinged
164 #   PlParam     "Ping"       "141.1.1.1"
165 #   PlParam     "Ping"       "194.25.2.129"
166 #}
167
168
169
170 # Interfaces and their rules
171 # Omitted options will be set to the
172 # default values. Multiple interfaces
173 # can be specified in the same block
174 # and multiple blocks can be set.
175
176 # !!CHANGE THE INTERFACE LABEL(s) TO MATCH YOUR INTERFACE(s)!!
177 # (eg. wlan0 or eth1):
178
179 Interface "XXX" "YYY"
180 {
181     # Olsrd can autodetect changes in NIC
182     # configurations(IP address changes etc.). 
183     # This is Enabled by default and the interval
184     # to poll for changes on is defined by 
185     # NicChgsPollInt.
186     # This polling can be disabled pr. NIC by setting
187     # AutoDetectChanges to no.
188
189     # AutoDetectChanges            yes
190
191     # IPv4 broadcast address to use. The
192     # one usefull example would be 255.255.255.255
193     # If not defined the broadcastaddress
194     # every card is configured with is used
195
196     # Ip4Broadcast              255.255.255.255
197
198     # IPv6 address scope to use.
199     # Must be 'site-local' or 'global'
200
201     # Ip6AddrType               site-local
202
203     # IPv6 multicast address to use when
204     # using site-local addresses.
205     # If not defined, ff05::15 is used
206
207     # Ip6MulticastSite          ff05::11
208
209     # IPv6 multicast address to use when
210     # using global addresses
211     # If not defined, ff0e::1 is used
212
213     # Ip6MulticastGlobal        ff0e::1
214
215
216     # Emission intervals.
217     # If not defined, RFC proposed values will
218     # be used in most cases.
219
220     # Hello interval in seconds(float)
221     # HelloInterval    2.0
222
223     # HELLO validity time
224     # HelloValidityTime 6.0
225
226     # TC interval in seconds(float)
227     # TcInterval        5.0
228
229     # TC validity time
230     # TcValidityTime    15.0
231
232     # MID interval in seconds(float)
233     # MidInterval       5.0
234
235     # MID validity time
236     # MidValidityTime   15.0
237
238     # HNA interval in seconds(float)
239     # HnaInterval       5.0
240
241     # HNA validity time
242     # HnaValidityTime   15.0
243
244
245     # When multiple links exist between hosts
246     # the weight of interface is used to determine
247     # the link to use. Normally the weight is
248     # automatically calculated by olsrd based
249     # on the characteristics of the interface,
250     # but here you can specify a fixed value.
251     # Olsrd will choose links with the lowest value.
252     # Note:
253     # Interface weight is used if LinkQualityAlgorithm is
254     # set to the currently unimplemented RFC mode plugin.
255     # Weight 0
256
257
258     # If a certain route should be preferred 
259     # or ignored by the mesh, the Link Quality 
260     # value of a node can be multiplied with a factor 
261     # entered here. In the example the route 
262     # using 192.168.0.1 would rather be ignored.
263     # A multiplier of 0.5 will result in a small
264     # (bad) LinkQuality value and a high (bad)
265     # ETX value.
266     # Note:
267     # Interface weight is used if LinkQualityAlgorithm is set to
268     # anything but the currently unimplemented RFC mode plugin.
269
270     # LinkQualityMult 192.168.0.1 0.5
271
272     # This multiplier applies to all other nodes 
273     # LinkQualityMult default 0.8
274
275 }
276