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

Diff Legend

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