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

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.15 by pcg, Tue Jun 21 08:48:03 2005 UTC vs.
Revision 1.16 by pcg, Mon Dec 5 12:58:06 2005 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "GVPE.CONF 5" 131.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2005-06-21" "1.9" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2005-12-05" "1.9" "GNU Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 134gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 3 137.Vb 3
… …
474reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 474reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
475.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 475.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
476.IX Subsection "NODE SPECIFIC SETTINGS" 476.IX Subsection "NODE SPECIFIC SETTINGS"
477The following settings are node\-specific, that is, every node can have 477The following settings are node\-specific, that is, every node can have
478different settings, even within the same gvpe instance. Settings that are 478different settings, even within the same gvpe instance. Settings that are
479executed before the first node section set the defaults, settings that are 479set before the first node section set the defaults, settings that are
480executed within a node section only apply to the given node. 480set within a node section only apply to the given node.
481.IP "allow-direct = nodename" 4
482.IX Item "allow-direct = nodename"
483Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
481.IP "compress = yes|true|on | no|false|off" 4 484.IP "compress = yes|true|on | no|false|off" 4
482.IX Item "compress = yes|true|on | no|false|off" 485.IX Item "compress = yes|true|on | no|false|off"
483Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 486Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
484Compression is really cheap even on slow computers and has no size 487Compression is really cheap even on slow computers and has no size
485overhead at all, so enabling this is a good idea. 488overhead at all, so enabling this is a good idea.
… …
489try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 492try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR
490(never initiate a connection to the given host, but accept connections), 493(never initiate a connection to the given host, but accept connections),
491\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 494\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and
492take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 495take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
493don't talk to it). 496don't talk to it).
497.IP "deny-direct = nodename | *" 4
498.IX Item "deny-direct = nodename | *"
499Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
500is given). Only one node can be specified, but you can use multiple
501\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
502networks with routers, as routers are required for indirect connections.
503.Sp
504Sometimes, a node cannot reach some other nodes for reasons of network
505connectivity. For example, a node behind a firewall that only allows
506conenctions to/from a single other node in the network. In this case one
507should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
508node \fImust\fR be a router for this to work).
509.Sp
510The algorithm to check wether a connection may be direct is as follows:
511.Sp
5121. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
513.Sp
5142. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
515.Sp
5163. Allow the connection.
517.Sp
518That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precende over \f(CW\*(C`deny\-direct\*(C'\fR.
519.Sp
520The check is done in both directions, i.e. both nodes must allow a direct
521connection before one is attempted, so you only need to specify connect
522limitations on one node.
494.IP "dns-domain = domain-suffix" 4 523.IP "dns-domain = domain-suffix" 4
495.IX Item "dns-domain = domain-suffix" 524.IX Item "dns-domain = domain-suffix"
496The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. 525The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
497.Sp 526.Sp
498The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 527The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
… …
553protocol is enabled automatically). 582protocol is enabled automatically).
554.Sp 583.Sp
555\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 584\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
556it might get switched on automatically, as some future version might 585it might get switched on automatically, as some future version might
557default to another default protocol. 586default to another default protocol.
587.IP "hostname = hostname | ip [can not be defaulted]" 4
588.IX Item "hostname = hostname | ip [can not be defaulted]"
589Forces the address of this node to be set to the given dns hostname or ip
590address. It will be resolved before each connect request, so dyndns should
591work fine. If this setting is not specified and a router is available,
592then the router will be queried for the address of this node. Otherwise,
593the connection attempt will fail.
558.IP "icmp-type = integer" 4 594.IP "icmp-type = integer" 4
559.IX Item "icmp-type = integer" 595.IX Item "icmp-type = integer"
560Sets the type value to be used for outgoing (and incoming) packets sent 596Sets the type value to be used for outgoing (and incoming) packets sent
561via the \s-1ICMP\s0 transport. 597via the \s-1ICMP\s0 transport.
562.Sp 598.Sp

Diff Legend

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