ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.conf.5.pod
(Generate patch)

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.14 by pcg, Tue Jun 21 08:46:53 2005 UTC vs.
Revision 1.24 by pcg, Sat Jul 18 05:59:16 2009 UTC

… …
2 2
3gvpe.conf - configuration file for the GNU VPE daemon 3gvpe.conf - configuration file for the GNU VPE daemon
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 # global options for all nodes
7 udp-port = 407 8 udp-port = 407
8 mtu = 1492 9 mtu = 1492
9 ifname = vpn0 10 ifname = vpn0
10 11
12 # first node is named branch1 and is at 1.2.3.4
11 node = branch1 13 node = branch1
12 hostname = 1.2.3.4 14 hostname = 1.2.3.4
13 15
16 # second node uses dns to resolve the address
14 node = branch2 17 node = branch2
15 hostname = www.example.net 18 hostname = www.example.net
16 udp-port = 500 # this host uses a different udp-port 19 udp-port = 500 # this host uses a different udp-port
17 20
21 # third node has no fixed ip address
18 node = branch3 22 node = branch3
19 connect = ondemand 23 connect = ondemand
20 24
21=head1 DESCRIPTION 25=head1 DESCRIPTION
22 26
… …
28 32
29The only exception to the above is the "on" directive that can prefix any 33The only exception to the above is the "on" directive that can prefix any
30C<name = value> setting and will only "execute" it on the named node, or 34C<name = value> setting and will only "execute" it on the named node, or
31(if the nodename starts with "!") on all nodes except the named one. 35(if the nodename starts with "!") on all nodes except the named one.
32 36
33 name = value 37For example, set the MTU to C<1450> everywhere, loglevel to C<noise> on
38branch1, and connect to C<ondemand> everywhere but on branch2:
39
40 mtu = 1450
34 on branch1 loglevel = noise 41 on branch1 loglevel = noise
35 on !branch2 connect = ondemand 42 on !branch2 connect = ondemand
36 43
37All settings are executed "in order", that is, later settings of the same 44All settings are applied "in order", that is, later settings of the same
38variable overwrite earlier ones. 45variable overwrite earlier ones.
39 46
40=head1 ANATOMY OF A CONFIG FILE 47=head1 ANATOMY OF A CONFIG FILE
41 48
42Usually, a config file starts with global settings (like the udp port to 49Usually, a config file starts with a few global settings (like the UDP
43listen on), followed by node-specific sections that begin with a C<node = 50port to listen on), followed by node-specific sections that begin with a
44nickname> line. 51C<node = nickname> line.
45 52
46Every node that is part of the network must have a section that starts 53Every node that is part of the network must have a section that starts
47with C<node = nickname>. The number and order of the nodes is important 54with C<node = nickname>. The number and order of the nodes is important
48and must be the same on all hosts. It is not uncommon for node sections to 55and must be the same on all nodes. It is not uncommon for node sections to
49be completely empty - if the default values are right. 56be completely empty - if the default values are right.
50 57
51Node-specific settings can be used at any time. If used before the first 58Node-specific settings can be used at any time. If used before the first
52node section they will set the default values for all following nodes. 59node section they will set the default values for all following nodes.
53 60
… …
62 69
63=over 4 70=over 4
64 71
65=item dns-forw-host = hostname/ip 72=item dns-forw-host = hostname/ip
66 73
67The dns server to forward dns requests to for the DNS tunnel protocol 74The DNS server to forward DNS requests to for the DNS tunnel protocol
68(default: C<127.0.0.1>, changing it is highly recommended). 75(default: C<127.0.0.1>, changing it is highly recommended).
69 76
70=item dns-forw-port = port-number 77=item dns-forw-port = port-number
71 78
72The port where the C<dns-forw-host> is to be contacted (default: C<53>, 79The port where the C<dns-forw-host> is to be contacted (default: C<53>,
… …
78(default: C<100>). GVPE will never issue more requests then the given 85(default: C<100>). GVPE will never issue more requests then the given
79limit without receiving replies. In heavily overloaded situations it might 86limit without receiving replies. In heavily overloaded situations it might
80help to set this to a low number (e.g. C<3> or even C<1>) to limit the 87help to set this to a low number (e.g. C<3> or even C<1>) to limit the
81number of parallel requests. 88number of parallel requests.
82 89
83The default should be working ok for most links. 90The default should be working OK for most links.
84 91
85=item dns-overlap-factor = float 92=item dns-overlap-factor = float
86 93
87The DNS transport uses the minimum request latency (B<min_latency>) seen 94The DNS transport uses the minimum request latency (B<min_latency>) seen
88during a connection as it's timing base. This factor (default: C<0.5>, 95during a connection as it's timing base. This factor (default: C<0.5>,
… …
91request might be generated every B<min_latency> seconds, which means on 98request might be generated every B<min_latency> seconds, which means on
92average there should only ever be one outstanding request. A factor of 99average there should only ever be one outstanding request. A factor of
93C<0.5> means that GVPE will send requests twice as often as the minimum 100C<0.5> means that GVPE will send requests twice as often as the minimum
94latency measured. 101latency measured.
95 102
96For congested or picky dns forwarders you could use a value nearer to or 103For congested or picky DNS forwarders you could use a value nearer to or
97exceeding C<1>. 104exceeding C<1>.
98 105
99The default should be working ok for most links. 106The default should be working OK for most links.
100 107
101=item dns-send-interval = send-interval-in-seconds 108=item dns-send-interval = send-interval-in-seconds
102 109
103The minimum send interval (= maximum rate) that the DNS transport will 110The minimum send interval (= maximum rate) that the DNS transport will
104use to send new DNS requests. GVPE will not exceed this rate even when 111use to send new DNS requests. GVPE will not exceed this rate even when
… …
106not send more than 100 DNS requests per connection per second. For 113not send more than 100 DNS requests per connection per second. For
107high-bandwidth links you could go lower, e.g. to C<0.001> or so. For 114high-bandwidth links you could go lower, e.g. to C<0.001> or so. For
108congested or rate-limited links, you might want to go higher, say C<0.1>, 115congested or rate-limited links, you might want to go higher, say C<0.1>,
109C<0.2> or even higher. 116C<0.2> or even higher.
110 117
111The default should be working ok for most links. 118The default should be working OK for most links.
112 119
113=item dns-timeout-factor = float 120=item dns-timeout-factor = float
114 121
115Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to 122Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to
116get request timeouts. The default of C<8> means that the DNS transport 123get request timeouts. The default of C<8> means that the DNS transport
117will resend the request when no reply has been received for longer than 124will resend the request when no reply has been received for longer than
118eight times the minimum (= expected) latency, assuming the request or 125eight times the minimum (= expected) latency, assuming the request or
119reply has been lost. 126reply has been lost.
120 127
121For congested links a higher value might be necessary (e.g. C<30>). If the 128For congested links a higher value might be necessary (e.g. C<30>). If
122link is very stable lower values (e.g. C<2>) might work nicely. Values 129the link is very stable lower values (e.g. C<2>) might work
123near or below C<1> makes no sense whatsoever. 130nicely. Values near or below C<1> makes no sense whatsoever.
124 131
125The default should be working ok for most links. 132The default should be working OK for most links but will result in low
133throughput if packet loss is high.
126 134
127=item if-up = relative-or-absolute-path 135=item if-up = relative-or-absolute-path
128 136
129Sets the path of a script that should be called immediately after the 137Sets the path of a script that should be called immediately after the
130network interface is initialized (but not neccessarily up). The following 138network interface is initialized (but not necessarily up). The following
131environment variables are passed to it (the values are just examples). 139environment variables are passed to it (the values are just examples).
132 140
133Variables that have the same value on all nodes: 141Variables that have the same value on all nodes:
134 142
135=over 4 143=over 4
… …
151select the correct syntax to use for network-related commands. 159select the correct syntax to use for network-related commands.
152 160
153=item MTU=1436 161=item MTU=1436
154 162
155The MTU to set the interface to. You can use lower values (if done 163The MTU to set the interface to. You can use lower values (if done
156consistently on all hosts), but this is usually ineffective. 164consistently on all nodes), but this is usually either inefficient or
165simply ineffective.
157 166
158=item NODES=5 167=item NODES=5
159 168
160The number of nodes in this GVPE network. 169The number of nodes in this GVPE network.
161 170
… …
173=item MAC=fe:fd:80:00:00:01 182=item MAC=fe:fd:80:00:00:01
174 183
175The MAC address the network interface has to use. 184The MAC address the network interface has to use.
176 185
177Might be used to initialize interfaces on platforms where GVPE does not 186Might be used to initialize interfaces on platforms where GVPE does not
178do this automatically. Please see the C<gvpe.osdep(5)> manpage for 187do this automatically. Please see the C<gvpe.osdep(5)> man page for
179platform-specific information. 188platform-specific information.
180 189
181=item NODENAME=branch1 190=item NODENAME=branch1
182 191
183The nickname of the node. 192The nickname of the node.
… …
200 ip link set $IFNAME up 209 ip link set $IFNAME up
201 [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 210 [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
202 [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 211 [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
203 ip route add 10.0.0.0/8 dev $IFNAME 212 ip route add 10.0.0.0/8 dev $IFNAME
204 213
205More complicated examples (using routing to reduce arp traffic) can be 214More complicated examples (using routing to reduce ARP traffic) can be
206found in the etc/ subdirectory of the distribution. 215found in the F<etc/> subdirectory of the distribution.
207 216
208=item ifname = devname 217=item ifname = devname
209 218
210Sets the tun interface name to the given name. The default is OS-specific 219Sets the tun interface name to the given name. The default is OS-specific
211and most probably something like C<tun0>. 220and most probably something like C<tun0>.
… …
220device. 229device.
221 230
222=item ip-proto = numerical-ip-protocol 231=item ip-proto = numerical-ip-protocol
223 232
224Sets the protocol number to be used for the rawip protocol. This is a 233Sets the protocol number to be used for the rawip protocol. This is a
225global option because all hosts must use the same protocol, and since 234global option because all nodes must use the same protocol, and since
226there are no port numbers, you cannot easily run more than one gvpe 235there are no port numbers, you cannot easily run more than one gvpe
227instance using the same protocol, nor can you share the protocol with 236instance using the same protocol, nor can you share the protocol with
228other programs. 237other programs.
229 238
230The default is 47 (GRE), which has a good chance of tunneling through 239The default is 47 (GRE), which has a good chance of tunneling
231firewalls (but note that the rawip protocol is not GRE compatible). Other 240through firewalls (but note that gvpe's rawip protocol is not GRE
232common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98 241compatible). Other common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4
233(ENCAP, rfc1241) 242(IPIP tunnels) or 98 (ENCAP, rfc1241)
234 243
235=item http-proxy-host = hostname/ip 244=item http-proxy-host = hostname/ip
236 245
237The C<http-proxy-*> family of options are only available if gvpe was 246The C<http-proxy-*> family of options are only available if gvpe was
238compiled with the C<--enable-http-proxy> option and enable tunneling of 247compiled with the C<--enable-http-proxy> option and enable tunneling of
… …
241C<http-proxy-host> and C<http-proxy-port> should specify the hostname and 250C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
242port number of the proxy server. See C<http-proxy-loginpw> if your proxy 251port number of the proxy server. See C<http-proxy-loginpw> if your proxy
243requires authentication. 252requires authentication.
244 253
245Please note that gvpe will still try to resolve all hostnames in the 254Please note that gvpe will still try to resolve all hostnames in the
246configuration file, so if you are behind a proxy without access to a dns 255configuration file, so if you are behind a proxy without access to a DNS
247server better use numerical IP addresses. 256server better use numerical IP addresses.
248 257
249To make best use of this option disable all protocols except tcp in your 258To make best use of this option disable all protocols except TCP in your
250config file and make sure your routers (or all other hosts) are listening 259config file and make sure your routers (or all other nodes) are listening
251on a port that the proxy allows (443, https, is a common choice). 260on a port that the proxy allows (443, https, is a common choice).
252 261
253If you have a router, connecting to it will suffice. Otherwise tcp must be 262If you have a router, connecting to it will suffice. Otherwise TCP must be
254enabled on all hosts. 263enabled on all nodes.
255 264
256Example: 265Example:
257 266
258 http-proxy-host = proxy.example.com 267 http-proxy-host = proxy.example.com
259 http-proxy-port = 3128 # 8080 is another common choice 268 http-proxy-port = 3128 # 8080 is another common choice
… …
264The port where your proxy server listens. 273The port where your proxy server listens.
265 274
266=item http-proxy-auth = login:password 275=item http-proxy-auth = login:password
267 276
268The optional login and password used to authenticate to the proxy server, 277The optional login and password used to authenticate to the proxy server,
269seperated by a literal colon (C<:>). Only basic authentication is 278separated by a literal colon (C<:>). Only basic authentication is
270currently supported. 279currently supported.
271 280
272=item keepalive = seconds 281=item keepalive = seconds
273 282
274Sets the keepalive probe interval in seconds (default: C<60>). After this 283Sets the keepalive probe interval in seconds (default: C<60>). After this
275many seconds of inactivity the daemon will start to send keepalive probe 284many seconds of inactivity the daemon will start to send keepalive probe
276every 5 seconds until it receives a reply from the other end. If no reply 285every 3 seconds until it receives a reply from the other end. If no reply
277is received within 30 seconds, the peer is considered unreachable and the 286is received within 15 seconds, the peer is considered unreachable and the
278connection is closed. 287connection is closed.
279 288
280=item loglevel = noise|trace|debug|info|notice|warn|error|critical 289=item loglevel = noise|trace|debug|info|notice|warn|error|critical
281 290
282Set the logging level. Connection established messages are logged at level 291Set the logging level. Connection established messages are logged at level
… …
284 293
285=item mtu = bytes 294=item mtu = bytes
286 295
287Sets the maximum MTU that should be used on outgoing packets (basically 296Sets the maximum MTU that should be used on outgoing packets (basically
288the MTU of the outgoing interface) The daemon will automatically calculate 297the MTU of the outgoing interface) The daemon will automatically calculate
289maximum overhead (e.g. udp header size, encryption blocksize...) and pass 298maximum overhead (e.g. UDP header size, encryption blocksize...) and pass
290this information to the C<if-up> script. 299this information to the C<if-up> script.
291 300
292Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 301Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
293 302
294This value must be the minimum of the mtu values of all hosts. 303This value must be the minimum of the MTU values of all nodes.
295 304
296=item node = nickname 305=item node = nickname
297 306
298Not really a config setting but introduces a node section. The nickname is 307Not really a config setting but introduces a node section. The nickname is
299used to select the right configuration section and must be passed as an 308used to select the right configuration section and must be passed as an
300argument to the gvpe daemon. 309argument to the gvpe daemon.
301 310
302=item node-up = relative-or-absolute-path 311=item node-up = relative-or-absolute-path
303 312
304Sets a command (default: no script) that should be called whenever a 313Sets a command (default: none) that should be called whenever a connection
305connection is established (even on rekeying operations). In addition to 314is established (even on rekeying operations). Note that node-up/down
315scripts will be run asynchronously, but execution is serialised, so there
316will only ever be one such script running.
317
306all the variables passed to C<if-up> scripts, the following environment 318In addition to all the variables passed to C<if-up> scripts, the following
307variables will be set: 319environment variables will be set (values are just examples):
308 320
309=over 4 321=over 4
310 322
311=item DESTNODE=branch2 323=item DESTNODE=branch2
312 324
… …
314 326
315=item DESTID=2 327=item DESTID=2
316 328
317The node id of the remote node. 329The node id of the remote node.
318 330
331=item DESTSI=rawip/88.99.77.55:0
332
333The "socket info" of the target node, protocol dependent but usually in
334the format protocol/ip:port.
335
319=item DESTIP=188.13.66.8 336=item DESTIP=188.13.66.8
320 337
321The numerical IP address of the remote host (gvpe accepts connections from 338The numerical IP address of the remote node (gvpe accepts connections from
322everywhere, as long as the other host can authenticate itself). 339everywhere, as long as the other node can authenticate itself).
323 340
324=item DESTPORT=655 # deprecated 341=item DESTPORT=655 # deprecated
325 342
326The UDP port used by the other side. 343The protocol port used by the other side, if applicable.
327 344
328=item STATE=UP 345=item STATE=up
329 346
330Node-up scripts get called with STATE=UP, node-down scripts get called 347Node-up scripts get called with STATE=up, node-change scripts get called
331with STATE=DOWN. 348with STATE=change and node-down scripts get called with STATE=down.
332 349
333=back 350=back
334 351
335Here is a nontrivial example that uses nsupdate to update the name => ip 352Here is a nontrivial example that uses nsupdate to update the name => ip
336mapping in some dns zone: 353mapping in some DNS zone:
337 354
338 #!/bin/sh 355 #!/bin/sh
339 { 356 {
340 echo update delete $DESTNODE.lowttl.example.net. a 357 echo update delete $DESTNODE.lowttl.example.net. a
341 echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 358 echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
342 echo 359 echo
343 } | nsupdate -d -k $CONFBASE:key.example.net. 360 } | nsupdate -d -k $CONFBASE:key.example.net.
344 361
362=item node-change = relative-or-absolute-path
363
364Same as C<node-change>, but gets called whenever something about a
365connection changes (such as the source IP address).
366
345=item node-down = relative-or-absolute-path 367=item node-down = relative-or-absolute-path
346 368
347Same as C<node-up>, but gets called whenever a connection is lost. 369Same as C<node-up>, but gets called whenever a connection is lost.
348 370
349=item pid-file = path 371=item pid-file = path
… …
358be doubled. A single C<%s> is replaced by the hostname, so you could 380be doubled. A single C<%s> is replaced by the hostname, so you could
359use paths like C<hostkeys/%s> to fetch the files at the location where 381use paths like C<hostkeys/%s> to fetch the files at the location where
360C<gvpectrl> puts them. 382C<gvpectrl> puts them.
361 383
362Since only the private key file of the current node is used and the 384Since only the private key file of the current node is used and the
363private key file should be kept secret per-host to avoid spoofings, it is 385private key file should be kept secret per-node to avoid spoofing, it is
364not recommended to use this feature. 386not recommended to use this feature.
365 387
366=item rekey = seconds 388=item rekey = seconds
367 389
368Sets the rekeying interval in seconds (default: C<3600>). Connections are 390Sets the rekeying interval in seconds (default: C<3600>). Connections are
369reestablished every C<rekey> seconds. 391reestablished every C<rekey> seconds, making them use a new encryption
392key.
393
394=item nfmark = integer
395
396This advanced option, when set to a nonzero value (default: C<0>), tries
397to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
398send packets.
399
400This can be used to make gvpe use a different set of routing rules. For
401example, on GNU/Linux, the C<if-up> could set C<nfmark> to 1000 and then
402put all routing rules into table C<99> and then use an ip rule to make
403gvpe traffic avoid that routing table, in effect routing normal traffic
404via gvpe and gvpe traffic via the normal system routing tables:
405
406 ip rule add not fwmark 1000 lookup 99
370 407
371=back 408=back
372 409
373=head2 NODE SPECIFIC SETTINGS 410=head2 NODE SPECIFIC SETTINGS
374 411
375The following settings are node-specific, that is, every node can have 412The following settings are node-specific, that is, every node can have
376different settings, even within the same gvpe instance. Settings that are 413different settings, even within the same gvpe instance. Settings that are
377executed before the first node section set the defaults, settings that are 414set before the first node section set the defaults, settings that are
378executed within a node section only apply to the given node. 415set within a node section only apply to the given node.
379 416
380=over 4 417=over 4
381 418
419=item allow-direct = nodename
420
421Allow direct connections to this node. See C<deny-direct> for more info.
422
382=item compress = yes|true|on | no|false|off 423=item compress = yes|true|on | no|false|off
383 424
384Wether to compress data packets sent to this host (default: C<yes>). 425Wether to compress data packets sent to this node (default: C<yes>).
385Compression is really cheap even on slow computers and has no size 426Compression is really cheap even on slow computers and has no size
386overhead at all, so enabling this is a good idea. 427overhead at all, so enabling this is often a good idea.
387 428
388=item connect = ondemand | never | always | disabled 429=item connect = ondemand | never | always | disabled
389 430
390Sets the connect mode (default: C<always>). It can be C<always> (always 431Sets the connect mode (default: C<always>). It can be C<always> (always
391try to establish and keep a connection to the given host), C<never> 432try to establish and keep a connection to the given node), C<never>
392(never initiate a connection to the given host, but accept connections), 433(never initiate a connection to the given host, but accept connections),
393C<ondemand> (try to establish a connection on the first packet sent, and 434C<ondemand> (try to establish a connection when there are outstanding
394take it down after the keepalive interval) or C<disabled> (node is bad, 435packets in the queue and take it down after the keepalive interval) or
395don't talk to it). 436C<disabled> (node is bad, don't talk to it).
437
438Routers will automatically be forced to C<always> unless they are
439C<disabled>, to ensure all nodes can talk to each other.
440
441=item deny-direct = nodename | *
442
443Deny direct connections to the specified node (or all nodes when C<*>
444is given). Only one node can be specified, but you can use multiple
445C<allow-direct> and C<deny-direct> statements. This only makes sense in
446networks with routers, as routers are required for indirect connections.
447
448Sometimes, a node cannot reach some other nodes for reasons of network
449connectivity. For example, a node behind a firewall that only allows
450connections to/from a single other node in the network. In this case one
451should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
452node I<must> be a router for this to work).
453
454The algorithm to check whether a connection may be direct is as follows:
455
4561. Other node mentioned in an C<allow-direct>? If yes, allow the connection.
457
4582. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
459
4603. Allow the connection.
461
462That is, C<allow-direct> takes precedence over C<deny-direct>.
463
464The check is done in both directions, i.e. both nodes must allow a direct
465connection before one is attempted, so you only need to specify connect
466limitations on one node.
396 467
397=item dns-domain = domain-suffix 468=item dns-domain = domain-suffix
398 469
399The DNS domain suffix that points to the DNS tunnel server for this node. 470The DNS domain suffix that points to the DNS tunnel server for this node.
400 471
… …
430 501
431=item enable-icmp = yes|true|on | no|false|off 502=item enable-icmp = yes|true|on | no|false|off
432 503
433See gvpe.protocol(7) for a description of the ICMP transport protocol. 504See gvpe.protocol(7) for a description of the ICMP transport protocol.
434 505
435Enable the ICMP transport using icmp packets of type C<icmp-type> on this 506Enable the ICMP transport using ICMP packets of type C<icmp-type> on this
436node. 507node.
437 508
438=item enable-rawip = yes|true|on | no|false|off 509=item enable-rawip = yes|true|on | no|false|off
439 510
440See gvpe.protocol(7) for a description of the RAW IP transport protocol. 511See gvpe.protocol(7) for a description of the RAW IP transport protocol.
… …
456 527
457Enable the UDPv4 transport using the C<udp-port> port (default: C<no>, 528Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,
458unless no other protocol is enabled for a node, in which case this 529unless no other protocol is enabled for a node, in which case this
459protocol is enabled automatically). 530protocol is enabled automatically).
460 531
461NOTE: Please specify C<enable-udp = yes> if you want t use it even though 532NOTE: Please specify C<enable-udp = yes> if you want to use it even though
462it might get switched on automatically, as some future version might 533it might get switched on automatically, as some future version might
463default to another default protocol. 534default to another default protocol.
464 535
536=item hostname = hostname | ip [can not be defaulted]
537
538Forces the address of this node to be set to the given DNS hostname or IP
539address. It will be resolved before each connect request, so dyndns should
540work fine. If this setting is not specified and a router is available,
541then the router will be queried for the address of this node. Otherwise,
542the connection attempt will fail.
543
544Note that DNS resolving is done synchronously, pausing the daemon. If that
545is an issue you need to specify IP addresses.
546
465=item icmp-type = integer 547=item icmp-type = integer
466 548
467Sets the type value to be used for outgoing (and incoming) packets sent 549Sets the type value to be used for outgoing (and incoming) packets sent
468via the ICMP transport. 550via the ICMP transport.
469 551
470The default is C<0> (which is C<echo-reply>, also known as 552The default is C<0> (which is C<echo-reply>, also known as
471"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a. 553"ping-reply"). Other useful values include C<8> (C<echo-request>, a.k.a.
472"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used. 554"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
473 555
474=item if-up-data = value 556=item if-up-data = value
475 557
476The value specified using this directive will be passed to the C<if-up> 558The value specified using this directive will be passed to the C<if-up>
… …
485 567
486=item max-retry = positive-number 568=item max-retry = positive-number
487 569
488The maximum interval in seconds (default: C<3600>, one hour) between 570The maximum interval in seconds (default: C<3600>, one hour) between
489retries to establish a connection to this node. When a connection cannot 571retries to establish a connection to this node. When a connection cannot
490be established, gvpe uses exponential backoff capped at this value. It's 572be established, gvpe uses exponential back-off capped at this value. It's
491sometimes useful to set this to a much lower value (e.g. C<120>) on 573sometimes useful to set this to a much lower value (e.g. C<120>) on
492connections to routers that usually are stable but sometimes are down, to 574connections to routers that usually are stable but sometimes are down, to
493assure quick reconnections even after longer downtimes. 575assure quick reconnections even after longer downtimes.
494 576
577=item max-ttl = seconds
578
579Expire packets that couldn't be sent after this many seconds
580(default: C<60>). Gvpe will normally queue packets for a node without an
581active connection, in the hope of establishing a connection soon. This
582value specifies the maximum lifetime a packet will stay in the queue, if a
583packet gets older, it will be thrown away.
584
585=item max-queue = positive-number>=1
586
587The maximum number of packets that will be queued (default: C<512>)
588for this node. If more packets are sent then earlier packets will be
589expired. See C<max-ttl>, above.
590
495=item router-priority = 0 | 1 | positive-number>=2 591=item router-priority = 0 | 1 | positive-number>=2
496 592
497Sets the router priority of the given host (default: C<0>, disabled). If 593Sets the router priority of the given node (default: C<0>, disabled).
498some host tries to connect to another host without a hostname, it asks
499the router host for it's IP address. The router host is the one with the
500highest priority larger than C<1> that is currently reachable.
501 594
502Make sure all hosts always connect (C<connect = always>) to the router 595If some node tries to connect to another node but it doesn't have a
503hosts, otherwise connecting to them might be impossible. 596hostname, it asks a router node for it's IP address. The router node
597chosen is the one with the highest priority larger than C<1> that is
598currently reachable. This is called a I<mediated> connection, as the
599connection itself will still be direct, but it uses another node to
600mediate between the two nodes.
601
602The value C<0> disables routing, that means if the node receives a packet
603not for itself it will not forward it but instead drop it.
504 604
505The special value C<1> allows other hosts to route through the router 605The special value C<1> allows other hosts to route through the router
506host, but they will never route through it by default. The value C<0> 606host, but they will never route through it by default (i.e. the config
507disables routing. The idea behind this is that some hosts can, if 607file of another node needs to specify a router priority higher than one
608to choose such a node for routing).
609
610The idea behind this is that some hosts can, if required, bump the
508required, bump the C<router-priority> setting to higher than C<1> in their 611C<router-priority> setting to higher than C<1> in their local config to
509local config to route through specific hosts. If C<router-priority> is 612route through specific hosts. If C<router-priority> is C<0>, then routing
510C<0>, then routing will be refused, so C<1> serves as a "enable, but do 613will be refused, so C<1> serves as a "enable, but do not use by default"
511not use by default" switch. 614switch.
615
616Nodes with C<router-priority> set to C<2> or higher will always be forced
617to C<connect> = C<always> (unless they are C<disabled>).
512 618
513=item tcp-port = port-number 619=item tcp-port = port-number
514 620
515Similar to C<udp-port> (default: C<655>), but sets the TCP port number. 621Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
516 622
… …
525 631
526The default (or recommended) directory layout for the config directory is: 632The default (or recommended) directory layout for the config directory is:
527 633
528=over 4 634=over 4
529 635
530=item X<gvpe.conf> 636=item gvpe.conf
531 637
532The config file. 638The config file.
533 639
534=item X<if-up> 640=item if-up
535 641
536The if-up script 642The if-up script
537 643
538=item X<node-up>, X<node-down> 644=item node-up, node-down
539 645
540If used the node up or node-down scripts. 646If used the node up or node-down scripts.
541 647
542=item X<hostkey> 648=item hostkey
543 649
544The private key (taken from C<hostkeys/nodename>) of the current host. 650The private key (taken from C<hostkeys/nodename>) of the current host.
545 651
546=item X<pubkey/nodename> 652=item pubkey/nodename
547 653
548The public keys of the other nodes, one file per node. 654The public keys of the other nodes, one file per node.
549 655
550=back 656=back
551 657

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines