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.13 by pcg, Wed Mar 23 21:55:39 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-23" "1.9" "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. 207.IP "dns-max-outstanding = integer-number-of-requests" 4
208.IP "private-key = relative-path-to-key" 4 208.IX Item "dns-max-outstanding = integer-number-of-requests"
209.IX Item "private-key = relative-path-to-key" 209The maximum number of outstanding \s-1DNS\s0 transport requests
210Sets the path (relative to the config directory) to the private key 210(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
211(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must 211limit without receiving replies. In heavily overloaded situations it might
212be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could 212help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
213use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where 213number of parallel requests.
214\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
215.Sp 214.Sp
216Since only the private key file of the current node is used and the 215The default should be working ok for most links.
217private key file should be kept secret per-host to avoid spoofings, it is 216.IP "dns-overlap-factor = float" 4
218not recommended to use this feature. 217.IX Item "dns-overlap-factor = float"
219.IP "ifpersist = yes|true|on | no|false|off" 4 218The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
220.IX Item "ifpersist = yes|true|on | no|false|off" 219during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
221Should the tun/tap device be made persistent, that is, should the device 220must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
222stay up even when gvpe exits? Some versions of the tunnel device have 221rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
223problems sending packets when gvpe is restarted in persistent mode, so 222request might be generated every \fBmin_latency\fR seconds, which means on
224if the connections can be established but you cannot send packets from 223average there should only ever be one outstanding request. A factor of
225the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the 224\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
226device. 225latency measured.
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 226.Sp
249Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 227For congested or picky dns forwarders you could use a value nearer to or
228exceeding \f(CW1\fR.
250.Sp 229.Sp
251This value must be the minimum of the mtu values of all hosts. 230The default should be working ok for most links.
252.IP "ip-proto = numerical-ip-protocol" 4 231.IP "dns-send-interval = send-interval-in-seconds" 4
253.IX Item "ip-proto = numerical-ip-protocol" 232.IX Item "dns-send-interval = send-interval-in-seconds"
254Sets the protocol number to be used for the rawip protocol. This is a 233The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
255global option because all hosts must use the same protocol, and since 234use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
256there are no port numbers, you cannot easily run more than one gvpe 235the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
257instance using the same protocol, nor can you share the protocol with 236not send more than 100 \s-1DNS\s0 requests per connection per second. For
258other programs. 237high-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,
239\&\f(CW0.2\fR or even higher.
259.Sp 240.Sp
260The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 241The default should be working ok for most links.
261firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other 242.IP "dns-timeout-factor = float" 4
262common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 243.IX Item "dns-timeout-factor = float"
263(\s-1ENCAP\s0, rfc1241) 244Factor 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
246will resend the request when no reply has been received for longer than
247eight times the minimum (= expected) latency, assuming the request or
248reply has been lost.
249.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the
251link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values
252near or below \f(CW1\fR makes no sense whatsoever.
253.Sp
254The default should be working ok for most links.
264.IP "if-up = relative-or-absolute-path" 4 255.IP "if-up = relative-or-absolute-path" 4
265.IX Item "if-up = relative-or-absolute-path" 256.IX Item "if-up = relative-or-absolute-path"
266Sets the path of a script that should be called immediately after the 257Sets the path of a script that should be called immediately after the
267network interface is initialized (but not neccessarily up). The following 258network interface is initialized (but not neccessarily up). The following
268environment variables are passed to it (the values are just examples): 259environment variables are passed to it (the values are just examples):
… …
318.Ve 309.Ve
319.Sp 310.Sp
320More complicated examples (using routing to reduce arp traffic) can be 311More complicated examples (using routing to reduce arp traffic) can be
321found in the etc/ subdirectory of the distribution. 312found in the etc/ subdirectory of the distribution.
322.RE 313.RE
314.IP "ifname = devname" 4
315.IX Item "ifname = devname"
316Sets the tun interface name to the given name. The default is OS-specific
317and most probably something like \f(CW\*(C`tun0\*(C'\fR.
318.IP "ifpersist = yes|true|on | no|false|off" 4
319.IX Item "ifpersist = yes|true|on | no|false|off"
320Should the tun/tap device be made persistent, that is, should the device
321stay up even when gvpe exits? Some versions of the tunnel device have
322problems sending packets when gvpe is restarted in persistent mode, so
323if the connections can be established but you cannot send packets from
324the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
325device.
326.IP "ip-proto = numerical-ip-protocol" 4
327.IX Item "ip-proto = numerical-ip-protocol"
328Sets 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
330there are no port numbers, you cannot easily run more than one gvpe
331instance using the same protocol, nor can you share the protocol with
332other programs.
333.Sp
334The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
335firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
336common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
337(\s-1ENCAP\s0, rfc1241)
338.IP "http-proxy-host = hostname/ip" 4
339.IX Item "http-proxy-host = hostname/ip"
340The \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
342tcp connections through a http proxy server.
343.Sp
344\&\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
346requires authentication.
347.Sp
348Please 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
350server better use numerical \s-1IP\s0 addresses.
351.Sp
352To make best use of this option disable all protocols except tcp in your
353config file and make sure your routers (or all other hosts) are listening
354on a port that the proxy allows (443, https, is a common choice).
355.Sp
356If you have a router, connecting to it will suffice. Otherwise tcp must be
357enabled on all hosts.
358.Sp
359Example:
360.Sp
361.Vb 3
362\& http-proxy-host = proxy.example.com
363\& http-proxy-port = 3128 # 8080 is another common choice
364\& http-proxy-auth = schmorp:grumbeere
365.Ve
366.IP "http-proxy-port = proxy-tcp-port" 4
367.IX Item "http-proxy-port = proxy-tcp-port"
368The port where your proxy server listens.
369.IP "http-proxy-auth = login:password" 4
370.IX Item "http-proxy-auth = login:password"
371The 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
373currently supported.
374.IP "keepalive = seconds" 4
375.IX Item "keepalive = seconds"
376Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
377many 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
379is received within 30 seconds, the peer is considered unreachable and the
380connection is closed.
381.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
382.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
383Set 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.
385.IP "mtu = bytes" 4
386.IX Item "mtu = bytes"
387Sets 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
389maximum overhead (e.g. udp header size, encryption blocksize...) and pass
390this information to the \f(CW\*(C`if\-up\*(C'\fR script.
391.Sp
392Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
393.Sp
394This value must be the minimum of the mtu values of all hosts.
395.IP "node = nickname" 4
396.IX Item "node = nickname"
397Not 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
399argument to the gvpe daemon.
323.IP "node-up = relative-or-absolute-path" 4 400.IP "node-up = relative-or-absolute-path" 4
324.IX Item "node-up = relative-or-absolute-path" 401.IX Item "node-up = relative-or-absolute-path"
325Sets a command (default: no script) that should be called whenever a 402Sets a command (default: no script) that should be called whenever a
326connection is established (even on rekeying operations). In addition 403connection is established (even on rekeying operations). In addition
327to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 404to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment
… …
360.Ve 437.Ve
361.RE 438.RE
362.IP "node-down = relative-or-absolute-path" 4 439.IP "node-down = relative-or-absolute-path" 4
363.IX Item "node-down = relative-or-absolute-path" 440.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. 441Same 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 442.IP "pid-file = path" 4
402.IX Item "pid-file = path" 443.IX Item "pid-file = path"
403The path to the pid file to check and create (Default: 444The path to the pid file to check and create
445(default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR).
446.IP "private-key = relative-path-to-key" 4
447.IX Item "private-key = relative-path-to-key"
448Sets the path (relative to the config directory) to the private key
449(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must
450be 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
452\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
453.Sp
454Since 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
456not recommended to use this feature.
457.IP "rekey = seconds" 4
458.IX Item "rekey = seconds"
459Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
460reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
404.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 461.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
405.IX Subsection "NODE SPECIFIC SETTINGS" 462.IX Subsection "NODE SPECIFIC SETTINGS"
406The following settings are node\-specific, that is, every node can have 463The following settings are node\-specific, that is, every node can have
407different settings, even within the same gvpe instance. Settings that are 464different settings, even within the same gvpe instance. Settings that are
408executed before the first node section set the defaults, settings that are 465executed before the first node section set the defaults, settings that are
409executed within a node section only apply to the given node. 466executed 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 467.IP "compress = yes|true|on | no|false|off" 4
423.IX Item "enable-udp = yes|true|on | no|false|off" 468.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, 469Wether 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 470Compression is really cheap even on slow computers and has no size
426protocol is enabled automatically). This is a good general choice since 471overhead 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 472.IP "connect = ondemand | never | always | disabled" 4
457.IX Item "connect = ondemand | never | always | disabled" 473.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 474Sets 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 475try 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), 476(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 477\&\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, 478take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
463don't talk to it). 479don't talk to it).
480.IP "dns-domain = domain-suffix" 4
481.IX Item "dns-domain = domain-suffix"
482The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
483.Sp
484The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
485i.e.
486.Sp
487.Vb 2
488\& dns-domainname = tunnel.example.net
489\& dns-hostname = tunnel-server.example.net
490.Ve
491.Sp
492Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain:
493.Sp
494.Vb 2
495\& tunnel.example.net. NS tunnel-server.example.net.
496\& tunnel-server.example.net. A 13.13.13.13
497.Ve
498.IP "dns-hostname = hostname/ip" 4
499.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,
501but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
502change.
503.IP "dns-port = port-number" 4
504.IX Item "dns-port = port-number"
505The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
506.IP "enable-dns = yes|true|on | no|false|off" 4
507.IX Item "enable-dns = yes|true|on | no|false|off"
508See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport
509protocol. Avoid this protocol if you can.
510.Sp
511Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
512client. Support for this transport protocol is only available when gvpe
513was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
514.IP "enable-icmp = yes|true|on | no|false|off" 4
515.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.
517.Sp
518Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
519node.
520.IP "enable-rawip = yes|true|on | no|false|off" 4
521.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.
523.Sp
524Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
525(default: \f(CW\*(C`no\*(C'\fR).
526.IP "enable-tcp = yes|true|on | no|false|off" 4
527.IX Item "enable-tcp = yes|true|on | no|false|off"
528See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol.
529.Sp
530Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
531(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available
532when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
533.IP "enable-udp = yes|true|on | no|false|off" 4
534.IX Item "enable-udp = yes|true|on | no|false|off"
535See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
536.Sp
537Enable 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
539protocol is enabled automatically).
540.Sp
541\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
542it might get switched on automatically, as some future version might
543default to another default protocol.
544.IP "icmp-type = integer" 4
545.IX Item "icmp-type = integer"
546Sets the type value to be used for outgoing (and incoming) packets sent
547via the \s-1ICMP\s0 transport.
548.Sp
549The 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.
551\&\*(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 552.IP "inherit-tos = yes|true|on | no|false|off" 4
465.IX Item "inherit-tos = yes|true|on | no|false|off" 553.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 554Wether 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 555sending 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 556outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
469to the tunnel device, which is usually what you want. 557to 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 558.IP "max-retry = positive-number" 4
476.IX Item "max-retry = positive-number" 559.IX Item "max-retry = positive-number"
477The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between 560The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
478retries to establish a connection to this node. When a connection cannot 561retries to establish a connection to this node. When a connection cannot
479be established, gvpe uses exponential backoff capped at this value. It's 562be 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 563sometimes 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 564connections to routers that usually are stable but sometimes are down, to
482assure quick reconnections. 565assure quick reconnections even after longer downtimes.
566.IP "router-priority = 0 | 1 | positive\-number>=2" 4
567.IX Item "router-priority = 0 | 1 | positive-number>=2"
568Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
569some host tries to connect to another host without a hostname, it asks
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
573Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router
574hosts, otherwise connecting to them might be impossible.
575.Sp
576The 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
578disables routing. The idea behind this is that some hosts can, if
579required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their
580local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is
581\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do
582not use by default\*(R" switch.
583.IP "tcp-port = port-number" 4
584.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.
586.IP "udp-port = port-number" 4
587.IX Item "udp-port = port-number"
588Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
589officially assigned by \s-1IANA\s0!).
483.SH "CONFIG DIRECTORY LAYOUT" 590.SH "CONFIG DIRECTORY LAYOUT"
484.IX Header "CONFIG DIRECTORY LAYOUT" 591.IX Header "CONFIG DIRECTORY LAYOUT"
485The default (or recommended) directory layout for the config directory is: 592The default (or recommended) directory layout for the config directory is:
486.IP "\(bu" 4 593.IP "\(bu" 4
487.IX Xref "gvpe.conf" 594.IX Xref "gvpe.conf"

Diff Legend

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