| … | |
… | |
| 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-07" "1.8" "GNU Virtual Private Ethernet" |
132 | .TH GVPE.CONF 5 "2005-03-23" "1.9" "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 |
| … | |
… | |
| 202 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
202 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
| 203 | .IP "dns-forw-port = port-number" 4 |
203 | .IP "dns-forw-port = port-number" 4 |
| 204 | .IX Item "dns-forw-port = port-number" |
204 | .IX Item "dns-forw-port = port-number" |
| 205 | The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
205 | The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
| 206 | which is fine in most cases). |
206 | which is fine in most cases). |
|
|
207 | .IP "dns-max-outstanding = integer-number-of-requests" 4 |
|
|
208 | .IX Item "dns-max-outstanding = integer-number-of-requests" |
|
|
209 | The maximum number of outstanding \s-1DNS\s0 transport requests |
|
|
210 | (default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given |
|
|
211 | limit without receiving replies. In heavily overloaded situations it might |
|
|
212 | help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the |
|
|
213 | number of parallel requests. |
|
|
214 | .Sp |
|
|
215 | The default should be working ok for most links. |
|
|
216 | .IP "dns-overlap-factor = float" 4 |
|
|
217 | .IX Item "dns-overlap-factor = float" |
|
|
218 | The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen |
|
|
219 | during a connection as it's timing base. This factor (default: \f(CW0.5\fR, |
|
|
220 | must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
|
|
221 | rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new |
|
|
222 | request might be generated every \fBmin_latency\fR seconds, which means on |
|
|
223 | average there should only ever be one outstanding request. A factor of |
|
|
224 | \&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
|
|
225 | latency measured. |
|
|
226 | .Sp |
|
|
227 | For congested or picky dns forwarders you could use a value nearer to or |
|
|
228 | exceeding \f(CW1\fR. |
|
|
229 | .Sp |
|
|
230 | The default should be working ok for most links. |
|
|
231 | .IP "dns-send-interval = send-interval-in-seconds" 4 |
|
|
232 | .IX Item "dns-send-interval = send-interval-in-seconds" |
|
|
233 | The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will |
|
|
234 | use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when |
|
|
235 | the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will |
|
|
236 | not send more than 100 \s-1DNS\s0 requests per connection per second. For |
|
|
237 | high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For |
|
|
238 | congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, |
|
|
239 | \&\f(CW0.2\fR or even higher. |
|
|
240 | .Sp |
|
|
241 | The default should be working ok for most links. |
|
|
242 | .IP "dns-timeout-factor = float" 4 |
|
|
243 | .IX Item "dns-timeout-factor = float" |
|
|
244 | Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to |
|
|
245 | get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport |
|
|
246 | will resend the request when no reply has been received for longer than |
|
|
247 | eight times the minimum (= expected) latency, assuming the request or |
|
|
248 | reply has been lost. |
|
|
249 | .Sp |
|
|
250 | For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the |
|
|
251 | link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values |
|
|
252 | near or below \f(CW1\fR makes no sense whatsoever. |
|
|
253 | .Sp |
|
|
254 | The default should be working ok for most links. |
| 207 | .IP "if-up = relative-or-absolute-path" 4 |
255 | .IP "if-up = relative-or-absolute-path" 4 |
| 208 | .IX Item "if-up = relative-or-absolute-path" |
256 | .IX Item "if-up = relative-or-absolute-path" |
| 209 | Sets the path of a script that should be called immediately after the |
257 | Sets the path of a script that should be called immediately after the |
| 210 | network interface is initialized (but not neccessarily up). The following |
258 | network interface is initialized (but not neccessarily up). The following |
| 211 | environment variables are passed to it (the values are just examples): |
259 | environment variables are passed to it (the values are just examples): |
| … | |
… | |
| 455 | .IP "dns-port = port-number" 4 |
503 | .IP "dns-port = port-number" 4 |
| 456 | .IX Item "dns-port = port-number" |
504 | .IX Item "dns-port = port-number" |
| 457 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. |
505 | The 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 |
506 | .IP "enable-dns = yes|true|on | no|false|off" 4 |
| 459 | .IX Item "enable-dns = yes|true|on | no|false|off" |
507 | .IX Item "enable-dns = yes|true|on | no|false|off" |
|
|
508 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport |
|
|
509 | protocol. Avoid this protocol if you can. |
|
|
510 | .Sp |
| 460 | Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
511 | Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
| 461 | client (only available when gvpe was compiled with \f(CW\*(C`\-\-enable\-dns\*(C'\fR). |
512 | client. Support for this transport protocol is only available when gvpe |
|
|
513 | was 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" |
|
|
516 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
| 462 | .Sp |
517 | .Sp |
| 463 | This is the worst choice of transport protocol with respect to overhead |
518 | Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
| 464 | (overhead cna be 2\-3 times higher than the transferred data), and probably |
519 | node. |
| 465 | the best choice when tunneling through firewalls. |
|
|
| 466 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
520 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
| 467 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
521 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
|
|
522 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
|
|
523 | .Sp |
| 468 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
524 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
| 469 | (default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the minimum overhead per |
525 | (default: \f(CW\*(C`no\*(C'\fR). |
| 470 | packet is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). |
|
|
| 471 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
526 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
| 472 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
527 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
|
|
528 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol. |
|
|
529 | .Sp |
| 473 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
530 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
| 474 | (default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only |
531 | (default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available |
| 475 | available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
532 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
| 476 | use this transport unless you really must, it is very inefficient and |
|
|
| 477 | resource-intensive compared to the other transports (except for \s-1DNS\s0, which |
|
|
| 478 | is worse). |
|
|
| 479 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
533 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
| 480 | .IX Item "enable-udp = yes|true|on | no|false|off" |
534 | .IX Item "enable-udp = yes|true|on | no|false|off" |
|
|
535 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
|
|
536 | .Sp |
| 481 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
537 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
| 482 | unless no other protocol is enabled for a node, in which case this |
538 | unless no other protocol is enabled for a node, in which case this |
| 483 | protocol is enabled automatically). This is a good general choice since |
539 | protocol is enabled automatically). |
| 484 | \&\s-1UDP\s0 tunnels well through many firewalls. |
|
|
| 485 | .Sp |
540 | .Sp |
| 486 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
541 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
| 487 | it might get switched on automatically, as some future version might |
542 | it might get switched on automatically, as some future version might |
| 488 | default to another default protocol. |
543 | default to another default protocol. |
|
|
544 | .IP "icmp-type = integer" 4 |
|
|
545 | .IX Item "icmp-type = integer" |
|
|
546 | Sets the type value to be used for outgoing (and incoming) packets sent |
|
|
547 | via the \s-1ICMP\s0 transport. |
|
|
548 | .Sp |
|
|
549 | The 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. |
| 489 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
552 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
| 490 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
553 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
| 491 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
554 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
| 492 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
555 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
| 493 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
556 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
