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.27 by root, Tue Feb 15 13:31:22 2011 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-07" "1.8" "GNU Virtual Private Ethernet" 127.TH GVPE.CONF 5 "2011-02-12" "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 163The 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 164\&\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. 165(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
169.PP 166.PP
167For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on
168branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2:
169.PP
170.Vb 3 170.Vb 3
171\& name = value 171\& mtu = 1450
172\& on branch1 loglevel = noise 172\& on branch1 loglevel = noise
173\& on !branch2 connect = ondemand 173\& on !branch2 connect = ondemand
174.Ve 174.Ve
175.PP 175.PP
176All settings are executed \*(L"in order\*(R", that is, later settings of the same 176All settings are applied \*(L"in order\*(R", that is, later settings of the same
177variable overwrite earlier ones. 177variable overwrite earlier ones.
178.SH "ANATOMY OF A CONFIG FILE" 178.SH "ANATOMY OF A CONFIG FILE"
179.IX Header "ANATOMY OF A CONFIG FILE" 179.IX Header "ANATOMY OF A CONFIG FILE"
180Usually, a config file starts with global settings (like the udp port to 180Usually, 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 = 181port to listen on), followed by node-specific sections that begin with a
182nickname\*(C'\fR line. 182\&\f(CW\*(C`node = nickname\*(C'\fR line.
183.PP 183.PP
184Every node that is part of the network must have a section that starts 184Every 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 185with \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 186and must be the same on all nodes. It is not uncommon for node sections to
187be completely empty \- if the default values are right. 187be completely empty \- if the default values are right.
188.PP 188.PP
189Node-specific settings can be used at any time. If used before the first 189Node-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. 190node section they will set the default values for all following nodes.
191.SH "CONFIG VARIABLES" 191.SH "CONFIG VARIABLES"
192.IX Header "CONFIG VARIABLES" 192.IX Header "CONFIG VARIABLES"
193.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" 193.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
194.IX Subsection "GLOBAL SETTINGS" 194.IX Subsection "GLOBAL SETTINGS"
195Global settings will affect the behaviour of the running gvpe daemon, that 195Global settings will affect the behaviour of the running gvpe daemon, that
196is, they are in some sense node-specific (config files can set different 196is, 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 197values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of
198the gvpe daemon and all connections it creates. 198the gvpe daemon and all connections it creates.
199.IP "dns-forw-host = hostname/ip" 4 199.IP "dns-forw-host = hostname/ip" 4
200.IX Item "dns-forw-host = hostname/ip" 200.IX Item "dns-forw-host = hostname/ip"
201The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol 201The \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). 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 \s-1OK\s0 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 \s-1DNS\s0 forwarders you could use a value nearer to or
228exceeding \f(CW1\fR.
229.Sp
230The default should be working \s-1OK\s0 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 \s-1OK\s0 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
251the link is very stable lower values (e.g. \f(CW2\fR) might work
252nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
253.Sp
254The default should be working \s-1OK\s0 for most links but will result in low
255throughput if packet loss is high.
207.IP "if-up = relative-or-absolute-path" 4 256.IP "if-up = relative-or-absolute-path" 4
208.IX Item "if-up = relative-or-absolute-path" 257.IX Item "if-up = relative-or-absolute-path"
209Sets the path of a script that should be called immediately after the 258Sets the path of a script that should be called immediately after the
210network interface is initialized (but not neccessarily up). The following 259network interface is initialized (but not necessarily up). The following
211environment variables are passed to it (the values are just examples): 260environment variables are passed to it (the values are just examples).
261.Sp
262Variables that have the same value on all nodes:
212.RS 4 263.RS 4
213.IP "CONFBASE=/etc/gvpe" 4 264.IP "CONFBASE=/etc/gvpe" 4
214.IX Item "CONFBASE=/etc/gvpe" 265.IX Item "CONFBASE=/etc/gvpe"
215The configuration base directory. 266The configuration base directory.
216.IP "IFNAME=vpn0" 4 267.IP "IFNAME=vpn0" 4
217.IX Item "IFNAME=vpn0" 268.IX Item "IFNAME=vpn0"
218The interface to initialize. 269The 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 270.IP "IFTYPE=native # or tincd" 4
235.IX Item "IFTYPE=native # or tincd" 271.IX Item "IFTYPE=native # or tincd"
236.PD 0 272.PD 0
237.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 273.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
238.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 274.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
239.PD 275.PD
240The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os 276The 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 277\&\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. 278select the correct syntax to use for network-related commands.
279.IP "MTU=1436" 4
280.IX Item "MTU=1436"
281The \s-1MTU\s0 to set the interface to. You can use lower values (if done
282consistently on all nodes), but this is usually either inefficient or
283simply ineffective.
284.IP "NODES=5" 4
285.IX Item "NODES=5"
286The number of nodes in this \s-1GVPE\s0 network.
287.RE
288.RS 4
289.Sp
290Variables that are node-specific and with values pertaining to the node
291running this \s-1GVPE:\s0
292.IP "IFUPDATA=string" 4
293.IX Item "IFUPDATA=string"
294The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR.
295.IP "MAC=fe:fd:80:00:00:01" 4
296.IX Item "MAC=fe:fd:80:00:00:01"
297The \s-1MAC\s0 address the network interface has to use.
298.Sp
299Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
300do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for
301platform-specific information.
243.IP "NODENAME=branch1" 4 302.IP "NODENAME=branch1" 4
244.IX Item "NODENAME=branch1" 303.IX Item "NODENAME=branch1"
245The nickname of the current node, as passed to the gvpe daemon. 304The nickname of the node.
246.IP "NODEID=1" 4 305.IP "NODEID=1" 4
247.IX Item "NODEID=1" 306.IX Item "NODEID=1"
248The numerical node id of the current node. The first node mentioned in the 307The 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. 308node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
250.RE 309.RE
251.RS 4 310.RS 4
252.Sp 311.Sp
312In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
313available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
314node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
315the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
316.Sp
253Here is a simple if-up script: 317Here is a simple if-up script:
254.Sp 318.Sp
255.Vb 5 319.Vb 5
256\& #!/bin/sh 320\& #!/bin/sh
257\& ip link set $IFNAME address $MAC mtu $MTU up 321\& ip link set $IFNAME up
258\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 322\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
259\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 323\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
260\& ip route add 10.0.0.0/8 dev $IFNAME 324\& ip route add 10.0.0.0/8 dev $IFNAME
261.Ve 325.Ve
262.Sp 326.Sp
263More complicated examples (using routing to reduce arp traffic) can be 327More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be
264found in the etc/ subdirectory of the distribution. 328found in the \fIetc/\fR subdirectory of the distribution.
265.RE 329.RE
266.IP "ifname = devname" 4 330.IP "ifname = devname" 4
267.IX Item "ifname = devname" 331.IX Item "ifname = devname"
268Sets the tun interface name to the given name. The default is OS-specific 332Sets the tun interface name to the given name. The default is OS-specific
269and most probably something like \f(CW\*(C`tun0\*(C'\fR. 333and 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 340the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
277device. 341device.
278.IP "ip-proto = numerical-ip-protocol" 4 342.IP "ip-proto = numerical-ip-protocol" 4
279.IX Item "ip-proto = numerical-ip-protocol" 343.IX Item "ip-proto = numerical-ip-protocol"
280Sets the protocol number to be used for the rawip protocol. This is a 344Sets 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 345global option because all nodes must use the same protocol, and since
282there are no port numbers, you cannot easily run more than one gvpe 346there are no port numbers, you cannot easily run more than one gvpe
283instance using the same protocol, nor can you share the protocol with 347instance using the same protocol, nor can you share the protocol with
284other programs. 348other programs.
285.Sp 349.Sp
286The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 350The 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 351through 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 352compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4
289(\s-1ENCAP\s0, rfc1241) 353(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241).
354.Sp
355Many versions of Linux seem to have a bug that causes them to reorder
356packets for some ip protocols (\s-1GRE\s0, \s-1ESP\s0) but not for others (\s-1AH\s0), so
357choose wisely (that is, use 51, \s-1AH\s0).
290.IP "http-proxy-host = hostname/ip" 4 358.IP "http-proxy-host = hostname/ip" 4
291.IX Item "http-proxy-host = hostname/ip" 359.IX Item "http-proxy-host = hostname/ip"
292The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was 360The \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 361compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
294tcp connections through a http proxy server. 362tcp 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 364\&\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 365port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
298requires authentication. 366requires authentication.
299.Sp 367.Sp
300Please note that gvpe will still try to resolve all hostnames in the 368Please 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 369configuration file, so if you are behind a proxy without access to a \s-1DNS\s0
302server better use numerical \s-1IP\s0 addresses. 370server better use numerical \s-1IP\s0 addresses.
303.Sp 371.Sp
304To make best use of this option disable all protocols except tcp in your 372To 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 373config 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). 374on a port that the proxy allows (443, https, is a common choice).
307.Sp 375.Sp
308If you have a router, connecting to it will suffice. Otherwise tcp must be 376If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be
309enabled on all hosts. 377enabled on all nodes.
310.Sp 378.Sp
311Example: 379Example:
312.Sp 380.Sp
313.Vb 3 381.Vb 3
314\& http-proxy-host = proxy.example.com 382\& http\-proxy\-host = proxy.example.com
315\& http-proxy-port = 3128 # 8080 is another common choice 383\& http\-proxy\-port = 3128 # 8080 is another common choice
316\& http-proxy-auth = schmorp:grumbeere 384\& http\-proxy\-auth = schmorp:grumbeere
317.Ve 385.Ve
318.IP "http-proxy-port = proxy-tcp-port" 4 386.IP "http-proxy-port = proxy-tcp-port" 4
319.IX Item "http-proxy-port = proxy-tcp-port" 387.IX Item "http-proxy-port = proxy-tcp-port"
320The port where your proxy server listens. 388The port where your proxy server listens.
321.IP "http-proxy-auth = login:password" 4 389.IP "http-proxy-auth = login:password" 4
322.IX Item "http-proxy-auth = login:password" 390.IX Item "http-proxy-auth = login:password"
323The optional login and password used to authenticate to the proxy server, 391The 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 392separated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
325currently supported. 393currently supported.
326.IP "keepalive = seconds" 4 394.IP "keepalive = seconds" 4
327.IX Item "keepalive = seconds" 395.IX Item "keepalive = seconds"
328Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this 396Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
329many seconds of inactivity the daemon will start to send keepalive probe 397many 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 398every 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 399is received within 15 seconds, the peer is considered unreachable and the
332connection is closed. 400connection is closed.
333.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 401.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
334.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 402.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
335Set the logging level. Connection established messages are logged at level 403Set 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. 404\&\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 405.IP "mtu = bytes" 4
338.IX Item "mtu = bytes" 406.IX Item "mtu = bytes"
339Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically 407Sets 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 408the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
341maximum overhead (e.g. udp header size, encryption blocksize...) and pass 409maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass
342this information to the \f(CW\*(C`if\-up\*(C'\fR script. 410this information to the \f(CW\*(C`if\-up\*(C'\fR script.
343.Sp 411.Sp
344Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 412Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
345.Sp 413.Sp
346This value must be the minimum of the mtu values of all hosts. 414This value must be the minimum of the \s-1MTU\s0 values of all nodes.
347.IP "node = nickname" 4 415.IP "node = nickname" 4
348.IX Item "node = nickname" 416.IX Item "node = nickname"
349Not really a config setting but introduces a node section. The nickname is 417Not 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 418used to select the right configuration section and must be passed as an
351argument to the gvpe daemon. 419argument to the gvpe daemon.
352.IP "node-up = relative-or-absolute-path" 4 420.IP "node-up = relative-or-absolute-path" 4
353.IX Item "node-up = relative-or-absolute-path" 421.IX Item "node-up = relative-or-absolute-path"
354Sets a command (default: no script) that should be called whenever a 422Sets a command (default: none) that should be called whenever a connection
355connection is established (even on rekeying operations). In addition 423is established (even on rekeying operations). Note that node\-up/down
424scripts will be run asynchronously, but execution is serialised, so there
425will only ever be one such script running.
426.Sp
356to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 427In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
357variables will be set: 428environment variables will be set (values are just examples):
358.RS 4 429.RS 4
359.IP "DESTNODE=branch2" 4 430.IP "DESTNODE=branch2" 4
360.IX Item "DESTNODE=branch2" 431.IX Item "DESTNODE=branch2"
361The name of the remote node. 432The name of the remote node.
362.IP "DESTID=2" 4 433.IP "DESTID=2" 4
363.IX Item "DESTID=2" 434.IX Item "DESTID=2"
364The node id of the remote node. 435The node id of the remote node.
436.IP "DESTSI=rawip/88.99.77.55:0" 4
437.IX Item "DESTSI=rawip/88.99.77.55:0"
438The \*(L"socket info\*(R" of the target node, protocol dependent but usually in
439the format protocol/ip:port.
365.IP "DESTIP=188.13.66.8" 4 440.IP "DESTIP=188.13.66.8" 4
366.IX Item "DESTIP=188.13.66.8" 441.IX Item "DESTIP=188.13.66.8"
367The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from 442The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
368everywhere, as long as the other host can authenticate itself). 443everywhere, as long as the other node can authenticate itself).
369.IP "DESTPORT=655 # deprecated" 4 444.IP "DESTPORT=655 # deprecated" 4
370.IX Item "DESTPORT=655 # deprecated" 445.IX Item "DESTPORT=655 # deprecated"
371The \s-1UDP\s0 port used by the other side. 446The protocol port used by the other side, if applicable.
372.IP "STATE=UP" 4 447.IP "STATE=up" 4
373.IX Item "STATE=UP" 448.IX Item "STATE=up"
374Node-up scripts get called with STATE=UP, node-down scripts get called 449Node-up scripts get called with STATE=up, node-change scripts get called
375with STATE=DOWN. 450with STATE=change and node-down scripts get called with STATE=down.
376.RE 451.RE
377.RS 4 452.RS 4
378.Sp 453.Sp
379Here is a nontrivial example that uses nsupdate to update the name => ip 454Here is a nontrivial example that uses nsupdate to update the name => ip
380mapping in some dns zone: 455mapping in some \s-1DNS\s0 zone:
381.Sp 456.Sp
382.Vb 6 457.Vb 6
383\& #!/bin/sh 458\& #!/bin/sh
384\& { 459\& {
385\& echo update delete $DESTNODE.lowttl.example.net. a 460\& echo update delete $DESTNODE.lowttl.example.net. a
386\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 461\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
387\& echo 462\& echo
388\& } | nsupdate -d -k $CONFBASE:key.example.net. 463\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
389.Ve 464.Ve
390.RE 465.RE
466.IP "node-change = relative-or-absolute-path" 4
467.IX Item "node-change = relative-or-absolute-path"
468Same as \f(CW\*(C`node\-change\*(C'\fR, but gets called whenever something about a
469connection changes (such as the source \s-1IP\s0 address).
391.IP "node-down = relative-or-absolute-path" 4 470.IP "node-down = relative-or-absolute-path" 4
392.IX Item "node-down = relative-or-absolute-path" 471.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. 472Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
394.IP "pid-file = path" 4 473.IP "pid-file = path" 4
395.IX Item "pid-file = path" 474.IX Item "pid-file = path"
… …
402be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 481be 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 482use 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. 483\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
405.Sp 484.Sp
406Since only the private key file of the current node is used and the 485Since 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 486private key file should be kept secret per-node to avoid spoofing, it is
408not recommended to use this feature. 487not recommended to use this feature.
409.IP "rekey = seconds" 4 488.IP "rekey = seconds" 4
410.IX Item "rekey = seconds" 489.IX Item "rekey = seconds"
411Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 490Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
412reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 491reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
492key.
493.IP "nfmark = integer" 4
494.IX Item "nfmark = integer"
495This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries
496to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
497send packets.
498.Sp
499This can be used to make gvpe use a different set of routing rules. For
500example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then
501put all routing rules into table \f(CW99\fR and then use an ip rule to make
502gvpe traffic avoid that routing table, in effect routing normal traffic
503via gvpe and gvpe traffic via the normal system routing tables:
504.Sp
505.Vb 1
506\& ip rule add not fwmark 1000 lookup 99
507.Ve
413.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 508.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
414.IX Subsection "NODE SPECIFIC SETTINGS" 509.IX Subsection "NODE SPECIFIC SETTINGS"
415The following settings are node\-specific, that is, every node can have 510The following settings are node-specific, that is, every node can have
416different settings, even within the same gvpe instance. Settings that are 511different settings, even within the same gvpe instance. Settings that are
417executed before the first node section set the defaults, settings that are 512set before the first node section set the defaults, settings that are
418executed within a node section only apply to the given node. 513set within a node section only apply to the given node.
514.IP "allow-direct = nodename" 4
515.IX Item "allow-direct = nodename"
516Allow 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 517.IP "compress = yes|true|on | no|false|off" 4
420.IX Item "compress = yes|true|on | no|false|off" 518.IX Item "compress = yes|true|on | no|false|off"
519For the current node, this specified whether it will accept compressed
520packets, 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). 521compress 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 522really cheap even on slow computers, has no size overhead at all and will
423overhead at all, so enabling this is a good idea. 523only be used when the other side supports compression, so enabling this is
524often a good idea.
424.IP "connect = ondemand | never | always | disabled" 4 525.IP "connect = ondemand | never | always | disabled" 4
425.IX Item "connect = ondemand | never | always | disabled" 526.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 527Sets 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 528try 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), 529(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 530\&\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, 531packets in the queue and take it down after the keepalive interval) or
431don't talk to it). 532\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
533.Sp
534Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are
535\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other.
536.IP "deny-direct = nodename | *" 4
537.IX Item "deny-direct = nodename | *"
538Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
539is given). Only one node can be specified, but you can use multiple
540\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
541networks with routers, as routers are required for indirect connections.
542.Sp
543Sometimes, a node cannot reach some other nodes for reasons of network
544connectivity. For example, a node behind a firewall that only allows
545connections to/from a single other node in the network. In this case one
546should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
547node \fImust\fR be a router for this to work).
548.Sp
549The algorithm to check whether a connection may be direct is as follows:
550.Sp
5511. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
552.Sp
5532. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
554.Sp
5553. Allow the connection.
556.Sp
557That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
558.Sp
559The check is done in both directions, i.e. both nodes must allow a direct
560connection before one is attempted, so you only need to specify connect
561limitations on one node.
432.IP "dns-domain = domain-suffix" 4 562.IP "dns-domain = domain-suffix" 4
433.IX Item "dns-domain = domain-suffix" 563.IX Item "dns-domain = domain-suffix"
434The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. 564The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
435.Sp 565.Sp
436The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 566The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
437i.e. 567i.e.
438.Sp 568.Sp
439.Vb 2 569.Vb 2
440\& dns-domainname = tunnel.example.net 570\& dns\-domainname = tunnel.example.net
441\& dns-hostname = tunnel-server.example.net 571\& dns\-hostname = tunnel\-server.example.net
442.Ve 572.Ve
443.Sp 573.Sp
444Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: 574Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
445.Sp 575.Sp
446.Vb 2 576.Vb 2
447\& tunnel.example.net. NS tunnel-server.example.net. 577\& tunnel.example.net. NS tunnel\-server.example.net.
448\& tunnel-server.example.net. A 13.13.13.13 578\& tunnel\-server.example.net. A 13.13.13.13
449.Ve 579.Ve
450.IP "dns-hostname = hostname/ip" 4 580.IP "dns-hostname = hostname/ip" 4
451.IX Item "dns-hostname = hostname/ip" 581.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, 582The 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 583but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
… …
455.IP "dns-port = port-number" 4 585.IP "dns-port = port-number" 4
456.IX Item "dns-port = port-number" 586.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. 587The 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 588.IP "enable-dns = yes|true|on | no|false|off" 4
459.IX Item "enable-dns = yes|true|on | no|false|off" 589.IX Item "enable-dns = yes|true|on | no|false|off"
590See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport
591protocol. Avoid this protocol if you can.
592.Sp
460Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as 593Enable 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). 594client. Support for this transport protocol is only available when gvpe
595was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
596.IP "enable-icmp = yes|true|on | no|false|off" 4
597.IX Item "enable-icmp = yes|true|on | no|false|off"
598See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
462.Sp 599.Sp
463This is the worst choice of transport protocol with respect to overhead 600Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 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 601node.
465the best choice when tunneling through firewalls.
466.IP "enable-rawip = yes|true|on | no|false|off" 4 602.IP "enable-rawip = yes|true|on | no|false|off" 4
467.IX Item "enable-rawip = yes|true|on | no|false|off" 603.IX Item "enable-rawip = yes|true|on | no|false|off"
604See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
605.Sp
468Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol 606Enable 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 607(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 608.IP "enable-tcp = yes|true|on | no|false|off" 4
472.IX Item "enable-tcp = yes|true|on | no|false|off" 609.IX Item "enable-tcp = yes|true|on | no|false|off"
610See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol.
611.Sp
473Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port 612Enable 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 613(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 614when 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 615.IP "enable-udp = yes|true|on | no|false|off" 4
480.IX Item "enable-udp = yes|true|on | no|false|off" 616.IX Item "enable-udp = yes|true|on | no|false|off"
617See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
618.Sp
481Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 619Enable 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 620unless no other protocol is enabled for a node, in which case this
483protocol is enabled automatically). This is a good general choice since 621protocol is enabled automatically).
484\&\s-1UDP\s0 tunnels well through many firewalls.
485.Sp 622.Sp
486\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 623\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though
487it might get switched on automatically, as some future version might 624it might get switched on automatically, as some future version might
488default to another default protocol. 625default to another default protocol.
626.IP "hostname = hostname | ip [can not be defaulted]" 4
627.IX Item "hostname = hostname | ip [can not be defaulted]"
628Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
629address. It will be resolved before each connect request, so dyndns should
630work fine. If this setting is not specified and a router is available,
631then the router will be queried for the address of this node. Otherwise,
632the connection attempt will fail.
633.Sp
634Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that
635is an issue you need to specify \s-1IP\s0 addresses.
636.IP "icmp-type = integer" 4
637.IX Item "icmp-type = integer"
638Sets the type value to be used for outgoing (and incoming) packets sent
639via the \s-1ICMP\s0 transport.
640.Sp
641The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
642\&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
643\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
644.IP "if-up-data = value" 4
645.IX Item "if-up-data = value"
646The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
647script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
489.IP "inherit-tos = yes|true|on | no|false|off" 4 648.IP "inherit-tos = yes|true|on | no|false|off" 4
490.IX Item "inherit-tos = yes|true|on | no|false|off" 649.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 650Whether 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 651sending 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 652outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
494to the tunnel device, which is usually what you want. 653to the tunnel device, which is usually what you want.
495.IP "max-retry = positive-number" 4 654.IP "max-retry = positive-number" 4
496.IX Item "max-retry = positive-number" 655.IX Item "max-retry = positive-number"
497The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 656The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
498retries to establish a connection to this node. When a connection cannot 657retries to establish a connection to this node. When a connection cannot
499be established, gvpe uses exponential backoff capped at this value. It's 658be established, gvpe uses exponential back-off capped at this value. It's
500sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 659sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
501connections to routers that usually are stable but sometimes are down, to 660connections to routers that usually are stable but sometimes are down, to
502assure quick reconnections even after longer downtimes. 661assure quick reconnections even after longer downtimes.
662.IP "max-ttl = seconds" 4
663.IX Item "max-ttl = seconds"
664Expire packets that couldn't be sent after this many seconds
665(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
666active connection, in the hope of establishing a connection soon. This
667value specifies the maximum lifetime a packet will stay in the queue, if a
668packet gets older, it will be thrown away.
669.IP "max-queue = positive\-number>=1" 4
670.IX Item "max-queue = positive-number>=1"
671The maximum number of packets that will be queued (default: \f(CW512\fR)
672for this node. If more packets are sent then earlier packets will be
673expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
503.IP "router-priority = 0 | 1 | positive\-number>=2" 4 674.IP "router-priority = 0 | 1 | positive\-number>=2" 4
504.IX Item "router-priority = 0 | 1 | positive-number>=2" 675.IX Item "router-priority = 0 | 1 | positive-number>=2"
505Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 676Sets the router priority of the given node (default: \f(CW0\fR, disabled).
506some host tries to connect to another host without a hostname, it asks
507the router host for it's \s-1IP\s0 address. The router host is the one with the
508highest priority larger than \f(CW1\fR that is currently reachable.
509.Sp 677.Sp
510Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router 678If some node tries to connect to another node but it doesn't have a
511hosts, otherwise connecting to them might be impossible. 679hostname, it asks a router node for it's \s-1IP\s0 address. The router node
680chosen is the one with the highest priority larger than \f(CW1\fR that is
681currently reachable. This is called a \fImediated\fR connection, as the
682connection itself will still be direct, but it uses another node to
683mediate between the two nodes.
684.Sp
685The value \f(CW0\fR disables routing, that means if the node receives a packet
686not for itself it will not forward it but instead drop it.
512.Sp 687.Sp
513The special value \f(CW1\fR allows other hosts to route through the router 688The special value \f(CW1\fR allows other hosts to route through the router
514host, but they will never route through it by default. The value \f(CW0\fR 689host, but they will never route through it by default (i.e. the config
515disables routing. The idea behind this is that some hosts can, if 690file of another node needs to specify a router priority higher than one
691to choose such a node for routing).
692.Sp
693The idea behind this is that some hosts can, if required, bump the
516required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 694\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to
517local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 695route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing
518\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 696will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R"
519not use by default\*(R" switch. 697switch.
698.Sp
699Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced
700to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR).
520.IP "tcp-port = port-number" 4 701.IP "tcp-port = port-number" 4
521.IX Item "tcp-port = port-number" 702.IX Item "tcp-port = port-number"
522Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 703Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
523.IP "udp-port = port-number" 4 704.IP "udp-port = port-number" 4
524.IX Item "udp-port = port-number" 705.IX Item "udp-port = port-number"
525Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 706Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
526officially assigned by \s-1IANA\s0!). 707officially assigned by \s-1IANA\s0!).
527.SH "CONFIG DIRECTORY LAYOUT" 708.SH "CONFIG DIRECTORY LAYOUT"
528.IX Header "CONFIG DIRECTORY LAYOUT" 709.IX Header "CONFIG DIRECTORY LAYOUT"
529The default (or recommended) directory layout for the config directory is: 710The default (or recommended) directory layout for the config directory is:
530.IP "\(bu" 4 711.IP "gvpe.conf" 4
531.IX Xref "gvpe.conf" 712.IX Item "gvpe.conf"
532The config file. 713The config file.
533.IP "\(bu" 4 714.IP "if-up" 4
534.IX Xref "if-up" 715.IX Item "if-up"
535The if-up script 716The if-up script
536.IP "," 4 717.IP "node-up, node-down" 4
537.IX Xref "node-up node-down" 718.IX Item "node-up, node-down"
538If used the node up or node-down scripts. 719If used the node up or node-down scripts.
539.IP "\(bu" 4 720.IP "hostkey" 4
540.IX Xref "hostkey" 721.IX Item "hostkey"
541The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 722The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
542.IP "\(bu" 4 723.IP "pubkey/nodename" 4
543.IX Xref "pubkey nodename" 724.IX Item "pubkey/nodename"
544The public keys of the other nodes, one file per node. 725The public keys of the other nodes, one file per node.
545.SH "SEE ALSO" 726.SH "SEE ALSO"
546.IX Header "SEE ALSO" 727.IX Header "SEE ALSO"
547\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 728\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
548.SH "AUTHOR" 729.SH "AUTHOR"
549.IX Header "AUTHOR" 730.IX Header "AUTHOR"
550Marc Lehmann <gvpe@plan9.de> 731Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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