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.13 by pcg, Wed Mar 23 21:55:39 2005 UTC vs.
Revision 1.20 by pcg, Sun Aug 10 10:35:26 2008 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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
… …
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
48. ds R" '' 48. ds R" ''
49'br\} 49'br\}
50.\" 50.\"
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 55.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 57.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 58.\" output yourself in some meaningful fashion.
55.if \nF \{\ 59.ie \nF \{\
56. de IX 60. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 61. tm Index:\\$1\t\\n%\t"\\$2"
58.. 62..
59. nr % 0 63. nr % 0
60. rr F 64. rr F
61.\} 65.\}
62.\" 66.el \{\
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 67. de IX
64.\" way too many mistakes in technical documents. 68..
65.hy 0 69.\}
66.if n .na
67.\" 70.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 72.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 73. \" fudge factors for nroff and troff
71.if n \{\ 74.if n \{\
… …
127.\} 130.\}
128.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
129.\" ======================================================================== 132.\" ========================================================================
130.\" 133.\"
131.IX Title "GVPE.CONF 5" 134.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2005-03-23" "1.9" "GNU Virtual Private Ethernet" 135.TH GVPE.CONF 5 "2008-08-07" "2.2" "GNU Virtual Private Ethernet"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
133.SH "NAME" 140.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 141gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 142.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 143.IX Header "SYNOPSIS"
137.Vb 3 144.Vb 3
138\& udp-port = 407 145\& udp\-port = 407
139\& mtu = 1492 146\& mtu = 1492
140\& ifname = vpn0 147\& ifname = vpn0
141.Ve 148\&
142.PP
143.Vb 2
144\& node = branch1 149\& node = branch1
145\& hostname = 1.2.3.4 150\& hostname = 1.2.3.4
146.Ve 151\&
147.PP
148.Vb 3
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\&
153.PP
154.Vb 2
155\& node = branch3 156\& node = branch3
156\& connect = ondemand 157\& connect = ondemand
157.Ve 158.Ve
158.SH "DESCRIPTION" 159.SH "DESCRIPTION"
159.IX Header "DESCRIPTION" 160.IX Header "DESCRIPTION"
160The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable 161The 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 162= 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 163extend 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 164after 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. 165values, but not within the variable names or values themselves.
165.PP 166.PP
166The only exception to the above is the \*(L"on\*(R" directive that can prefix any 167The 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 168\&\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. 169(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
169.PP 170.PP
… …
245get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport 246get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
246will resend the request when no reply has been received for longer than 247will resend the request when no reply has been received for longer than
247eight times the minimum (= expected) latency, assuming the request or 248eight times the minimum (= expected) latency, assuming the request or
248reply has been lost. 249reply has been lost.
249.Sp 250.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the 251For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
251link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values 252the link is very stable lower values (e.g. \f(CW2\fR) might work
252near or below \f(CW1\fR makes no sense whatsoever. 253nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
253.Sp 254.Sp
254The default should be working ok for most links. 255The default should be working ok for most links but will result in low
256throughput if packet loss is high.
255.IP "if-up = relative-or-absolute-path" 4 257.IP "if-up = relative-or-absolute-path" 4
256.IX Item "if-up = relative-or-absolute-path" 258.IX Item "if-up = relative-or-absolute-path"
257Sets the path of a script that should be called immediately after the 259Sets the path of a script that should be called immediately after the
258network interface is initialized (but not neccessarily up). The following 260network interface is initialized (but not neccessarily up). The following
259environment variables are passed to it (the values are just examples): 261environment variables are passed to it (the values are just examples).
262.Sp
263Variables that have the same value on all nodes:
260.RS 4 264.RS 4
261.IP "CONFBASE=/etc/gvpe" 4 265.IP "CONFBASE=/etc/gvpe" 4
262.IX Item "CONFBASE=/etc/gvpe" 266.IX Item "CONFBASE=/etc/gvpe"
263The configuration base directory. 267The configuration base directory.
264.IP "IFNAME=vpn0" 4 268.IP "IFNAME=vpn0" 4
265.IX Item "IFNAME=vpn0" 269.IX Item "IFNAME=vpn0"
266The interface to initialize. 270The network interface to initialize.
267.IP "MTU=1436" 4
268.IX Item "MTU=1436"
269The \s-1MTU\s0 to set the interface to. You can use lower values (if done
270consistently on all hosts), but this is usually ineffective.
271.IP "MAC=fe:fd:80:00:00:01" 4
272.IX Item "MAC=fe:fd:80:00:00:01"
273The \s-1MAC\s0 address to set the interface to. The script *must* set the
274interface \s-1MAC\s0 to this value. You will most likely use one of these:
275.Sp
276.Vb 2
277\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
278\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
279.Ve
280.Sp
281Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
282.IP "IFTYPE=native # or tincd" 4 271.IP "IFTYPE=native # or tincd" 4
283.IX Item "IFTYPE=native # or tincd" 272.IX Item "IFTYPE=native # or tincd"
284.PD 0 273.PD 0
285.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 274.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
286.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 275.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
287.PD 276.PD
288The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os 277The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the
289name in lowercase) that this gvpe was configured for. Can be used to select 278\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
290the correct syntax to use for network-related commands. 279select the correct syntax to use for network-related commands.
280.IP "MTU=1436" 4
281.IX Item "MTU=1436"
282The \s-1MTU\s0 to set the interface to. You can use lower values (if done
283consistently on all hosts), but this is usually ineffective.
284.IP "NODES=5" 4
285.IX Item "NODES=5"
286The number of nodes in this \s-1GVPE\s0 network.
287.RE
288.RS 4
289.Sp
290Variables that are node-specific and with values pertaining to the node
291running this \s-1GVPE:\s0
292.IP "IFUPDATA=string" 4
293.IX Item "IFUPDATA=string"
294The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR.
295.IP "MAC=fe:fd:80:00:00:01" 4
296.IX Item "MAC=fe:fd:80:00:00:01"
297The \s-1MAC\s0 address the network interface has to use.
298.Sp
299Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
300do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for
301platform-specific information.
291.IP "NODENAME=branch1" 4 302.IP "NODENAME=branch1" 4
292.IX Item "NODENAME=branch1" 303.IX Item "NODENAME=branch1"
293The nickname of the current node, as passed to the gvpe daemon. 304The nickname of the node.
294.IP "NODEID=1" 4 305.IP "NODEID=1" 4
295.IX Item "NODEID=1" 306.IX Item "NODEID=1"
296The numerical node id of the current node. The first node mentioned in the 307The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first
297config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. 308node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
298.RE 309.RE
299.RS 4 310.RS 4
300.Sp 311.Sp
312In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
313available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
314node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
315the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
316.Sp
301Here is a simple if-up script: 317Here is a simple if-up script:
302.Sp 318.Sp
303.Vb 5 319.Vb 5
304\& #!/bin/sh 320\& #!/bin/sh
305\& ip link set $IFNAME address $MAC mtu $MTU up 321\& ip link set $IFNAME up
306\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 322\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
307\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 323\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
308\& ip route add 10.0.0.0/8 dev $IFNAME 324\& ip route add 10.0.0.0/8 dev $IFNAME
309.Ve 325.Ve
310.Sp 326.Sp
… …
357enabled on all hosts. 373enabled on all hosts.
358.Sp 374.Sp
359Example: 375Example:
360.Sp 376.Sp
361.Vb 3 377.Vb 3
362\& http-proxy-host = proxy.example.com 378\& http\-proxy\-host = proxy.example.com
363\& http-proxy-port = 3128 # 8080 is another common choice 379\& http\-proxy\-port = 3128 # 8080 is another common choice
364\& http-proxy-auth = schmorp:grumbeere 380\& http\-proxy\-auth = schmorp:grumbeere
365.Ve 381.Ve
366.IP "http-proxy-port = proxy-tcp-port" 4 382.IP "http-proxy-port = proxy-tcp-port" 4
367.IX Item "http-proxy-port = proxy-tcp-port" 383.IX Item "http-proxy-port = proxy-tcp-port"
368The port where your proxy server listens. 384The port where your proxy server listens.
369.IP "http-proxy-auth = login:password" 4 385.IP "http-proxy-auth = login:password" 4
… …
397Not really a config setting but introduces a node section. The nickname is 413Not really a config setting but introduces a node section. The nickname is
398used to select the right configuration section and must be passed as an 414used to select the right configuration section and must be passed as an
399argument to the gvpe daemon. 415argument to the gvpe daemon.
400.IP "node-up = relative-or-absolute-path" 4 416.IP "node-up = relative-or-absolute-path" 4
401.IX Item "node-up = relative-or-absolute-path" 417.IX Item "node-up = relative-or-absolute-path"
402Sets a command (default: no script) that should be called whenever a 418Sets a command (default: none) that should be called whenever a connection
403connection is established (even on rekeying operations). In addition 419is established (even on rekeying operations). Note that node\-up/down
420scripts will be run asynchronously, but execution is serialised, so there
421will only ever be one such script running.
422.Sp
404to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 423In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
405variables will be set: 424environment variables will be set:
406.RS 4 425.RS 4
407.IP "DESTNODE=branch2" 4 426.IP "DESTNODE=branch2" 4
408.IX Item "DESTNODE=branch2" 427.IX Item "DESTNODE=branch2"
409The name of the remote node. 428The name of the remote node.
410.IP "DESTID=2" 4 429.IP "DESTID=2" 4
… …
431\& #!/bin/sh 450\& #!/bin/sh
432\& { 451\& {
433\& echo update delete $DESTNODE.lowttl.example.net. a 452\& echo update delete $DESTNODE.lowttl.example.net. a
434\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 453\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
435\& echo 454\& echo
436\& } | nsupdate -d -k $CONFBASE:key.example.net. 455\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
437.Ve 456.Ve
438.RE 457.RE
439.IP "node-down = relative-or-absolute-path" 4 458.IP "node-down = relative-or-absolute-path" 4
440.IX Item "node-down = relative-or-absolute-path" 459.IX Item "node-down = relative-or-absolute-path"
441Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 460Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
… …
458.IX Item "rekey = seconds" 477.IX Item "rekey = seconds"
459Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 478Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
460reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 479reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
461.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 480.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
462.IX Subsection "NODE SPECIFIC SETTINGS" 481.IX Subsection "NODE SPECIFIC SETTINGS"
463The following settings are node\-specific, that is, every node can have 482The following settings are node-specific, that is, every node can have
464different settings, even within the same gvpe instance. Settings that are 483different settings, even within the same gvpe instance. Settings that are
465executed before the first node section set the defaults, settings that are 484set before the first node section set the defaults, settings that are
466executed within a node section only apply to the given node. 485set within a node section only apply to the given node.
486.IP "allow-direct = nodename" 4
487.IX Item "allow-direct = nodename"
488Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
467.IP "compress = yes|true|on | no|false|off" 4 489.IP "compress = yes|true|on | no|false|off" 4
468.IX Item "compress = yes|true|on | no|false|off" 490.IX Item "compress = yes|true|on | no|false|off"
469Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 491Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
470Compression is really cheap even on slow computers and has no size 492Compression is really cheap even on slow computers and has no size
471overhead at all, so enabling this is a good idea. 493overhead at all, so enabling this is a good idea.
472.IP "connect = ondemand | never | always | disabled" 4 494.IP "connect = ondemand | never | always | disabled" 4
473.IX Item "connect = ondemand | never | always | disabled" 495.IX Item "connect = ondemand | never | always | disabled"
474Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 496Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
475try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 497try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR
476(never initiate a connection to the given host, but accept connections), 498(never initiate a connection to the given host, but accept connections),
477\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 499\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding
478take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 500packets in the queue and take it down after the keepalive interval) or
479don't talk to it). 501\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
502.IP "deny-direct = nodename | *" 4
503.IX Item "deny-direct = nodename | *"
504Deny 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
506\&\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.
508.Sp
509Sometimes, a node cannot reach some other nodes for reasons of network
510connectivity. For example, a node behind a firewall that only allows
511conenctions 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
513node \fImust\fR be a router for this to work).
514.Sp
515The algorithm to check wether a connection may be direct is as follows:
516.Sp
5171. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
518.Sp
5192. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
520.Sp
5213. Allow the connection.
522.Sp
523That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
524.Sp
525The check is done in both directions, i.e. both nodes must allow a direct
526connection before one is attempted, so you only need to specify connect
527limitations on one node.
480.IP "dns-domain = domain-suffix" 4 528.IP "dns-domain = domain-suffix" 4
481.IX Item "dns-domain = domain-suffix" 529.IX Item "dns-domain = domain-suffix"
482The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. 530The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
483.Sp 531.Sp
484The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 532The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
485i.e. 533i.e.
486.Sp 534.Sp
487.Vb 2 535.Vb 2
488\& dns-domainname = tunnel.example.net 536\& dns\-domainname = tunnel.example.net
489\& dns-hostname = tunnel-server.example.net 537\& dns\-hostname = tunnel\-server.example.net
490.Ve 538.Ve
491.Sp 539.Sp
492Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: 540Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
493.Sp 541.Sp
494.Vb 2 542.Vb 2
495\& tunnel.example.net. NS tunnel-server.example.net. 543\& tunnel.example.net. NS tunnel\-server.example.net.
496\& tunnel-server.example.net. A 13.13.13.13 544\& tunnel\-server.example.net. A 13.13.13.13
497.Ve 545.Ve
498.IP "dns-hostname = hostname/ip" 4 546.IP "dns-hostname = hostname/ip" 4
499.IX Item "dns-hostname = hostname/ip" 547.IX Item "dns-hostname = hostname/ip"
500The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, 548The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
501but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might 549but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
… …
539protocol is enabled automatically). 587protocol is enabled automatically).
540.Sp 588.Sp
541\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 589\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
542it might get switched on automatically, as some future version might 590it might get switched on automatically, as some future version might
543default to another default protocol. 591default to another default protocol.
592.IP "hostname = hostname | ip [can not be defaulted]" 4
593.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
595address. It will be resolved before each connect request, so dyndns should
596work 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,
598the connection attempt will fail.
544.IP "icmp-type = integer" 4 599.IP "icmp-type = integer" 4
545.IX Item "icmp-type = integer" 600.IX Item "icmp-type = integer"
546Sets the type value to be used for outgoing (and incoming) packets sent 601Sets the type value to be used for outgoing (and incoming) packets sent
547via the \s-1ICMP\s0 transport. 602via the \s-1ICMP\s0 transport.
548.Sp 603.Sp
549The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as 604The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
550\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. 605\&\*(L"ping-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
551\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. 606\&\*(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
608.IX Item "if-up-data = value"
609The 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.
552.IP "inherit-tos = yes|true|on | no|false|off" 4 611.IP "inherit-tos = yes|true|on | no|false|off" 4
553.IX Item "inherit-tos = yes|true|on | no|false|off" 612.IX Item "inherit-tos = yes|true|on | no|false|off"
554Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 613Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
555sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 614sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
556outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 615outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
… …
561retries to establish a connection to this node. When a connection cannot 620retries to establish a connection to this node. When a connection cannot
562be established, gvpe uses exponential backoff capped at this value. It's 621be established, gvpe uses exponential backoff capped at this value. It's
563sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 622sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
564connections to routers that usually are stable but sometimes are down, to 623connections to routers that usually are stable but sometimes are down, to
565assure quick reconnections even after longer downtimes. 624assure quick reconnections even after longer downtimes.
625.IP "max-ttl = seconds" 4
626.IX Item "max-ttl = seconds"
627Expire 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
629active connection, in the hope of establishing a connection soon. This
630value specifies the maximum lifetime a packet will stay in the queue, if a
631packet gets older, it will be thrown away.
632.IP "max-queue = positive-number" 4
633.IX Item "max-queue = positive-number"
634The 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
636expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
566.IP "router-priority = 0 | 1 | positive\-number>=2" 4 637.IP "router-priority = 0 | 1 | positive\-number>=2" 4
567.IX Item "router-priority = 0 | 1 | positive-number>=2" 638.IX Item "router-priority = 0 | 1 | positive-number>=2"
568Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 639Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
569some host tries to connect to another host without a hostname, it asks 640some host tries to connect to another host without a hostname, it asks
570the router host for it's \s-1IP\s0 address. The router host is the one with the 641the router host for it's \s-1IP\s0 address. The router host is the one with the
… …
588Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 659Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
589officially assigned by \s-1IANA\s0!). 660officially assigned by \s-1IANA\s0!).
590.SH "CONFIG DIRECTORY LAYOUT" 661.SH "CONFIG DIRECTORY LAYOUT"
591.IX Header "CONFIG DIRECTORY LAYOUT" 662.IX Header "CONFIG DIRECTORY LAYOUT"
592The default (or recommended) directory layout for the config directory is: 663The default (or recommended) directory layout for the config directory is:
593.IP "\(bu" 4 664.IP "" 4
594.IX Xref "gvpe.conf" 665.IX Xref "gvpe.conf"
595The config file. 666The config file.
596.IP "\(bu" 4 667.IP "" 4
597.IX Xref "if-up" 668.IX Xref "if-up"
598The if-up script 669The if-up script
599.IP "," 4 670.IP "," 4
600.IX Xref "node-up node-down" 671.IX Xref "node-up node-down"
601If used the node up or node-down scripts. 672If used the node up or node-down scripts.
602.IP "\(bu" 4 673.IP "" 4
603.IX Xref "hostkey" 674.IX Xref "hostkey"
604The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 675The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
605.IP "\(bu" 4 676.IP "" 4
606.IX Xref "pubkey nodename" 677.IX Xref "pubkey nodename"
607The public keys of the other nodes, one file per node. 678The public keys of the other nodes, one file per node.
608.SH "SEE ALSO" 679.SH "SEE ALSO"
609.IX Header "SEE ALSO" 680.IX Header "SEE ALSO"
610\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 681\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
611.SH "AUTHOR" 682.SH "AUTHOR"
612.IX Header "AUTHOR" 683.IX Header "AUTHOR"
613Marc Lehmann <gvpe@plan9.de> 684Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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