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.18 by pcg, Thu Aug 7 17:30:27 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
372 373
373=head2 NODE SPECIFIC SETTINGS 374=head2 NODE SPECIFIC SETTINGS
374 375
375The following settings are node-specific, that is, every node can have 376The following settings are node-specific, that is, every node can have
376different settings, even within the same gvpe instance. Settings that are 377different settings, even within the same gvpe instance. Settings that are
377executed before the first node section set the defaults, settings that are 378set before the first node section set the defaults, settings that are
378executed within a node section only apply to the given node. 379set within a node section only apply to the given node.
379 380
380=over 4 381=over 4
382
383=item allow-direct = nodename
384
385Allow direct connections to this node. See C<deny-direct> for more info.
381 386
382=item compress = yes|true|on | no|false|off 387=item compress = yes|true|on | no|false|off
383 388
384Wether to compress data packets sent to this host (default: C<yes>). 389Wether to compress data packets sent to this host (default: C<yes>).
385Compression is really cheap even on slow computers and has no size 390Compression is really cheap even on slow computers and has no size
388=item connect = ondemand | never | always | disabled 393=item connect = ondemand | never | always | disabled
389 394
390Sets the connect mode (default: C<always>). It can be C<always> (always 395Sets 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> 396try to establish and keep a connection to the given host), C<never>
392(never initiate a connection to the given host, but accept connections), 397(never initiate a connection to the given host, but accept connections),
393C<ondemand> (try to establish a connection on the first packet sent, and 398C<ondemand> (try to establish a connection when there are outstanding
394take it down after the keepalive interval) or C<disabled> (node is bad, 399packets in the queue and take it down after the keepalive interval) or
395don't talk to it). 400C<disabled> (node is bad, don't talk to it).
401
402=item deny-direct = nodename | *
403
404Deny direct connections to the specified node (or all nodes when C<*>
405is given). Only one node can be specified, but you can use multiple
406C<allow-direct> and C<deny-direct> statements. This only makes sense in
407networks with routers, as routers are required for indirect connections.
408
409Sometimes, a node cannot reach some other nodes for reasons of network
410connectivity. For example, a node behind a firewall that only allows
411conenctions to/from a single other node in the network. In this case one
412should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
413node I<must> be a router for this to work).
414
415The algorithm to check wether a connection may be direct is as follows:
416
4171. Other node mentioned in a C<allow-direct>? If yes, allow the connection.
418
4192. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
420
4213. Allow the connection.
422
423That is, C<allow-direct> takes precedence over C<deny-direct>.
424
425The check is done in both directions, i.e. both nodes must allow a direct
426connection before one is attempted, so you only need to specify connect
427limitations on one node.
396 428
397=item dns-domain = domain-suffix 429=item dns-domain = domain-suffix
398 430
399The DNS domain suffix that points to the DNS tunnel server for this node. 431The DNS domain suffix that points to the DNS tunnel server for this node.
400 432
459protocol is enabled automatically). 491protocol is enabled automatically).
460 492
461NOTE: Please specify C<enable-udp = yes> if you want t use it even though 493NOTE: 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 494it might get switched on automatically, as some future version might
463default to another default protocol. 495default to another default protocol.
496
497=item hostname = hostname | ip [can not be defaulted]
498
499Forces the address of this node to be set to the given dns hostname or ip
500address. It will be resolved before each connect request, so dyndns should
501work fine. If this setting is not specified and a router is available,
502then the router will be queried for the address of this node. Otherwise,
503the connection attempt will fail.
464 504
465=item icmp-type = integer 505=item icmp-type = integer
466 506
467Sets the type value to be used for outgoing (and incoming) packets sent 507Sets the type value to be used for outgoing (and incoming) packets sent
468via the ICMP transport. 508via the ICMP transport.
489retries to establish a connection to this node. When a connection cannot 529retries to establish a connection to this node. When a connection cannot
490be established, gvpe uses exponential backoff capped at this value. It's 530be 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 531sometimes 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 532connections to routers that usually are stable but sometimes are down, to
493assure quick reconnections even after longer downtimes. 533assure quick reconnections even after longer downtimes.
534
535=item max-ttl = seconds
536
537Expire packets that couldn't be sent after this many seconds
538(default: C<60>). Gvpe will normally queue packets for a node without an
539active connection, in the hope of establishing a connection soon. This
540value specifies the maximum lifetime a packet will stay in the queue, if a
541packet gets older, it will be thrown away.
542
543=item max-queue = positive-number
544
545The maximum number of packets that will be queued (default: C<512>)
546for this node. If more packets are sent then earlier packets will be
547expired. See C<max-ttl>, above.
494 548
495=item router-priority = 0 | 1 | positive-number>=2 549=item router-priority = 0 | 1 | positive-number>=2
496 550
497Sets the router priority of the given host (default: C<0>, disabled). If 551Sets 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 552some host tries to connect to another host without a hostname, it asks

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines