files: rename the generated configuration files
[olsrd.git] / files / olsrd.conf.default.lq.txt
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 take-down percentage for a non-current smart gateway tunnel.
98 # If the cost of the current smart gateway tunnel is less than this percentage
99 # of the cost of the non-current smart gateway tunnel, then the non-current smart
100 # gateway tunnel is taken down because it is then presumed to be 'too expensive'.
101 # This setting is only relevant when SmartGatewayUseCount is larger than 1;
102 # a value of 0 will result in the tunnels not being taken down proactively.
103 # (default is 0)
104
105 # SmartGatewayTakeDownPercentage 0
106
107 # Determines the policy routing script that is executed during startup and
108 # shutdown of olsrd. The script is only executed when SmartGatewayUseCount
109 # is set to a value larger than 1. The script must setup policy routing
110 # rules such that multi-gateway mode works. A sample script is included.
111 # (default is not set)
112
113 # SmartGatewayPolicyRoutingScript ""
114
115 # Determines the egress interfaces that are part of the multi-gateway setup and
116 # therefore only relevant when SmartGatewayUseCount is larger than 1 (in which
117 # case it must be explicitly set).
118 # (default is not set)
119
120 # SmartGatewayEgressInterfaces ""
121
122 # Declares the file that contains the bandwidth parameters of the egress
123 # interfaces declared by SmartGatewayEgressInterfaces. Every line in the file
124 # declares bandwidth parameters of an egress interface, with the format:
125 #   # this is a comment
126 #   interface=upstream,downstream,pathcost,network/prefix,gateway
127 # (default is /var/run/olsrd-sgw-egress.conf)
128
129 # SmartGatewayEgressFile "/var/run/olsrd-sgw-egress.conf"
130
131 # Determines the period (in milliseconds) on which the SmartGatewayEgressFile
132 # is checked for changes and processed if changed.
133 # (default is 5000)
134
135 # SmartGatewayEgressFilePeriod "5000"
136
137 # Declares the file that is written by olsrd to contain the status of the smart
138 # gateways and is only relevant when SmartGatewayUseCount is larger than 1.
139 # The default setting is <not set>
140
141 # SmartGatewayStatusFile <not set>
142
143 # Determines the routing tables offset for multi-gateway policy routing tables
144 # See the policy routing script for an explanation.
145 # (default is 90)
146
147 # SmartGatewayTablesOffset 90
148
149 # Determines the policy routing rules offset for multi-gateway policy routing
150 # rules. See the policy routing script for an explanation.
151 # (default is 0, which indicates that the rules and tables should be aligned and
152 # puts this value at SmartGatewayTablesOffset - # egress interfaces -
153 # # olsr interfaces)
154
155 # SmartGatewayRulesOffset 87
156
157 # Allows the selection of a smartgateway with NAT (only for IPv4)
158 # (default is "yes")
159
160 # SmartGatewayAllowNAT yes
161
162 # Determines the period (in milliseconds) on which a new smart gateway
163 # selection is performed.
164 # (default is 10000 milliseconds)
165
166 # SmartGatewayPeriod 10000
167
168 # Determines the number of times the link state database must be stable
169 # before a new smart gateway is selected.
170 # (default is 6)
171
172 # SmartGatewayStableCount 6
173
174 # When another gateway than the current one has a cost of less than the cost
175 # of the current gateway multiplied by SmartGatewayThreshold then the smart
176 # gateway is switched to the other gateway. The unit is percentage.
177 # (defaults to 0)
178
179 # SmartGatewayThreshold 0
180
181 # The weighing factor for the gateway uplink bandwidth (exit link, uplink).
182 # See README-Olsr-Extensions for a description of smart gateways.
183 # (default is 1)
184
185 # SmartGatewayWeightExitLinkUp 1
186
187 # The weighing factor for the gateway downlink bandwidth (exit link, downlink).
188 # See README-Olsr-Extensions for a description of smart gateways.
189 # (default is 1)
190
191 # SmartGatewayWeightExitLinkDown 1
192
193 # The weighing factor for the ETX costs.
194 # See README-Olsr-Extensions for a description of smart gateways.
195 # (default is 1)
196
197 # SmartGatewayWeightEtx 1
198
199 # The divider for the ETX costs.
200 # See README-Olsr-Extensions for a description of smart gateways.
201 # (default is 0)
202
203 # SmartGatewayDividerEtx 0
204
205 # Defines what kind of Uplink this node will publish as a
206 # smartgateway. The existence of the uplink is detected by
207 # a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.
208 # possible values are "none", "ipv4", "ipv6", "both"
209 # (default is "both")
210
211 # SmartGatewayUplink "both"
212
213 # Specifies if the local ipv4 uplink use NAT
214 # (default is "yes")
215
216 # SmartGatewayUplinkNAT yes
217
218 # Specifies the speed of the uplink in kilobit/s.
219 # First parameter is upstream, second parameter is downstream
220 # (default is 128/1024)
221
222 # SmartGatewaySpeed 128 1024
223
224 # Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix
225 # length of more than 64 is not allowed.
226 # (default is 0::/0
227
228 # SmartGatewayPrefix 0::/0
229
230 ##############################
231 ### OLSR protocol settings ###
232 ##############################
233
234 # HNA (Host network association) allows the OLSR to announce
235 # additional IPs or IP subnets to the net that are reachable
236 # through this node.
237 # Syntax for HNA4 is "network-address    network-mask"
238 # Syntax for HNA6 is "network-address    prefix-length"
239 # (default is no HNA)
240 Hna4
241 {
242 # Internet gateway
243 # 0.0.0.0   0.0.0.0
244 # specific small networks reachable through this node
245 # 15.15.0.0 255.255.255.0
246 }
247 Hna6
248 {
249 # Internet gateway
250 #   0::                     0
251 # specific small networks reachable through this node
252 #   fec0:2200:106:0:0:0:0:0 48
253 }
254
255 ################################
256 ### OLSR protocol extensions ###
257 ################################
258
259 # Link quality algorithm (only for lq level 2)
260 # (see README-Olsr-Extensions)
261 # - "etx_float", a floating point  ETX with exponential aging
262 # - "etx_fpm", same as ext_float, but with integer arithmetic
263 # - "etx_ff" (ETX freifunk), an etx variant which use all OLSR
264 #   traffic (instead of only hellos) for ETX calculation
265 # - "etx_ffeth", an incompatible variant of etx_ff that allows
266 #   ethernet links with ETX 0.1.
267 # (defaults to "etx_ff")
268
269 # LinkQualityAlgorithm    "etx_ff"
270
271 # Fisheye mechanism for TCs (0 meansoff, 1 means on)
272 # (default is 1)
273
274 LinkQualityFishEye  0
275
276 #####################################
277 ### Example plugin configurations ###
278 #####################################
279 # Olsrd plugins to load
280 # This must be the absolute path to the file
281 # or the loader will use the following scheme:
282 # - Try the paths in the LD_LIBRARY_PATH 
283 #   environment variable.
284 # - The list of libraries cached in /etc/ld.so.cache
285 # - /lib, followed by /usr/lib
286 #
287 # the examples in this list are for linux, so check if the plugin is
288 # available if you use windows/BSD.
289 # each plugin should have a README file in it's lib subfolder
290
291 # LoadPlugin "olsrd_txtinfo.dll"
292 LoadPlugin "olsrd_txtinfo.so.0.1"
293 {
294     # the default port is 2006 but you can change it like this:
295     #PlParam     "port"   "8080"
296
297     # You can set a "accept" single address to allow to connect to
298     # txtinfo. If no address is specified, then localhost (127.0.0.1)
299     # is allowed by default.  txtinfo will only use the first "accept"
300     # parameter specified and will ignore the rest.
301
302     # to allow a specific host:
303     #PlParam      "accept" "172.29.44.23"
304     # if you set it to 0.0.0.0, it will accept all connections
305     #PlParam      "accept" "0.0.0.0"
306 }
307
308 #############################################
309 ### OLSRD default interface configuration ###
310 #############################################
311 # the default interface section can have the same values as the following
312 # interface configuration. It will allow you so set common options for all
313 # interfaces.
314
315 InterfaceDefaults {
316     # Ip4Broadcast      255.255.255.255
317 }
318
319 ######################################
320 ### OLSRd Interfaces configuration ###
321 ######################################
322 # multiple interfaces can be specified for a single configuration block
323 # multiple configuration blocks can be specified
324
325 # WARNING, don't forget to insert your interface names here !
326 Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
327 {
328     # Interface Mode is used to prevent unnecessary
329     # packet forwarding on switched ethernet interfaces
330     # valid Modes are "mesh" and "ether"
331     # (default is "mesh")
332
333     # Mode "mesh"
334 }