ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/vped.conf.5
(Generate patch)

Comparing gvpe/doc/vped.conf.5 (file contents):
Revision 1.4 by pcg, Mon Mar 24 15:20:24 2003 UTC vs.
Revision 1.9 by pcg, Thu Oct 16 20:35:14 2003 UTC

1.\" Automatically generated by Pod::Man v1.36, Pod::Parser v1.13 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13
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 "2003-10-16" "1.2" "Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134vped.conf \- vpe daemon configuration file 134vped.conf \- vpe daemon configuration file
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 3 137.Vb 3
… …
214\&\f(CW\*(C`vpectrl\*(C'\fR puts them. 214\&\f(CW\*(C`vpectrl\*(C'\fR puts them.
215.Sp 215.Sp
216Since only the private key file of the current node is used and the 216Since only the private key file of the current node is used and the
217private key file should be kept secret per-host to avoid spoofings, it is 217private key file should be kept secret per-host to avoid spoofings, it is
218not recommended to use this feature. 218not recommended to use this feature.
219.IP "ifpersist = yes|no" 4 219.IP "ifpersist = yes|true|on | no|false|off" 4
220.IX Item "ifpersist = yes|no" 220.IX Item "ifpersist = yes|true|on | no|false|off"
221Should the tun/tap device be made persistent, that is, should the device 221Should the tun/tap device be made persistent, that is, should the device
222stay up even when vped exits? Some versions of the tunnel device have 222stay up even when vped exits? Some versions of the tunnel device have
223problems sending packets when vped is restarted in persistent mode, so 223problems sending packets when vped is restarted in persistent mode, so
224if the connections can be established but you cannot send packets from 224if the connections can be established but you cannot send packets from
225the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the 225the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the
… …
247this information to the \f(CW\*(C`if\-up\*(C'\fR script. 247this information to the \f(CW\*(C`if\-up\*(C'\fR script.
248.Sp 248.Sp
249Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 249Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
250.Sp 250.Sp
251This value must be the minimum of the mtu values of all hosts. 251This value must be the minimum of the mtu values of all hosts.
252.IP "ip-proto = numerical-ip-protocol" 4
253.IX Item "ip-proto = numerical-ip-protocol"
254Sets the protocol number to be used for the rawip protocol. This is a
255global option because all hosts must use the same protocol, and since
256there are no port numbers, you cannot easily run more than one vped
257instance using the same protocol, nor can you share the protocol with
258other programs.
259.Sp
260The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
261firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
262common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
263(\s-1ENCAP\s0, rfc1241)
252.IP "if-up = relative-or-absolute-path" 4 264.IP "if-up = relative-or-absolute-path" 4
253.IX Item "if-up = relative-or-absolute-path" 265.IX Item "if-up = relative-or-absolute-path"
254Sets the path of a script that should be called immediately after the 266Sets the path of a script that should be called immediately after the
255network interface is initialized (but not neccessarily up). The following 267network interface is initialized (but not neccessarily up). The following
256environment variables are passed to it (the values are just examples): 268environment variables are passed to it (the values are just examples):
… …
266The \s-1MTU\s0 to set the interface to. You can use lower values (if done 278The \s-1MTU\s0 to set the interface to. You can use lower values (if done
267consistently on all hosts), but this is usually ineffective. 279consistently on all hosts), but this is usually ineffective.
268.IP "MAC=fe:fd:80:00:00:01" 4 280.IP "MAC=fe:fd:80:00:00:01" 4
269.IX Item "MAC=fe:fd:80:00:00:01" 281.IX Item "MAC=fe:fd:80:00:00:01"
270The \s-1MAC\s0 address to set the interface to. The script *must* set the 282The \s-1MAC\s0 address to set the interface to. The script *must* set the
271interface \s-1MAC\s0 to this value. On GNU/Linux you will most likely use this: 283interface \s-1MAC\s0 to this value. You will most likely use one of these:
272.Sp 284.Sp
273.Vb 1 285.Vb 2
274\& ip link set $IFNAME address $MAC mtu $MTU up 286\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
287\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
275.Ve 288.Ve
289.IP "IFTYPE=native" 4
290.IX Item "IFTYPE=native"
291.PD 0
292.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
293.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
294.PD
295The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os
296name in lowercase) that this vpe was configured for. Can be used to select
297the correct syntax to use for network-related commands.
276.IP "NODENAME=branch1" 4 298.IP "NODENAME=branch1" 4
277.IX Item "NODENAME=branch1" 299.IX Item "NODENAME=branch1"
278The nickname of the current node, as passed to the vped daemon. 300The nickname of the current node, as passed to the vped daemon.
279.IP "NODEID=1" 4 301.IP "NODEID=1" 4
280.IX Item "NODEID=1" 302.IX Item "NODEID=1"
… …
311The node id of the remote node. 333The node id of the remote node.
312.IP "DESTIP=188.13.66.8" 4 334.IP "DESTIP=188.13.66.8" 4
313.IX Item "DESTIP=188.13.66.8" 335.IX Item "DESTIP=188.13.66.8"
314The numerical \s-1IP\s0 address of the remote host (vped accepts connections from 336The numerical \s-1IP\s0 address of the remote host (vped accepts connections from
315everywhere, as long as the other host can authenticate itself). 337everywhere, as long as the other host can authenticate itself).
316.IP "DESTPORT=407 # deprecated" 4 338.IP "DESTPORT=655 # deprecated" 4
317.IX Item "DESTPORT=407 # deprecated" 339.IX Item "DESTPORT=655 # deprecated"
318The \s-1UDP\s0 port used by the other side. 340The \s-1UDP\s0 port used by the other side.
319.IP "STATE=UP" 4 341.IP "STATE=UP" 4
320.IX Item "STATE=UP" 342.IX Item "STATE=UP"
321Node-up scripts get called with STATE=UP, node-down scripts get called 343Node-up scripts get called with STATE=UP, node-down scripts get called
322with STATE=DOWN. 344with STATE=DOWN.
… …
336.Ve 358.Ve
337.RE 359.RE
338.IP "node-down = relative-or-absolute-path" 4 360.IP "node-down = relative-or-absolute-path" 4
339.IX Item "node-down = relative-or-absolute-path" 361.IX Item "node-down = relative-or-absolute-path"
340Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 362Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
363.IP "http-proxy-host = hostname/ip" 4
364.IX Item "http-proxy-host = hostname/ip"
365The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if vpe was
366compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
367tcp connections through a http proxy server.
368.Sp
369\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
370port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
371requires authentication.
372.Sp
373Please note that vpe will still try to resolve all hostnames in the
374configuration file, so if you are behind a proxy without access to a dns
375server better use numerical \s-1IP\s0 addresses.
376.Sp
377To make best use of this option disable all protocols except tcp in your
378config file and make sure your routers (or all other hosts) are listening
379on a port that the proxy allows (443, https, is a common choice).
380.Sp
381If you have a router, connecting to it will suffice. Otherwise tcp must be
382enabled on all hosts.
383.Sp
384Example:
385.Sp
386.Vb 3
387\& http-proxy-host = proxy.example.com
388\& http-proxy-port = 3128 # 8080 is another common choice
389\& http-proxy-auth = schmorp:grumbeere
390.Ve
391.IP "http-proxy-port = proxy-tcp-port" 4
392.IX Item "http-proxy-port = proxy-tcp-port"
393The port where your proxy server listens.
394.IP "http-proxy-auth = login:password" 4
395.IX Item "http-proxy-auth = login:password"
396The optional login and password used to authenticate to the proxy server,
397seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
398currently supported.
341.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 399.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
342.IX Subsection "NODE SPECIFIC SETTINGS" 400.IX Subsection "NODE SPECIFIC SETTINGS"
343The following settings are node\-specific, that is, every node can have 401The following settings are node\-specific, that is, every node can have
344different settings, even within the same vped instance. Settings that are 402different settings, even within the same vped instance. Settings that are
345executed before the first node section set the defaults, settings that are 403executed before the first node section set the defaults, settings that are
346executed within a node section only apply to the given node. 404executed within a node section only apply to the given node.
347.IP "udp-port = port-number" 4 405.IP "udp-port = port-number" 4
348.IX Item "udp-port = port-number" 406.IX Item "udp-port = port-number"
349Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW407\fR, not 407Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
350officially assigned by \s-1IANA\s0!). 408officially assigned by \s-1IANA\s0!).
409.IP "tcp-port = port-number" 4
410.IX Item "tcp-port = port-number"
411Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
412.IP "enable-rawip = yes|true|on | no|false|off" 4
413.IX Item "enable-rawip = yes|true|on | no|false|off"
414Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
415(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet
416is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
417.IP "enable-udp = yes|true|on | no|false|off" 4
418.IX Item "enable-udp = yes|true|on | no|false|off"
419Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port
420(default: \f(CW\*(C`yes\*(C'\fR). This is a good general choice since \s-1UDP\s0 tunnels well
421through many firewalls.
422.IP "enable-tcp = yes|true|on | no|false|off" 4
423.IX Item "enable-tcp = yes|true|on | no|false|off"
424Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
425(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only
426available when vpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never
427use this transport unless you really must, it is horribly ineffiecent and
428resource-intensive compared to the other transports.
351.IP "router-priority = positive-number" 4 429.IP "router-priority = positive-number" 4
352.IX Item "router-priority = positive-number" 430.IX Item "router-priority = positive-number"
353Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 431Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
354some host tries to connect to another host without a hostname, it asks 432some host tries to connect to another host without a hostname, it asks
355the router host for it's \s-1IP\s0 address. The router host is the one with the 433the router host for it's \s-1IP\s0 address. The router host is the one with the
… …
361try to establish and keep a conenction to the given host), \f(CW\*(C`never\*(C'\fR 439try 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), 440(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 441\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and
364take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 442take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
365don't talk to it). 443don't talk to it).
366.IP "inherit-tos = yes|no" 4 444.IP "inherit-tos = yes|true|on | no|false|off" 4
367.IX Item "inherit-tos = yes|no" 445.IX Item "inherit-tos = yes|true|on | no|false|off"
368Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 446Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
369sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 447sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
370outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 448outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
371to the tunnel device, which is usually what you want. 449to the tunnel device, which is usually what you want.
372.IP "compress = yes|no" 4 450.IP "compress = yes|true|on | no|false|off" 4
373.IX Item "compress = yes|no" 451.IX Item "compress = yes|true|on | no|false|off"
374Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR, 452Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
375compression is really cheap even on slow computers and has no size 453Compression is really cheap even on slow computers and has no size
376overhead at all). 454overhead at all, so enabling this is a good idea.
377.SH "CONFIG DIRECTORY LAYOUT" 455.SH "CONFIG DIRECTORY LAYOUT"
378.IX Header "CONFIG DIRECTORY LAYOUT" 456.IX Header "CONFIG DIRECTORY LAYOUT"
379The default (or recommended) directory layout for the config directory is: 457The default (or recommended) directory layout for the config directory is:
380.IP "vped.conf" 4 458.IP "vped.conf" 4
381.IX Item "vped.conf" 459.IX Item "vped.conf"
… …
392.IP "pubkey/nodename" 4 470.IP "pubkey/nodename" 4
393.IX Item "pubkey/nodename" 471.IX Item "pubkey/nodename"
394The public keys of the other nodes, one file per node. 472The public keys of the other nodes, one file per node.
395.SH "SEE ALSO" 473.SH "SEE ALSO"
396.IX Header "SEE ALSO" 474.IX Header "SEE ALSO"
397\&\fIvpe\fR\|(8), \fIvped\fR\|(8), \fIvpectrl\fR\|(8). 475\&\fIvpe\fR\|(5), \fIvped\fR\|(8), \fIvpectrl\fR\|(8).
398.SH "AUTHOR" 476.SH "AUTHOR"
399.IX Header "AUTHOR" 477.IX Header "AUTHOR"
400Marc Lehmann <vpe@plan9.de> 478Marc Lehmann <vpe@plan9.de>

Diff Legend

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