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.5 by pcg, Fri Mar 28 18:14:57 2003 UTC vs.
Revision 1.10 by pcg, Thu Oct 16 21:57:54 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
… …
126. ds Ae AE 126. ds Ae AE
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "VPED.CONF.5 5" 131.IX Title "VPED.CONF 5"
132.TH VPED.CONF.5 5 "2003-03-28" "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
… …
259.Sp 259.Sp
260The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 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 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 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) 263(\s-1ENCAP\s0, rfc1241)
264.IP "enable-udp = yes|true|on | no|false|off" 4
265.IX Item "enable-udp = yes|true|on | no|false|off"
266Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port
267(default: \f(CW\*(C`yes\*(C'\fR). This is a good general choice since \s-1UDP\s0 tunnels well
268through many firewalls.
269.IP "enable-rawip = yes|true|on | no|false|off" 4
270.IX Item "enable-rawip = yes|true|on | no|false|off"
271Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
272(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet
273is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
274.IP "if-up = relative-or-absolute-path" 4 264.IP "if-up = relative-or-absolute-path" 4
275.IX Item "if-up = relative-or-absolute-path" 265.IX Item "if-up = relative-or-absolute-path"
276Sets 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
277network interface is initialized (but not neccessarily up). The following 267network interface is initialized (but not neccessarily up). The following
278environment variables are passed to it (the values are just examples): 268environment variables are passed to it (the values are just examples):
… …
288The \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
289consistently on all hosts), but this is usually ineffective. 279consistently on all hosts), but this is usually ineffective.
290.IP "MAC=fe:fd:80:00:00:01" 4 280.IP "MAC=fe:fd:80:00:00:01" 4
291.IX Item "MAC=fe:fd:80:00:00:01" 281.IX Item "MAC=fe:fd:80:00:00:01"
292The \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
293interface \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:
294.Sp 284.Sp
295.Vb 1 285.Vb 2
296\& 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
297.Ve 288.Ve
289.Sp
290Please see the \f(CW\*(C`vpe.osdep(5)\*(C'\fR manpage for platform-specific information.
291.IP "IFTYPE=native # or tincd" 4
292.IX Item "IFTYPE=native # or tincd"
293.PD 0
294.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
295.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
296.PD
297The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os
298name in lowercase) that this vpe was configured for. Can be used to select
299the correct syntax to use for network-related commands.
298.IP "NODENAME=branch1" 4 300.IP "NODENAME=branch1" 4
299.IX Item "NODENAME=branch1" 301.IX Item "NODENAME=branch1"
300The nickname of the current node, as passed to the vped daemon. 302The nickname of the current node, as passed to the vped daemon.
301.IP "NODEID=1" 4 303.IP "NODEID=1" 4
302.IX Item "NODEID=1" 304.IX Item "NODEID=1"
… …
333The node id of the remote node. 335The node id of the remote node.
334.IP "DESTIP=188.13.66.8" 4 336.IP "DESTIP=188.13.66.8" 4
335.IX Item "DESTIP=188.13.66.8" 337.IX Item "DESTIP=188.13.66.8"
336The numerical \s-1IP\s0 address of the remote host (vped accepts connections from 338The numerical \s-1IP\s0 address of the remote host (vped accepts connections from
337everywhere, as long as the other host can authenticate itself). 339everywhere, as long as the other host can authenticate itself).
338.IP "DESTPORT=407 # deprecated" 4 340.IP "DESTPORT=655 # deprecated" 4
339.IX Item "DESTPORT=407 # deprecated" 341.IX Item "DESTPORT=655 # deprecated"
340The \s-1UDP\s0 port used by the other side. 342The \s-1UDP\s0 port used by the other side.
341.IP "STATE=UP" 4 343.IP "STATE=UP" 4
342.IX Item "STATE=UP" 344.IX Item "STATE=UP"
343Node-up scripts get called with STATE=UP, node-down scripts get called 345Node-up scripts get called with STATE=UP, node-down scripts get called
344with STATE=DOWN. 346with STATE=DOWN.
… …
358.Ve 360.Ve
359.RE 361.RE
360.IP "node-down = relative-or-absolute-path" 4 362.IP "node-down = relative-or-absolute-path" 4
361.IX Item "node-down = relative-or-absolute-path" 363.IX Item "node-down = relative-or-absolute-path"
362Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 364Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
365.IP "http-proxy-host = hostname/ip" 4
366.IX Item "http-proxy-host = hostname/ip"
367The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if vpe was
368compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
369tcp connections through a http proxy server.
370.Sp
371\&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and
372port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
373requires authentication.
374.Sp
375Please note that vpe will still try to resolve all hostnames in the
376configuration file, so if you are behind a proxy without access to a dns
377server better use numerical \s-1IP\s0 addresses.
378.Sp
379To make best use of this option disable all protocols except tcp in your
380config file and make sure your routers (or all other hosts) are listening
381on a port that the proxy allows (443, https, is a common choice).
382.Sp
383If you have a router, connecting to it will suffice. Otherwise tcp must be
384enabled on all hosts.
385.Sp
386Example:
387.Sp
388.Vb 3
389\& http-proxy-host = proxy.example.com
390\& http-proxy-port = 3128 # 8080 is another common choice
391\& http-proxy-auth = schmorp:grumbeere
392.Ve
393.IP "http-proxy-port = proxy-tcp-port" 4
394.IX Item "http-proxy-port = proxy-tcp-port"
395The port where your proxy server listens.
396.IP "http-proxy-auth = login:password" 4
397.IX Item "http-proxy-auth = login:password"
398The optional login and password used to authenticate to the proxy server,
399seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
400currently supported.
363.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 401.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
364.IX Subsection "NODE SPECIFIC SETTINGS" 402.IX Subsection "NODE SPECIFIC SETTINGS"
365The following settings are node\-specific, that is, every node can have 403The following settings are node\-specific, that is, every node can have
366different settings, even within the same vped instance. Settings that are 404different settings, even within the same vped instance. Settings that are
367executed before the first node section set the defaults, settings that are 405executed before the first node section set the defaults, settings that are
368executed within a node section only apply to the given node. 406executed within a node section only apply to the given node.
369.IP "udp-port = port-number" 4 407.IP "udp-port = port-number" 4
370.IX Item "udp-port = port-number" 408.IX Item "udp-port = port-number"
371Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW407\fR, not 409Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
372officially assigned by \s-1IANA\s0!). 410officially assigned by \s-1IANA\s0!).
411.IP "tcp-port = port-number" 4
412.IX Item "tcp-port = port-number"
413Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
414.IP "enable-rawip = yes|true|on | no|false|off" 4
415.IX Item "enable-rawip = yes|true|on | no|false|off"
416Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
417(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet
418is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
419.IP "enable-udp = yes|true|on | no|false|off" 4
420.IX Item "enable-udp = yes|true|on | no|false|off"
421Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port
422(default: \f(CW\*(C`yes\*(C'\fR). This is a good general choice since \s-1UDP\s0 tunnels well
423through many firewalls.
424.IP "enable-tcp = yes|true|on | no|false|off" 4
425.IX Item "enable-tcp = yes|true|on | no|false|off"
426Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
427(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only
428available when vpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never
429use this transport unless you really must, it is horribly ineffiecent and
430resource-intensive compared to the other transports.
373.IP "router-priority = positive-number" 4 431.IP "router-priority = positive-number" 4
374.IX Item "router-priority = positive-number" 432.IX Item "router-priority = positive-number"
375Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 433Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
376some host tries to connect to another host without a hostname, it asks 434some host tries to connect to another host without a hostname, it asks
377the router host for it's \s-1IP\s0 address. The router host is the one with the 435the router host for it's \s-1IP\s0 address. The router host is the one with the

Diff Legend

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