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.19 by pcg, Thu Aug 7 19:07:02 2008 UTC

… …
116get request timeouts. The default of C<8> means that the DNS transport 116get 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 117will resend the request when no reply has been received for longer than
118eight times the minimum (= expected) latency, assuming the request or 118eight times the minimum (= expected) latency, assuming the request or
119reply has been lost. 119reply has been lost.
120 120
121For congested links a higher value might be necessary (e.g. C<30>). If the 121For 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 122the link is very stable lower values (e.g. C<2>) might work
123near or below C<1> makes no sense whatsoever. 123nicely. Values near or below C<1> makes no sense whatsoever.
124 124
125The default should be working ok for most links. 125The default should be working ok for most links but will result in low
126throughput if packet loss is high.
126 127
127=item if-up = relative-or-absolute-path 128=item if-up = relative-or-absolute-path
128 129
129Sets the path of a script that should be called immediately after the 130Sets the path of a script that should be called immediately after the
130network interface is initialized (but not neccessarily up). The following 131network interface is initialized (but not neccessarily up). The following
… …
299used to select the right configuration section and must be passed as an 300used to select the right configuration section and must be passed as an
300argument to the gvpe daemon. 301argument to the gvpe daemon.
301 302
302=item node-up = relative-or-absolute-path 303=item node-up = relative-or-absolute-path
303 304
304Sets a command (default: no script) that should be called whenever a 305Sets a command (default: none) that should be called whenever a connection
305connection is established (even on rekeying operations). In addition to 306is established (even on rekeying operations). Note that node-up/down
307scripts will be run asynchronously, but execution is serialised, so there
308will only ever be one such script running.
309
306all the variables passed to C<if-up> scripts, the following environment 310In addition to all the variables passed to C<if-up> scripts, the following
307variables will be set: 311environment variables will be set:
308 312
309=over 4 313=over 4
310 314
311=item DESTNODE=branch2 315=item DESTNODE=branch2
312 316
… …
372 376
373=head2 NODE SPECIFIC SETTINGS 377=head2 NODE SPECIFIC SETTINGS
374 378
375The following settings are node-specific, that is, every node can have 379The following settings are node-specific, that is, every node can have
376different settings, even within the same gvpe instance. Settings that are 380different settings, even within the same gvpe instance. Settings that are
377executed before the first node section set the defaults, settings that are 381set before the first node section set the defaults, settings that are
378executed within a node section only apply to the given node. 382set within a node section only apply to the given node.
379 383
380=over 4 384=over 4
385
386=item allow-direct = nodename
387
388Allow direct connections to this node. See C<deny-direct> for more info.
381 389
382=item compress = yes|true|on | no|false|off 390=item compress = yes|true|on | no|false|off
383 391
384Wether to compress data packets sent to this host (default: C<yes>). 392Wether to compress data packets sent to this host (default: C<yes>).
385Compression is really cheap even on slow computers and has no size 393Compression is really cheap even on slow computers and has no size
… …
388=item connect = ondemand | never | always | disabled 396=item connect = ondemand | never | always | disabled
389 397
390Sets the connect mode (default: C<always>). It can be C<always> (always 398Sets 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> 399try to establish and keep a connection to the given host), C<never>
392(never initiate a connection to the given host, but accept connections), 400(never initiate a connection to the given host, but accept connections),
393C<ondemand> (try to establish a connection on the first packet sent, and 401C<ondemand> (try to establish a connection when there are outstanding
394take it down after the keepalive interval) or C<disabled> (node is bad, 402packets in the queue and take it down after the keepalive interval) or
395don't talk to it). 403C<disabled> (node is bad, don't talk to it).
404
405=item deny-direct = nodename | *
406
407Deny direct connections to the specified node (or all nodes when C<*>
408is given). Only one node can be specified, but you can use multiple
409C<allow-direct> and C<deny-direct> statements. This only makes sense in
410networks with routers, as routers are required for indirect connections.
411
412Sometimes, a node cannot reach some other nodes for reasons of network
413connectivity. For example, a node behind a firewall that only allows
414conenctions to/from a single other node in the network. In this case one
415should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
416node I<must> be a router for this to work).
417
418The algorithm to check wether a connection may be direct is as follows:
419
4201. Other node mentioned in a C<allow-direct>? If yes, allow the connection.
421
4222. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
423
4243. Allow the connection.
425
426That is, C<allow-direct> takes precedence over C<deny-direct>.
427
428The check is done in both directions, i.e. both nodes must allow a direct
429connection before one is attempted, so you only need to specify connect
430limitations on one node.
396 431
397=item dns-domain = domain-suffix 432=item dns-domain = domain-suffix
398 433
399The DNS domain suffix that points to the DNS tunnel server for this node. 434The DNS domain suffix that points to the DNS tunnel server for this node.
400 435
… …
459protocol is enabled automatically). 494protocol is enabled automatically).
460 495
461NOTE: Please specify C<enable-udp = yes> if you want t use it even though 496NOTE: Please specify C<enable-udp = yes> if you want t use it even though
462it might get switched on automatically, as some future version might 497it might get switched on automatically, as some future version might
463default to another default protocol. 498default to another default protocol.
499
500=item hostname = hostname | ip [can not be defaulted]
501
502Forces the address of this node to be set to the given dns hostname or ip
503address. It will be resolved before each connect request, so dyndns should
504work fine. If this setting is not specified and a router is available,
505then the router will be queried for the address of this node. Otherwise,
506the connection attempt will fail.
464 507
465=item icmp-type = integer 508=item icmp-type = integer
466 509
467Sets the type value to be used for outgoing (and incoming) packets sent 510Sets the type value to be used for outgoing (and incoming) packets sent
468via the ICMP transport. 511via the ICMP transport.
… …
489retries to establish a connection to this node. When a connection cannot 532retries to establish a connection to this node. When a connection cannot
490be established, gvpe uses exponential backoff capped at this value. It's 533be established, gvpe uses exponential backoff capped at this value. It's
491sometimes useful to set this to a much lower value (e.g. C<120>) on 534sometimes 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 535connections to routers that usually are stable but sometimes are down, to
493assure quick reconnections even after longer downtimes. 536assure quick reconnections even after longer downtimes.
537
538=item max-ttl = seconds
539
540Expire packets that couldn't be sent after this many seconds
541(default: C<60>). Gvpe will normally queue packets for a node without an
542active connection, in the hope of establishing a connection soon. This
543value specifies the maximum lifetime a packet will stay in the queue, if a
544packet gets older, it will be thrown away.
545
546=item max-queue = positive-number
547
548The maximum number of packets that will be queued (default: C<512>)
549for this node. If more packets are sent then earlier packets will be
550expired. See C<max-ttl>, above.
494 551
495=item router-priority = 0 | 1 | positive-number>=2 552=item router-priority = 0 | 1 | positive-number>=2
496 553
497Sets the router priority of the given host (default: C<0>, disabled). If 554Sets the router priority of the given host (default: C<0>, disabled). If
498some host tries to connect to another host without a hostname, it asks 555some host tries to connect to another host without a hostname, it asks

Diff Legend

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