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.1 by pcg, Fri Mar 28 18:14:57 2003 UTC vs.
Revision 1.4 by pcg, Mon Apr 7 01:12:56 2003 UTC

… …
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 udp-port = 407 7 udp-port = 407
8 mtu = 1492 8 mtu = 1492
9 ifname = vpn0 9 ifname = vpn0
10 10
11 node = branch1 11 node = branch1
12 hostname = 1.2.3.4 12 hostname = 1.2.3.4
13 13
14 node = branch2 14 node = branch2
15 hostname = www.example.net 15 hostname = www.example.net
… …
134The default is 47 (GRE), which has a good chance of tunneling through 134The default is 47 (GRE), which has a good chance of tunneling through
135firewalls (but note that the rawip protocol is not GRE compatible). Other 135firewalls (but note that the rawip protocol is not GRE compatible). Other
136common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98 136common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98
137(ENCAP, rfc1241) 137(ENCAP, rfc1241)
138 138
139=item enable-udp = yes|true|on | no|false|off
140
141Enable the UDPv4 transport using the C<udp-port> port
142(default: C<yes>). This is a good general choice since UDP tunnels well
143through many firewalls.
144
145=item enable-rawip = yes|true|on | no|false|off
146
147Enable the RAW IPv4 transport using the C<ip-proto> protocol
148(default: C<no>). This is the best choice, since the overhead per packet
149is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+).
150
151=item if-up = relative-or-absolute-path 139=item if-up = relative-or-absolute-path
152 140
153Sets the path of a script that should be called immediately after the 141Sets the path of a script that should be called immediately after the
154network interface is initialized (but not neccessarily up). The following 142network interface is initialized (but not neccessarily up). The following
155environment variables are passed to it (the values are just examples): 143environment variables are passed to it (the values are just examples):
… …
243 231
244=item node-down = relative-or-absolute-path 232=item node-down = relative-or-absolute-path
245 233
246Same as C<node-up>, but gets called whenever a connection is lost. 234Same as C<node-up>, but gets called whenever a connection is lost.
247 235
236=item http-proxy-host = hostname/ip
237
238The C<http-proxy>-family of options are only available if vpe was
239compiled with the C<--enable-http-proxy> option and enable tunneling of
240tcp connections through a http proxy server.
241
242C<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
244requires authentication.
245
246Please note that vpe will still try to resolve all hostnames in the
247configuration file, so if you are behind a proxy without access to a dns
248server better use numerical IP addresses.
249
250To make best use of this option disable all protocols except tcp in your
251config file and make sure your routers (or all other hosts) are listening
252on a port that the proxy allows (443, https, is a common choice).
253
254If you have a router, connecting to it will suffice. Otherwise tcp must be
255enabled on all hosts.
256
257Example:
258
259 http-proxy-host = proxy.example.com
260 http-proxy-port = 3128 # 8080 is another common choice
261 http-proxy-auth = schmorp:grumbeere
262
263=item http-proxy-port = proxy-tcp-port
264
265The port where your proxy server listens.
266
267=item http-proxy-auth = login:password
268
269The optional login and password used to authenticate to the proxy server,
270seperated by a literal colon (C<:>). Only basic authentication is
271currently supported.
272
248=back 273=back
249 274
250=head2 NODE SPECIFIC SETTINGS 275=head2 NODE SPECIFIC SETTINGS
251 276
252The following settings are node-specific, that is, every node can have 277The following settings are node-specific, that is, every node can have
… …
258 283
259=item udp-port = port-number 284=item udp-port = port-number
260 285
261Sets the port number used by the UDP protocol (default: C<407>, not 286Sets the port number used by the UDP protocol (default: C<407>, not
262officially assigned by IANA!). 287officially assigned by IANA!).
288
289=item tcp-port = port-number
290
291Similar to C<udp-port> (default: C<407>), but sets the TCP port number.
292
293=item enable-rawip = yes|true|on | no|false|off
294
295Enable the RAW IPv4 transport using the C<ip-proto> protocol
296(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+).
298
299=item enable-udp = yes|true|on | no|false|off
300
301Enable the UDPv4 transport using the C<udp-port> port
302(default: C<yes>). This is a good general choice since UDP tunnels well
303through many firewalls.
304
305=item enable-tcp = yes|true|on | no|false|off
306
307Enable the TCPv4 transport using the C<tcp-port> port
308(default: C<no>). Support for this horribly unsuitable protocol is only
309available when vpe was compiled using the C<--enable-tcp> option. Never
310use this transport unless you really must, it is horribly ineffiecent and
311resource-intensive compared to the other transports.
263 312
264=item router-priority = positive-number 313=item router-priority = positive-number
265 314
266Sets the router priority of the given host (default: C<0>, disabled). If 315Sets the router priority of the given host (default: C<0>, disabled). If
267some host tries to connect to another host without a hostname, it asks 316some host tries to connect to another host without a hostname, it asks

Diff Legend

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