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

Comparing gvpe/doc/vped.conf.5.pod (file contents):
Revision 1.4 by pcg, Mon Apr 7 01:12:56 2003 UTC vs.
Revision 1.10 by pcg, Mon Jun 7 03:21:16 2004 UTC

1=head1 NAME 1=head1 NAME
2 2
3vped.conf - vpe daemon configuration file 3vped.conf - configuration file for the GNU VPE daemon
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 enable-udp = yes
7 udp-port = 407 8 udp-port = 407
8 mtu = 1492 9 mtu = 1492
9 ifname = vpn0 10 ifname = vpn0
10 11
11 node = branch1 12 node = branch1
… …
158consistently on all hosts), but this is usually ineffective. 159consistently on all hosts), but this is usually ineffective.
159 160
160=item MAC=fe:fd:80:00:00:01 161=item MAC=fe:fd:80:00:00:01
161 162
162The MAC address to set the interface to. The script *must* set the 163The MAC address to set the interface to. The script *must* set the
163interface MAC to this value. On GNU/Linux you will most likely use this: 164interface MAC to this value. You will most likely use one of these:
164 165
165 ip link set $IFNAME address $MAC mtu $MTU up 166 ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
167 ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
168
169Please see the C<vpe.osdep(5)> manpage for platform-specific information.
170
171=item IFTYPE=native # or tincd
172
173=item IFSUBTYPE=linux # or freebsd, darwin etc..
174
175The interface type (C<native> or C<tincd>) and the subtype (usually the os
176name in lowercase) that this vpe was configured for. Can be used to select
177the correct syntax to use for network-related commands.
166 178
167=item NODENAME=branch1 179=item NODENAME=branch1
168 180
169The nickname of the current node, as passed to the vped daemon. 181The nickname of the current node, as passed to the vped daemon.
170 182
… …
206=item DESTIP=188.13.66.8 218=item DESTIP=188.13.66.8
207 219
208The numerical IP address of the remote host (vped accepts connections from 220The numerical IP address of the remote host (vped accepts connections from
209everywhere, as long as the other host can authenticate itself). 221everywhere, as long as the other host can authenticate itself).
210 222
211=item DESTPORT=407 # deprecated 223=item DESTPORT=655 # deprecated
212 224
213The UDP port used by the other side. 225The UDP port used by the other side.
214 226
215=item STATE=UP 227=item STATE=UP
216 228
… …
233 245
234Same as C<node-up>, but gets called whenever a connection is lost. 246Same as C<node-up>, but gets called whenever a connection is lost.
235 247
236=item http-proxy-host = hostname/ip 248=item http-proxy-host = hostname/ip
237 249
238The C<http-proxy>-family of options are only available if vpe was 250The C<http-proxy-*> family of options are only available if vpe was
239compiled with the C<--enable-http-proxy> option and enable tunneling of 251compiled with the C<--enable-http-proxy> option and enable tunneling of
240tcp connections through a http proxy server. 252tcp connections through a http proxy server.
241 253
242C<http-proxy-host> and C<http-proxy-port> should specify the hostname and 254C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
243port number of the proxy server. See C<http-proxy-loginpw> if your proxy 255port number of the proxy server. See C<http-proxy-loginpw> if your proxy
… …
267=item http-proxy-auth = login:password 279=item http-proxy-auth = login:password
268 280
269The optional login and password used to authenticate to the proxy server, 281The optional login and password used to authenticate to the proxy server,
270seperated by a literal colon (C<:>). Only basic authentication is 282seperated by a literal colon (C<:>). Only basic authentication is
271currently supported. 283currently supported.
284
285=item pid-file = path
286
287The path to the pid file to check and create (Default:
272 288
273=back 289=back
274 290
275=head2 NODE SPECIFIC SETTINGS 291=head2 NODE SPECIFIC SETTINGS
276 292
… …
281 297
282=over 4 298=over 4
283 299
284=item udp-port = port-number 300=item udp-port = port-number
285 301
286Sets the port number used by the UDP protocol (default: C<407>, not 302Sets the port number used by the UDP protocol (default: C<655>, not
287officially assigned by IANA!). 303officially assigned by IANA!).
288 304
289=item tcp-port = port-number 305=item tcp-port = port-number
290 306
291Similar to C<udp-port> (default: C<407>), but sets the TCP port number. 307Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
292 308
293=item enable-rawip = yes|true|on | no|false|off 309=item enable-rawip = yes|true|on | no|false|off
294 310
295Enable the RAW IPv4 transport using the C<ip-proto> protocol 311Enable the RAW IPv4 transport using the C<ip-proto> protocol
296(default: C<no>). This is the best choice, since the overhead per packet 312(default: C<no>). This is the best choice, since the overhead per packet
297is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+). 313is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+).
298 314
299=item enable-udp = yes|true|on | no|false|off 315=item enable-udp = yes|true|on | no|false|off
300 316
301Enable the UDPv4 transport using the C<udp-port> port 317Enable the UDPv4 transport using the C<udp-port> port (default: C<yes>,
302(default: C<yes>). This is a good general choice since UDP tunnels well 318but this will change!). This is a good general choice since UDP tunnels
303through many firewalls. 319well through many firewalls.
320
321NOTE: Please specify C<enable-udp = yes> even though it is the default, as
322some future version will have all protocols disabled by default.
304 323
305=item enable-tcp = yes|true|on | no|false|off 324=item enable-tcp = yes|true|on | no|false|off
306 325
307Enable the TCPv4 transport using the C<tcp-port> port 326Enable the TCPv4 transport using the C<tcp-port> port
308(default: C<no>). Support for this horribly unsuitable protocol is only 327(default: C<no>). Support for this horribly unsuitable protocol is only

Diff Legend

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