ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.conf.5
(Generate patch)

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.6 by pcg, Thu Mar 3 07:24:57 2005 UTC vs.
Revision 1.11 by pcg, Thu Mar 17 23:59:37 2005 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "GVPE.CONF 5" 131.IX Title "GVPE.CONF 5"
132.TH GVPE.CONF 5 "2005-03-01" "1.7" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2005-03-17" "1.8" "GNU Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 134gvpe.conf \- configuration file for the GNU VPE daemon
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 3 137.Vb 3
… …
194.IX Subsection "GLOBAL SETTINGS" 194.IX Subsection "GLOBAL SETTINGS"
195Global settings will affect the behaviour of the running gvpe daemon, that 195Global settings will affect the behaviour of the running gvpe daemon, that
196is, they are in some sense node-specific (config files can set different 196is, 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 197values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of
198the gvpe daemon and all connections it creates. 198the gvpe daemon and all connections it creates.
199.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 199.IP "dns-forw-host = hostname/ip" 4
200.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 200.IX Item "dns-forw-host = hostname/ip"
201Set the logging level. Connection established messages are logged at level 201The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol
202\&\f(CW\*(C`info\*(C'\fR, notable errors are logged with \f(CW\*(C`error\*(C'\fR. Default is \f(CW\*(C`info\*(C'\fR. 202(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
203.IP "node = nickname" 4 203.IP "dns-forw-port = port-number" 4
204.IX Item "node = nickname" 204.IX Item "dns-forw-port = port-number"
205Not really a config setting but introduces a node section. The nickname is 205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
206used to select the right configuration section and must be passed as an 206which is fine in most cases).
207argument to the gvpe daemon.
208.IP "private-key = relative-path-to-key" 4
209.IX Item "private-key = relative-path-to-key"
210Sets the path (relative to the config directory) to the private key
211(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must
212be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
213use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
214\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
215.Sp
216Since only the private key file of the current node is used and the
217private key file should be kept secret per-host to avoid spoofings, it is
218not recommended to use this feature.
219.IP "ifpersist = yes|true|on | no|false|off" 4
220.IX Item "ifpersist = yes|true|on | no|false|off"
221Should the tun/tap device be made persistent, that is, should the device
222stay up even when gvpe exits? Some versions of the tunnel device have
223problems sending packets when gvpe is restarted in persistent mode, so
224if the connections can be established but you cannot send packets from
225the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
226device.
227.IP "ifname = devname" 4
228.IX Item "ifname = devname"
229Sets the tun interface name to the given name. The default is OS-specific
230and most probably something like \f(CW\*(C`tun0\*(C'\fR.
231.IP "rekey = seconds" 4
232.IX Item "rekey = seconds"
233Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
234reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
235.IP "keepalive = seconds" 4
236.IX Item "keepalive = seconds"
237Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
238many seconds of inactivity the daemon will start to send keepalive probe
239every 5 seconds until it receives a reply from the other end. If no reply
240is received within 30 seconds, the peer is considered unreachable and the
241connection is closed.
242.IP "mtu = bytes" 4
243.IX Item "mtu = bytes"
244Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
245the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
246maximum overhead (e.g. udp header size, encryption blocksize...) and pass
247this information to the \f(CW\*(C`if\-up\*(C'\fR script.
248.Sp
249Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
250.Sp
251This value must be the minimum of the mtu values of all hosts.
252.IP "ip-proto = numerical-ip-protocol" 4
253.IX Item "ip-proto = numerical-ip-protocol"
254Sets the protocol number to be used for the rawip protocol. This is a
255global option because all hosts must use the same protocol, and since
256there are no port numbers, you cannot easily run more than one gvpe
257instance using the same protocol, nor can you share the protocol with
258other programs.
259.Sp
260The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
261firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
262common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
263(\s-1ENCAP\s0, rfc1241)
264.IP "if-up = relative-or-absolute-path" 4 207.IP "if-up = relative-or-absolute-path" 4
265.IX Item "if-up = relative-or-absolute-path" 208.IX Item "if-up = relative-or-absolute-path"
266Sets the path of a script that should be called immediately after the 209Sets the path of a script that should be called immediately after the
267network interface is initialized (but not neccessarily up). The following 210network interface is initialized (but not neccessarily up). The following
268environment variables are passed to it (the values are just examples): 211environment variables are passed to it (the values are just examples):
… …
318.Ve 261.Ve
319.Sp 262.Sp
320More complicated examples (using routing to reduce arp traffic) can be 263More complicated examples (using routing to reduce arp traffic) can be
321found in the etc/ subdirectory of the distribution. 264found in the etc/ subdirectory of the distribution.
322.RE 265.RE
266.IP "ifname = devname" 4
267.IX Item "ifname = devname"
268Sets the tun interface name to the given name. The default is OS-specific
269and most probably something like \f(CW\*(C`tun0\*(C'\fR.
270.IP "ifpersist = yes|true|on | no|false|off" 4
271.IX Item "ifpersist = yes|true|on | no|false|off"
272Should the tun/tap device be made persistent, that is, should the device
273stay up even when gvpe exits? Some versions of the tunnel device have
274problems sending packets when gvpe is restarted in persistent mode, so
275if the connections can be established but you cannot send packets from
276the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
277device.
278.IP "ip-proto = numerical-ip-protocol" 4
279.IX Item "ip-proto = numerical-ip-protocol"
280Sets the protocol number to be used for the rawip protocol. This is a
281global option because all hosts must use the same protocol, and since
282there are no port numbers, you cannot easily run more than one gvpe
283instance using the same protocol, nor can you share the protocol with
284other programs.
285.Sp
286The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
287firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
288common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
289(\s-1ENCAP\s0, rfc1241)
290.IP "http-proxy-host = hostname/ip" 4
291.IX Item "http-proxy-host = hostname/ip"
292The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was
293compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
294tcp connections through a http proxy server.
295.Sp
296\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
297port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
298requires authentication.
299.Sp
300Please note that gvpe will still try to resolve all hostnames in the
301configuration file, so if you are behind a proxy without access to a dns
302server better use numerical \s-1IP\s0 addresses.
303.Sp
304To make best use of this option disable all protocols except tcp in your
305config file and make sure your routers (or all other hosts) are listening
306on a port that the proxy allows (443, https, is a common choice).
307.Sp
308If you have a router, connecting to it will suffice. Otherwise tcp must be
309enabled on all hosts.
310.Sp
311Example:
312.Sp
313.Vb 3
314\& http-proxy-host = proxy.example.com
315\& http-proxy-port = 3128 # 8080 is another common choice
316\& http-proxy-auth = schmorp:grumbeere
317.Ve
318.IP "http-proxy-port = proxy-tcp-port" 4
319.IX Item "http-proxy-port = proxy-tcp-port"
320The port where your proxy server listens.
321.IP "http-proxy-auth = login:password" 4
322.IX Item "http-proxy-auth = login:password"
323The optional login and password used to authenticate to the proxy server,
324seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
325currently supported.
326.IP "keepalive = seconds" 4
327.IX Item "keepalive = seconds"
328Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
329many seconds of inactivity the daemon will start to send keepalive probe
330every 5 seconds until it receives a reply from the other end. If no reply
331is received within 30 seconds, the peer is considered unreachable and the
332connection is closed.
333.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
334.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
335Set the logging level. Connection established messages are logged at level
336\&\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.
337.IP "mtu = bytes" 4
338.IX Item "mtu = bytes"
339Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
340the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
341maximum overhead (e.g. udp header size, encryption blocksize...) and pass
342this information to the \f(CW\*(C`if\-up\*(C'\fR script.
343.Sp
344Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
345.Sp
346This value must be the minimum of the mtu values of all hosts.
347.IP "node = nickname" 4
348.IX Item "node = nickname"
349Not really a config setting but introduces a node section. The nickname is
350used to select the right configuration section and must be passed as an
351argument to the gvpe daemon.
323.IP "node-up = relative-or-absolute-path" 4 352.IP "node-up = relative-or-absolute-path" 4
324.IX Item "node-up = relative-or-absolute-path" 353.IX Item "node-up = relative-or-absolute-path"
325Sets a command (default: no script) that should be called whenever a 354Sets a command (default: no script) that should be called whenever a
326connection is established (even on rekeying operations). In addition 355connection is established (even on rekeying operations). In addition
327to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 356to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment
… …
360.Ve 389.Ve
361.RE 390.RE
362.IP "node-down = relative-or-absolute-path" 4 391.IP "node-down = relative-or-absolute-path" 4
363.IX Item "node-down = relative-or-absolute-path" 392.IX Item "node-down = relative-or-absolute-path"
364Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 393Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
365.IP "http-proxy-host = hostname/ip" 4
366.IX Item "http-proxy-host = hostname/ip"
367The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was
368compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
369tcp connections through a http proxy server.
370.Sp
371\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
372port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
373requires authentication.
374.Sp
375Please note that gvpe will still try to resolve all hostnames in the
376configuration file, so if you are behind a proxy without access to a dns
377server better use numerical \s-1IP\s0 addresses.
378.Sp
379To make best use of this option disable all protocols except tcp in your
380config file and make sure your routers (or all other hosts) are listening
381on a port that the proxy allows (443, https, is a common choice).
382.Sp
383If you have a router, connecting to it will suffice. Otherwise tcp must be
384enabled on all hosts.
385.Sp
386Example:
387.Sp
388.Vb 3
389\& http-proxy-host = proxy.example.com
390\& http-proxy-port = 3128 # 8080 is another common choice
391\& http-proxy-auth = schmorp:grumbeere
392.Ve
393.IP "http-proxy-port = proxy-tcp-port" 4
394.IX Item "http-proxy-port = proxy-tcp-port"
395The port where your proxy server listens.
396.IP "http-proxy-auth = login:password" 4
397.IX Item "http-proxy-auth = login:password"
398The optional login and password used to authenticate to the proxy server,
399seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
400currently supported.
401.IP "pid-file = path" 4 394.IP "pid-file = path" 4
402.IX Item "pid-file = path" 395.IX Item "pid-file = path"
403The path to the pid file to check and create (Default: 396The path to the pid file to check and create
397(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR).
398.IP "private-key = relative-path-to-key" 4
399.IX Item "private-key = relative-path-to-key"
400Sets the path (relative to the config directory) to the private key
401(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must
402be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
403use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
404\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
405.Sp
406Since only the private key file of the current node is used and the
407private key file should be kept secret per-host to avoid spoofings, it is
408not recommended to use this feature.
409.IP "rekey = seconds" 4
410.IX Item "rekey = seconds"
411Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
412reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
404.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 413.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
405.IX Subsection "NODE SPECIFIC SETTINGS" 414.IX Subsection "NODE SPECIFIC SETTINGS"
406The following settings are node\-specific, that is, every node can have 415The following settings are node\-specific, that is, every node can have
407different settings, even within the same gvpe instance. Settings that are 416different settings, even within the same gvpe instance. Settings that are
408executed before the first node section set the defaults, settings that are 417executed before the first node section set the defaults, settings that are
409executed within a node section only apply to the given node. 418executed within a node section only apply to the given node.
410.IP "udp-port = port-number" 4
411.IX Item "udp-port = port-number"
412Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
413officially assigned by \s-1IANA\s0!).
414.IP "tcp-port = port-number" 4
415.IX Item "tcp-port = port-number"
416Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
417.IP "enable-rawip = yes|true|on | no|false|off" 4
418.IX Item "enable-rawip = yes|true|on | no|false|off"
419Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
420(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet
421is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
422.IP "enable-udp = yes|true|on | no|false|off" 4 419.IP "compress = yes|true|on | no|false|off" 4
423.IX Item "enable-udp = yes|true|on | no|false|off" 420.IX Item "compress = yes|true|on | no|false|off"
424Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 421Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
425unless no other protocol is enabled for a node, in which case this 422Compression is really cheap even on slow computers and has no size
426protocol is enabled automatically). This is a good general choice since 423overhead at all, so enabling this is a good idea.
427\&\s-1UDP\s0 tunnels well through many firewalls.
428.Sp
429\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
430it might get switched on automatically, as some future version might
431default to another default protocol.
432.IP "enable-tcp = yes|true|on | no|false|off" 4
433.IX Item "enable-tcp = yes|true|on | no|false|off"
434Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
435(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only
436available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never
437use this transport unless you really must, it is horribly ineffiecent and
438resource-intensive compared to the other transports.
439.IP "router-priority = 0 | 1 | positive\-number>2" 4
440.IX Item "router-priority = 0 | 1 | positive-number>2"
441Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
442some host tries to connect to another host without a hostname, it asks
443the router host for it's \s-1IP\s0 address. The router host is the one with the
444highest priority larger than \f(CW1\fR that is currently reachable.
445.Sp
446Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router
447hosts, otherwise connecting to them might be impossible.
448.Sp
449The special value \f(CW1\fR allows other hosts to route through the router
450host, but they will never route through it by default. The value \f(CW0\fR
451disables routing. The idea behind this is that some hosts can, if
452required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their
453local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is
454\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do
455not use by default\*(R" switch.
456.IP "connect = ondemand | never | always | disabled" 4 424.IP "connect = ondemand | never | always | disabled" 4
457.IX Item "connect = ondemand | never | always | disabled" 425.IX Item "connect = ondemand | never | always | disabled"
458Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always 426Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always
459try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 427try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR
460(never initiate a connection to the given host, but accept connections), 428(never initiate a connection to the given host, but accept connections),
461\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 429\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and
462take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 430take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
463don't talk to it). 431don't talk to it).
432.IP "dns-domain = domain-suffix" 4
433.IX Item "dns-domain = domain-suffix"
434The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
435.Sp
436The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
437i.e.
438.Sp
439.Vb 2
440\& dns-domainname = tunnel.example.net
441\& dns-hostname = tunnel-server.example.net
442.Ve
443.Sp
444Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
445.Sp
446.Vb 2
447\& tunnel.example.net. NS tunnel-server.example.net.
448\& tunnel-server.example.net. A 13.13.13.13
449.Ve
450.IP "dns-hostname = hostname/ip" 4
451.IX Item "dns-hostname = hostname/ip"
452The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
453but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
454change.
455.IP "dns-port = port-number" 4
456.IX Item "dns-port = port-number"
457The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
458.IP "enable-dns = yes|true|on | no|false|off" 4
459.IX Item "enable-dns = yes|true|on | no|false|off"
460See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport
461protocol. Avoid this protocol if you can.
462.Sp
463Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
464client. Support for this transport protocol is only available when gvpe
465was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
466.IP "enable-icmp = yes|true|on | no|false|off" 4
467.IX Item "enable-icmp = yes|true|on | no|false|off"
468See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
469.Sp
470Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
471node.
472.IP "enable-rawip = yes|true|on | no|false|off" 4
473.IX Item "enable-rawip = yes|true|on | no|false|off"
474See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
475.Sp
476Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
477(default: \f(CW\*(C`no\*(C'\fR).
478.IP "enable-tcp = yes|true|on | no|false|off" 4
479.IX Item "enable-tcp = yes|true|on | no|false|off"
480See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol.
481.Sp
482Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
483(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available
484when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
485.IP "enable-udp = yes|true|on | no|false|off" 4
486.IX Item "enable-udp = yes|true|on | no|false|off"
487See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
488.Sp
489Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
490unless no other protocol is enabled for a node, in which case this
491protocol is enabled automatically).
492.Sp
493\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
494it might get switched on automatically, as some future version might
495default to another default protocol.
496.IP "icmp-type = integer" 4
497.IX Item "icmp-type = integer"
498Sets the type value to be used for outgoing (and incoming) packets sent
499via the \s-1ICMP\s0 transport.
500.Sp
501The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
502\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
503\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
464.IP "inherit-tos = yes|true|on | no|false|off" 4 504.IP "inherit-tos = yes|true|on | no|false|off" 4
465.IX Item "inherit-tos = yes|true|on | no|false|off" 505.IX Item "inherit-tos = yes|true|on | no|false|off"
466Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 506Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
467sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 507sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
468outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 508outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
469to the tunnel device, which is usually what you want. 509to the tunnel device, which is usually what you want.
470.IP "compress = yes|true|on | no|false|off" 4
471.IX Item "compress = yes|true|on | no|false|off"
472Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
473Compression is really cheap even on slow computers and has no size
474overhead at all, so enabling this is a good idea.
475.IP "max-retry = positive-number" 4 510.IP "max-retry = positive-number" 4
476.IX Item "max-retry = positive-number" 511.IX Item "max-retry = positive-number"
477The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between 512The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
478retries to establish a connection to this node. When a connection cannot 513retries to establish a connection to this node. When a connection cannot
479be established, gvpe uses exponential backoff capped at this value. It's 514be established, gvpe uses exponential backoff capped at this value. It's
480sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 515sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
481connections to routers that usually are stable but sometimes are down, to 516connections to routers that usually are stable but sometimes are down, to
482assure quick reconnections. 517assure quick reconnections even after longer downtimes.
518.IP "router-priority = 0 | 1 | positive\-number>=2" 4
519.IX Item "router-priority = 0 | 1 | positive-number>=2"
520Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
521some host tries to connect to another host without a hostname, it asks
522the router host for it's \s-1IP\s0 address. The router host is the one with the
523highest priority larger than \f(CW1\fR that is currently reachable.
524.Sp
525Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router
526hosts, otherwise connecting to them might be impossible.
527.Sp
528The special value \f(CW1\fR allows other hosts to route through the router
529host, but they will never route through it by default. The value \f(CW0\fR
530disables routing. The idea behind this is that some hosts can, if
531required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their
532local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is
533\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do
534not use by default\*(R" switch.
535.IP "tcp-port = port-number" 4
536.IX Item "tcp-port = port-number"
537Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
538.IP "udp-port = port-number" 4
539.IX Item "udp-port = port-number"
540Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
541officially assigned by \s-1IANA\s0!).
483.SH "CONFIG DIRECTORY LAYOUT" 542.SH "CONFIG DIRECTORY LAYOUT"
484.IX Header "CONFIG DIRECTORY LAYOUT" 543.IX Header "CONFIG DIRECTORY LAYOUT"
485The default (or recommended) directory layout for the config directory is: 544The default (or recommended) directory layout for the config directory is:
486.IP "\(bu" 4 545.IP "\(bu" 4
487.IX Xref "gvpe.conf" 546.IX Xref "gvpe.conf"

Diff Legend

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