1 | .\" Automatically generated by Pod::Man v1.36, Pod::Parser v1.13 |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
36 | . ds PI pi |
36 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
39 | . ds L" "" |
39 | . ds L" "" |
40 | . ds R" "" |
40 | . ds R" "" |
41 | . ds C` "" |
41 | . ds C` |
42 | . ds C' "" |
42 | . ds C' |
43 | 'br\} |
43 | 'br\} |
44 | .el\{\ |
44 | .el\{\ |
45 | . ds -- \|\(em\| |
45 | . ds -- \|\(em\| |
46 | . ds PI \(*p |
46 | . ds PI \(*p |
47 | . ds L" `` |
47 | . ds L" `` |
… | |
… | |
127 | .\} |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
130 | .\" |
130 | .\" |
131 | .IX Title "VPED.CONF 5" |
131 | .IX Title "VPED.CONF 5" |
132 | .TH VPED.CONF 5 "2003-03-24" "0.1" "Virtual Private Ethernet" |
132 | .TH VPED.CONF 5 "2004-04-01" "1.5" "Virtual Private Ethernet" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | vped.conf \- vpe daemon configuration file |
134 | vped.conf \- vpe daemon configuration file |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 3 |
137 | .Vb 4 |
|
|
138 | \& enable-udp = yes |
138 | \& udp-port = 407 |
139 | \& udp-port = 407 |
139 | \& mtu = 1492 |
140 | \& mtu = 1492 |
140 | \& ifname = vpn0 |
141 | \& ifname = vpn0 |
141 | .Ve |
142 | .Ve |
142 | .PP |
143 | .PP |
… | |
… | |
214 | \&\f(CW\*(C`vpectrl\*(C'\fR puts them. |
215 | \&\f(CW\*(C`vpectrl\*(C'\fR puts them. |
215 | .Sp |
216 | .Sp |
216 | Since only the private key file of the current node is used and the |
217 | Since only the private key file of the current node is used and the |
217 | private key file should be kept secret per-host to avoid spoofings, it is |
218 | private key file should be kept secret per-host to avoid spoofings, it is |
218 | not recommended to use this feature. |
219 | not recommended to use this feature. |
219 | .IP "ifpersist = yes|no" 4 |
220 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
220 | .IX Item "ifpersist = yes|no" |
221 | .IX Item "ifpersist = yes|true|on | no|false|off" |
221 | Should the tun/tap device be made persistent, that is, should the device |
222 | Should the tun/tap device be made persistent, that is, should the device |
222 | stay up even when vped exits? Some versions of the tunnel device have |
223 | stay up even when vped exits? Some versions of the tunnel device have |
223 | problems sending packets when vped is restarted in persistent mode, so |
224 | problems sending packets when vped is restarted in persistent mode, so |
224 | if the connections can be established but you cannot send packets from |
225 | if the connections can be established but you cannot send packets from |
225 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
226 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
… | |
… | |
247 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
248 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
248 | .Sp |
249 | .Sp |
249 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
250 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
250 | .Sp |
251 | .Sp |
251 | This value must be the minimum of the mtu values of all hosts. |
252 | This 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" |
|
|
255 | Sets the protocol number to be used for the rawip protocol. This is a |
|
|
256 | global option because all hosts must use the same protocol, and since |
|
|
257 | there are no port numbers, you cannot easily run more than one vped |
|
|
258 | instance using the same protocol, nor can you share the protocol with |
|
|
259 | other programs. |
|
|
260 | .Sp |
|
|
261 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
|
|
262 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
|
|
263 | common 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) |
252 | .IP "if-up = relative-or-absolute-path" 4 |
265 | .IP "if-up = relative-or-absolute-path" 4 |
253 | .IX Item "if-up = relative-or-absolute-path" |
266 | .IX Item "if-up = relative-or-absolute-path" |
254 | Sets the path of a script that should be called immediately after the |
267 | Sets the path of a script that should be called immediately after the |
255 | network interface is initialized (but not neccessarily up). The following |
268 | network interface is initialized (but not neccessarily up). The following |
256 | environment variables are passed to it (the values are just examples): |
269 | environment variables are passed to it (the values are just examples): |
… | |
… | |
266 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
279 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
267 | consistently on all hosts), but this is usually ineffective. |
280 | consistently on all hosts), but this is usually ineffective. |
268 | .IP "MAC=fe:fd:80:00:00:01" 4 |
281 | .IP "MAC=fe:fd:80:00:00:01" 4 |
269 | .IX Item "MAC=fe:fd:80:00:00:01" |
282 | .IX Item "MAC=fe:fd:80:00:00:01" |
270 | The \s-1MAC\s0 address to set the interface to. The script *must* set the |
283 | The \s-1MAC\s0 address to set the interface to. The script *must* set the |
271 | interface \s-1MAC\s0 to this value. On GNU/Linux you will most likely use this: |
284 | interface \s-1MAC\s0 to this value. You will most likely use one of these: |
272 | .Sp |
285 | .Sp |
273 | .Vb 1 |
286 | .Vb 2 |
274 | \& ip link set $IFNAME address $MAC mtu $MTU up |
287 | \& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
|
|
288 | \& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
275 | .Ve |
289 | .Ve |
|
|
290 | .Sp |
|
|
291 | Please see the \f(CW\*(C`vpe.osdep(5)\*(C'\fR manpage for platform-specific information. |
|
|
292 | .IP "IFTYPE=native # or tincd" 4 |
|
|
293 | .IX Item "IFTYPE=native # or tincd" |
|
|
294 | .PD 0 |
|
|
295 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
|
|
296 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
|
|
297 | .PD |
|
|
298 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os |
|
|
299 | name in lowercase) that this vpe was configured for. Can be used to select |
|
|
300 | the correct syntax to use for network-related commands. |
276 | .IP "NODENAME=branch1" 4 |
301 | .IP "NODENAME=branch1" 4 |
277 | .IX Item "NODENAME=branch1" |
302 | .IX Item "NODENAME=branch1" |
278 | The nickname of the current node, as passed to the vped daemon. |
303 | The nickname of the current node, as passed to the vped daemon. |
279 | .IP "NODEID=1" 4 |
304 | .IP "NODEID=1" 4 |
280 | .IX Item "NODEID=1" |
305 | .IX Item "NODEID=1" |
… | |
… | |
311 | The node id of the remote node. |
336 | The node id of the remote node. |
312 | .IP "DESTIP=188.13.66.8" 4 |
337 | .IP "DESTIP=188.13.66.8" 4 |
313 | .IX Item "DESTIP=188.13.66.8" |
338 | .IX Item "DESTIP=188.13.66.8" |
314 | The numerical \s-1IP\s0 address of the remote host (vped accepts connections from |
339 | The numerical \s-1IP\s0 address of the remote host (vped accepts connections from |
315 | everywhere, as long as the other host can authenticate itself). |
340 | everywhere, as long as the other host can authenticate itself). |
316 | .IP "DESTPORT=407 # deprecated" 4 |
341 | .IP "DESTPORT=655 # deprecated" 4 |
317 | .IX Item "DESTPORT=407 # deprecated" |
342 | .IX Item "DESTPORT=655 # deprecated" |
318 | The \s-1UDP\s0 port used by the other side. |
343 | The \s-1UDP\s0 port used by the other side. |
319 | .IP "STATE=UP" 4 |
344 | .IP "STATE=UP" 4 |
320 | .IX Item "STATE=UP" |
345 | .IX Item "STATE=UP" |
321 | Node-up scripts get called with STATE=UP, node-down scripts get called |
346 | Node-up scripts get called with STATE=UP, node-down scripts get called |
322 | with STATE=DOWN. |
347 | with STATE=DOWN. |
… | |
… | |
336 | .Ve |
361 | .Ve |
337 | .RE |
362 | .RE |
338 | .IP "node-down = relative-or-absolute-path" 4 |
363 | .IP "node-down = relative-or-absolute-path" 4 |
339 | .IX Item "node-down = relative-or-absolute-path" |
364 | .IX Item "node-down = relative-or-absolute-path" |
340 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
365 | Same 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" |
|
|
368 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if vpe was |
|
|
369 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
|
|
370 | tcp 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 |
|
|
373 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
|
|
374 | requires authentication. |
|
|
375 | .Sp |
|
|
376 | Please note that vpe will still try to resolve all hostnames in the |
|
|
377 | configuration file, so if you are behind a proxy without access to a dns |
|
|
378 | server better use numerical \s-1IP\s0 addresses. |
|
|
379 | .Sp |
|
|
380 | To make best use of this option disable all protocols except tcp in your |
|
|
381 | config file and make sure your routers (or all other hosts) are listening |
|
|
382 | on a port that the proxy allows (443, https, is a common choice). |
|
|
383 | .Sp |
|
|
384 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
|
|
385 | enabled on all hosts. |
|
|
386 | .Sp |
|
|
387 | Example: |
|
|
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" |
|
|
396 | The port where your proxy server listens. |
|
|
397 | .IP "http-proxy-auth = login:password" 4 |
|
|
398 | .IX Item "http-proxy-auth = login:password" |
|
|
399 | The optional login and password used to authenticate to the proxy server, |
|
|
400 | seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
|
|
401 | currently supported. |
|
|
402 | .IP "pid-file = path" 4 |
|
|
403 | .IX Item "pid-file = path" |
|
|
404 | The path to the pid file to check and create (Default: |
341 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
405 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
342 | .IX Subsection "NODE SPECIFIC SETTINGS" |
406 | .IX Subsection "NODE SPECIFIC SETTINGS" |
343 | The following settings are node\-specific, that is, every node can have |
407 | The following settings are node\-specific, that is, every node can have |
344 | different settings, even within the same vped instance. Settings that are |
408 | different settings, even within the same vped instance. Settings that are |
345 | executed before the first node section set the defaults, settings that are |
409 | executed before the first node section set the defaults, settings that are |
346 | executed within a node section only apply to the given node. |
410 | executed within a node section only apply to the given node. |
347 | .IP "udp-port = port-number" 4 |
411 | .IP "udp-port = port-number" 4 |
348 | .IX Item "udp-port = port-number" |
412 | .IX Item "udp-port = port-number" |
349 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW407\fR, not |
413 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
350 | officially assigned by \s-1IANA\s0!). |
414 | officially assigned by \s-1IANA\s0!). |
|
|
415 | .IP "tcp-port = port-number" 4 |
|
|
416 | .IX Item "tcp-port = port-number" |
|
|
417 | Similar 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" |
|
|
420 | 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 |
|
|
422 | 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 |
|
|
424 | .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, |
|
|
426 | but this will change!). This is a good general choice since \s-1UDP\s0 tunnels |
|
|
427 | well through many firewalls. |
|
|
428 | .Sp |
|
|
429 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR even though it is the default, as |
|
|
430 | some 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" |
|
|
433 | 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 | available when vpe 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 | resource-intensive compared to the other transports. |
351 | .IP "router-priority = positive-number" 4 |
438 | .IP "router-priority = positive-number" 4 |
352 | .IX Item "router-priority = positive-number" |
439 | .IX Item "router-priority = positive-number" |
353 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
440 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
354 | some host tries to connect to another host without a hostname, it asks |
441 | some host tries to connect to another host without a hostname, it asks |
355 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
442 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
… | |
… | |
361 | try to establish and keep a conenction to the given host), \f(CW\*(C`never\*(C'\fR |
448 | try to establish and keep a conenction to the given host), \f(CW\*(C`never\*(C'\fR |
362 | (nevr initiate a connection to the given host, but accept connections), |
449 | (nevr initiate a connection to the given host, but accept connections), |
363 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
450 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
364 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
451 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
365 | don't talk to it). |
452 | don't talk to it). |
366 | .IP "inherit-tos = yes|no" 4 |
453 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
367 | .IX Item "inherit-tos = yes|no" |
454 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
368 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
455 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
369 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
456 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
370 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
457 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
371 | to the tunnel device, which is usually what you want. |
458 | to the tunnel device, which is usually what you want. |
372 | .IP "compress = yes|no" 4 |
459 | .IP "compress = yes|true|on | no|false|off" 4 |
373 | .IX Item "compress = yes|no" |
460 | .IX Item "compress = yes|true|on | no|false|off" |
374 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR, |
461 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
375 | compression is really cheap even on slow computers and has no size |
462 | Compression is really cheap even on slow computers and has no size |
376 | overhead at all). |
463 | overhead at all, so enabling this is a good idea. |
377 | .SH "CONFIG DIRECTORY LAYOUT" |
464 | .SH "CONFIG DIRECTORY LAYOUT" |
378 | .IX Header "CONFIG DIRECTORY LAYOUT" |
465 | .IX Header "CONFIG DIRECTORY LAYOUT" |
379 | The default (or recommended) directory layout for the config directory is: |
466 | The default (or recommended) directory layout for the config directory is: |
380 | .IP "vped.conf" 4 |
467 | .IP "vped.conf" 4 |
381 | .IX Item "vped.conf" |
468 | .IX Item "vped.conf" |
… | |
… | |
392 | .IP "pubkey/nodename" 4 |
479 | .IP "pubkey/nodename" 4 |
393 | .IX Item "pubkey/nodename" |
480 | .IX Item "pubkey/nodename" |
394 | The public keys of the other nodes, one file per node. |
481 | The public keys of the other nodes, one file per node. |
395 | .SH "SEE ALSO" |
482 | .SH "SEE ALSO" |
396 | .IX Header "SEE ALSO" |
483 | .IX Header "SEE ALSO" |
397 | \&\fIvpe\fR\|(8), \fIvped\fR\|(8), \fIvpectrl\fR\|(8). |
484 | \&\fIvpe\fR\|(5), \fIvped\fR\|(8), \fIvpectrl\fR\|(8). |
398 | .SH "AUTHOR" |
485 | .SH "AUTHOR" |
399 | .IX Header "AUTHOR" |
486 | .IX Header "AUTHOR" |
400 | Marc Lehmann <vpe@plan9.de> |
487 | Marc Lehmann <vpe@plan9.de> |