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.11 by pcg, Thu Mar 17 23:59:37 2005 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.14 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
… …
23.ft R 15.ft R
24.fi 16.fi
25.. 17..
26.\" Set up some character translations and predefined strings. \*(-- will 18.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a 20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" expand to `' in nroff, nothing in troff, for use with C<>. 23.\" nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr 24.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\ 26.ie n \{\
35. ds -- \(*W- 27. ds -- \(*W-
36. ds PI pi 28. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
… …
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 "2005-03-17" "1.8" "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 3 136.Vb 4
137\& # global options for all nodes
138\& udp-port = 407 138\& udp\-port = 407
139\& mtu = 1492 139\& mtu = 1492
140\& ifname = vpn0 140\& ifname = vpn0
141.Ve 141\&
142.PP 142\& # first node is named branch1 and is at 1.2.3.4
143.Vb 2
144\& node = branch1 143\& node = branch1
145\& hostname = 1.2.3.4 144\& hostname = 1.2.3.4
146.Ve 145\&
147.PP 146\& # second node uses dns to resolve the address
148.Vb 3
149\& node = branch2 147\& node = branch2
150\& hostname = www.example.net 148\& hostname = www.example.net
151\& udp-port = 500 # this host uses a different udp-port 149\& udp\-port = 500 # this host uses a different udp\-port
152.Ve 150\&
153.PP 151\& # third node has no fixed ip address
154.Vb 2
155\& node = branch3 152\& node = branch3
156\& connect = ondemand 153\& connect = ondemand
157.Ve 154.Ve
158.SH "DESCRIPTION" 155.SH "DESCRIPTION"
159.IX Header "DESCRIPTION" 156.IX Header "DESCRIPTION"
160The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable 157The 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 158= 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 159extend 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 160after 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. 161values, but not within the variable names or values themselves.
165.PP 162.PP
166The 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
167\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 164variable overwrite earlier ones.
168(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
169.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
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
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.
179.Sp
170.Vb 3 180.Vb 3
171\& name = value 181\& mtu = 1450
172\& on branch1 loglevel = noise 182\& on branch1 loglevel = noise
173\& on !branch2 connect = ondemand 183\& on !branch2 connect = ondemand
174.Ve 184.Ve
175.PP 185.IP "include relative-or-absolute-path" 4
176All settings are executed \*(L"in order\*(R", that is, later settings of the same 186.IX Item "include relative-or-absolute-path"
177variable 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
178.SH "ANATOMY OF A CONFIG FILE" 209.SH "ANATOMY OF A CONFIG FILE"
179.IX Header "ANATOMY OF A CONFIG FILE" 210.IX Header "ANATOMY OF A CONFIG FILE"
180Usually, a config file starts with global settings (like the udp port to 211Usually, a config file starts with a few global settings (like the \s-1UDP\s0
181listen on), followed by node-specific sections that begin with a \f(CW\*(C`node = 212port to listen on), followed by node-specific sections that begin with a
182nickname\*(C'\fR line. 213\&\f(CW\*(C`node = nickname\*(C'\fR line.
183.PP 214.PP
184Every node that is part of the network must have a section that starts 215Every node that is part of the network must have a section that starts
185with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important 216with \f(CW\*(C`node = nickname\*(C'\fR. The number and order of the nodes is important
186and must be the same on all hosts. It is not uncommon for node sections to 217and must be the same on all nodes. It is not uncommon for node sections to
187be completely empty \- if the default values are right. 218be completely empty \- if the default values are right.
188.PP 219.PP
189Node-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
190node section they will set the default values for all following nodes. 221node section they will set the default values for all following nodes.
191.SH "CONFIG VARIABLES" 222.SH "CONFIG VARIABLES"
192.IX Header "CONFIG VARIABLES" 223.IX Header "CONFIG VARIABLES"
193.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" 224.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
194.IX Subsection "GLOBAL SETTINGS" 225.IX Subsection "GLOBAL SETTINGS"
195Global settings will affect the behaviour of the running gvpe daemon, that 226Global settings will affect the behaviour of the running gvpe daemon, that
196is, 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
197values 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
198the gvpe daemon and all connections it creates. 229the gvpe daemon and all connections it creates.
199.IP "dns-forw-host = hostname/ip" 4 230.IP "dns-forw-host = hostname/ip" 4
200.IX Item "dns-forw-host = hostname/ip" 231.IX Item "dns-forw-host = hostname/ip"
201The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol 232The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol
202(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).
203.IP "dns-forw-port = port-number" 4 234.IP "dns-forw-port = port-number" 4
204.IX Item "dns-forw-port = port-number" 235.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, 236The 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). 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.
246.IP "dns-max-outstanding = integer-number-of-requests" 4
247.IX Item "dns-max-outstanding = integer-number-of-requests"
248The maximum number of outstanding \s-1DNS\s0 transport requests
249(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
250limit without receiving replies. In heavily overloaded situations it might
251help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
252number of parallel requests.
253.Sp
254The default should be working \s-1OK\s0 for most links.
255.IP "dns-overlap-factor = float" 4
256.IX Item "dns-overlap-factor = float"
257The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
258during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
259must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
260rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
261request might be generated every \fBmin_latency\fR seconds, which means on
262average there should only ever be one outstanding request. A factor of
263\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
264latency measured.
265.Sp
266For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or
267exceeding \f(CW1\fR.
268.Sp
269The default should be working \s-1OK\s0 for most links.
270.IP "dns-send-interval = send-interval-in-seconds" 4
271.IX Item "dns-send-interval = send-interval-in-seconds"
272The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
273use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
274the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
275not send more than 100 \s-1DNS\s0 requests per connection per second. For
276high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
277congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
278\&\f(CW0.2\fR or even higher.
279.Sp
280The default should be working \s-1OK\s0 for most links.
281.IP "dns-timeout-factor = float" 4
282.IX Item "dns-timeout-factor = float"
283Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
284get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
285will resend the request when no reply has been received for longer than
286eight times the minimum (= expected) latency, assuming the request or
287reply has been lost.
288.Sp
289For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
290the link is very stable lower values (e.g. \f(CW2\fR) might work
291nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
292.Sp
293The default should be working \s-1OK\s0 for most links but will result in low
294throughput if packet loss is high.
207.IP "if-up = relative-or-absolute-path" 4 295.IP "if-up = relative-or-absolute-path" 4
208.IX Item "if-up = relative-or-absolute-path" 296.IX Item "if-up = relative-or-absolute-path"
209Sets the path of a script that should be called immediately after the 297Sets the path of a script that should be called immediately after the
210network interface is initialized (but not neccessarily up). The following 298network interface is initialized (but not necessarily up). The following
211environment variables are passed to it (the values are just examples): 299environment variables are passed to it (the values are just examples).
300.Sp
301Variables that have the same value on all nodes:
212.RS 4 302.RS 4
213.IP "CONFBASE=/etc/gvpe" 4 303.IP "CONFBASE=/etc/gvpe" 4
214.IX Item "CONFBASE=/etc/gvpe" 304.IX Item "CONFBASE=/etc/gvpe"
215The configuration base directory. 305The configuration base directory.
216.IP "IFNAME=vpn0" 4 306.IP "IFNAME=vpn0" 4
217.IX Item "IFNAME=vpn0" 307.IX Item "IFNAME=vpn0"
218The interface to initialize. 308The 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 309.IP "IFTYPE=native # or tincd" 4
235.IX Item "IFTYPE=native # or tincd" 310.IX Item "IFTYPE=native # or tincd"
236.PD 0 311.PD 0
237.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 312.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
238.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 313.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
239.PD 314.PD
240The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os 315The 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 316\&\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. 317select the correct syntax to use for network-related commands.
318.IP "MTU=1436" 4
319.IX Item "MTU=1436"
320The \s-1MTU\s0 to set the interface to. You can use lower values (if done
321consistently on all nodes), but this is usually either inefficient or
322simply ineffective.
323.IP "NODES=5" 4
324.IX Item "NODES=5"
325The number of nodes in this \s-1GVPE\s0 network.
326.RE
327.RS 4
328.Sp
329Variables that are node-specific and with values pertaining to the node
330running this \s-1GVPE:\s0
331.IP "IFUPDATA=string" 4
332.IX Item "IFUPDATA=string"
333The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR.
334.IP "MAC=fe:fd:80:00:00:01" 4
335.IX Item "MAC=fe:fd:80:00:00:01"
336The \s-1MAC\s0 address the network interface has to use.
337.Sp
338Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
339do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for
340platform-specific information.
243.IP "NODENAME=branch1" 4 341.IP "NODENAME=branch1" 4
244.IX Item "NODENAME=branch1" 342.IX Item "NODENAME=branch1"
245The nickname of the current node, as passed to the gvpe daemon. 343The nickname of the node.
246.IP "NODEID=1" 4 344.IP "NODEID=1" 4
247.IX Item "NODEID=1" 345.IX Item "NODEID=1"
248The numerical node id of the current node. The first node mentioned in the 346The 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. 347node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
250.RE 348.RE
251.RS 4 349.RS 4
252.Sp 350.Sp
351In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
352available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
353node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
354the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
355.Sp
253Here is a simple if-up script: 356Here is a simple if-up script:
254.Sp 357.Sp
255.Vb 5 358.Vb 5
256\& #!/bin/sh 359\& #!/bin/sh
257\& ip link set $IFNAME address $MAC mtu $MTU up 360\& ip link set $IFNAME up
258\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 361\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
259\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 362\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
260\& ip route add 10.0.0.0/8 dev $IFNAME 363\& ip route add 10.0.0.0/8 dev $IFNAME
261.Ve 364.Ve
262.Sp 365.Sp
263More complicated examples (using routing to reduce arp traffic) can be 366More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be
264found in the etc/ subdirectory of the distribution. 367found in the \fIetc/\fR subdirectory of the distribution.
265.RE 368.RE
266.IP "ifname = devname" 4 369.IP "ifname = devname" 4
267.IX Item "ifname = devname" 370.IX Item "ifname = devname"
268Sets the tun interface name to the given name. The default is OS-specific 371Sets the tun interface name to the given name. The default is OS-specific
269and most probably something like \f(CW\*(C`tun0\*(C'\fR. 372and most probably something like \f(CW\*(C`tun0\*(C'\fR.
… …
276the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the 379the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
277device. 380device.
278.IP "ip-proto = numerical-ip-protocol" 4 381.IP "ip-proto = numerical-ip-protocol" 4
279.IX Item "ip-proto = numerical-ip-protocol" 382.IX Item "ip-proto = numerical-ip-protocol"
280Sets the protocol number to be used for the rawip protocol. This is a 383Sets the protocol number to be used for the rawip protocol. This is a
281global option because all hosts must use the same protocol, and since 384global option because all nodes must use the same protocol, and since
282there are no port numbers, you cannot easily run more than one gvpe 385there are no port numbers, you cannot easily run more than one gvpe
283instance using the same protocol, nor can you share the protocol with 386instance using the same protocol, nor can you share the protocol with
284other programs. 387other programs.
285.Sp 388.Sp
286The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 389The default is 47 (\s-1GRE\s0), which has a good chance of tunneling
287firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other 390through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0
288common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 391compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4
289(\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).
290.IP "http-proxy-host = hostname/ip" 4 397.IP "http-proxy-host = hostname/ip" 4
291.IX Item "http-proxy-host = hostname/ip" 398.IX Item "http-proxy-host = hostname/ip"
292The \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
293compiled 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
294tcp connections through a http proxy server. 401tcp connections through a http proxy server.
… …
296\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and 403\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
297port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy 404port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
298requires authentication. 405requires authentication.
299.Sp 406.Sp
300Please note that gvpe will still try to resolve all hostnames in the 407Please note that gvpe will still try to resolve all hostnames in the
301configuration file, so if you are behind a proxy without access to a dns 408configuration file, so if you are behind a proxy without access to a \s-1DNS\s0
302server better use numerical \s-1IP\s0 addresses. 409server better use numerical \s-1IP\s0 addresses.
303.Sp 410.Sp
304To make best use of this option disable all protocols except tcp in your 411To make best use of this option disable all protocols except \s-1TCP\s0 in your
305config file and make sure your routers (or all other hosts) are listening 412config file and make sure your routers (or all other nodes) are listening
306on a port that the proxy allows (443, https, is a common choice). 413on a port that the proxy allows (443, https, is a common choice).
307.Sp 414.Sp
308If you have a router, connecting to it will suffice. Otherwise tcp must be 415If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be
309enabled on all hosts. 416enabled on all nodes.
310.Sp 417.Sp
311Example: 418Example:
312.Sp 419.Sp
313.Vb 3 420.Vb 3
314\& http-proxy-host = proxy.example.com 421\& http\-proxy\-host = proxy.example.com
315\& http-proxy-port = 3128 # 8080 is another common choice 422\& http\-proxy\-port = 3128 # 8080 is another common choice
316\& http-proxy-auth = schmorp:grumbeere 423\& http\-proxy\-auth = schmorp:grumbeere
317.Ve 424.Ve
318.IP "http-proxy-port = proxy-tcp-port" 4 425.IP "http-proxy-port = proxy-tcp-port" 4
319.IX Item "http-proxy-port = proxy-tcp-port" 426.IX Item "http-proxy-port = proxy-tcp-port"
320The port where your proxy server listens. 427The port where your proxy server listens.
321.IP "http-proxy-auth = login:password" 4 428.IP "http-proxy-auth = login:password" 4
322.IX Item "http-proxy-auth = login:password" 429.IX Item "http-proxy-auth = login:password"
323The optional login and password used to authenticate to the proxy server, 430The optional login and password used to authenticate to the proxy server,
324seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is 431separated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
325currently supported. 432currently supported.
326.IP "keepalive = seconds" 4 433.IP "keepalive = seconds" 4
327.IX Item "keepalive = seconds" 434.IX Item "keepalive = seconds"
328Sets 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
329many seconds of inactivity the daemon will start to send keepalive probe 436many seconds of inactivity the daemon will start to send keepalive probe
330every 5 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
331is received within 30 seconds, the peer is considered unreachable and the 438is received within 15 seconds, the peer is considered unreachable and the
332connection is closed. 439connection is closed.
333.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 440.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
334.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 441.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
335Set the logging level. Connection established messages are logged at level 442Set the logging level. Connection established messages are logged at level
336\&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR. 443\&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR.
337.IP "mtu = bytes" 4 444.IP "mtu = bytes" 4
338.IX Item "mtu = bytes" 445.IX Item "mtu = bytes"
339Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically 446Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
340the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate 447the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
341maximum overhead (e.g. udp header size, encryption blocksize...) and pass 448maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass
342this information to the \f(CW\*(C`if\-up\*(C'\fR script. 449this information to the \f(CW\*(C`if\-up\*(C'\fR script.
343.Sp 450.Sp
344Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 451Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
345.Sp 452.Sp
346This value must be the minimum of the mtu values of all hosts. 453This value must be the minimum of the \s-1MTU\s0 values of all nodes.
347.IP "node = nickname" 4 454.IP "node = nickname" 4
348.IX Item "node = nickname" 455.IX Item "node = nickname"
349Not really a config setting but introduces a node section. The nickname is 456Not really a config setting but introduces a node section. The nickname is
350used to select the right configuration section and must be passed as an 457used to select the right configuration section and must be passed as an
351argument to the gvpe daemon. 458argument to the gvpe daemon.
352.IP "node-up = relative-or-absolute-path" 4 459.IP "node-up = relative-or-absolute-path" 4
353.IX Item "node-up = relative-or-absolute-path" 460.IX Item "node-up = relative-or-absolute-path"
354Sets a command (default: no script) that should be called whenever a 461Sets a command (default: none) that should be called whenever a connection
355connection is established (even on rekeying operations). In addition 462is established (even on rekeying operations). Note that node\-up/down
463scripts will be run asynchronously, but execution is serialised, so there
464will only ever be one such script running.
465.Sp
356to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 466In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
357variables will be set: 467environment variables will be set (values are just examples):
358.RS 4 468.RS 4
359.IP "DESTNODE=branch2" 4 469.IP "DESTNODE=branch2" 4
360.IX Item "DESTNODE=branch2" 470.IX Item "DESTNODE=branch2"
361The name of the remote node. 471The name of the remote node.
362.IP "DESTID=2" 4 472.IP "DESTID=2" 4
363.IX Item "DESTID=2" 473.IX Item "DESTID=2"
364The 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.
365.IP "DESTIP=188.13.66.8" 4 479.IP "DESTIP=188.13.66.8" 4
366.IX Item "DESTIP=188.13.66.8" 480.IX Item "DESTIP=188.13.66.8"
367The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from 481The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
368everywhere, as long as the other host can authenticate itself). 482everywhere, as long as the other node can authenticate itself).
369.IP "DESTPORT=655 # deprecated" 4 483.IP "DESTPORT=655 # deprecated" 4
370.IX Item "DESTPORT=655 # deprecated" 484.IX Item "DESTPORT=655 # deprecated"
371The \s-1UDP\s0 port used by the other side. 485The protocol port used by the other side, if applicable.
372.IP "STATE=UP" 4 486.IP "STATE=up" 4
373.IX Item "STATE=UP" 487.IX Item "STATE=up"
374Node-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
375with STATE=DOWN. 489with STATE=change and node-down scripts get called with STATE=down.
376.RE 490.RE
377.RS 4 491.RS 4
378.Sp 492.Sp
379Here 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
380mapping in some dns zone: 494mapping in some \s-1DNS\s0 zone:
381.Sp 495.Sp
382.Vb 6 496.Vb 6
383\& #!/bin/sh 497\& #!/bin/sh
384\& { 498\& {
385\& echo update delete $DESTNODE.lowttl.example.net. a 499\& echo update delete $DESTNODE.lowttl.example.net. a
386\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 500\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
387\& echo 501\& echo
388\& } | nsupdate -d -k $CONFBASE:key.example.net. 502\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
389.Ve 503.Ve
390.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).
391.IP "node-down = relative-or-absolute-path" 4 509.IP "node-down = relative-or-absolute-path" 4
392.IX Item "node-down = relative-or-absolute-path" 510.IX Item "node-down = relative-or-absolute-path"
393Same 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.
394.IP "pid-file = path" 4 512.IP "pid-file = path" 4
395.IX Item "pid-file = path" 513.IX Item "pid-file = path"
… …
402be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 520be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
403use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where 521use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
404\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. 522\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
405.Sp 523.Sp
406Since only the private key file of the current node is used and the 524Since only the private key file of the current node is used and the
407private key file should be kept secret per-host to avoid spoofings, it is 525private key file should be kept secret per-node to avoid spoofing, it is
408not recommended to use this feature. 526not recommended to use this feature.
409.IP "rekey = seconds" 4 527.IP "rekey = seconds" 4
410.IX Item "rekey = seconds" 528.IX Item "rekey = seconds"
411Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 529Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
412reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 530reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
531key.
532.IP "nfmark = integer" 4
533.IX Item "nfmark = integer"
534This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries
535to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
536send packets.
537.Sp
538This can be used to make gvpe use a different set of routing rules. For
539example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then
540put all routing rules into table \f(CW99\fR and then use an ip rule to make
541gvpe traffic avoid that routing table, in effect routing normal traffic
542via gvpe and gvpe traffic via the normal system routing tables:
543.Sp
544.Vb 1
545\& ip rule add not fwmark 1000 lookup 99
546.Ve
413.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 547.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
414.IX Subsection "NODE SPECIFIC SETTINGS" 548.IX Subsection "NODE SPECIFIC SETTINGS"
415The following settings are node\-specific, that is, every node can have 549The following settings are node-specific, that is, every node can have
416different settings, even within the same gvpe instance. Settings that are 550different settings, even within the same gvpe instance. Settings that are
417executed before the first node section set the defaults, settings that are 551set before the first node section set the defaults, settings that are
418executed within a node section only apply to the given node. 552set within a node section only apply to the given node.
553.IP "allow-direct = nodename" 4
554.IX Item "allow-direct = nodename"
555Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
419.IP "compress = yes|true|on | no|false|off" 4 556.IP "compress = yes|true|on | no|false|off" 4
420.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
421Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 560compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR). Compression is
422Compression 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
423overhead at all, so enabling this is a good idea. 562only be used when the other side supports compression, so enabling this is
563often a good idea.
424.IP "connect = ondemand | never | always | disabled" 4 564.IP "connect = ondemand | never | always | disabled" 4
425.IX Item "connect = ondemand | never | always | disabled" 565.IX Item "connect = ondemand | never | always | disabled"
426Sets 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
427try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 567try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR
428(never initiate a connection to the given host, but accept connections), 568(never initiate a connection to the given host, but accept connections),
429\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 569\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding
430take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 570packets in the queue and take it down after the keepalive interval) or
431don't talk to it). 571\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
572.Sp
573Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are
574\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other.
575.IP "deny-direct = nodename | *" 4
576.IX Item "deny-direct = nodename | *"
577Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
578is given). Only one node can be specified, but you can use multiple
579\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
580networks with routers, as routers are required for indirect connections.
581.Sp
582Sometimes, a node cannot reach some other nodes for reasons of network
583connectivity. For example, a node behind a firewall that only allows
584connections to/from a single other node in the network. In this case one
585should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
586node \fImust\fR be a router for this to work).
587.Sp
588The algorithm to check whether a connection may be direct is as follows:
589.Sp
5901. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
591.Sp
5922. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
593.Sp
5943. Allow the connection.
595.Sp
596That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
597.Sp
598The check is done in both directions, i.e. both nodes must allow a direct
599connection before one is attempted, so you only need to specify connect
600limitations on one node.
432.IP "dns-domain = domain-suffix" 4 601.IP "dns-domain = domain-suffix" 4
433.IX Item "dns-domain = domain-suffix" 602.IX Item "dns-domain = domain-suffix"
434The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. 603The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
435.Sp 604.Sp
436The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 605The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
437i.e. 606i.e.
438.Sp 607.Sp
439.Vb 2 608.Vb 2
440\& dns-domainname = tunnel.example.net 609\& dns\-domainname = tunnel.example.net
441\& dns-hostname = tunnel-server.example.net 610\& dns\-hostname = tunnel\-server.example.net
442.Ve 611.Ve
443.Sp 612.Sp
444Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: 613Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
445.Sp 614.Sp
446.Vb 2 615.Vb 2
447\& tunnel.example.net. NS tunnel-server.example.net. 616\& tunnel.example.net. NS tunnel\-server.example.net.
448\& tunnel-server.example.net. A 13.13.13.13 617\& tunnel\-server.example.net. A 13.13.13.13
449.Ve 618.Ve
450.IP "dns-hostname = hostname/ip" 4 619.IP "dns-hostname = hostname/ip" 4
451.IX Item "dns-hostname = hostname/ip" 620.IX Item "dns-hostname = hostname/ip"
452The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, 621The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
453but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might 622but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
… …
465was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. 634was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
466.IP "enable-icmp = yes|true|on | no|false|off" 4 635.IP "enable-icmp = yes|true|on | no|false|off" 4
467.IX Item "enable-icmp = yes|true|on | no|false|off" 636.IX Item "enable-icmp = yes|true|on | no|false|off"
468See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. 637See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
469.Sp 638.Sp
470Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this 639Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
471node. 640node.
472.IP "enable-rawip = yes|true|on | no|false|off" 4 641.IP "enable-rawip = yes|true|on | no|false|off" 4
473.IX Item "enable-rawip = yes|true|on | no|false|off" 642.IX Item "enable-rawip = yes|true|on | no|false|off"
474See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. 643See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
475.Sp 644.Sp
… …
484when 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.
485.IP "enable-udp = yes|true|on | no|false|off" 4 654.IP "enable-udp = yes|true|on | no|false|off" 4
486.IX Item "enable-udp = yes|true|on | no|false|off" 655.IX Item "enable-udp = yes|true|on | no|false|off"
487See \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.
488.Sp 657.Sp
489Enable 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).
490unless no other protocol is enabled for a node, in which case this 659.IP "hostname = hostname | ip [can not be defaulted]" 4
491protocol is enabled automatically). 660.IX Item "hostname = hostname | ip [can not be defaulted]"
661Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
662address. It will be resolved before each connect request, so dyndns should
663work fine. If this setting is not specified and a router is available,
664then the router will be queried for the address of this node. Otherwise,
665the connection attempt will fail.
492.Sp 666.Sp
493\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 667Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that
494it might get switched on automatically, as some future version might 668is an issue you need to specify \s-1IP\s0 addresses.
495default to another default protocol.
496.IP "icmp-type = integer" 4 669.IP "icmp-type = integer" 4
497.IX Item "icmp-type = integer" 670.IX Item "icmp-type = integer"
498Sets 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
499via the \s-1ICMP\s0 transport. 672via the \s-1ICMP\s0 transport.
500.Sp 673.Sp
501The 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
502\&\*(L"ping\-replies\*(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.
503\&\*(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.
677.IP "if-up-data = value" 4
678.IX Item "if-up-data = value"
679The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
680script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
504.IP "inherit-tos = yes|true|on | no|false|off" 4 681.IP "inherit-tos = yes|true|on | no|false|off" 4
505.IX Item "inherit-tos = yes|true|on | no|false|off" 682.IX Item "inherit-tos = yes|true|on | no|false|off"
506Wether 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
507sending 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
508outgoing 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
509to the tunnel device, which is usually what you want. 686to the tunnel device, which is usually what you want.
510.IP "max-retry = positive-number" 4 687.IP "max-retry = positive-number" 4
511.IX Item "max-retry = positive-number" 688.IX Item "max-retry = positive-number"
512The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 689The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
513retries to establish a connection to this node. When a connection cannot 690retries to establish a connection to this node. When a connection cannot
514be established, gvpe uses exponential backoff capped at this value. It's 691be established, gvpe uses exponential back-off capped at this value. It's
515sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 692sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
516connections to routers that usually are stable but sometimes are down, to 693connections to routers that usually are stable but sometimes are down, to
517assure quick reconnections even after longer downtimes. 694assure quick reconnections even after longer downtimes.
695.IP "max-ttl = seconds" 4
696.IX Item "max-ttl = seconds"
697Expire packets that couldn't be sent after this many seconds
698(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
699active connection, in the hope of establishing a connection soon. This
700value specifies the maximum lifetime a packet will stay in the queue, if a
701packet gets older, it will be thrown away.
702.IP "max-queue = positive\-number>=1" 4
703.IX Item "max-queue = positive-number>=1"
704The maximum number of packets that will be queued (default: \f(CW512\fR)
705for this node. If more packets are sent then earlier packets will be
706expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
518.IP "router-priority = 0 | 1 | positive\-number>=2" 4 707.IP "router-priority = 0 | 1 | positive\-number>=2" 4
519.IX Item "router-priority = 0 | 1 | positive-number>=2" 708.IX Item "router-priority = 0 | 1 | positive-number>=2"
520Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 709Sets the router priority of the given node (default: \f(CW0\fR, disabled).
521some host tries to connect to another host without a hostname, it asks
522the router host for it's \s-1IP\s0 address. The router host is the one with the
523highest priority larger than \f(CW1\fR that is currently reachable.
524.Sp 710.Sp
525Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router 711If some node tries to connect to another node but it doesn't have a
526hosts, otherwise connecting to them might be impossible. 712hostname, it asks a router node for it's \s-1IP\s0 address. The router node
713chosen is the one with the highest priority larger than \f(CW1\fR that is
714currently reachable. This is called a \fImediated\fR connection, as the
715connection itself will still be direct, but it uses another node to
716mediate between the two nodes.
717.Sp
718The value \f(CW0\fR disables routing, that means if the node receives a packet
719not for itself it will not forward it but instead drop it.
527.Sp 720.Sp
528The special value \f(CW1\fR allows other hosts to route through the router 721The special value \f(CW1\fR allows other hosts to route through the router
529host, but they will never route through it by default. The value \f(CW0\fR 722host, but they will never route through it by default (i.e. the config
530disables routing. The idea behind this is that some hosts can, if 723file of another node needs to specify a router priority higher than one
724to choose such a node for routing).
725.Sp
726The idea behind this is that some hosts can, if required, bump the
531required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 727\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to
532local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 728route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing
533\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 729will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R"
534not use by default\*(R" switch. 730switch.
731.Sp
732Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced
733to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR).
535.IP "tcp-port = port-number" 4 734.IP "tcp-port = port-number" 4
536.IX Item "tcp-port = port-number" 735.IX Item "tcp-port = port-number"
537Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 736Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
538.IP "udp-port = port-number" 4 737.IP "udp-port = port-number" 4
539.IX Item "udp-port = port-number" 738.IX Item "udp-port = port-number"
540Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 739Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
541officially assigned by \s-1IANA\s0!). 740officially assigned by \s-1IANA\s0!).
542.SH "CONFIG DIRECTORY LAYOUT" 741.SH "CONFIG DIRECTORY LAYOUT"
543.IX Header "CONFIG DIRECTORY LAYOUT" 742.IX Header "CONFIG DIRECTORY LAYOUT"
544The default (or recommended) directory layout for the config directory is: 743The default (or recommended) directory layout for the config directory is:
545.IP "\(bu" 4 744.IP "gvpe.conf" 4
546.IX Xref "gvpe.conf" 745.IX Item "gvpe.conf"
547The config file. 746The config file.
548.IP "\(bu" 4 747.IP "if-up" 4
549.IX Xref "if-up" 748.IX Item "if-up"
550The if-up script 749The if-up script
551.IP "," 4 750.IP "node-up, node-down" 4
552.IX Xref "node-up node-down" 751.IX Item "node-up, node-down"
553If used the node up or node-down scripts. 752If used the node up or node-down scripts.
554.IP "\(bu" 4 753.IP "hostkey" 4
555.IX Xref "hostkey" 754.IX Item "hostkey"
556The 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.
557.IP "\(bu" 4 756.IP "pubkey/nodename" 4
558.IX Xref "pubkey nodename" 757.IX Item "pubkey/nodename"
559The public keys of the other nodes, one file per node. 758The public keys of the other nodes, one file per node.
560.SH "SEE ALSO" 759.SH "SEE ALSO"
561.IX Header "SEE ALSO" 760.IX Header "SEE ALSO"
562\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 761\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
563.SH "AUTHOR" 762.SH "AUTHOR"
564.IX Header "AUTHOR" 763.IX Header "AUTHOR"
565Marc Lehmann <gvpe@plan9.de> 764Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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