… | |
… | |
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" |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
134 | gvpe.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 |
… | |
… | |
420 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
419 | Enable 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 |
422 | is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). |
421 | is 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" |
425 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`yes\*(C'\fR, |
424 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
426 | but this will change!). This is a good general choice since \s-1UDP\s0 tunnels |
425 | unless no other protocol is enabled for a node, in which case this |
427 | well through many firewalls. |
426 | protocol 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 |
430 | some future version will have all protocols disabled by default. |
430 | it might get switched on automatically, as some future version might |
|
|
431 | default 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" |
433 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
434 | Enable 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 |
435 | available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
436 | available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
436 | use this transport unless you really must, it is horribly ineffiecent and |
437 | use this transport unless you really must, it is horribly ineffiecent and |
437 | resource-intensive compared to the other transports. |
438 | resource-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" |
440 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
441 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
441 | some host tries to connect to another host without a hostname, it asks |
442 | some host tries to connect to another host without a hostname, it asks |
442 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
443 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
443 | highest priority that is currently reachable. Make sure all clients always |
444 | highest priority larger than \f(CW1\fR that is currently reachable. |
|
|
445 | .Sp |
|
|
446 | Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router |
444 | connect to the router hosts, otherwise conencting to them is impossible. |
447 | hosts, otherwise connecting to them might be impossible. |
|
|
448 | .Sp |
|
|
449 | The special value \f(CW1\fR allows other hosts to route through the router |
|
|
450 | host, but they will never route through it by default. The value \f(CW0\fR |
|
|
451 | disables routing. The idea behind this is that some hosts can, if |
|
|
452 | required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their |
|
|
453 | local 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 |
|
|
455 | not 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" |
447 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
458 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
448 | try to establish and keep a conenction to the given host), \f(CW\*(C`never\*(C'\fR |
459 | try 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 |
451 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
462 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
452 | don't talk to it). |
463 | don'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" |
… | |
… | |
470 | connections to routers that usually are stable but sometimes are down, to |
481 | connections to routers that usually are stable but sometimes are down, to |
471 | assure quick reconnections. |
482 | assure quick reconnections. |
472 | .SH "CONFIG DIRECTORY LAYOUT" |
483 | .SH "CONFIG DIRECTORY LAYOUT" |
473 | .IX Header "CONFIG DIRECTORY LAYOUT" |
484 | .IX Header "CONFIG DIRECTORY LAYOUT" |
474 | The default (or recommended) directory layout for the config directory is: |
485 | The 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" |
477 | The config file. |
488 | The config file. |
478 | .IP "if-up" 4 |
489 | .IP "\(bu" 4 |
479 | .IX Item "if-up" |
490 | .IX Xref "if-up" |
480 | The if-up script |
491 | The 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" |
483 | If used the node up or node-down scripts. |
494 | If used the node up or node-down scripts. |
484 | .IP "hostkey" 4 |
495 | .IP "\(bu" 4 |
485 | .IX Item "hostkey" |
496 | .IX Xref "hostkey" |
486 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
497 | The 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" |
489 | The public keys of the other nodes, one file per node. |
500 | The 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" |