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.18 by pcg, Wed Nov 22 22:55:15 2006 UTC vs.
Revision 1.25 by pcg, Sat Jul 18 05:59:16 2009 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 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 "2006-11-22" "2.0" "GNU Virtual Private Ethernet" 135.TH GVPE.CONF 5 "2009-06-01" "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"
… …
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
… …
249.Sp 257.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If 258For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
251the link is very stable lower values (e.g. \f(CW2\fR) might work 259the link is very stable lower values (e.g. \f(CW2\fR) might work
252nicely. Values near or below \f(CW1\fR makes no sense whatsoever. 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 but will result in low 262The default should be working \s-1OK\s0 for most links but will result in low
255throughput if packet loss is high. 263throughput if packet loss is high.
256.IP "if-up = relative-or-absolute-path" 4 264.IP "if-up = relative-or-absolute-path" 4
257.IX Item "if-up = relative-or-absolute-path" 265.IX Item "if-up = relative-or-absolute-path"
258Sets 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
259network interface is initialized (but not neccessarily up). The following 267network interface is initialized (but not necessarily up). The following
260environment variables are passed to it (the values are just examples). 268environment variables are passed to it (the values are just examples).
261.Sp 269.Sp
262Variables that have the same value on all nodes: 270Variables that have the same value on all nodes:
263.RS 4 271.RS 4
264.IP "CONFBASE=/etc/gvpe" 4 272.IP "CONFBASE=/etc/gvpe" 4
… …
277\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to 285\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
278select the correct syntax to use for network-related commands. 286select the correct syntax to use for network-related commands.
279.IP "MTU=1436" 4 287.IP "MTU=1436" 4
280.IX Item "MTU=1436" 288.IX Item "MTU=1436"
281The \s-1MTU\s0 to set the interface to. You can use lower values (if done 289The \s-1MTU\s0 to set the interface to. You can use lower values (if done
282consistently on all hosts), but this is usually ineffective. 290consistently on all nodes), but this is usually either inefficient or
291simply ineffective.
283.IP "NODES=5" 4 292.IP "NODES=5" 4
284.IX Item "NODES=5" 293.IX Item "NODES=5"
285The number of nodes in this \s-1GVPE\s0 network. 294The number of nodes in this \s-1GVPE\s0 network.
286.RE 295.RE
287.RS 4 296.RS 4
… …
294.IP "MAC=fe:fd:80:00:00:01" 4 303.IP "MAC=fe:fd:80:00:00:01" 4
295.IX Item "MAC=fe:fd:80:00:00:01" 304.IX Item "MAC=fe:fd:80:00:00:01"
296The \s-1MAC\s0 address the network interface has to use. 305The \s-1MAC\s0 address the network interface has to use.
297.Sp 306.Sp
298Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not 307Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
299do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for 308do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR man page for
300platform-specific information. 309platform-specific information.
301.IP "NODENAME=branch1" 4 310.IP "NODENAME=branch1" 4
302.IX Item "NODENAME=branch1" 311.IX Item "NODENAME=branch1"
303The nickname of the node. 312The nickname of the node.
304.IP "NODEID=1" 4 313.IP "NODEID=1" 4
… …
321\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 330\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
322\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 331\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
323\& ip route add 10.0.0.0/8 dev $IFNAME 332\& ip route add 10.0.0.0/8 dev $IFNAME
324.Ve 333.Ve
325.Sp 334.Sp
326More complicated examples (using routing to reduce arp traffic) can be 335More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be
327found in the etc/ subdirectory of the distribution. 336found in the \fIetc/\fR subdirectory of the distribution.
328.RE 337.RE
329.IP "ifname = devname" 4 338.IP "ifname = devname" 4
330.IX Item "ifname = devname" 339.IX Item "ifname = devname"
331Sets 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
332and most probably something like \f(CW\*(C`tun0\*(C'\fR. 341and most probably something like \f(CW\*(C`tun0\*(C'\fR.
… …
339the 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
340device. 349device.
341.IP "ip-proto = numerical-ip-protocol" 4 350.IP "ip-proto = numerical-ip-protocol" 4
342.IX Item "ip-proto = numerical-ip-protocol" 351.IX Item "ip-proto = numerical-ip-protocol"
343Sets 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
344global option because all hosts must use the same protocol, and since 353global option because all nodes must use the same protocol, and since
345there 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
346instance using the same protocol, nor can you share the protocol with 355instance using the same protocol, nor can you share the protocol with
347other programs. 356other programs.
348.Sp 357.Sp
349The 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
350firewalls (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
351common 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
352(\s-1ENCAP\s0, rfc1241) 361(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241)
353.IP "http-proxy-host = hostname/ip" 4 362.IP "http-proxy-host = hostname/ip" 4
354.IX Item "http-proxy-host = hostname/ip" 363.IX Item "http-proxy-host = hostname/ip"
355The \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
356compiled 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
357tcp connections through a http proxy server. 366tcp connections through a http proxy server.
… …
359\&\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
360port 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
361requires authentication. 370requires authentication.
362.Sp 371.Sp
363Please 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
364configuration 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
365server better use numerical \s-1IP\s0 addresses. 374server better use numerical \s-1IP\s0 addresses.
366.Sp 375.Sp
367To 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
368config 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
369on 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).
370.Sp 379.Sp
371If 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
372enabled on all hosts. 381enabled on all nodes.
373.Sp 382.Sp
374Example: 383Example:
375.Sp 384.Sp
376.Vb 3 385.Vb 3
377\& http-proxy-host = proxy.example.com 386\& http\-proxy\-host = proxy.example.com
378\& http-proxy-port = 3128 # 8080 is another common choice 387\& http\-proxy\-port = 3128 # 8080 is another common choice
379\& http-proxy-auth = schmorp:grumbeere 388\& http\-proxy\-auth = schmorp:grumbeere
380.Ve 389.Ve
381.IP "http-proxy-port = proxy-tcp-port" 4 390.IP "http-proxy-port = proxy-tcp-port" 4
382.IX Item "http-proxy-port = proxy-tcp-port" 391.IX Item "http-proxy-port = proxy-tcp-port"
383The port where your proxy server listens. 392The port where your proxy server listens.
384.IP "http-proxy-auth = login:password" 4 393.IP "http-proxy-auth = login:password" 4
385.IX Item "http-proxy-auth = login:password" 394.IX Item "http-proxy-auth = login:password"
386The optional login and password used to authenticate to the proxy server, 395The optional login and password used to authenticate to the proxy server,
387seperated 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
388currently supported. 397currently supported.
389.IP "keepalive = seconds" 4 398.IP "keepalive = seconds" 4
390.IX Item "keepalive = seconds" 399.IX Item "keepalive = seconds"
391Sets 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
392many seconds of inactivity the daemon will start to send keepalive probe 401many seconds of inactivity the daemon will start to send keepalive probe
393every 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
394is received within 30 seconds, the peer is considered unreachable and the 403is received within 15 seconds, the peer is considered unreachable and the
395connection is closed. 404connection is closed.
396.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 405.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
397.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 406.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
398Set the logging level. Connection established messages are logged at level 407Set the logging level. Connection established messages are logged at level
399\&\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.
400.IP "mtu = bytes" 4 409.IP "mtu = bytes" 4
401.IX Item "mtu = bytes" 410.IX Item "mtu = bytes"
402Sets 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
403the \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
404maximum overhead (e.g. udp header size, encryption blocksize...) and pass 413maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass
405this information to the \f(CW\*(C`if\-up\*(C'\fR script. 414this information to the \f(CW\*(C`if\-up\*(C'\fR script.
406.Sp 415.Sp
407Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 416Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
408.Sp 417.Sp
409This 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.
410.IP "node = nickname" 4 419.IP "node = nickname" 4
411.IX Item "node = nickname" 420.IX Item "node = nickname"
412Not 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
413used 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
414argument to the gvpe daemon. 423argument to the gvpe daemon.
415.IP "node-up = relative-or-absolute-path" 4 424.IP "node-up = relative-or-absolute-path" 4
416.IX Item "node-up = relative-or-absolute-path" 425.IX Item "node-up = relative-or-absolute-path"
417Sets a command (default: no script) that should be called whenever a 426Sets a command (default: none) that should be called whenever a connection
418connection is established (even on rekeying operations). In addition to 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
419all 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
420variables will be set: 432environment variables will be set (values are just examples):
421.RS 4 433.RS 4
422.IP "DESTNODE=branch2" 4 434.IP "DESTNODE=branch2" 4
423.IX Item "DESTNODE=branch2" 435.IX Item "DESTNODE=branch2"
424The name of the remote node. 436The name of the remote node.
425.IP "DESTID=2" 4 437.IP "DESTID=2" 4
426.IX Item "DESTID=2" 438.IX Item "DESTID=2"
427The node id of the remote node. 439The node id of the remote node.
440.IP "DESTSI=rawip/88.99.77.55:0" 4
441.IX Item "DESTSI=rawip/88.99.77.55:0"
442The \*(L"socket info\*(R" of the target node, protocol dependent but usually in
443the format protocol/ip:port.
428.IP "DESTIP=188.13.66.8" 4 444.IP "DESTIP=188.13.66.8" 4
429.IX Item "DESTIP=188.13.66.8" 445.IX Item "DESTIP=188.13.66.8"
430The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from 446The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
431everywhere, as long as the other host can authenticate itself). 447everywhere, as long as the other node can authenticate itself).
432.IP "DESTPORT=655 # deprecated" 4 448.IP "DESTPORT=655 # deprecated" 4
433.IX Item "DESTPORT=655 # deprecated" 449.IX Item "DESTPORT=655 # deprecated"
434The \s-1UDP\s0 port used by the other side. 450The protocol port used by the other side, if applicable.
435.IP "STATE=UP" 4 451.IP "STATE=up" 4
436.IX Item "STATE=UP" 452.IX Item "STATE=up"
437Node-up scripts get called with STATE=UP, node-down scripts get called 453Node-up scripts get called with STATE=up, node-change scripts get called
438with STATE=DOWN. 454with STATE=change and node-down scripts get called with STATE=down.
439.RE 455.RE
440.RS 4 456.RS 4
441.Sp 457.Sp
442Here is a nontrivial example that uses nsupdate to update the name => ip 458Here is a nontrivial example that uses nsupdate to update the name => ip
443mapping in some dns zone: 459mapping in some \s-1DNS\s0 zone:
444.Sp 460.Sp
445.Vb 6 461.Vb 6
446\& #!/bin/sh 462\& #!/bin/sh
447\& { 463\& {
448\& echo update delete $DESTNODE.lowttl.example.net. a 464\& echo update delete $DESTNODE.lowttl.example.net. a
449\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 465\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
450\& echo 466\& echo
451\& } | nsupdate -d -k $CONFBASE:key.example.net. 467\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
452.Ve 468.Ve
453.RE 469.RE
470.IP "node-change = relative-or-absolute-path" 4
471.IX Item "node-change = relative-or-absolute-path"
472Same as \f(CW\*(C`node\-change\*(C'\fR, but gets called whenever something about a
473connection changes (such as the source \s-1IP\s0 address).
454.IP "node-down = relative-or-absolute-path" 4 474.IP "node-down = relative-or-absolute-path" 4
455.IX Item "node-down = relative-or-absolute-path" 475.IX Item "node-down = relative-or-absolute-path"
456Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 476Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
457.IP "pid-file = path" 4 477.IP "pid-file = path" 4
458.IX Item "pid-file = path" 478.IX Item "pid-file = path"
… …
465be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 485be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
466use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where 486use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
467\&\f(CW\*(C`gvpectrl\*(C'\fR puts them. 487\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
468.Sp 488.Sp
469Since only the private key file of the current node is used and the 489Since only the private key file of the current node is used and the
470private key file should be kept secret per-host to avoid spoofings, it is 490private key file should be kept secret per-node to avoid spoofing, it is
471not recommended to use this feature. 491not recommended to use this feature.
472.IP "rekey = seconds" 4 492.IP "rekey = seconds" 4
473.IX Item "rekey = seconds" 493.IX Item "rekey = seconds"
474Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 494Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
475reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 495reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
496key.
497.IP "nfmark = integer" 4
498.IX Item "nfmark = integer"
499This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries
500to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
501send packets.
502.Sp
503This can be used to make gvpe use a different set of routing rules. For
504example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then
505put all routing rules into table \f(CW99\fR and then use an ip rule to make
506gvpe traffic avoid that routing table, in effect routing normal traffic
507via gvpe and gvpe traffic via the normal system routing tables:
508.Sp
509.Vb 1
510\& ip rule add not fwmark 1000 lookup 99
511.Ve
476.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 512.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
477.IX Subsection "NODE SPECIFIC SETTINGS" 513.IX Subsection "NODE SPECIFIC SETTINGS"
478The following settings are node\-specific, that is, every node can have 514The following settings are node-specific, that is, every node can have
479different settings, even within the same gvpe instance. Settings that are 515different settings, even within the same gvpe instance. Settings that are
480set before the first node section set the defaults, settings that are 516set before the first node section set the defaults, settings that are
481set within a node section only apply to the given node. 517set within a node section only apply to the given node.
482.IP "allow-direct = nodename" 4 518.IP "allow-direct = nodename" 4
483.IX Item "allow-direct = nodename" 519.IX Item "allow-direct = nodename"
484Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. 520Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
485.IP "compress = yes|true|on | no|false|off" 4 521.IP "compress = yes|true|on | no|false|off" 4
486.IX Item "compress = yes|true|on | no|false|off" 522.IX Item "compress = yes|true|on | no|false|off"
487Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 523Wether to compress data packets sent to this node (default: \f(CW\*(C`yes\*(C'\fR).
488Compression is really cheap even on slow computers and has no size 524Compression is really cheap even on slow computers and has no size
489overhead at all, so enabling this is a good idea. 525overhead at all, so enabling this is often a good idea.
490.IP "connect = ondemand | never | always | disabled" 4 526.IP "connect = ondemand | never | always | disabled" 4
491.IX Item "connect = ondemand | never | always | disabled" 527.IX Item "connect = ondemand | never | always | disabled"
492Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 528Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
493try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 529try to establish and keep a connection to the given node), \f(CW\*(C`never\*(C'\fR
494(never initiate a connection to the given host, but accept connections), 530(never initiate a connection to the given host, but accept connections),
495\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 531\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection when there are outstanding
496take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 532packets in the queue and take it down after the keepalive interval) or
497don't talk to it). 533\&\f(CW\*(C`disabled\*(C'\fR (node is bad, don't talk to it).
534.Sp
535Routers will automatically be forced to \f(CW\*(C`always\*(C'\fR unless they are
536\&\f(CW\*(C`disabled\*(C'\fR, to ensure all nodes can talk to each other.
498.IP "deny-direct = nodename | *" 4 537.IP "deny-direct = nodename | *" 4
499.IX Item "deny-direct = nodename | *" 538.IX Item "deny-direct = nodename | *"
500Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR 539Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
501is given). Only one node can be specified, but you can use multiple 540is given). Only one node can be specified, but you can use multiple
502\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in 541\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
503networks with routers, as routers are required for indirect connections. 542networks with routers, as routers are required for indirect connections.
504.Sp 543.Sp
505Sometimes, a node cannot reach some other nodes for reasons of network 544Sometimes, a node cannot reach some other nodes for reasons of network
506connectivity. For example, a node behind a firewall that only allows 545connectivity. For example, a node behind a firewall that only allows
507conenctions to/from a single other node in the network. In this case one 546connections to/from a single other node in the network. In this case one
508should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other 547should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
509node \fImust\fR be a router for this to work). 548node \fImust\fR be a router for this to work).
510.Sp 549.Sp
511The algorithm to check wether a connection may be direct is as follows: 550The algorithm to check whether a connection may be direct is as follows:
512.Sp 551.Sp
5131. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. 5521. Other node mentioned in an \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
514.Sp 553.Sp
5152. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. 5542. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
516.Sp 555.Sp
5173. Allow the connection. 5563. Allow the connection.
518.Sp 557.Sp
… …
527.Sp 566.Sp
528The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 567The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
529i.e. 568i.e.
530.Sp 569.Sp
531.Vb 2 570.Vb 2
532\& dns-domainname = tunnel.example.net 571\& dns\-domainname = tunnel.example.net
533\& dns-hostname = tunnel-server.example.net 572\& dns\-hostname = tunnel\-server.example.net
534.Ve 573.Ve
535.Sp 574.Sp
536Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: 575Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
537.Sp 576.Sp
538.Vb 2 577.Vb 2
539\& tunnel.example.net. NS tunnel-server.example.net. 578\& tunnel.example.net. NS tunnel\-server.example.net.
540\& tunnel-server.example.net. A 13.13.13.13 579\& tunnel\-server.example.net. A 13.13.13.13
541.Ve 580.Ve
542.IP "dns-hostname = hostname/ip" 4 581.IP "dns-hostname = hostname/ip" 4
543.IX Item "dns-hostname = hostname/ip" 582.IX Item "dns-hostname = hostname/ip"
544The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, 583The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
545but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might 584but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
… …
557was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. 596was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
558.IP "enable-icmp = yes|true|on | no|false|off" 4 597.IP "enable-icmp = yes|true|on | no|false|off" 4
559.IX Item "enable-icmp = yes|true|on | no|false|off" 598.IX Item "enable-icmp = yes|true|on | no|false|off"
560See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. 599See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
561.Sp 600.Sp
562Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this 601Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
563node. 602node.
564.IP "enable-rawip = yes|true|on | no|false|off" 4 603.IP "enable-rawip = yes|true|on | no|false|off" 4
565.IX Item "enable-rawip = yes|true|on | no|false|off" 604.IX Item "enable-rawip = yes|true|on | no|false|off"
566See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. 605See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
567.Sp 606.Sp
… …
580.Sp 619.Sp
581Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 620Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
582unless no other protocol is enabled for a node, in which case this 621unless no other protocol is enabled for a node, in which case this
583protocol is enabled automatically). 622protocol is enabled automatically).
584.Sp 623.Sp
585\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 624\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though
586it might get switched on automatically, as some future version might 625it might get switched on automatically, as some future version might
587default to another default protocol. 626default to another default protocol.
588.IP "hostname = hostname | ip [can not be defaulted]" 4 627.IP "hostname = hostname | ip [can not be defaulted]" 4
589.IX Item "hostname = hostname | ip [can not be defaulted]" 628.IX Item "hostname = hostname | ip [can not be defaulted]"
590Forces the address of this node to be set to the given dns hostname or ip 629Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
591address. It will be resolved before each connect request, so dyndns should 630address. It will be resolved before each connect request, so dyndns should
592work fine. If this setting is not specified and a router is available, 631work fine. If this setting is not specified and a router is available,
593then the router will be queried for the address of this node. Otherwise, 632then the router will be queried for the address of this node. Otherwise,
594the connection attempt will fail. 633the connection attempt will fail.
634.Sp
635Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that
636is an issue you need to specify \s-1IP\s0 addresses.
595.IP "icmp-type = integer" 4 637.IP "icmp-type = integer" 4
596.IX Item "icmp-type = integer" 638.IX Item "icmp-type = integer"
597Sets the type value to be used for outgoing (and incoming) packets sent 639Sets the type value to be used for outgoing (and incoming) packets sent
598via the \s-1ICMP\s0 transport. 640via the \s-1ICMP\s0 transport.
599.Sp 641.Sp
600The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as 642The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
601\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. 643\&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
602\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. 644\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
603.IP "if-up-data = value" 4 645.IP "if-up-data = value" 4
604.IX Item "if-up-data = value" 646.IX Item "if-up-data = value"
605The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR 647The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
606script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. 648script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
… …
612to the tunnel device, which is usually what you want. 654to the tunnel device, which is usually what you want.
613.IP "max-retry = positive-number" 4 655.IP "max-retry = positive-number" 4
614.IX Item "max-retry = positive-number" 656.IX Item "max-retry = positive-number"
615The maximum interval in seconds (default: \f(CW3600\fR, one hour) between 657The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
616retries to establish a connection to this node. When a connection cannot 658retries to establish a connection to this node. When a connection cannot
617be established, gvpe uses exponential backoff capped at this value. It's 659be established, gvpe uses exponential back-off capped at this value. It's
618sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 660sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
619connections to routers that usually are stable but sometimes are down, to 661connections to routers that usually are stable but sometimes are down, to
620assure quick reconnections even after longer downtimes. 662assure quick reconnections even after longer downtimes.
663.IP "max-ttl = seconds" 4
664.IX Item "max-ttl = seconds"
665Expire packets that couldn't be sent after this many seconds
666(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
667active connection, in the hope of establishing a connection soon. This
668value specifies the maximum lifetime a packet will stay in the queue, if a
669packet gets older, it will be thrown away.
670.IP "max-queue = positive\-number>=1" 4
671.IX Item "max-queue = positive-number>=1"
672The maximum number of packets that will be queued (default: \f(CW512\fR)
673for this node. If more packets are sent then earlier packets will be
674expired. See \f(CW\*(C`max\-ttl\*(C'\fR, above.
621.IP "router-priority = 0 | 1 | positive\-number>=2" 4 675.IP "router-priority = 0 | 1 | positive\-number>=2" 4
622.IX Item "router-priority = 0 | 1 | positive-number>=2" 676.IX Item "router-priority = 0 | 1 | positive-number>=2"
623Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 677Sets the router priority of the given node (default: \f(CW0\fR, disabled).
624some host tries to connect to another host without a hostname, it asks
625the router host for it's \s-1IP\s0 address. The router host is the one with the
626highest priority larger than \f(CW1\fR that is currently reachable.
627.Sp 678.Sp
628Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router 679If some node tries to connect to another node but it doesn't have a
629hosts, otherwise connecting to them might be impossible. 680hostname, it asks a router node for it's \s-1IP\s0 address. The router node
681chosen is the one with the highest priority larger than \f(CW1\fR that is
682currently reachable. This is called a \fImediated\fR connection, as the
683connection itself will still be direct, but it uses another node to
684mediate between the two nodes.
685.Sp
686The value \f(CW0\fR disables routing, that means if the node receives a packet
687not for itself it will not forward it but instead drop it.
630.Sp 688.Sp
631The special value \f(CW1\fR allows other hosts to route through the router 689The special value \f(CW1\fR allows other hosts to route through the router
632host, but they will never route through it by default. The value \f(CW0\fR 690host, but they will never route through it by default (i.e. the config
633disables routing. The idea behind this is that some hosts can, if 691file of another node needs to specify a router priority higher than one
692to choose such a node for routing).
693.Sp
694The idea behind this is that some hosts can, if required, bump the
634required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their 695\&\f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their local config to
635local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is 696route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is \f(CW0\fR, then routing
636\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do 697will be refused, so \f(CW1\fR serves as a \*(L"enable, but do not use by default\*(R"
637not use by default\*(R" switch. 698switch.
699.Sp
700Nodes with \f(CW\*(C`router\-priority\*(C'\fR set to \f(CW2\fR or higher will always be forced
701to \f(CW\*(C`connect\*(C'\fR = \f(CW\*(C`always\*(C'\fR (unless they are \f(CW\*(C`disabled\*(C'\fR).
638.IP "tcp-port = port-number" 4 702.IP "tcp-port = port-number" 4
639.IX Item "tcp-port = port-number" 703.IX Item "tcp-port = port-number"
640Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. 704Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
641.IP "udp-port = port-number" 4 705.IP "udp-port = port-number" 4
642.IX Item "udp-port = port-number" 706.IX Item "udp-port = port-number"
643Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not 707Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
644officially assigned by \s-1IANA\s0!). 708officially assigned by \s-1IANA\s0!).
645.SH "CONFIG DIRECTORY LAYOUT" 709.SH "CONFIG DIRECTORY LAYOUT"
646.IX Header "CONFIG DIRECTORY LAYOUT" 710.IX Header "CONFIG DIRECTORY LAYOUT"
647The default (or recommended) directory layout for the config directory is: 711The default (or recommended) directory layout for the config directory is:
648.IP "\(bu" 4 712.IP "gvpe.conf" 4
649.IX Xref "gvpe.conf" 713.IX Item "gvpe.conf"
650The config file. 714The config file.
651.IP "\(bu" 4 715.IP "if-up" 4
652.IX Xref "if-up" 716.IX Item "if-up"
653The if-up script 717The if-up script
654.IP "," 4 718.IP "node-up, node-down" 4
655.IX Xref "node-up node-down" 719.IX Item "node-up, node-down"
656If used the node up or node-down scripts. 720If used the node up or node-down scripts.
657.IP "\(bu" 4 721.IP "hostkey" 4
658.IX Xref "hostkey" 722.IX Item "hostkey"
659The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 723The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
660.IP "\(bu" 4 724.IP "pubkey/nodename" 4
661.IX Xref "pubkey nodename" 725.IX Item "pubkey/nodename"
662The public keys of the other nodes, one file per node. 726The public keys of the other nodes, one file per node.
663.SH "SEE ALSO" 727.SH "SEE ALSO"
664.IX Header "SEE ALSO" 728.IX Header "SEE ALSO"
665\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 729\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
666.SH "AUTHOR" 730.SH "AUTHOR"

Diff Legend

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