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.3 by pcg, Sun Mar 23 14:49:16 2003 UTC vs.
Revision 1.12 by pcg, Mon Jun 7 03:21:16 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
… …
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-23" "0.1" "Virtual Private Ethernet" 132.TH VPED.CONF 5 "2004-06-07" "1.7" "Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134vped.conf \- vpe daemon configuration file 134vped.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 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
… …
166The only exception to the above is the \*(L"on\*(R" directive that can prefix any 167The only exception to the above is the \*(L"on\*(R" directive that can prefix any
167\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 168\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or
168(if the nodename starts with \*(L"!\*(R") on all nodes except the named one. 169(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
169.PP 170.PP
170.Vb 3 171.Vb 3
171\& name = value 172\& name = value
172\& on branch1 loglevel = noise 173\& on branch1 loglevel = noise
173\& on !branch2 connect = ondemand 174\& on !branch2 connect = ondemand
174.Ve 175.Ve
175.PP 176.PP
176All settings are executed \*(L"in order\*(R", that is, later settings of the same 177All settings are executed \*(L"in order\*(R", that is, later settings of the same
177variable overwrite earlier ones. 178variable overwrite earlier ones.
178.SH "ANATOMY OF A CONFIG FILE" 179.SH "ANATOMY OF A CONFIG FILE"
… …
214\&\f(CW\*(C`vpectrl\*(C'\fR puts them. 215\&\f(CW\*(C`vpectrl\*(C'\fR puts them.
215.Sp 216.Sp
216Since only the private key file of the current node is used and the 217Since 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 218private key file should be kept secret per-host to avoid spoofings, it is
218not recommended to use this feature. 219not 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"
221Should the tun/tap device be made persistent, that is, should the device 222Should 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 223stay up even when vped exits? Some versions of the tunnel device have
223problems sending packets when vped is restarted in persistent mode, so 224problems sending packets when vped is restarted in persistent mode, so
224if the connections can be established but you cannot send packets from 225if 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 226the 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. 248this information to the \f(CW\*(C`if\-up\*(C'\fR script.
248.Sp 249.Sp
249Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). 250Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
250.Sp 251.Sp
251This value must be the minimum of the mtu values of all hosts. 252This 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"
255Sets the protocol number to be used for the rawip protocol. This is a
256global option because all hosts must use the same protocol, and since
257there are no port numbers, you cannot easily run more than one vped
258instance using the same protocol, nor can you share the protocol with
259other programs.
260.Sp
261The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
262firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
263common 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"
254Sets 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
255network interface is initialized (but not neccessarily up). The following 268network interface is initialized (but not neccessarily up). The following
256environment variables are passed to it (the values are just examples): 269environment 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 279The \s-1MTU\s0 to set the interface to. You can use lower values (if done
267consistently on all hosts), but this is usually ineffective. 280consistently 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"
270The \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
271interface \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:
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
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.
276.IP "NODENAME=branch1" 4 301.IP "NODENAME=branch1" 4
277.IX Item "NODENAME=branch1" 302.IX Item "NODENAME=branch1"
278The nickname of the current node, as passed to the vped daemon. 303The 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"
… …
284.RS 4 309.RS 4
285.Sp 310.Sp
286Here is a simple if-up script: 311Here is a simple if-up script:
287.Sp 312.Sp
288.Vb 5 313.Vb 5
289\& #!/bin/sh 314\& #!/bin/sh
290\& ip link set $IFNAME address $MAC mtu $MTU up 315\& ip link set $IFNAME address $MAC mtu $MTU up
291\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 316\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
292\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 317\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
293\& ip route add 10.0.0.0/8 dev $IFNAME 318\& ip route add 10.0.0.0/8 dev $IFNAME
294.Ve 319.Ve
295.Sp 320.Sp
296More complicated examples (using routing to reduce arp traffic) can be 321More complicated examples (using routing to reduce arp traffic) can be
297found in the etc/ subdirectory of the distribution. 322found in the etc/ subdirectory of the distribution.
298.RE 323.RE
… …
311The node id of the remote node. 336The 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"
314The 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
315everywhere, as long as the other host can authenticate itself). 340everywhere, 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"
318The \s-1UDP\s0 port used by the other side. 343The \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"
321Node-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
322with STATE=DOWN. 347with STATE=DOWN.
… …
325.Sp 350.Sp
326Here is a nontrivial example that uses nsupdate to update the name => ip 351Here is a nontrivial example that uses nsupdate to update the name => ip
327mapping in some dns zone: 352mapping in some dns zone:
328.Sp 353.Sp
329.Vb 6 354.Vb 6
330\& #!/bin/sh 355\& #!/bin/sh
331\& { 356\& {
332\& echo update delete $DESTNODE.lowttl.example.net. a 357\& echo update delete $DESTNODE.lowttl.example.net. a
333\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 358\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
334\& echo 359\& echo
335\& } | nsupdate -d -k $CONFBASE:key.example.net. 360\& } | nsupdate -d -k $CONFBASE:key.example.net.
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"
340Same 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:
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"
343The following settings are node\-specific, that is, every node can have 407The following settings are node\-specific, that is, every node can have
344different settings, even within the same vped instance. Settings that are 408different settings, even within the same vped instance. Settings that are
345executed before the first node section set the defaults, settings that are 409executed before the first node section set the defaults, settings that are
346executed within a node section only apply to the given node. 410executed 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"
349Sets 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
350officially 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.
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"
353Sets 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
354some 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
355the 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
… …
361try to establish and keep a conenction to the given host), \f(CW\*(C`never\*(C'\fR 448try 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
364take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 451take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
365don't talk to it). 452don'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"
368Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 455Wether 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 456sending 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 457outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
371to the tunnel device, which is usually what you want. 458to 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"
374Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR, 461Wether 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 462Compression is really cheap even on slow computers and has no size
376overhead at all). 463overhead 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"
379The default (or recommended) directory layout for the config directory is: 466The 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"
394The public keys of the other nodes, one file per node. 481The 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"
400Marc Lehmann <vpe@plan9.de> 487Marc Lehmann <vpe@plan9.de>

Diff Legend

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