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.6 by pcg, Thu Mar 3 07:24:57 2005 UTC vs.
Revision 1.28 by root, Sun Mar 6 13:49:49 2011 UTC

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

Diff Legend

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