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.24 by pcg, Mon Mar 23 15:21:59 2009 UTC vs.
Revision 1.30 by root, Tue Dec 4 10:29:43 2012 UTC

1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) 1.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
… …
51.\" Escape single quotes in literal strings from groff's Unicode transform. 43.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq 44.ie \n(.g .ds Aq \(aq
53.el .ds Aq ' 45.el .ds Aq '
54.\" 46.\"
55.\" If the F register is turned on, we'll generate index entries on stderr for 47.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the 49.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
59.ie \nF \{\ 51.ie \nF \{\
60. de IX 52. de IX
61. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
… …
130.\} 122.\}
131.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
132.\" ======================================================================== 124.\" ========================================================================
133.\" 125.\"
134.IX Title "GVPE.CONF 5" 126.IX Title "GVPE.CONF 5"
135.TH GVPE.CONF 5 "2009-03-23" "2.22" "GNU Virtual Private Ethernet" 127.TH GVPE.CONF 5 "2012-07-06" "2.24" "GNU Virtual Private Ethernet"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
138.if n .ad l 130.if n .ad l
139.nh 131.nh
140.SH "NAME" 132.SH "NAME"
… …
166= value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and 158= value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and
167extend to the end of the line. They can be used on their own lines, or 159extend to the end of the line. They can be used on their own lines, or
168after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after 160after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after
169values, but not within the variable names or values themselves. 161values, but not within the variable names or values themselves.
170.PP 162.PP
171The only exception to the above is the \*(L"on\*(R" directive that can prefix any 163All settings are applied \*(L"in order\*(R", that is, later settings of the same
172\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 164variable overwrite earlier ones.
173(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
174.PP 165.PP
166The only exceptions to the above are the \*(L"on\*(R" and \*(L"include\*(R" directives:
167.IP "on nodename ..." 4
168.IX Item "on nodename ..."
169.PD 0
170.IP "on !nodename ..." 4
171.IX Item "on !nodename ..."
172.PD
173You can prefix any configuration directive with \f(CW\*(C`on\*(C'\fR and a nodename. \s-1GVPE\s0
174will will only \*(L"execute\*(R" it on the named node, or (if the nodename starts
175with \f(CW\*(C`!\*(C'\fR) on all nodes except the named one.
176.Sp
175For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on 177Example: set the \s-1MTU\s0 to \f(CW1450\fR everywhere, \f(CW\*(C`loglevel\*(C'\fR to \f(CW\*(C`noise\*(C'\fR on
176branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: 178\&\f(CW\*(C`branch1\*(C'\fR, and \f(CW\*(C`connect\*(C'\fR to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2.
177.PP 179.Sp
178.Vb 3 180.Vb 3
179\& mtu = 1450 181\& mtu = 1450
180\& on branch1 loglevel = noise 182\& on branch1 loglevel = noise
181\& on !branch2 connect = ondemand 183\& on !branch2 connect = ondemand
182.Ve 184.Ve
183.PP 185.IP "include relative-or-absolute-path" 4
184All settings are applied \*(L"in order\*(R", that is, later settings of the same 186.IX Item "include relative-or-absolute-path"
185variable overwrite earlier ones. 187Reads the specified file (the path must not contain whitespace or \f(CW\*(C`=\*(C'\fR
188characters) and evaluate all config directives in it as if they were
189spelled out in place of the \f(CW\*(C`include\*(C'\fR directive.
190.Sp
191The path is a printf format string, that is, you must escape any \f(CW\*(C`%\*(C'\fR
192by doubling it, and you can have a single \f(CW%s\fR inside, which will be
193replaced by the current nodename.
194.Sp
195Relative paths are interpreted relative to the \s-1GVPE\s0 config directory.
196.Sp
197Example: include the file \fIlocal.conf\fR in the config directory on every
198node.
199.Sp
200.Vb 1
201\& include local.conf
202.Ve
203.Sp
204Example: include a file \fIconf/\fRnodename\fI.conf\fR
205.Sp
206.Vb 1
207\& include conf/%s.conf
208.Ve
186.SH "ANATOMY OF A CONFIG FILE" 209.SH "ANATOMY OF A CONFIG FILE"
187.IX Header "ANATOMY OF A CONFIG FILE" 210.IX Header "ANATOMY OF A CONFIG FILE"
188Usually, a config file starts with a few global settings (like the \s-1UDP\s0 211Usually, a config file starts with a few global settings (like the \s-1UDP\s0
189port to listen on), followed by node-specific sections that begin with a 212port to listen on), followed by node-specific sections that begin with a
190\&\f(CW\*(C`node = nickname\*(C'\fR line. 213\&\f(CW\*(C`node = nickname\*(C'\fR line.
… …
196.PP 219.PP
197Node-specific settings can be used at any time. If used before the first 220Node-specific settings can be used at any time. If used before the first
198node section they will set the default values for all following nodes. 221node section they will set the default values for all following nodes.
199.SH "CONFIG VARIABLES" 222.SH "CONFIG VARIABLES"
200.IX Header "CONFIG VARIABLES" 223.IX Header "CONFIG VARIABLES"
201.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" 224.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
202.IX Subsection "GLOBAL SETTINGS" 225.IX Subsection "GLOBAL SETTINGS"
203Global settings will affect the behaviour of the running gvpe daemon, that 226Global settings will affect the behaviour of the running gvpe daemon, that
204is, they are in some sense node-specific (config files can set different 227is, they are in some sense node-specific (config files can set different
205values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of 228values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of
206the gvpe daemon and all connections it creates. 229the gvpe daemon and all connections it creates.
… …
210(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 233(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
211.IP "dns-forw-port = port-number" 4 234.IP "dns-forw-port = port-number" 4
212.IX Item "dns-forw-port = port-number" 235.IX Item "dns-forw-port = port-number"
213The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 236The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
214which is fine in most cases). 237which is fine in most cases).
238.IP "dns-case-preserving = yes|true|on | no|false|off" 4
239.IX Item "dns-case-preserving = yes|true|on | no|false|off"
240Sets whether the \s-1DNS\s0 transport forwarding server preserves case (\s-1DNS\s0
241servers have to, but some access systems are even more broken than others)
242(default: true).
243.Sp
244Normally, when the forwarding server changes the case of domain names then
245\&\s-1GVPE\s0 will automatically set this to false.
215.IP "dns-max-outstanding = integer-number-of-requests" 4 246.IP "dns-max-outstanding = integer-number-of-requests" 4
216.IX Item "dns-max-outstanding = integer-number-of-requests" 247.IX Item "dns-max-outstanding = integer-number-of-requests"
217The maximum number of outstanding \s-1DNS\s0 transport requests 248The maximum number of outstanding \s-1DNS\s0 transport requests
218(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given 249(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
219limit without receiving replies. In heavily overloaded situations it might 250limit without receiving replies. In heavily overloaded situations it might
… …
356other programs. 387other programs.
357.Sp 388.Sp
358The default is 47 (\s-1GRE\s0), which has a good chance of tunneling 389The default is 47 (\s-1GRE\s0), which has a good chance of tunneling
359through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0 390through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0
360compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 391compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4
361(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241) 392(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241).
393.Sp
394Many versions of Linux seem to have a bug that causes them to reorder
395packets for some ip protocols (\s-1GRE\s0, \s-1ESP\s0) but not for others (\s-1AH\s0), so
396choose wisely (that is, use 51, \s-1AH\s0).
362.IP "http-proxy-host = hostname/ip" 4 397.IP "http-proxy-host = hostname/ip" 4
363.IX Item "http-proxy-host = hostname/ip" 398.IX Item "http-proxy-host = hostname/ip"
364The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was 399The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was
365compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of 400compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
366tcp connections through a http proxy server. 401tcp connections through a http proxy server.
… …
397currently supported. 432currently supported.
398.IP "keepalive = seconds" 4 433.IP "keepalive = seconds" 4
399.IX Item "keepalive = seconds" 434.IX Item "keepalive = seconds"
400Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this 435Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
401many seconds of inactivity the daemon will start to send keepalive probe 436many seconds of inactivity the daemon will start to send keepalive probe
402every 3 seconds until it receives a reply from the other end. If no reply 437every 3 seconds until it receives a reply from the other end. If no reply
403is received within 15 seconds, the peer is considered unreachable and the 438is received within 15 seconds, the peer is considered unreachable and the
404connection is closed. 439connection is closed.
405.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 440.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
406.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 441.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
407Set the logging level. Connection established messages are logged at level 442Set the logging level. Connection established messages are logged at level
… …
427is established (even on rekeying operations). Note that node\-up/down 462is established (even on rekeying operations). Note that node\-up/down
428scripts will be run asynchronously, but execution is serialised, so there 463scripts will be run asynchronously, but execution is serialised, so there
429will only ever be one such script running. 464will only ever be one such script running.
430.Sp 465.Sp
431In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following 466In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
432environment variables will be set: 467environment variables will be set (values are just examples):
433.RS 4 468.RS 4
434.IP "DESTNODE=branch2" 4 469.IP "DESTNODE=branch2" 4
435.IX Item "DESTNODE=branch2" 470.IX Item "DESTNODE=branch2"
436The name of the remote node. 471The name of the remote node.
437.IP "DESTID=2" 4 472.IP "DESTID=2" 4
438.IX Item "DESTID=2" 473.IX Item "DESTID=2"
439The node id of the remote node. 474The node id of the remote node.
475.IP "DESTSI=rawip/88.99.77.55:0" 4
476.IX Item "DESTSI=rawip/88.99.77.55:0"
477The \*(L"socket info\*(R" of the target node, protocol dependent but usually in
478the format protocol/ip:port.
440.IP "DESTIP=188.13.66.8" 4 479.IP "DESTIP=188.13.66.8" 4
441.IX Item "DESTIP=188.13.66.8" 480.IX Item "DESTIP=188.13.66.8"
442The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from 481The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
443everywhere, as long as the other node can authenticate itself). 482everywhere, as long as the other node can authenticate itself).
444.IP "DESTPORT=655 # deprecated" 4 483.IP "DESTPORT=655 # deprecated" 4
445.IX Item "DESTPORT=655 # deprecated" 484.IX Item "DESTPORT=655 # deprecated"
446The \s-1UDP\s0 port used by the other side. 485The protocol port used by the other side, if applicable.
447.IP "STATE=UP" 4 486.IP "STATE=up" 4
448.IX Item "STATE=UP" 487.IX Item "STATE=up"
449Node-up scripts get called with STATE=UP, node-down scripts get called 488Node-up scripts get called with STATE=up, node-change scripts get called
450with STATE=DOWN. 489with STATE=change and node-down scripts get called with STATE=down.
451.RE 490.RE
452.RS 4 491.RS 4
453.Sp 492.Sp
454Here is a nontrivial example that uses nsupdate to update the name => ip 493Here is a nontrivial example that uses nsupdate to update the name => ip
455mapping in some \s-1DNS\s0 zone: 494mapping in some \s-1DNS\s0 zone:
… …
461\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 500\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
462\& echo 501\& echo
463\& } | nsupdate \-d \-k $CONFBASE:key.example.net. 502\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
464.Ve 503.Ve
465.RE 504.RE
505.IP "node-change = relative-or-absolute-path" 4
506.IX Item "node-change = relative-or-absolute-path"
507Same as \f(CW\*(C`node\-change\*(C'\fR, but gets called whenever something about a
508connection changes (such as the source \s-1IP\s0 address).
466.IP "node-down = relative-or-absolute-path" 4 509.IP "node-down = relative-or-absolute-path" 4
467.IX Item "node-down = relative-or-absolute-path" 510.IX Item "node-down = relative-or-absolute-path"
468Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 511Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
469.IP "pid-file = path" 4 512.IP "pid-file = path" 4
470.IX Item "pid-file = path" 513.IX Item "pid-file = path"
… …
499via gvpe and gvpe traffic via the normal system routing tables: 542via gvpe and gvpe traffic via the normal system routing tables:
500.Sp 543.Sp
501.Vb 1 544.Vb 1
502\& ip rule add not fwmark 1000 lookup 99 545\& ip rule add not fwmark 1000 lookup 99
503.Ve 546.Ve
504.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 547.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
505.IX Subsection "NODE SPECIFIC SETTINGS" 548.IX Subsection "NODE SPECIFIC SETTINGS"
506The following settings are node-specific, that is, every node can have 549The following settings are node-specific, that is, every node can have
507different settings, even within the same gvpe instance. Settings that are 550different settings, even within the same gvpe instance. Settings that are
508set before the first node section set the defaults, settings that are 551set before the first node section set the defaults, settings that are
509set within a node section only apply to the given node. 552set within a node section only apply to the given node.
510.IP "allow-direct = nodename" 4 553.IP "allow-direct = nodename" 4
511.IX Item "allow-direct = nodename" 554.IX Item "allow-direct = nodename"
512Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. 555Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
513.IP "compress = yes|true|on | no|false|off" 4 556.IP "compress = yes|true|on | no|false|off" 4
514.IX Item "compress = yes|true|on | no|false|off" 557.IX Item "compress = yes|true|on | no|false|off"
558For the current node, this specified whether it will accept compressed
559packets, and for all other nodes, this specifies whether to try to
515Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). 560compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). Compression is
516Compression is really cheap even on slow computers and has no size 561really cheap even on slow computers, has no size overhead at all and will
517overhead at all, so enabling this is often a good idea. 562only be used when the other side supports compression, so enabling this is
563often a good idea.
518.IP "connect = ondemand | never | always | disabled" 4 564.IP "connect = ondemand | never | always | disabled" 4
519.IX Item "connect = ondemand | never | always | disabled" 565.IX Item "connect = ondemand | never | always | disabled"
520Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 566Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
521try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR 567try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR
522(never initiate a connection to the given host, but accept connections), 568(never initiate a connection to the given host, but accept connections),
… …
607when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. 653when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
608.IP "enable-udp = yes|true|on | no|false|off" 4 654.IP "enable-udp = yes|true|on | no|false|off" 4
609.IX Item "enable-udp = yes|true|on | no|false|off" 655.IX Item "enable-udp = yes|true|on | no|false|off"
610See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. 656See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
611.Sp 657.Sp
612Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 658Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR).
613unless no other protocol is enabled for a node, in which case this
614protocol is enabled automatically).
615.Sp
616\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though
617it might get switched on automatically, as some future version might
618default to another default protocol.
619.IP "hostname = hostname | ip [can not be defaulted]" 4 659.IP "hostname = hostname | ip [can not be defaulted]" 4
620.IX Item "hostname = hostname | ip [can not be defaulted]" 660.IX Item "hostname = hostname | ip [can not be defaulted]"
621Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 661Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
622address. It will be resolved before each connect request, so dyndns should 662address. It will be resolved before each connect request, so dyndns should
623work fine. If this setting is not specified and a router is available, 663work fine. If this setting is not specified and a router is available,
… …
638.IX Item "if-up-data = value" 678.IX Item "if-up-data = value"
639The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR 679The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
640script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. 680script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
641.IP "inherit-tos = yes|true|on | no|false|off" 4 681.IP "inherit-tos = yes|true|on | no|false|off" 4
642.IX Item "inherit-tos = yes|true|on | no|false|off" 682.IX Item "inherit-tos = yes|true|on | no|false|off"
643Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 683Whether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
644sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 684sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
645outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 685outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
646to the tunnel device, which is usually what you want. 686to the tunnel device, which is usually what you want.
647.IP "max-retry = positive-number" 4 687.IP "max-retry = positive-number" 4
648.IX Item "max-retry = positive-number" 688.IX Item "max-retry = positive-number"

Diff Legend

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