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.6 by pcg, Sun Mar 6 18:34:46 2005 UTC vs.
Revision 1.11 by pcg, Thu Mar 17 22:28:53 2005 UTC

322take it down after the keepalive interval) or C<disabled> (node is bad, 322take it down after the keepalive interval) or C<disabled> (node is bad,
323don't talk to it). 323don't talk to it).
324 324
325=item dns-domain = domain-suffix 325=item dns-domain = domain-suffix
326 326
327The DNS domain suffix that points to the DNS tunnel server. Needs to be 327The DNS domain suffix that points to the DNS tunnel server for this node.
328set on both client and server.
329 328
330The domain must point to a NS record that points to the I<dns-hostname>, 329The domain must point to a NS record that points to the I<dns-hostname>,
331i.e. 330i.e.
332 331
333 dns-domainname = tunnel.example.net 332 dns-domainname = tunnel.example.net
344but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might 343but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might
345change. 344change.
346 345
347=item dns-port = port-number 346=item dns-port = port-number
348 347
349The port to bind the DNS tunnel socket to. Must be C<0> on all DNS tunnel 348The port to bind the DNS tunnel socket to. Must be C<53> on DNS tunnel servers.
350clients and C<53> on the server. 349
350=item enable-dns = yes|true|on | no|false|off
351
352See gvpe.protocol(7) for a description of the DNS transport
353protocol. Avoid this protocol if you can.
354
355Enable the DNS tunneling protocol on this node, either as server or as
356client. Support for this transport protocol is only available when gvpe
357was compiled using the C<--enable-dns> option.
358
359=item enable-icmp = yes|true|on | no|false|off
360
361See gvpe.protocol(7) for a description of the ICMP transport protocol.
362
363Enable the ICMP transport using icmp packets of type C<icmp-type> on this
364node.
351 365
352=item enable-rawip = yes|true|on | no|false|off 366=item enable-rawip = yes|true|on | no|false|off
353 367
368See gvpe.protocol(7) for a description of the RAW IP transport protocol.
369
354Enable the RAW IPv4 transport using the C<ip-proto> protocol 370Enable the RAW IPv4 transport using the C<ip-proto> protocol
355(default: C<no>). This is the best choice, since the overhead per packet 371(default: C<no>).
356is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+).
357 372
358=item enable-tcp = yes|true|on | no|false|off 373=item enable-tcp = yes|true|on | no|false|off
359 374
375See gvpe.protocol(7) for a description of the TCP transport protocol.
376
360Enable the TCPv4 transport using the C<tcp-port> port 377Enable the TCPv4 transport using the C<tcp-port> port
361(default: C<no>). Support for this horribly unsuitable protocol is only 378(default: C<no>). Support for this transport protocol is only available
362available when gvpe was compiled using the C<--enable-tcp> option. Never 379when gvpe was compiled using the C<--enable-tcp> option.
363use this transport unless you really must, it is horribly ineffiecent and
364resource-intensive compared to the other transports.
365 380
366=item enable-udp = yes|true|on | no|false|off 381=item enable-udp = yes|true|on | no|false|off
382
383See gvpe.protocol(7) for a description of the UDP transport protocol.
367 384
368Enable the UDPv4 transport using the C<udp-port> port (default: C<no>, 385Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,
369unless no other protocol is enabled for a node, in which case this 386unless no other protocol is enabled for a node, in which case this
370protocol is enabled automatically). This is a good general choice since 387protocol is enabled automatically).
371UDP tunnels well through many firewalls.
372 388
373NOTE: Please specify C<enable-udp = yes> if you want t use it even though 389NOTE: Please specify C<enable-udp = yes> if you want t use it even though
374it might get switched on automatically, as some future version might 390it might get switched on automatically, as some future version might
375default to another default protocol. 391default to another default protocol.
392
393=item icmp-type = integer
394
395Sets the type value to be used for outgoing (and incoming) packets sent
396via the ICMP transport.
397
398The default is C<0> (which is C<echo-reply>, also known as
399"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.
400"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
376 401
377=item inherit-tos = yes|true|on | no|false|off 402=item inherit-tos = yes|true|on | no|false|off
378 403
379Wether to inherit the TOS settings of packets sent to the tunnel when 404Wether to inherit the TOS settings of packets sent to the tunnel when
380sending packets to this node (default: C<yes>). If set to C<yes> then 405sending packets to this node (default: C<yes>). If set to C<yes> then
381outgoing tunnel packets will have the same TOS setting as the packets sent 406outgoing tunnel packets will have the same TOS setting as the packets sent
382to the tunnel device, which is usually what you want. 407to the tunnel device, which is usually what you want.
383 408
384=item max-retry = positive-number 409=item max-retry = positive-number
385 410
386The maximum interval in seconds (default: C<28800>, 8 hours) between 411The maximum interval in seconds (default: C<3600>, one hour) between
387retries to establish a connection to this node. When a connection cannot 412retries to establish a connection to this node. When a connection cannot
388be established, gvpe uses exponential backoff capped at this value. It's 413be established, gvpe uses exponential backoff capped at this value. It's
389sometimes useful to set this to a much lower value (e.g. C<120>) on 414sometimes useful to set this to a much lower value (e.g. C<120>) on
390connections to routers that usually are stable but sometimes are down, to 415connections to routers that usually are stable but sometimes are down, to
391assure quick reconnections. 416assure quick reconnections even after longer downtimes.
392 417
393=item router-priority = 0 | 1 | positive-number>2 418=item router-priority = 0 | 1 | positive-number>=2
394 419
395Sets the router priority of the given host (default: C<0>, disabled). If 420Sets the router priority of the given host (default: C<0>, disabled). If
396some host tries to connect to another host without a hostname, it asks 421some host tries to connect to another host without a hostname, it asks
397the router host for it's IP address. The router host is the one with the 422the router host for it's IP address. The router host is the one with the
398highest priority larger than C<1> that is currently reachable. 423highest priority larger than C<1> that is currently reachable.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines