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.14 by pcg, Sat Mar 26 03:16:23 2005 UTC vs.
Revision 1.18 by pcg, Wed Nov 22 22:55:15 2006 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
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-03-26" "1.9" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2006-11-22" "2.0" "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
… …
245get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport 245get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
246will resend the request when no reply has been received for longer than 246will resend the request when no reply has been received for longer than
247eight times the minimum (= expected) latency, assuming the request or 247eight times the minimum (= expected) latency, assuming the request or
248reply has been lost. 248reply has been lost.
249.Sp 249.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the 250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
251link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values 251the link is very stable lower values (e.g. \f(CW2\fR) might work
252near or below \f(CW1\fR makes no sense whatsoever. 252nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
253.Sp 253.Sp
254The default should be working ok for most links. 254The default should be working ok for most links but will result in low
255throughput if packet loss is high.
255.IP "if-up = relative-or-absolute-path" 4 256.IP "if-up = relative-or-absolute-path" 4
256.IX Item "if-up = relative-or-absolute-path" 257.IX Item "if-up = relative-or-absolute-path"
257Sets the path of a script that should be called immediately after the 258Sets the path of a script that should be called immediately after the
258network interface is initialized (but not neccessarily up). The following 259network interface is initialized (but not neccessarily up). The following
259environment variables are passed to it (the values are just examples). 260environment variables are passed to it (the values are just examples).
… …
474reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 475reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
475.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 476.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
476.IX Subsection "NODE SPECIFIC SETTINGS" 477.IX Subsection "NODE SPECIFIC SETTINGS"
477The following settings are node\-specific, that is, every node can have 478The following settings are node\-specific, that is, every node can have
478different settings, even within the same gvpe instance. Settings that are 479different settings, even within the same gvpe instance. Settings that are
479executed before the first node section set the defaults, settings that are 480set before the first node section set the defaults, settings that are
480executed within a node section only apply to the given node. 481set within a node section only apply to the given node.
482.IP "allow-direct = nodename" 4
483.IX Item "allow-direct = nodename"
484Allow 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 485.IP "compress = yes|true|on | no|false|off" 4
482.IX Item "compress = yes|true|on | no|false|off" 486.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). 487Wether 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 488Compression is really cheap even on slow computers and has no size
485overhead at all, so enabling this is a good idea. 489overhead 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 493try 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), 494(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 495\&\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, 496take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
493don't talk to it). 497don't talk to it).
498.IP "deny-direct = nodename | *" 4
499.IX Item "deny-direct = nodename | *"
500Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
501is given). Only one node can be specified, but you can use multiple
502\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
503networks with routers, as routers are required for indirect connections.
504.Sp
505Sometimes, a node cannot reach some other nodes for reasons of network
506connectivity. For example, a node behind a firewall that only allows
507conenctions to/from a single other node in the network. In this case one
508should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
509node \fImust\fR be a router for this to work).
510.Sp
511The algorithm to check wether a connection may be direct is as follows:
512.Sp
5131. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
514.Sp
5152. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
516.Sp
5173. Allow the connection.
518.Sp
519That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
520.Sp
521The check is done in both directions, i.e. both nodes must allow a direct
522connection before one is attempted, so you only need to specify connect
523limitations on one node.
494.IP "dns-domain = domain-suffix" 4 524.IP "dns-domain = domain-suffix" 4
495.IX Item "dns-domain = domain-suffix" 525.IX Item "dns-domain = domain-suffix"
496The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. 526The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
497.Sp 527.Sp
498The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 528The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
… …
553protocol is enabled automatically). 583protocol is enabled automatically).
554.Sp 584.Sp
555\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 585\&\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 586it might get switched on automatically, as some future version might
557default to another default protocol. 587default to another default protocol.
588.IP "hostname = hostname | ip [can not be defaulted]" 4
589.IX Item "hostname = hostname | ip [can not be defaulted]"
590Forces the address of this node to be set to the given dns hostname or ip
591address. It will be resolved before each connect request, so dyndns should
592work fine. If this setting is not specified and a router is available,
593then the router will be queried for the address of this node. Otherwise,
594the connection attempt will fail.
558.IP "icmp-type = integer" 4 595.IP "icmp-type = integer" 4
559.IX Item "icmp-type = integer" 596.IX Item "icmp-type = integer"
560Sets the type value to be used for outgoing (and incoming) packets sent 597Sets the type value to be used for outgoing (and incoming) packets sent
561via the \s-1ICMP\s0 transport. 598via the \s-1ICMP\s0 transport.
562.Sp 599.Sp
… …
626.SH "SEE ALSO" 663.SH "SEE ALSO"
627.IX Header "SEE ALSO" 664.IX Header "SEE ALSO"
628\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 665\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
629.SH "AUTHOR" 666.SH "AUTHOR"
630.IX Header "AUTHOR" 667.IX Header "AUTHOR"
631Marc Lehmann <gvpe@plan9.de> 668Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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