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.6 by pcg, Thu Mar 3 07:24:57 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-01" "1.7" "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
… …
420Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol 419Enable 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 420(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+). 421is 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 422.IP "enable-udp = yes|true|on | no|false|off" 4
424.IX Item "enable-udp = yes|true|on | no|false|off" 423.IX Item "enable-udp = 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, 424Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
426but this will change!). This is a good general choice since \s-1UDP\s0 tunnels 425unless no other protocol is enabled for a node, in which case this
427well through many firewalls. 426protocol is enabled automatically). This is a good general choice since
427\&\s-1UDP\s0 tunnels well through many firewalls.
428.Sp 428.Sp
429\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR even though it is the default, as 429\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
430some future version will have all protocols disabled by default. 430it might get switched on automatically, as some future version might
431default to another default protocol.
431.IP "enable-tcp = yes|true|on | no|false|off" 4 432.IP "enable-tcp = yes|true|on | no|false|off" 4
432.IX Item "enable-tcp = yes|true|on | no|false|off" 433.IX Item "enable-tcp = yes|true|on | no|false|off"
433Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port 434Enable 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 435(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 436available 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 437use this transport unless you really must, it is horribly ineffiecent and
437resource-intensive compared to the other transports. 438resource-intensive compared to the other transports.
438.IP "router-priority = positive-number" 4 439.IP "router-priority = 0 | 1 | positive\-number>2" 4
439.IX Item "router-priority = positive-number" 440.IX Item "router-priority = 0 | 1 | positive-number>2"
440Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 441Sets 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 442some 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 443the 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 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
444connect to the router hosts, otherwise conencting to them is impossible. 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.
445.IP "connect = ondemand|never|always|disabled" 4 456.IP "connect = ondemand | never | always | disabled" 4
446.IX Item "connect = ondemand|never|always|disabled" 457.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 458Sets 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 459try 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), 460(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 461\&\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, 462take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
452don't talk to it). 463don't talk to it).
453.IP "inherit-tos = yes|true|on | no|false|off" 4 464.IP "inherit-tos = yes|true|on | no|false|off" 4
454.IX Item "inherit-tos = yes|true|on | no|false|off" 465.IX Item "inherit-tos = yes|true|on | no|false|off"
… …
470connections to routers that usually are stable but sometimes are down, to 481connections to routers that usually are stable but sometimes are down, to
471assure quick reconnections. 482assure quick reconnections.
472.SH "CONFIG DIRECTORY LAYOUT" 483.SH "CONFIG DIRECTORY LAYOUT"
473.IX Header "CONFIG DIRECTORY LAYOUT" 484.IX Header "CONFIG DIRECTORY LAYOUT"
474The default (or recommended) directory layout for the config directory is: 485The default (or recommended) directory layout for the config directory is:
475.IP "gvpe.conf" 4 486.IP "\(bu" 4
476.IX Item "gvpe.conf" 487.IX Xref "gvpe.conf"
477The config file. 488The config file.
478.IP "if-up" 4 489.IP "\(bu" 4
479.IX Item "if-up" 490.IX Xref "if-up"
480The if-up script 491The if-up script
481.IP "node\-up, node-down" 4 492.IP "," 4
482.IX Item "node-up, node-down" 493.IX Xref "node-up node-down"
483If used the node up or node-down scripts. 494If used the node up or node-down scripts.
484.IP "hostkey" 4 495.IP "\(bu" 4
485.IX Item "hostkey" 496.IX Xref "hostkey"
486The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. 497The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host.
487.IP "pubkey/nodename" 4 498.IP "\(bu" 4
488.IX Item "pubkey/nodename" 499.IX Xref "pubkey nodename"
489The public keys of the other nodes, one file per node. 500The public keys of the other nodes, one file per node.
490.SH "SEE ALSO" 501.SH "SEE ALSO"
491.IX Header "SEE ALSO" 502.IX Header "SEE ALSO"
492\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 503\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
493.SH "AUTHOR" 504.SH "AUTHOR"

Diff Legend

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