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.8 by pcg, Mon Mar 7 01:31:26 2005 UTC vs.
Revision 1.15 by pcg, Tue Jun 21 08:48:03 2005 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
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-07" "1.8" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2005-06-21" "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
… …
158.SH "DESCRIPTION" 158.SH "DESCRIPTION"
159.IX Header "DESCRIPTION" 159.IX Header "DESCRIPTION"
160The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable 160The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable
161= value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and 161= value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and
162extend to the end of the line. They can be used on their own lines, or 162extend to the end of the line. They can be used on their own lines, or
163after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or 163after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after
164after values, but not within the variable names or values themselves. 164values, but not within the variable names or values themselves.
165.PP 165.PP
166The only exception to the above is the \*(L"on\*(R" directive that can prefix any 166The only exception to the above is the \*(L"on\*(R" directive that can prefix any
167\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 167\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or
168(if the nodename starts with \*(L"!\*(R") on all nodes except the named one. 168(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
169.PP 169.PP
… …
202(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 202(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
203.IP "dns-forw-port = port-number" 4 203.IP "dns-forw-port = port-number" 4
204.IX Item "dns-forw-port = port-number" 204.IX Item "dns-forw-port = port-number"
205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
206which is fine in most cases). 206which is fine in most cases).
207.IP "dns-max-outstanding = integer-number-of-requests" 4
208.IX Item "dns-max-outstanding = integer-number-of-requests"
209The maximum number of outstanding \s-1DNS\s0 transport requests
210(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
211limit without receiving replies. In heavily overloaded situations it might
212help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
213number of parallel requests.
214.Sp
215The default should be working ok for most links.
216.IP "dns-overlap-factor = float" 4
217.IX Item "dns-overlap-factor = float"
218The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
219during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
220must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
221rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
222request might be generated every \fBmin_latency\fR seconds, which means on
223average there should only ever be one outstanding request. A factor of
224\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
225latency measured.
226.Sp
227For congested or picky dns forwarders you could use a value nearer to or
228exceeding \f(CW1\fR.
229.Sp
230The default should be working ok for most links.
231.IP "dns-send-interval = send-interval-in-seconds" 4
232.IX Item "dns-send-interval = send-interval-in-seconds"
233The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
234use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
235the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
236not send more than 100 \s-1DNS\s0 requests per connection per second. For
237high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
238congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
239\&\f(CW0.2\fR or even higher.
240.Sp
241The default should be working ok for most links.
242.IP "dns-timeout-factor = float" 4
243.IX Item "dns-timeout-factor = float"
244Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
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
247eight times the minimum (= expected) latency, assuming the request or
248reply has been lost.
249.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the
251link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values
252near or below \f(CW1\fR makes no sense whatsoever.
253.Sp
254The default should be working ok for most links.
207.IP "if-up = relative-or-absolute-path" 4 255.IP "if-up = relative-or-absolute-path" 4
208.IX Item "if-up = relative-or-absolute-path" 256.IX Item "if-up = relative-or-absolute-path"
209Sets the path of a script that should be called immediately after the 257Sets the path of a script that should be called immediately after the
210network interface is initialized (but not neccessarily up). The following 258network interface is initialized (but not neccessarily up). The following
211environment variables are passed to it (the values are just examples): 259environment variables are passed to it (the values are just examples).
260.Sp
261Variables that have the same value on all nodes:
212.RS 4 262.RS 4
213.IP "CONFBASE=/etc/gvpe" 4 263.IP "CONFBASE=/etc/gvpe" 4
214.IX Item "CONFBASE=/etc/gvpe" 264.IX Item "CONFBASE=/etc/gvpe"
215The configuration base directory. 265The configuration base directory.
216.IP "IFNAME=vpn0" 4 266.IP "IFNAME=vpn0" 4
217.IX Item "IFNAME=vpn0" 267.IX Item "IFNAME=vpn0"
218The interface to initialize. 268The network interface to initialize.
219.IP "MTU=1436" 4
220.IX Item "MTU=1436"
221The \s-1MTU\s0 to set the interface to. You can use lower values (if done
222consistently on all hosts), but this is usually ineffective.
223.IP "MAC=fe:fd:80:00:00:01" 4
224.IX Item "MAC=fe:fd:80:00:00:01"
225The \s-1MAC\s0 address to set the interface to. The script *must* set the
226interface \s-1MAC\s0 to this value. You will most likely use one of these:
227.Sp
228.Vb 2
229\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
230\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
231.Ve
232.Sp
233Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
234.IP "IFTYPE=native # or tincd" 4 269.IP "IFTYPE=native # or tincd" 4
235.IX Item "IFTYPE=native # or tincd" 270.IX Item "IFTYPE=native # or tincd"
236.PD 0 271.PD 0
237.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 272.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
238.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 273.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
239.PD 274.PD
240The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os 275The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the
241name in lowercase) that this gvpe was configured for. Can be used to select 276\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
242the correct syntax to use for network-related commands. 277select the correct syntax to use for network-related commands.
278.IP "MTU=1436" 4
279.IX Item "MTU=1436"
280The \s-1MTU\s0 to set the interface to. You can use lower values (if done
281consistently on all hosts), but this is usually ineffective.
282.IP "NODES=5" 4
283.IX Item "NODES=5"
284The number of nodes in this \s-1GVPE\s0 network.
285.RE
286.RS 4
287.Sp
288Variables that are node-specific and with values pertaining to the node
289running this \s-1GVPE:\s0
290.IP "IFUPDATA=string" 4
291.IX Item "IFUPDATA=string"
292The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR.
293.IP "MAC=fe:fd:80:00:00:01" 4
294.IX Item "MAC=fe:fd:80:00:00:01"
295The \s-1MAC\s0 address the network interface has to use.
296.Sp
297Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
298do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for
299platform-specific information.
243.IP "NODENAME=branch1" 4 300.IP "NODENAME=branch1" 4
244.IX Item "NODENAME=branch1" 301.IX Item "NODENAME=branch1"
245The nickname of the current node, as passed to the gvpe daemon. 302The nickname of the node.
246.IP "NODEID=1" 4 303.IP "NODEID=1" 4
247.IX Item "NODEID=1" 304.IX Item "NODEID=1"
248The numerical node id of the current node. The first node mentioned in the 305The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first
249config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. 306node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
250.RE 307.RE
251.RS 4 308.RS 4
252.Sp 309.Sp
310In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
311available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
312node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
313the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
314.Sp
253Here is a simple if-up script: 315Here is a simple if-up script:
254.Sp 316.Sp
255.Vb 5 317.Vb 5
256\& #!/bin/sh 318\& #!/bin/sh
257\& ip link set $IFNAME address $MAC mtu $MTU up 319\& ip link set $IFNAME up
258\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 320\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
259\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 321\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
260\& ip route add 10.0.0.0/8 dev $IFNAME 322\& ip route add 10.0.0.0/8 dev $IFNAME
261.Ve 323.Ve
262.Sp 324.Sp
… …
350used to select the right configuration section and must be passed as an 412used to select the right configuration section and must be passed as an
351argument to the gvpe daemon. 413argument to the gvpe daemon.
352.IP "node-up = relative-or-absolute-path" 4 414.IP "node-up = relative-or-absolute-path" 4
353.IX Item "node-up = relative-or-absolute-path" 415.IX Item "node-up = relative-or-absolute-path"
354Sets a command (default: no script) that should be called whenever a 416Sets a command (default: no script) that should be called whenever a
355connection is established (even on rekeying operations). In addition 417connection is established (even on rekeying operations). In addition to
356to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 418all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment
357variables will be set: 419variables will be set:
358.RS 4 420.RS 4
359.IP "DESTNODE=branch2" 4 421.IP "DESTNODE=branch2" 4
360.IX Item "DESTNODE=branch2" 422.IX Item "DESTNODE=branch2"
361The name of the remote node. 423The name of the remote node.
… …
455.IP "dns-port = port-number" 4 517.IP "dns-port = port-number" 4
456.IX Item "dns-port = port-number" 518.IX Item "dns-port = port-number"
457The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. 519The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
458.IP "enable-dns = yes|true|on | no|false|off" 4 520.IP "enable-dns = yes|true|on | no|false|off" 4
459.IX Item "enable-dns = yes|true|on | no|false|off" 521.IX Item "enable-dns = yes|true|on | no|false|off"
522See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport
523protocol. Avoid this protocol if you can.
524.Sp
460Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as 525Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
461client (only available when gvpe was compiled with \f(CW\*(C`\-\-enable\-dns\*(C'\fR). 526client. Support for this transport protocol is only available when gvpe
527was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
528.IP "enable-icmp = yes|true|on | no|false|off" 4
529.IX Item "enable-icmp = yes|true|on | no|false|off"
530See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
462.Sp 531.Sp
463This is the worst choice of transport protocol with respect to overhead 532Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
464(overhead cna be 2\-3 times higher than the transferred data), and probably 533node.
465the best choice when tunneling through firewalls.
466.IP "enable-rawip = yes|true|on | no|false|off" 4 534.IP "enable-rawip = yes|true|on | no|false|off" 4
467.IX Item "enable-rawip = yes|true|on | no|false|off" 535.IX Item "enable-rawip = yes|true|on | no|false|off"
536See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
537.Sp
468Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol 538Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
469(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the minimum overhead per 539(default: \f(CW\*(C`no\*(C'\fR).
470packet is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
471.IP "enable-tcp = yes|true|on | no|false|off" 4 540.IP "enable-tcp = yes|true|on | no|false|off" 4
472.IX Item "enable-tcp = yes|true|on | no|false|off" 541.IX Item "enable-tcp = yes|true|on | no|false|off"
542See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol.
543.Sp
473Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port 544Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
474(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only 545(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available
475available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never 546when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
476use this transport unless you really must, it is very inefficient and
477resource-intensive compared to the other transports (except for \s-1DNS\s0, which
478is worse).
479.IP "enable-udp = yes|true|on | no|false|off" 4 547.IP "enable-udp = yes|true|on | no|false|off" 4
480.IX Item "enable-udp = yes|true|on | no|false|off" 548.IX Item "enable-udp = yes|true|on | no|false|off"
549See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
550.Sp
481Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 551Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
482unless no other protocol is enabled for a node, in which case this 552unless no other protocol is enabled for a node, in which case this
483protocol is enabled automatically). This is a good general choice since 553protocol is enabled automatically).
484\&\s-1UDP\s0 tunnels well through many firewalls.
485.Sp 554.Sp
486\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 555\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
487it might get switched on automatically, as some future version might 556it might get switched on automatically, as some future version might
488default to another default protocol. 557default to another default protocol.
558.IP "icmp-type = integer" 4
559.IX Item "icmp-type = integer"
560Sets the type value to be used for outgoing (and incoming) packets sent
561via the \s-1ICMP\s0 transport.
562.Sp
563The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
564\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
565\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
566.IP "if-up-data = value" 4
567.IX Item "if-up-data = value"
568The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
569script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
489.IP "inherit-tos = yes|true|on | no|false|off" 4 570.IP "inherit-tos = yes|true|on | no|false|off" 4
490.IX Item "inherit-tos = yes|true|on | no|false|off" 571.IX Item "inherit-tos = yes|true|on | no|false|off"
491Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 572Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
492sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 573sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
493outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 574outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
… …
545.SH "SEE ALSO" 626.SH "SEE ALSO"
546.IX Header "SEE ALSO" 627.IX Header "SEE ALSO"
547\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 628\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
548.SH "AUTHOR" 629.SH "AUTHOR"
549.IX Header "AUTHOR" 630.IX Header "AUTHOR"
550Marc Lehmann <gvpe@plan9.de> 631Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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