… | |
… | |
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-06" "1.8" "GNU Virtual Private Ethernet" |
132 | .TH GVPE.CONF 5 "2005-03-17" "1.8" "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 3 |
137 | .Vb 3 |
… | |
… | |
429 | \&\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 |
430 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
430 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
431 | don't talk to it). |
431 | don't talk to it). |
432 | .IP "dns-domain = domain-suffix" 4 |
432 | .IP "dns-domain = domain-suffix" 4 |
433 | .IX Item "dns-domain = domain-suffix" |
433 | .IX Item "dns-domain = domain-suffix" |
434 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server. Needs to be |
434 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. |
435 | set on both client and server. |
|
|
436 | .Sp |
435 | .Sp |
437 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
436 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
438 | i.e. |
437 | i.e. |
439 | .Sp |
438 | .Sp |
440 | .Vb 2 |
439 | .Vb 2 |
… | |
… | |
453 | The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
452 | The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
454 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
453 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
455 | change. |
454 | change. |
456 | .IP "dns-port = port-number" 4 |
455 | .IP "dns-port = port-number" 4 |
457 | .IX Item "dns-port = port-number" |
456 | .IX Item "dns-port = port-number" |
458 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW0\fR on all \s-1DNS\s0 tunnel |
457 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. |
459 | clients and \f(CW53\fR on the server. |
458 | .IP "enable-dns = yes|true|on | no|false|off" 4 |
|
|
459 | .IX Item "enable-dns = yes|true|on | no|false|off" |
|
|
460 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport |
|
|
461 | protocol. Avoid this protocol if you can. |
|
|
462 | .Sp |
|
|
463 | Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
|
|
464 | client. Support for this transport protocol is only available when gvpe |
|
|
465 | was 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" |
|
|
468 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
|
|
469 | .Sp |
|
|
470 | Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
|
|
471 | node. |
460 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
472 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
461 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
473 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
|
|
474 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
|
|
475 | .Sp |
462 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
476 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
463 | (default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet |
477 | (default: \f(CW\*(C`no\*(C'\fR). |
464 | is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). |
|
|
465 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
478 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
466 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
479 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
|
|
480 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol. |
|
|
481 | .Sp |
467 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
482 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
468 | (default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only |
483 | (default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available |
469 | available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
484 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
470 | use this transport unless you really must, it is horribly ineffiecent and |
|
|
471 | resource-intensive compared to the other transports. |
|
|
472 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
485 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
473 | .IX Item "enable-udp = yes|true|on | no|false|off" |
486 | .IX Item "enable-udp = yes|true|on | no|false|off" |
|
|
487 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
|
|
488 | .Sp |
474 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
489 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
475 | unless no other protocol is enabled for a node, in which case this |
490 | unless no other protocol is enabled for a node, in which case this |
476 | protocol is enabled automatically). This is a good general choice since |
491 | protocol is enabled automatically). |
477 | \&\s-1UDP\s0 tunnels well through many firewalls. |
|
|
478 | .Sp |
492 | .Sp |
479 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
493 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
480 | it might get switched on automatically, as some future version might |
494 | it might get switched on automatically, as some future version might |
481 | default to another default protocol. |
495 | default to another default protocol. |
|
|
496 | .IP "icmp-type = integer" 4 |
|
|
497 | .IX Item "icmp-type = integer" |
|
|
498 | Sets the type value to be used for outgoing (and incoming) packets sent |
|
|
499 | via the \s-1ICMP\s0 transport. |
|
|
500 | .Sp |
|
|
501 | The 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. |
482 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
504 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
483 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
505 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
484 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
506 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
485 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
507 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
486 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
508 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
487 | to the tunnel device, which is usually what you want. |
509 | to the tunnel device, which is usually what you want. |
488 | .IP "max-retry = positive-number" 4 |
510 | .IP "max-retry = positive-number" 4 |
489 | .IX Item "max-retry = positive-number" |
511 | .IX Item "max-retry = positive-number" |
490 | The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between |
512 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
491 | retries to establish a connection to this node. When a connection cannot |
513 | retries to establish a connection to this node. When a connection cannot |
492 | be established, gvpe uses exponential backoff capped at this value. It's |
514 | be established, gvpe uses exponential backoff capped at this value. It's |
493 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
515 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
494 | connections to routers that usually are stable but sometimes are down, to |
516 | connections to routers that usually are stable but sometimes are down, to |
495 | assure quick reconnections. |
517 | assure quick reconnections even after longer downtimes. |
496 | .IP "router-priority = 0 | 1 | positive\-number>2" 4 |
518 | .IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
497 | .IX Item "router-priority = 0 | 1 | positive-number>2" |
519 | .IX Item "router-priority = 0 | 1 | positive-number>=2" |
498 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
520 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
499 | some host tries to connect to another host without a hostname, it asks |
521 | some host tries to connect to another host without a hostname, it asks |
500 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
522 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
501 | highest priority larger than \f(CW1\fR that is currently reachable. |
523 | highest priority larger than \f(CW1\fR that is currently reachable. |
502 | .Sp |
524 | .Sp |