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.1 by pcg, Fri Jun 11 15:56:12 2004 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 "2004-06-11" "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 4 137.Vb 3
138\& enable-udp = yes
139\& udp-port = 407 138\& udp-port = 407
140\& mtu = 1492 139\& mtu = 1492
141\& ifname = vpn0 140\& ifname = vpn0
142.Ve 141.Ve
143.PP 142.PP
… …
195.IX Subsection "GLOBAL SETTINGS" 194.IX Subsection "GLOBAL SETTINGS"
196Global settings will affect the behaviour of the running gvpe daemon, that 195Global settings will affect the behaviour of the running gvpe daemon, that
197is, 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
198values 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
199the gvpe daemon and all connections it creates. 198the gvpe daemon and all connections it creates.
200.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 199.IP "dns-forw-host = hostname/ip" 4
201.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 200.IX Item "dns-forw-host = hostname/ip"
202Set 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
203\&\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).
204.IP "node = nickname" 4 203.IP "dns-forw-port = port-number" 4
205.IX Item "node = nickname" 204.IX Item "dns-forw-port = port-number"
206Not 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,
207used to select the right configuration section and must be passed as an 206which is fine in most cases).
208argument to the gvpe daemon.
209.IP "private-key = relative-path-to-key" 4
210.IX Item "private-key = relative-path-to-key"
211Sets the path (relative to the config directory) to the private key
212(default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must
213be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
214use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where
215\&\f(CW\*(C`gvpectrl\*(C'\fR puts them.
216.Sp
217Since only the private key file of the current node is used and the
218private key file should be kept secret per-host to avoid spoofings, it is
219not recommended to use this feature.
220.IP "ifpersist = yes|true|on | no|false|off" 4
221.IX Item "ifpersist = yes|true|on | no|false|off"
222Should the tun/tap device be made persistent, that is, should the device
223stay up even when gvpe exits? Some versions of the tunnel device have
224problems sending packets when gvpe is restarted in persistent mode, so
225if the connections can be established but you cannot send packets from
226the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
227device.
228.IP "ifname = devname" 4
229.IX Item "ifname = devname"
230Sets the tun interface name to the given name. The default is OS-specific
231and most probably something like \f(CW\*(C`tun0\*(C'\fR.
232.IP "rekey = seconds" 4
233.IX Item "rekey = seconds"
234Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
235reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
236.IP "keepalive = seconds" 4
237.IX Item "keepalive = seconds"
238Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
239many seconds of inactivity the daemon will start to send keepalive probe
240every 5 seconds until it receives a reply from the other end. If no reply
241is received within 30 seconds, the peer is considered unreachable and the
242connection is closed.
243.IP "mtu = bytes" 4
244.IX Item "mtu = bytes"
245Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
246the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
247maximum overhead (e.g. udp header size, encryption blocksize...) and pass
248this information to the \f(CW\*(C`if\-up\*(C'\fR script.
249.Sp
250Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
251.Sp
252This value must be the minimum of the mtu values of all hosts.
253.IP "ip-proto = numerical-ip-protocol" 4
254.IX Item "ip-proto = numerical-ip-protocol"
255Sets the protocol number to be used for the rawip protocol. This is a
256global option because all hosts must use the same protocol, and since
257there are no port numbers, you cannot easily run more than one gvpe
258instance using the same protocol, nor can you share the protocol with
259other programs.
260.Sp
261The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
262firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
263common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
264(\s-1ENCAP\s0, rfc1241)
265.IP "if-up = relative-or-absolute-path" 4 207.IP "if-up = relative-or-absolute-path" 4
266.IX Item "if-up = relative-or-absolute-path" 208.IX Item "if-up = relative-or-absolute-path"
267Sets 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
268network interface is initialized (but not neccessarily up). The following 210network interface is initialized (but not neccessarily up). The following
269environment variables are passed to it (the values are just examples): 211environment variables are passed to it (the values are just examples):
… …
319.Ve 261.Ve
320.Sp 262.Sp
321More complicated examples (using routing to reduce arp traffic) can be 263More complicated examples (using routing to reduce arp traffic) can be
322found in the etc/ subdirectory of the distribution. 264found in the etc/ subdirectory of the distribution.
323.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.
324.IP "node-up = relative-or-absolute-path" 4 352.IP "node-up = relative-or-absolute-path" 4
325.IX Item "node-up = relative-or-absolute-path" 353.IX Item "node-up = relative-or-absolute-path"
326Sets a command (default: no script) that should be called whenever a 354Sets a command (default: no script) that should be called whenever a
327connection is established (even on rekeying operations). In addition 355connection is established (even on rekeying operations). In addition
328to 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
… …
361.Ve 389.Ve
362.RE 390.RE
363.IP "node-down = relative-or-absolute-path" 4 391.IP "node-down = relative-or-absolute-path" 4
364.IX Item "node-down = relative-or-absolute-path" 392.IX Item "node-down = relative-or-absolute-path"
365Same 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.
366.IP "http-proxy-host = hostname/ip" 4
367.IX Item "http-proxy-host = hostname/ip"
368The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was
369compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
370tcp connections through a http proxy server.
371.Sp
372\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
373port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
374requires authentication.
375.Sp
376Please note that gvpe will still try to resolve all hostnames in the
377configuration file, so if you are behind a proxy without access to a dns
378server better use numerical \s-1IP\s0 addresses.
379.Sp
380To make best use of this option disable all protocols except tcp in your
381config file and make sure your routers (or all other hosts) are listening
382on a port that the proxy allows (443, https, is a common choice).
383.Sp
384If you have a router, connecting to it will suffice. Otherwise tcp must be
385enabled on all hosts.
386.Sp
387Example:
388.Sp
389.Vb 3
390\& http-proxy-host = proxy.example.com
391\& http-proxy-port = 3128 # 8080 is another common choice
392\& http-proxy-auth = schmorp:grumbeere
393.Ve
394.IP "http-proxy-port = proxy-tcp-port" 4
395.IX Item "http-proxy-port = proxy-tcp-port"
396The port where your proxy server listens.
397.IP "http-proxy-auth = login:password" 4
398.IX Item "http-proxy-auth = login:password"
399The optional login and password used to authenticate to the proxy server,
400seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
401currently supported.
402.IP "pid-file = path" 4 394.IP "pid-file = path" 4
403.IX Item "pid-file = path" 395.IX Item "pid-file = path"
404The 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.
405.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 413.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
406.IX Subsection "NODE SPECIFIC SETTINGS" 414.IX Subsection "NODE SPECIFIC SETTINGS"
407The following settings are node\-specific, that is, every node can have 415The following settings are node\-specific, that is, every node can have
408different settings, even within the same gvpe instance. Settings that are 416different settings, even within the same gvpe instance. Settings that are
409executed before the first node section set the defaults, settings that are 417executed before the first node section set the defaults, settings that are
410executed within a node section only apply to the given node. 418executed within a node section only apply to the given node.
411.IP "udp-port = port-number" 4
412.IX Item "udp-port = port-number"
413Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
414officially assigned by \s-1IANA\s0!).
415.IP "tcp-port = port-number" 4
416.IX Item "tcp-port = port-number"
417Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
418.IP "enable-rawip = yes|true|on | no|false|off" 4
419.IX Item "enable-rawip = yes|true|on | no|false|off"
420Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
421(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet
422is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
423.IP "enable-udp = yes|true|on | no|false|off" 4 419.IP "compress = yes|true|on | no|false|off" 4
424.IX Item "enable-udp = yes|true|on | no|false|off" 420.IX Item "compress = yes|true|on | no|false|off"
425Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`yes\*(C'\fR, 421Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
426but this will change!). This is a good general choice since \s-1UDP\s0 tunnels 422Compression is really cheap even on slow computers and has no size
427well through many firewalls. 423overhead at all, so enabling this is a good idea.
428.Sp
429\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR even though it is the default, as
430some future version will have all protocols disabled by default.
431.IP "enable-tcp = yes|true|on | no|false|off" 4
432.IX Item "enable-tcp = yes|true|on | no|false|off"
433Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
434(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only
435available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never
436use this transport unless you really must, it is horribly ineffiecent and
437resource-intensive compared to the other transports.
438.IP "router-priority = positive-number" 4
439.IX Item "router-priority = positive-number"
440Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
441some host tries to connect to another host without a hostname, it asks
442the router host for it's \s-1IP\s0 address. The router host is the one with the
443highest priority that is currently reachable. Make sure all clients always
444connect to the router hosts, otherwise conencting to them is impossible.
445.IP "connect = ondemand|never|always|disabled" 4 424.IP "connect = ondemand | never | always | disabled" 4
446.IX Item "connect = ondemand|never|always|disabled" 425.IX Item "connect = ondemand | never | always | disabled"
447Sets 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
448try to establish and keep a conenction 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
449(nevr initiate a connection to the given host, but accept connections), 428(never initiate a connection to the given host, but accept connections),
450\&\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
451take 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,
452don'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.
453.IP "inherit-tos = yes|true|on | no|false|off" 4 504.IP "inherit-tos = yes|true|on | no|false|off" 4
454.IX Item "inherit-tos = yes|true|on | no|false|off" 505.IX Item "inherit-tos = yes|true|on | no|false|off"
455Wether 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
456sending 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
457outgoing 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
458to the tunnel device, which is usually what you want. 509to the tunnel device, which is usually what you want.
459.IP "compress = yes|true|on | no|false|off" 4
460.IX Item "compress = yes|true|on | no|false|off"
461Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
462Compression is really cheap even on slow computers and has no size
463overhead at all, so enabling this is a good idea.
464.IP "max-retry = positive-number" 4 510.IP "max-retry = positive-number" 4
465.IX Item "max-retry = positive-number" 511.IX Item "max-retry = positive-number"
466The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between 512The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
467retries to establish a connection to this node. When a connection cannot 513retries to establish a connection to this node. When a connection cannot
468be established, gvpe uses exponential backoff capped at this value. It's 514be established, gvpe uses exponential backoff capped at this value. It's
469sometimes 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
470connections to routers that usually are stable but sometimes are down, to 516connections to routers that usually are stable but sometimes are down, to
471assure 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!).
472.SH "CONFIG DIRECTORY LAYOUT" 542.SH "CONFIG DIRECTORY LAYOUT"
473.IX Header "CONFIG DIRECTORY LAYOUT" 543.IX Header "CONFIG DIRECTORY LAYOUT"
474The default (or recommended) directory layout for the config directory is: 544The default (or recommended) directory layout for the config directory is:
475.IP "gvpe.conf" 4 545.IP "\(bu" 4
476.IX Item "gvpe.conf" 546.IX Xref "gvpe.conf"
477The config file. 547The config file.
478.IP "if-up" 4 548.IP "\(bu" 4
479.IX Item "if-up" 549.IX Xref "if-up"
480The if-up script 550The if-up script
481.IP "node\-up, node-down" 4 551.IP "," 4
482.IX Item "node-up, node-down" 552.IX Xref "node-up node-down"
483If used the node up or node-down scripts. 553If used the node up or node-down scripts.
484.IP "hostkey" 4 554.IP "\(bu" 4
485.IX Item "hostkey" 555.IX Xref "hostkey"
486The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 556The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
487.IP "pubkey/nodename" 4 557.IP "\(bu" 4
488.IX Item "pubkey/nodename" 558.IX Xref "pubkey nodename"
489The public keys of the other nodes, one file per node. 559The public keys of the other nodes, one file per node.
490.SH "SEE ALSO" 560.SH "SEE ALSO"
491.IX Header "SEE ALSO" 561.IX Header "SEE ALSO"
492\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 562\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
493.SH "AUTHOR" 563.SH "AUTHOR"

Diff Legend

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