[ViewVC] Diff of: cvs/gvpe/doc/gvpe.conf.5.pod

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs.
Revision 1.16 by pcg, Wed Aug 2 16:58:49 2006 UTC

…		…
21	=head1 DESCRIPTION	21	=head1 DESCRIPTION
22		22
23	The gvpe config file consists of a series of lines that contain C<variable	23	The gvpe config file consists of a series of lines that contain C<variable
24	= value> pairs. Empty lines are ignored. Comments start with a C<#> and	24	= value> pairs. Empty lines are ignored. Comments start with a C<#> and
25	extend to the end of the line. They can be used on their own lines, or	25	extend to the end of the line. They can be used on their own lines, or
26	after any directives. Spaces are allowed before or after the C<=> sign or	26	after any directives. Whitespace is allowed around the C<=> sign or after
27	after values, but not within the variable names or values themselves.	27	values, but not within the variable names or values themselves.
28		28
29	The only exception to the above is the "on" directive that can prefix any	29	The only exception to the above is the "on" directive that can prefix any
30	C<name = value> setting and will only "execute" it on the named node, or	30	C<name = value> setting and will only "execute" it on the named node, or
31	(if the nodename starts with "!") on all nodes except the named one.	31	(if the nodename starts with "!") on all nodes except the named one.
32		32
…		…
60	values on different nodes using C<on>), but will affect the behaviour of	60	values on different nodes using C<on>), but will affect the behaviour of
61	the gvpe daemon and all connections it creates.	61	the gvpe daemon and all connections it creates.
62		62
63	=over 4	63	=over 4
64		64
65	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	65	=item dns-forw-host = hostname/ip
66		66
67	Set the logging level. Connection established messages are logged at level	67	The dns server to forward dns requests to for the DNS tunnel protocol
68	C<info>, notable errors are logged with C<error>. Default is C<info>.	68	(default: C<127.0.0.1>, changing it is highly recommended).
69		69
70	=item node = nickname	70	=item dns-forw-port = port-number
71		71
72	Not really a config setting but introduces a node section. The nickname is	72	The port where the C<dns-forw-host> is to be contacted (default: C<53>,
73	used to select the right configuration section and must be passed as an	73	which is fine in most cases).
74	argument to the gvpe daemon.
75		74
76	=item private-key = relative-path-to-key	75	=item dns-max-outstanding = integer-number-of-requests
77		76
78	Sets the path (relative to the config directory) to the private key	77	The maximum number of outstanding DNS transport requests
79	(default: C<hostkey>). This is a printf format string so every C<%> must	78	(default: C<100>). GVPE will never issue more requests then the given
80	be doubled. A single C<%s> is replaced by the hostname, so you could	79	limit without receiving replies. In heavily overloaded situations it might
81	use paths like C<hostkeys/%s> to fetch the files at the location where	80	help to set this to a low number (e.g. C<3> or even C<1>) to limit the
82	C<gvpectrl> puts them.	81	number of parallel requests.
83		82
84	Since only the private key file of the current node is used and the	83	The default should be working ok for most links.
85	private key file should be kept secret per-host to avoid spoofings, it is	84
86	not recommended to use this feature.	85	=item dns-overlap-factor = float
		86
		87	The DNS transport uses the minimum request latency (B<min_latency>) seen
		88	during a connection as it's timing base. This factor (default: C<0.5>,
		89	must be > 0) is multiplied by B<min_latency> to get the maximum sending
		90	rate (= minimum send interval), i.e. a factor of C<1> means that a new
		91	request might be generated every B<min_latency> seconds, which means on
		92	average there should only ever be one outstanding request. A factor of
		93	C<0.5> means that GVPE will send requests twice as often as the minimum
		94	latency measured.
		95
		96	For congested or picky dns forwarders you could use a value nearer to or
		97	exceeding C<1>.
		98
		99	The default should be working ok for most links.
		100
		101	=item dns-send-interval = send-interval-in-seconds
		102
		103	The minimum send interval (= maximum rate) that the DNS transport will
		104	use to send new DNS requests. GVPE will not exceed this rate even when
		105	the latency is very low. The default is C<0.01>, which means GVPE will
		106	not send more than 100 DNS requests per connection per second. For
		107	high-bandwidth links you could go lower, e.g. to C<0.001> or so. For
		108	congested or rate-limited links, you might want to go higher, say C<0.1>,
		109	C<0.2> or even higher.
		110
		111	The default should be working ok for most links.
		112
		113	=item dns-timeout-factor = float
		114
		115	Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to
		116	get request timeouts. The default of C<8> means that the DNS transport
		117	will resend the request when no reply has been received for longer than
		118	eight times the minimum (= expected) latency, assuming the request or
		119	reply has been lost.
		120
		121	For congested links a higher value might be necessary (e.g. C<30>). If the
		122	link is very stable lower values (e.g. C<2>) might work nicely. Values
		123	near or below C<1> makes no sense whatsoever.
		124
		125	The default should be working ok for most links.
		126
		127	=item if-up = relative-or-absolute-path
		128
		129	Sets the path of a script that should be called immediately after the
		130	network interface is initialized (but not neccessarily up). The following
		131	environment variables are passed to it (the values are just examples).
		132
		133	Variables that have the same value on all nodes:
		134
		135	=over 4
		136
		137	=item CONFBASE=/etc/gvpe
		138
		139	The configuration base directory.
		140
		141	=item IFNAME=vpn0
		142
		143	The network interface to initialize.
		144
		145	=item IFTYPE=native # or tincd
		146
		147	=item IFSUBTYPE=linux # or freebsd, darwin etc..
		148
		149	The interface type (C<native> or C<tincd>) and the subtype (usually the
		150	OS name in lowercase) that this GVPE was configured for. Can be used to
		151	select the correct syntax to use for network-related commands.
		152
		153	=item MTU=1436
		154
		155	The MTU to set the interface to. You can use lower values (if done
		156	consistently on all hosts), but this is usually ineffective.
		157
		158	=item NODES=5
		159
		160	The number of nodes in this GVPE network.
		161
		162	=back
		163
		164	Variables that are node-specific and with values pertaining to the node
		165	running this GVPE:
		166
		167	=over 4
		168
		169	=item IFUPDATA=string
		170
		171	The value of the configuration directive C<if-up-data>.
		172
		173	=item MAC=fe:fd:80:00:00:01
		174
		175	The MAC address the network interface has to use.
		176
		177	Might be used to initialize interfaces on platforms where GVPE does not
		178	do this automatically. Please see the C<gvpe.osdep(5)> manpage for
		179	platform-specific information.
		180
		181	=item NODENAME=branch1
		182
		183	The nickname of the node.
		184
		185	=item NODEID=1
		186
		187	The numerical node ID of the node running this instance of GVPE. The first
		188	node mentioned in the config file gets ID 1, the second ID 2 and so on.
		189
		190	=back
		191
		192	In addition, all node-specific variables (except C<NODEID>) will be
		193	available with a postfix of C<_nodeid>, which contains the value for that
		194	node, e.g. the C<MAC_1> variable contains the MAC address of node #1, while
		195	the C<NODENAME_22> variable contains the name of node #22.
		196
		197	Here is a simple if-up script:
		198
		199	#!/bin/sh
		200	ip link set $IFNAME up
		201	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
		202	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
		203	ip route add 10.0.0.0/8 dev $IFNAME
		204
		205	More complicated examples (using routing to reduce arp traffic) can be
		206	found in the etc/ subdirectory of the distribution.
		207
		208	=item ifname = devname
		209
		210	Sets the tun interface name to the given name. The default is OS-specific
		211	and most probably something like C<tun0>.
87		212
88	=item ifpersist = yes\|true\|on \| no\|false\|off	213	=item ifpersist = yes\|true\|on \| no\|false\|off
89		214
90	Should the tun/tap device be made persistent, that is, should the device	215	Should the tun/tap device be made persistent, that is, should the device
91	stay up even when gvpe exits? Some versions of the tunnel device have	216	stay up even when gvpe exits? Some versions of the tunnel device have
92	problems sending packets when gvpe is restarted in persistent mode, so	217	problems sending packets when gvpe is restarted in persistent mode, so
93	if the connections can be established but you cannot send packets from	218	if the connections can be established but you cannot send packets from
94	the local node, try to set this to C<off> and do an ifconfig down on the	219	the local node, try to set this to C<off> and do an ifconfig down on the
95	device.	220	device.
96		221
97	=item ifname = devname	222	=item ip-proto = numerical-ip-protocol
98		223
99	Sets the tun interface name to the given name. The default is OS-specific	224	Sets the protocol number to be used for the rawip protocol. This is a
100	and most probably something like C<tun0>.	225	global option because all hosts must use the same protocol, and since
		226	there are no port numbers, you cannot easily run more than one gvpe
		227	instance using the same protocol, nor can you share the protocol with
		228	other programs.
101		229
102	=item rekey = seconds	230	The default is 47 (GRE), which has a good chance of tunneling through
		231	firewalls (but note that the rawip protocol is not GRE compatible). Other
		232	common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98
		233	(ENCAP, rfc1241)
103		234
104	Sets the rekeying interval in seconds (default: C<3600>). Connections are	235	=item http-proxy-host = hostname/ip
105	reestablished every C<rekey> seconds.	236
		237	The C<http-proxy-*> family of options are only available if gvpe was
		238	compiled with the C<--enable-http-proxy> option and enable tunneling of
		239	tcp connections through a http proxy server.
		240
		241	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
		242	port number of the proxy server. See C<http-proxy-loginpw> if your proxy
		243	requires authentication.
		244
		245	Please note that gvpe will still try to resolve all hostnames in the
		246	configuration file, so if you are behind a proxy without access to a dns
		247	server better use numerical IP addresses.
		248
		249	To make best use of this option disable all protocols except tcp in your
		250	config file and make sure your routers (or all other hosts) are listening
		251	on a port that the proxy allows (443, https, is a common choice).
		252
		253	If you have a router, connecting to it will suffice. Otherwise tcp must be
		254	enabled on all hosts.
		255
		256	Example:
		257
		258	http-proxy-host = proxy.example.com
		259	http-proxy-port = 3128 # 8080 is another common choice
		260	http-proxy-auth = schmorp:grumbeere
		261
		262	=item http-proxy-port = proxy-tcp-port
		263
		264	The port where your proxy server listens.
		265
		266	=item http-proxy-auth = login:password
		267
		268	The optional login and password used to authenticate to the proxy server,
		269	seperated by a literal colon (C<:>). Only basic authentication is
		270	currently supported.
106		271
107	=item keepalive = seconds	272	=item keepalive = seconds
108		273
109	Sets the keepalive probe interval in seconds (default: C<60>). After this	274	Sets the keepalive probe interval in seconds (default: C<60>). After this
110	many seconds of inactivity the daemon will start to send keepalive probe	275	many seconds of inactivity the daemon will start to send keepalive probe
111	every 5 seconds until it receives a reply from the other end. If no reply	276	every 5 seconds until it receives a reply from the other end. If no reply
112	is received within 30 seconds, the peer is considered unreachable and the	277	is received within 30 seconds, the peer is considered unreachable and the
113	connection is closed.	278	connection is closed.
114		279
		280	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
		281
		282	Set the logging level. Connection established messages are logged at level
		283	C<info>, notable errors are logged with C<error>. Default is C<info>.
		284
115	=item mtu = bytes	285	=item mtu = bytes
116		286
117	Sets the maximum MTU that should be used on outgoing packets (basically	287	Sets the maximum MTU that should be used on outgoing packets (basically
118	the MTU of the outgoing interface) The daemon will automatically calculate	288	the MTU of the outgoing interface) The daemon will automatically calculate
119	maximum overhead (e.g. udp header size, encryption blocksize...) and pass	289	maximum overhead (e.g. udp header size, encryption blocksize...) and pass
…		…
121		291
122	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	292	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
123		293
124	This value must be the minimum of the mtu values of all hosts.	294	This value must be the minimum of the mtu values of all hosts.
125		295
126	=item ip-proto = numerical-ip-protocol	296	=item node = nickname
127		297
128	Sets the protocol number to be used for the rawip protocol. This is a	298	Not really a config setting but introduces a node section. The nickname is
129	global option because all hosts must use the same protocol, and since	299	used to select the right configuration section and must be passed as an
130	there are no port numbers, you cannot easily run more than one gvpe	300	argument to the gvpe daemon.
131	instance using the same protocol, nor can you share the protocol with
132	other programs.
133
134	The default is 47 (GRE), which has a good chance of tunneling through
135	firewalls (but note that the rawip protocol is not GRE compatible). Other
136	common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98
137	(ENCAP, rfc1241)
138
139	=item if-up = relative-or-absolute-path
140
141	Sets the path of a script that should be called immediately after the
142	network interface is initialized (but not neccessarily up). The following
143	environment variables are passed to it (the values are just examples):
144
145	=over 4
146
147	=item CONFBASE=/etc/gvpe
148
149	The configuration base directory.
150
151	=item IFNAME=vpn0
152
153	The interface to initialize.
154
155	=item MTU=1436
156
157	The MTU to set the interface to. You can use lower values (if done
158	consistently on all hosts), but this is usually ineffective.
159
160	=item MAC=fe:fd:80:00:00:01
161
162	The MAC address to set the interface to. The script must set the
163	interface MAC to this value. You will most likely use one of these:
164
165	ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
166	ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
167
168	Please see the C<gvpe.osdep(5)> manpage for platform-specific information.
169
170	=item IFTYPE=native # or tincd
171
172	=item IFSUBTYPE=linux # or freebsd, darwin etc..
173
174	The interface type (C<native> or C<tincd>) and the subtype (usually the os
175	name in lowercase) that this gvpe was configured for. Can be used to select
176	the correct syntax to use for network-related commands.
177
178	=item NODENAME=branch1
179
180	The nickname of the current node, as passed to the gvpe daemon.
181
182	=item NODEID=1
183
184	The numerical node id of the current node. The first node mentioned in the
185	config file gets ID 1, the second ID 2 and so on.
186
187	=back
188
189	Here is a simple if-up script:
190
191	#!/bin/sh
192	ip link set $IFNAME address $MAC mtu $MTU up
193	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
194	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
195	ip route add 10.0.0.0/8 dev $IFNAME
196
197	More complicated examples (using routing to reduce arp traffic) can be
198	found in the etc/ subdirectory of the distribution.
199		301
200	=item node-up = relative-or-absolute-path	302	=item node-up = relative-or-absolute-path
201		303
202	Sets a command (default: no script) that should be called whenever a	304	Sets a command (default: no script) that should be called whenever a
203	connection is established (even on rekeying operations). In addition	305	connection is established (even on rekeying operations). In addition to
204	to the variables passed to C<if-up> scripts, the following environment	306	all the variables passed to C<if-up> scripts, the following environment
205	variables will be set:	307	variables will be set:
206		308
207	=over 4	309	=over 4
208		310
209	=item DESTNODE=branch2	311	=item DESTNODE=branch2
…		…
242		344
243	=item node-down = relative-or-absolute-path	345	=item node-down = relative-or-absolute-path
244		346
245	Same as C<node-up>, but gets called whenever a connection is lost.	347	Same as C<node-up>, but gets called whenever a connection is lost.
246		348
247	=item http-proxy-host = hostname/ip
248
249	The C<http-proxy-*> family of options are only available if gvpe was
250	compiled with the C<--enable-http-proxy> option and enable tunneling of
251	tcp connections through a http proxy server.
252
253	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
254	port number of the proxy server. See C<http-proxy-loginpw> if your proxy
255	requires authentication.
256
257	Please note that gvpe will still try to resolve all hostnames in the
258	configuration file, so if you are behind a proxy without access to a dns
259	server better use numerical IP addresses.
260
261	To make best use of this option disable all protocols except tcp in your
262	config file and make sure your routers (or all other hosts) are listening
263	on a port that the proxy allows (443, https, is a common choice).
264
265	If you have a router, connecting to it will suffice. Otherwise tcp must be
266	enabled on all hosts.
267
268	Example:
269
270	http-proxy-host = proxy.example.com
271	http-proxy-port = 3128 # 8080 is another common choice
272	http-proxy-auth = schmorp:grumbeere
273
274	=item http-proxy-port = proxy-tcp-port
275
276	The port where your proxy server listens.
277
278	=item http-proxy-auth = login:password
279
280	The optional login and password used to authenticate to the proxy server,
281	seperated by a literal colon (C<:>). Only basic authentication is
282	currently supported.
283
284	=item pid-file = path	349	=item pid-file = path
285		350
286	The path to the pid file to check and create (Default:	351	The path to the pid file to check and create
		352	(default: C<LOCALSTATEDIR/run/gvpe.pid>).
		353
		354	=item private-key = relative-path-to-key
		355
		356	Sets the path (relative to the config directory) to the private key
		357	(default: C<hostkey>). This is a printf format string so every C<%> must
		358	be doubled. A single C<%s> is replaced by the hostname, so you could
		359	use paths like C<hostkeys/%s> to fetch the files at the location where
		360	C<gvpectrl> puts them.
		361
		362	Since only the private key file of the current node is used and the
		363	private key file should be kept secret per-host to avoid spoofings, it is
		364	not recommended to use this feature.
		365
		366	=item rekey = seconds
		367
		368	Sets the rekeying interval in seconds (default: C<3600>). Connections are
		369	reestablished every C<rekey> seconds.
287		370
288	=back	371	=back
289		372
290	=head2 NODE SPECIFIC SETTINGS	373	=head2 NODE SPECIFIC SETTINGS
291		374
292	The following settings are node-specific, that is, every node can have	375	The following settings are node-specific, that is, every node can have
293	different settings, even within the same gvpe instance. Settings that are	376	different settings, even within the same gvpe instance. Settings that are
294	executed before the first node section set the defaults, settings that are	377	set before the first node section set the defaults, settings that are
295	executed within a node section only apply to the given node.	378	set within a node section only apply to the given node.
296		379
297	=over 4	380	=over 4
298		381
		382	=item allow-direct = nodename
		383
		384	Allow direct connections to this node. See C<deny-direct> for more info.
		385
		386	=item compress = yes\|true\|on \| no\|false\|off
		387
		388	Wether to compress data packets sent to this host (default: C<yes>).
		389	Compression is really cheap even on slow computers and has no size
		390	overhead at all, so enabling this is a good idea.
		391
		392	=item connect = ondemand \| never \| always \| disabled
		393
		394	Sets the connect mode (default: C<always>). It can be C<always> (always
		395	try to establish and keep a connection to the given host), C<never>
		396	(never initiate a connection to the given host, but accept connections),
		397	C<ondemand> (try to establish a connection on the first packet sent, and
		398	take it down after the keepalive interval) or C<disabled> (node is bad,
		399	don't talk to it).
		400
		401	=item deny-direct = nodename \| *
		402
		403	Deny direct connections to the specified node (or all nodes when C<*>
		404	is given). Only one node can be specified, but you can use multiple
		405	C<allow-direct> and C<deny-direct> statements. This only makes sense in
		406	networks with routers, as routers are required for indirect connections.
		407
		408	Sometimes, a node cannot reach some other nodes for reasons of network
		409	connectivity. For example, a node behind a firewall that only allows
		410	conenctions to/from a single other node in the network. In this case one
		411	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
		412	node I<must> be a router for this to work).
		413
		414	The algorithm to check wether a connection may be direct is as follows:
		415
		416	1. Other node mentioned in a C<allow-direct>? If yes, allow the connection.
		417
		418	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
		419
		420	3. Allow the connection.
		421
		422	That is, C<allow-direct> takes precedence over C<deny-direct>.
		423
		424	The check is done in both directions, i.e. both nodes must allow a direct
		425	connection before one is attempted, so you only need to specify connect
		426	limitations on one node.
		427
		428	=item dns-domain = domain-suffix
		429
		430	The DNS domain suffix that points to the DNS tunnel server for this node.
		431
		432	The domain must point to a NS record that points to the I<dns-hostname>,
		433	i.e.
		434
		435	dns-domainname = tunnel.example.net
		436	dns-hostname = tunnel-server.example.net
		437
		438	Corresponds to the following DNS entries in the C<example.net> domain:
		439
		440	tunnel.example.net. NS tunnel-server.example.net.
		441	tunnel-server.example.net. A 13.13.13.13
		442
		443	=item dns-hostname = hostname/ip
		444
		445	The address to bind the DNS tunnel socket to, similar to the C<hostname>,
		446	but for the DNS tunnel protocol only. Default: C<0.0.0.0>, but that might
		447	change.
		448
299	=item udp-port = port-number	449	=item dns-port = port-number
300		450
301	Sets the port number used by the UDP protocol (default: C<655>, not	451	The port to bind the DNS tunnel socket to. Must be C<53> on DNS tunnel servers.
302	officially assigned by IANA!).
303		452
304	=item tcp-port = port-number	453	=item enable-dns = yes\|true\|on \| no\|false\|off
305		454
306	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.	455	See gvpe.protocol(7) for a description of the DNS transport
		456	protocol. Avoid this protocol if you can.
		457
		458	Enable the DNS tunneling protocol on this node, either as server or as
		459	client. Support for this transport protocol is only available when gvpe
		460	was compiled using the C<--enable-dns> option.
		461
		462	=item enable-icmp = yes\|true\|on \| no\|false\|off
		463
		464	See gvpe.protocol(7) for a description of the ICMP transport protocol.
		465
		466	Enable the ICMP transport using icmp packets of type C<icmp-type> on this
		467	node.
307		468
308	=item enable-rawip = yes\|true\|on \| no\|false\|off	469	=item enable-rawip = yes\|true\|on \| no\|false\|off
309		470
		471	See gvpe.protocol(7) for a description of the RAW IP transport protocol.
		472
310	Enable the RAW IPv4 transport using the C<ip-proto> protocol	473	Enable the RAW IPv4 transport using the C<ip-proto> protocol
311	(default: C<no>). This is the best choice, since the overhead per packet	474	(default: C<no>).
312	is only 38 bytes, as opposed to UDP's 58 (or TCP's 60+).	475
		476	=item enable-tcp = yes\|true\|on \| no\|false\|off
		477
		478	See gvpe.protocol(7) for a description of the TCP transport protocol.
		479
		480	Enable the TCPv4 transport using the C<tcp-port> port
		481	(default: C<no>). Support for this transport protocol is only available
		482	when gvpe was compiled using the C<--enable-tcp> option.
313		483
314	=item enable-udp = yes\|true\|on \| no\|false\|off	484	=item enable-udp = yes\|true\|on \| no\|false\|off
		485
		486	See gvpe.protocol(7) for a description of the UDP transport protocol.
315		487
316	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,	488	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,
317	unless no other protocol is enabled for a node, in which case this	489	unless no other protocol is enabled for a node, in which case this
318	protocol is enabled automatically). This is a good general choice since	490	protocol is enabled automatically).
319	UDP tunnels well through many firewalls.
320		491
321	NOTE: Please specify C<enable-udp = yes> if you want t use it even though	492	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
322	it might get switched on automatically, as some future version might	493	it might get switched on automatically, as some future version might
323	default to another default protocol.	494	default to another default protocol.
324		495
		496	=item hostname = hostname \| ip [can not be defaulted]
		497
		498	Forces the address of this node to be set to the given dns hostname or ip
		499	address. It will be resolved before each connect request, so dyndns should
		500	work fine. If this setting is not specified and a router is available,
		501	then the router will be queried for the address of this node. Otherwise,
		502	the connection attempt will fail.
		503
		504	=item icmp-type = integer
		505
		506	Sets the type value to be used for outgoing (and incoming) packets sent
		507	via the ICMP transport.
		508
		509	The default is C<0> (which is C<echo-reply>, also known as
		510	"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.
		511	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
		512
		513	=item if-up-data = value
		514
		515	The value specified using this directive will be passed to the C<if-up>
		516	script in the environment variable C<IFUPDATA>.
		517
325	=item enable-tcp = yes\|true\|on \| no\|false\|off	518	=item inherit-tos = yes\|true\|on \| no\|false\|off
326		519
327	Enable the TCPv4 transport using the C<tcp-port> port	520	Wether to inherit the TOS settings of packets sent to the tunnel when
328	(default: C<no>). Support for this horribly unsuitable protocol is only	521	sending packets to this node (default: C<yes>). If set to C<yes> then
329	available when gvpe was compiled using the C<--enable-tcp> option. Never	522	outgoing tunnel packets will have the same TOS setting as the packets sent
330	use this transport unless you really must, it is horribly ineffiecent and	523	to the tunnel device, which is usually what you want.
331	resource-intensive compared to the other transports.
332		524
		525	=item max-retry = positive-number
		526
		527	The maximum interval in seconds (default: C<3600>, one hour) between
		528	retries to establish a connection to this node. When a connection cannot
		529	be established, gvpe uses exponential backoff capped at this value. It's
		530	sometimes useful to set this to a much lower value (e.g. C<120>) on
		531	connections to routers that usually are stable but sometimes are down, to
		532	assure quick reconnections even after longer downtimes.
		533
333	=item router-priority = 0 \| 1 \| positive-number>2	534	=item router-priority = 0 \| 1 \| positive-number>=2
334		535
335	Sets the router priority of the given host (default: C<0>, disabled). If	536	Sets the router priority of the given host (default: C<0>, disabled). If
336	some host tries to connect to another host without a hostname, it asks	537	some host tries to connect to another host without a hostname, it asks
337	the router host for it's IP address. The router host is the one with the	538	the router host for it's IP address. The router host is the one with the
338	highest priority larger than C<1> that is currently reachable.	539	highest priority larger than C<1> that is currently reachable.
…		…
346	required, bump the C<router-priority> setting to higher than C<1> in their	547	required, bump the C<router-priority> setting to higher than C<1> in their
347	local config to route through specific hosts. If C<router-priority> is	548	local config to route through specific hosts. If C<router-priority> is
348	C<0>, then routing will be refused, so C<1> serves as a "enable, but do	549	C<0>, then routing will be refused, so C<1> serves as a "enable, but do
349	not use by default" switch.	550	not use by default" switch.
350		551
351	=item connect = ondemand \| never \| always \| disabled	552	=item tcp-port = port-number
352		553
353	Sets the connect mode (default: C<always>). It can be C<always> (always	554	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
354	try to establish and keep a connection to the given host), C<never>
355	(never initiate a connection to the given host, but accept connections),
356	C<ondemand> (try to establish a connection on the first packet sent, and
357	take it down after the keepalive interval) or C<disabled> (node is bad,
358	don't talk to it).
359		555
360	=item inherit-tos = yes\|true\|on \| no\|false\|off	556	=item udp-port = port-number
361		557
362	Wether to inherit the TOS settings of packets sent to the tunnel when	558	Sets the port number used by the UDP protocol (default: C<655>, not
363	sending packets to this node (default: C<yes>). If set to C<yes> then	559	officially assigned by IANA!).
364	outgoing tunnel packets will have the same TOS setting as the packets sent
365	to the tunnel device, which is usually what you want.
366
367	=item compress = yes\|true\|on \| no\|false\|off
368
369	Wether to compress data packets sent to this host (default: C<yes>).
370	Compression is really cheap even on slow computers and has no size
371	overhead at all, so enabling this is a good idea.
372
373	=item max-retry = positive-number
374
375	The maximum interval in seconds (default: C<28800>, 8 hours) between
376	retries to establish a connection to this node. When a connection cannot
377	be established, gvpe uses exponential backoff capped at this value. It's
378	sometimes useful to set this to a much lower value (e.g. C<120>) on
379	connections to routers that usually are stable but sometimes are down, to
380	assure quick reconnections.
381		560
382	=back	561	=back
383		562
384	=head1 CONFIG DIRECTORY LAYOUT	563	=head1 CONFIG DIRECTORY LAYOUT
385		564
…		…
413		592
414	gvpe(5), gvpe(8), gvpectrl(8).	593	gvpe(5), gvpe(8), gvpectrl(8).
415		594
416	=head1 AUTHOR	595	=head1 AUTHOR
417		596
418	Marc Lehmann <gvpe@plan9.de>	597	Marc Lehmann <gvpe@schmorp.de>
419		598

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs. Revision 1.16 by pcg, Wed Aug 2 16:58:49 2006 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs.
Revision 1.16 by pcg, Wed Aug 2 16:58:49 2006 UTC