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.20 by pcg, Sun Aug 10 10:35:26 2008 UTC vs.
Revision 1.30 by root, Tue Dec 4 10:29:43 2012 UTC

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

Diff Legend

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