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.11 by pcg, Mon May 10 18:57:07 2004 UTC

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
… …
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 "2004-04-01" "1.5" "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 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
… …
259.Sp 260.Sp
260The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through 261The 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 262firewalls (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 263common 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) 264(\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 265.IP "if-up = relative-or-absolute-path" 4
275.IX Item "if-up = relative-or-absolute-path" 266.IX Item "if-up = relative-or-absolute-path"
276Sets the path of a script that should be called immediately after the 267Sets the path of a script that should be called immediately after the
277network interface is initialized (but not neccessarily up). The following 268network interface is initialized (but not neccessarily up). The following
278environment variables are passed to it (the values are just examples): 269environment 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 279The \s-1MTU\s0 to set the interface to. You can use lower values (if done
289consistently on all hosts), but this is usually ineffective. 280consistently on all hosts), but this is usually ineffective.
290.IP "MAC=fe:fd:80:00:00:01" 4 281.IP "MAC=fe:fd:80:00:00:01" 4
291.IX Item "MAC=fe:fd:80:00:00:01" 282.IX Item "MAC=fe:fd:80:00:00:01"
292The \s-1MAC\s0 address to set the interface to. The script *must* set the 283The \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: 284interface \s-1MAC\s0 to this value. You will most likely use one of these:
294.Sp 285.Sp
295.Vb 1 286.Vb 2
296\& 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
297.Ve 289.Ve
290.Sp
291Please 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
298The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os
299name in lowercase) that this vpe was configured for. Can be used to select
300the correct syntax to use for network-related commands.
298.IP "NODENAME=branch1" 4 301.IP "NODENAME=branch1" 4
299.IX Item "NODENAME=branch1" 302.IX Item "NODENAME=branch1"
300The nickname of the current node, as passed to the vped daemon. 303The nickname of the current node, as passed to the vped daemon.
301.IP "NODEID=1" 4 304.IP "NODEID=1" 4
302.IX Item "NODEID=1" 305.IX Item "NODEID=1"
… …
333The node id of the remote node. 336The node id of the remote node.
334.IP "DESTIP=188.13.66.8" 4 337.IP "DESTIP=188.13.66.8" 4
335.IX Item "DESTIP=188.13.66.8" 338.IX Item "DESTIP=188.13.66.8"
336The numerical \s-1IP\s0 address of the remote host (vped accepts connections from 339The numerical \s-1IP\s0 address of the remote host (vped accepts connections from
337everywhere, as long as the other host can authenticate itself). 340everywhere, as long as the other host can authenticate itself).
338.IP "DESTPORT=407 # deprecated" 4 341.IP "DESTPORT=655 # deprecated" 4
339.IX Item "DESTPORT=407 # deprecated" 342.IX Item "DESTPORT=655 # deprecated"
340The \s-1UDP\s0 port used by the other side. 343The \s-1UDP\s0 port used by the other side.
341.IP "STATE=UP" 4 344.IP "STATE=UP" 4
342.IX Item "STATE=UP" 345.IX Item "STATE=UP"
343Node-up scripts get called with STATE=UP, node-down scripts get called 346Node-up scripts get called with STATE=UP, node-down scripts get called
344with STATE=DOWN. 347with STATE=DOWN.
… …
358.Ve 361.Ve
359.RE 362.RE
360.IP "node-down = relative-or-absolute-path" 4 363.IP "node-down = relative-or-absolute-path" 4
361.IX Item "node-down = relative-or-absolute-path" 364.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. 365Same 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"
368The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if vpe was
369compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of
370tcp 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
373port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy
374requires authentication.
375.Sp
376Please note that vpe will still try to resolve all hostnames in the
377configuration file, so if you are behind a proxy without access to a dns
378server better use numerical \s-1IP\s0 addresses.
379.Sp
380To make best use of this option disable all protocols except tcp in your
381config file and make sure your routers (or all other hosts) are listening
382on a port that the proxy allows (443, https, is a common choice).
383.Sp
384If you have a router, connecting to it will suffice. Otherwise tcp must be
385enabled on all hosts.
386.Sp
387Example:
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"
396The port where your proxy server listens.
397.IP "http-proxy-auth = login:password" 4
398.IX Item "http-proxy-auth = login:password"
399The optional login and password used to authenticate to the proxy server,
400seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is
401currently supported.
402.IP "pid-file = path" 4
403.IX Item "pid-file = path"
404The path to the pid file to check and create (Default:
363.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 405.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
364.IX Subsection "NODE SPECIFIC SETTINGS" 406.IX Subsection "NODE SPECIFIC SETTINGS"
365The following settings are node\-specific, that is, every node can have 407The following settings are node\-specific, that is, every node can have
366different settings, even within the same vped instance. Settings that are 408different settings, even within the same vped instance. Settings that are
367executed before the first node section set the defaults, settings that are 409executed before the first node section set the defaults, settings that are
368executed within a node section only apply to the given node. 410executed within a node section only apply to the given node.
369.IP "udp-port = port-number" 4 411.IP "udp-port = port-number" 4
370.IX Item "udp-port = port-number" 412.IX Item "udp-port = port-number"
371Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW407\fR, not 413Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
372officially assigned by \s-1IANA\s0!). 414officially assigned by \s-1IANA\s0!).
415.IP "tcp-port = port-number" 4
416.IX Item "tcp-port = port-number"
417Similar 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"
420Enable 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
422is 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"
425Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`yes\*(C'\fR,
426but this will change!). This is a good general choice since \s-1UDP\s0 tunnels
427well 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
430some 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"
433Enable 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
435available when vpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never
436use this transport unless you really must, it is horribly ineffiecent and
437resource-intensive compared to the other transports.
373.IP "router-priority = positive-number" 4 438.IP "router-priority = positive-number" 4
374.IX Item "router-priority = positive-number" 439.IX Item "router-priority = positive-number"
375Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 440Sets 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 441some 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 442the 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