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.28 by root, Sun Mar 6 13:49:49 2011 UTC vs.
Revision 1.30 by root, Tue Dec 4 10:29:43 2012 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 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
… …
46. ds PI \(*p 38. ds PI \(*p
47. ds L" `` 39. ds L" ``
48. ds R" '' 40. ds R" ''
49'br\} 41'br\}
50.\" 42.\"
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
51.\" 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
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53.\" 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
54.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
55.if \nF \{\ 51.ie \nF \{\
56. de IX 52. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
58.. 54..
59. nr % 0 55. nr % 0
60. rr F 56. rr F
61.\} 57.\}
62.\" 58.el \{\
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 59. de IX
64.\" way too many mistakes in technical documents. 60..
65.hy 0 61.\}
66.if n .na
67.\" 62.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 64.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 65. \" fudge factors for nroff and troff
71.if n \{\ 66.if n \{\
… …
127.\} 122.\}
128.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
129.\" ======================================================================== 124.\" ========================================================================
130.\" 125.\"
131.IX Title "GVPE.CONF 5" 126.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2011-02-15" "2.24" "GNU Virtual Private Ethernet" 127.TH GVPE.CONF 5 "2012-07-06" "2.24" "GNU Virtual Private Ethernet"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
133.SH "NAME" 132.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 133gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 134.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 135.IX Header "SYNOPSIS"
137.Vb 4 136.Vb 4
138\& # global options for all nodes 137\& # global options for all nodes
139\& udp\-port = 407 138\& udp\-port = 407
140\& mtu = 1492 139\& mtu = 1492
141\& ifname = vpn0 140\& ifname = vpn0
142.Ve 141\&
143.PP
144.Vb 3
145\& # first node is named branch1 and is at 1.2.3.4 142\& # first node is named branch1 and is at 1.2.3.4
146\& node = branch1 143\& node = branch1
147\& hostname = 1.2.3.4 144\& hostname = 1.2.3.4
148.Ve 145\&
149.PP
150.Vb 4
151\& # second node uses dns to resolve the address 146\& # second node uses dns to resolve the address
152\& node = branch2 147\& node = branch2
153\& hostname = www.example.net 148\& hostname = www.example.net
154\& udp\-port = 500 # this host uses a different udp\-port 149\& udp\-port = 500 # this host uses a different udp\-port
155.Ve 150\&
156.PP
157.Vb 3
158\& # third node has no fixed ip address 151\& # third node has no fixed ip address
159\& node = branch3 152\& node = branch3
160\& connect = ondemand 153\& connect = ondemand
161.Ve 154.Ve
162.SH "DESCRIPTION" 155.SH "DESCRIPTION"
… …
165= 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
166extend 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
167after 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
168values, but not within the variable names or values themselves. 161values, but not within the variable names or values themselves.
169.PP 162.PP
170The 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
171\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 164variable overwrite earlier ones.
172(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
173.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
174For 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
175branch1, 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.
176.PP 179.Sp
177.Vb 3 180.Vb 3
178\& mtu = 1450 181\& mtu = 1450
179\& on branch1 loglevel = noise 182\& on branch1 loglevel = noise
180\& on !branch2 connect = ondemand 183\& on !branch2 connect = ondemand
181.Ve 184.Ve
182.PP 185.IP "include relative-or-absolute-path" 4
183All settings are applied \*(L"in order\*(R", that is, later settings of the same 186.IX Item "include relative-or-absolute-path"
184variable 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
185.SH "ANATOMY OF A CONFIG FILE" 209.SH "ANATOMY OF A CONFIG FILE"
186.IX Header "ANATOMY OF A CONFIG FILE" 210.IX Header "ANATOMY OF A CONFIG FILE"
187Usually, 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
188port 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
189\&\f(CW\*(C`node = nickname\*(C'\fR line. 213\&\f(CW\*(C`node = nickname\*(C'\fR line.
… …
195.PP 219.PP
196Node-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
197node section they will set the default values for all following nodes. 221node section they will set the default values for all following nodes.
198.SH "CONFIG VARIABLES" 222.SH "CONFIG VARIABLES"
199.IX Header "CONFIG VARIABLES" 223.IX Header "CONFIG VARIABLES"
200.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" 224.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
201.IX Subsection "GLOBAL SETTINGS" 225.IX Subsection "GLOBAL SETTINGS"
202Global settings will affect the behaviour of the running gvpe daemon, that 226Global settings will affect the behaviour of the running gvpe daemon, that
203is, 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
204values 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
205the gvpe daemon and all connections it creates. 229the gvpe daemon and all connections it creates.
… …
209(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).
210.IP "dns-forw-port = port-number" 4 234.IP "dns-forw-port = port-number" 4
211.IX Item "dns-forw-port = port-number" 235.IX Item "dns-forw-port = port-number"
212The 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,
213which 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.
214.IP "dns-max-outstanding = integer-number-of-requests" 4 246.IP "dns-max-outstanding = integer-number-of-requests" 4
215.IX Item "dns-max-outstanding = integer-number-of-requests" 247.IX Item "dns-max-outstanding = integer-number-of-requests"
216The maximum number of outstanding \s-1DNS\s0 transport requests 248The maximum number of outstanding \s-1DNS\s0 transport requests
217(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
218limit without receiving replies. In heavily overloaded situations it might 250limit without receiving replies. In heavily overloaded situations it might
… …
400currently supported. 432currently supported.
401.IP "keepalive = seconds" 4 433.IP "keepalive = seconds" 4
402.IX Item "keepalive = seconds" 434.IX Item "keepalive = seconds"
403Sets 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
404many seconds of inactivity the daemon will start to send keepalive probe 436many seconds of inactivity the daemon will start to send keepalive probe
405every 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
406is received within 15 seconds, the peer is considered unreachable and the 438is received within 15 seconds, the peer is considered unreachable and the
407connection is closed. 439connection is closed.
408.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 440.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
409.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 441.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
410Set the logging level. Connection established messages are logged at level 442Set the logging level. Connection established messages are logged at level
… …
510via gvpe and gvpe traffic via the normal system routing tables: 542via gvpe and gvpe traffic via the normal system routing tables:
511.Sp 543.Sp
512.Vb 1 544.Vb 1
513\& ip rule add not fwmark 1000 lookup 99 545\& ip rule add not fwmark 1000 lookup 99
514.Ve 546.Ve
515.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 547.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
516.IX Subsection "NODE SPECIFIC SETTINGS" 548.IX Subsection "NODE SPECIFIC SETTINGS"
517The following settings are node\-specific, that is, every node can have 549The following settings are node-specific, that is, every node can have
518different settings, even within the same gvpe instance. Settings that are 550different settings, even within the same gvpe instance. Settings that are
519set before the first node section set the defaults, settings that are 551set before the first node section set the defaults, settings that are
520set within a node section only apply to the given node. 552set within a node section only apply to the given node.
521.IP "allow-direct = nodename" 4 553.IP "allow-direct = nodename" 4
522.IX Item "allow-direct = nodename" 554.IX Item "allow-direct = nodename"
… …
638.IX Item "icmp-type = integer" 670.IX Item "icmp-type = integer"
639Sets the type value to be used for outgoing (and incoming) packets sent 671Sets the type value to be used for outgoing (and incoming) packets sent
640via the \s-1ICMP\s0 transport. 672via the \s-1ICMP\s0 transport.
641.Sp 673.Sp
642The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as 674The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
643\&\*(L"ping\-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. 675\&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
644\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. 676\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
645.IP "if-up-data = value" 4 677.IP "if-up-data = value" 4
646.IX Item "if-up-data = value" 678.IX Item "if-up-data = value"
647The 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
648script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. 680script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
… …
713.IX Item "gvpe.conf" 745.IX Item "gvpe.conf"
714The config file. 746The config file.
715.IP "if-up" 4 747.IP "if-up" 4
716.IX Item "if-up" 748.IX Item "if-up"
717The if-up script 749The if-up script
718.IP "node\-up, node-down" 4 750.IP "node-up, node-down" 4
719.IX Item "node-up, node-down" 751.IX Item "node-up, node-down"
720If used the node up or node-down scripts. 752If used the node up or node-down scripts.
721.IP "hostkey" 4 753.IP "hostkey" 4
722.IX Item "hostkey" 754.IX Item "hostkey"
723The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 755The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.

Diff Legend

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