Branch v0.6.6
[olsrd.git] / files / olsrd.conf.default.lq
1 #
2 # OLSR.org routing daemon config file
3 # This file contains the usual options for an ETX based
4 # stationary network without fisheye
5 # (for other options see olsrd.conf.default.full)
6 #
7 # Lines starting with a # are discarded
8 #
9
10 #### ATTENTION for IPv6 users ####
11 # Because of limitations in the parser IPv6 addresses must NOT
12 # begin with a ":", so please add a "0" as a prefix.
13
14 ###########################
15 ### Basic configuration ###
16 ###########################
17 # keep this settings at the beginning of your first configuration file
18
19 # Debug level (0-9)
20 # If set to 0 the daemon runs in the background, unless "NoFork" is set to true
21 # (Default is 1)
22
23 # DebugLevel  1
24
25 # IP version to use (4 or 6)
26 # (Default is 4)
27
28 # IpVersion 4
29
30 #################################
31 ### OLSRd agent configuration ###
32 #################################
33 # this parameters control the settings of the routing agent which are not
34 # related to the OLSR protocol and it's extensions
35
36 # FIBMetric controls the metric value of the host-routes OLSRd sets.
37 # - "flat" means that the metric value is always 2. This is the preferred value
38 #   because it helps the linux kernel routing to clean up older routes
39 # - "correct" use the hopcount as the metric value.
40 # - "approx" use the hopcount as the metric value too, but does only update the
41 #   hopcount if the nexthop changes too
42 # (Default is "flat")
43
44 # FIBMetric "flat"
45
46 #######################################
47 ### Linux specific OLSRd extensions ###
48 #######################################
49 # these parameters are only working on linux at the moment, but might become
50 # useful on BSD in the future
51
52 # SrcIpRoutes tells OLSRd to set the Src flag of host routes to the originator-ip
53 # of the node. In addition to this an additional localhost device is created
54 # to make sure the returning traffic can be received.
55 # (Default is "no")
56
57 # SrcIpRoutes no
58
59 # Specify the proto tag to be used for routes olsr inserts into kernel
60 # currently only implemented for linux
61 # valid values under linux are 1 .. 254
62 # 1 gets remapped by olsrd to 0 UNSPECIFIED (1 is reserved for ICMP redirects)
63 # 2 KERNEL routes (not very wise to use)
64 # 3 BOOT (should in fact not be used by routing daemons)
65 # 4 STATIC 
66 # 8 .. 15 various routing daemons (gated, zebra, bird, & co)
67 # (defaults to 0 which gets replaced by an OS-specific default value
68 # under linux 3 (BOOT) (for backward compatibility)
69
70 # RtProto 0
71
72 # Activates (in IPv6 mode) the automatic use of NIIT
73 # (see README-Olsr-Extensions)
74 # (default is "yes")
75
76 # UseNiit yes
77
78 # Activates the smartgateway ipip tunnel feature.
79 # See README-Olsr-Extensions for a description of smartgateways.
80 # (default is "no")
81
82 # SmartGateway no
83
84 # Signals that the server tunnel must always be removed on shutdown,
85 # irrespective of the interface up/down state during startup.
86 # (default is "no")
87
88 # SmartGatewayAlwaysRemoveServerTunnel no
89
90 # Determines the maximum number of gateways that can be in use at any given
91 # time. This setting is used to mitigate the effects of breaking connections
92 # (due to the selection of a new gateway) on a dynamic network.
93 # (default is 1)
94
95 # SmartGatewayUseCount 1
96
97 # Determines the policy routing script that is executed during startup and
98 # shutdown of olsrd. The script is only executed when SmartGatewayUseCount
99 # is set to a value larger than 1. The script must setup policy routing
100 # rules such that multi-gateway mode works. A sample script is included.
101 # (default is not set)
102
103 # SmartGatewayPolicyRoutingScript ""
104
105 # Determines the egress interfaces that are part of the multi-gateway setup and
106 # therefore only relevant when SmartGatewayUseCount is larger than 1 (in which
107 # case it must be explicitly set).
108 # (default is not set)
109
110 # SmartGatewayEgressInterfaces ""
111
112 # Determines the offset of the smart gateway egress interfaces mark that are
113 # used in the policy routing rules in a multi-gateway setup. Only relevant
114 # when a multi-gateway setup is used.
115 # (default is 91)
116
117 # SmartGatewayMarkOffsetEgress 91
118
119 # Determines the offset of the smart gateway tunnel interfaces mark that are
120 # used in the policy routing rules in a multi-gateway setup. Only relevant
121 # when a multi-gateway setup is used.
122 # The ranges [egress offset, egress offset + egress count] and
123 # [tunnel offset, tunnel offset + use count] are not allowed to overlap.
124 # (default is 101)
125
126 # SmartGatewayMarkOffsetTunnels 101
127
128 # Allows the selection of a smartgateway with NAT (only for IPv4)
129 # (default is "yes")
130
131 # SmartGatewayAllowNAT yes
132
133 # Determines the period (in milliseconds) on which a new smart gateway
134 # selection is performed.
135 # (default is 10000 milliseconds)
136
137 # SmartGatewayPeriod 10000
138
139 # Determines the number of times the link state database must be stable
140 # before a new smart gateway is selected.
141 # (default is 6)
142
143 # SmartGatewayStableCount 6
144
145 # When another gateway than the current one has a cost of less than the cost
146 # of the current gateway multiplied by SmartGatewayThreshold then the smart
147 # gateway is switched to the other gateway. The unit is percentage.
148 # (defaults to 0)
149
150 # SmartGatewayThreshold 0
151
152 # The weighing factor for the gateway uplink bandwidth (exit link, uplink).
153 # See README-Olsr-Extensions for a description of smart gateways.
154 # (default is 1)
155
156 # SmartGatewayWeightExitLinkUp 1
157
158 # The weighing factor for the gateway downlink bandwidth (exit link, downlink).
159 # See README-Olsr-Extensions for a description of smart gateways.
160 # (default is 1)
161
162 # SmartGatewayWeightExitLinkDown 1
163
164 # The weighing factor for the ETX costs.
165 # See README-Olsr-Extensions for a description of smart gateways.
166 # (default is 1)
167
168 # SmartGatewayWeightEtx 1
169
170 # The divider for the ETX costs.
171 # See README-Olsr-Extensions for a description of smart gateways.
172 # (default is 0)
173
174 # SmartGatewayDividerEtx 0
175
176 # Defines what kind of Uplink this node will publish as a
177 # smartgateway. The existence of the uplink is detected by
178 # a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.
179 # possible values are "none", "ipv4", "ipv6", "both"
180 # (default is "both")
181
182 # SmartGatewayUplink "both"
183
184 # Specifies if the local ipv4 uplink use NAT
185 # (default is "yes")
186
187 # SmartGatewayUplinkNAT yes
188
189 # Specifies the speed of the uplink in kilobit/s.
190 # First parameter is upstream, second parameter is downstream
191 # (default is 128/1024)
192
193 # SmartGatewaySpeed 128 1024
194
195 # Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix
196 # length of more than 64 is not allowed.
197 # (default is 0::/0
198
199 # SmartGatewayPrefix 0::/0
200
201 ##############################
202 ### OLSR protocol settings ###
203 ##############################
204
205 # HNA (Host network association) allows the OLSR to announce
206 # additional IPs or IP subnets to the net that are reachable
207 # through this node.
208 # Syntax for HNA4 is "network-address    network-mask"
209 # Syntax for HNA6 is "network-address    prefix-length"
210 # (default is no HNA)
211 Hna4
212 {
213 # Internet gateway
214 # 0.0.0.0   0.0.0.0
215 # specific small networks reachable through this node
216 # 15.15.0.0 255.255.255.0
217 }
218 Hna6
219 {
220 # Internet gateway
221 #   0::                     0
222 # specific small networks reachable through this node
223 #   fec0:2200:106:0:0:0:0:0 48
224 }
225
226 ################################
227 ### OLSR protocol extensions ###
228 ################################
229
230 # Link quality algorithm (only for lq level 2)
231 # (see README-Olsr-Extensions)
232 # - "etx_float", a floating point  ETX with exponential aging
233 # - "etx_fpm", same as ext_float, but with integer arithmetic
234 # - "etx_ff" (ETX freifunk), an etx variant which use all OLSR
235 #   traffic (instead of only hellos) for ETX calculation
236 # - "etx_ffeth", an incompatible variant of etx_ff that allows
237 #   ethernet links with ETX 0.1.
238 # (defaults to "etx_ff")
239
240 # LinkQualityAlgorithm    "etx_ff"
241
242 # Fisheye mechanism for TCs (0 meansoff, 1 means on)
243 # (default is 1)
244
245 LinkQualityFishEye  0
246
247 #####################################
248 ### Example plugin configurations ###
249 #####################################
250 # Olsrd plugins to load
251 # This must be the absolute path to the file
252 # or the loader will use the following scheme:
253 # - Try the paths in the LD_LIBRARY_PATH 
254 #   environment variable.
255 # - The list of libraries cached in /etc/ld.so.cache
256 # - /lib, followed by /usr/lib
257 #
258 # the examples in this list are for linux, so check if the plugin is
259 # available if you use windows/BSD.
260 # each plugin should have a README file in it's lib subfolder
261
262 # LoadPlugin "olsrd_txtinfo.dll"
263 LoadPlugin "olsrd_txtinfo.so.0.1"
264 {
265     # the default port is 2006 but you can change it like this:
266     #PlParam     "port"   "8080"
267
268     # You can set a "accept" single address to allow to connect to
269     # txtinfo. If no address is specified, then localhost (127.0.0.1)
270     # is allowed by default.  txtinfo will only use the first "accept"
271     # parameter specified and will ignore the rest.
272
273     # to allow a specific host:
274     #PlParam      "accept" "172.29.44.23"
275     # if you set it to 0.0.0.0, it will accept all connections
276     #PlParam      "accept" "0.0.0.0"
277 }
278
279 #############################################
280 ### OLSRD default interface configuration ###
281 #############################################
282 # the default interface section can have the same values as the following
283 # interface configuration. It will allow you so set common options for all
284 # interfaces.
285
286 InterfaceDefaults {
287     # Ip4Broadcast      255.255.255.255
288 }
289
290 ######################################
291 ### OLSRd Interfaces configuration ###
292 ######################################
293 # multiple interfaces can be specified for a single configuration block
294 # multiple configuration blocks can be specified
295
296 # WARNING, don't forget to insert your interface names here !
297 Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
298 {
299     # Interface Mode is used to prevent unnecessary
300     # packet forwarding on switched ethernet interfaces
301     # valid Modes are "mesh" and "ether"
302     # (default is "mesh")
303
304     # Mode "mesh"
305 }