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

Diff Legend

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