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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC vs.
Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC

…		…
2		2
3	gvpe.conf - configuration file for the GNU VPE daemon	3	gvpe.conf - configuration file for the GNU VPE daemon
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
		7	# global options for all nodes
7	udp-port = 407	8	udp-port = 407
8	mtu = 1492	9	mtu = 1492
9	ifname = vpn0	10	ifname = vpn0
10		11
		12	# first node is named branch1 and is at 1.2.3.4
11	node = branch1	13	node = branch1
12	hostname = 1.2.3.4	14	hostname = 1.2.3.4
13		15
		16	# second node uses dns to resolve the address
14	node = branch2	17	node = branch2
15	hostname = www.example.net	18	hostname = www.example.net
16	udp-port = 500 # this host uses a different udp-port	19	udp-port = 500 # this host uses a different udp-port
17		20
		21	# third node has no fixed ip address
18	node = branch3	22	node = branch3
19	connect = ondemand	23	connect = ondemand
20		24
21	=head1 DESCRIPTION	25	=head1 DESCRIPTION
22		26
…		…
24	= value> pairs. Empty lines are ignored. Comments start with a C<#> and	28	= 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	29	extend to the end of the line. They can be used on their own lines, or
26	after any directives. Whitespace is allowed around the C<=> sign or after	30	after any directives. Whitespace is allowed around the C<=> sign or after
27	values, but not within the variable names or values themselves.	31	values, but not within the variable names or values themselves.
28		32
29	The only exception to the above is the "on" directive that can prefix any	33	All settings are applied "in order", that is, later settings of the same
30	C<name = value> setting and will only "execute" it on the named node, or	34	variable overwrite earlier ones.
31	(if the nodename starts with "!") on all nodes except the named one.
32		35
33	name = value	36	The only exceptions to the above are the "on" and "include" directives:
		37
		38	=over 4
		39
		40	=item on nodename ...
		41
		42	=item on !nodename ...
		43
		44	You can prefix any configuration directive with C<on> and a nodename. GVPE
		45	will will only "execute" it on the named node, or (if the nodename starts
		46	with C<!>) on all nodes except the named one.
		47
		48	Example: set the MTU to C<1450> everywhere, C<loglevel> to C<noise> on
		49	C<branch1>, and C<connect> to C<ondemand> everywhere but on branch2.
		50
		51	mtu = 1450
34	on branch1 loglevel = noise	52	on branch1 loglevel = noise
35	on !branch2 connect = ondemand	53	on !branch2 connect = ondemand
36		54
37	All settings are executed "in order", that is, later settings of the same	55	=item include relative-or-absolute-path
38	variable overwrite earlier ones.	56
		57	Reads the specified file (the path must not contain whitespace or C<=>
		58	characters) and evaluate all config directives in it as if they were
		59	spelled out in place of the C<include> directive.
		60
		61	The path is a printf format string, that is, you must escape any C<%>
		62	by doubling it, and you can have a single C<%s> inside, which will be
		63	replaced by the current nodename.
		64
		65	Relative paths are interpreted relative to the GVPE config directory.
		66
		67	Example: include the file F<local.conf> in the config directory on every
		68	node.
		69
		70	include local.conf
		71
		72	Example: include a file F<conf/>nodenameF<.conf>
		73
		74	include conf/%s.conf
		75
		76	=back
39		77
40	=head1 ANATOMY OF A CONFIG FILE	78	=head1 ANATOMY OF A CONFIG FILE
41		79
42	Usually, a config file starts with global settings (like the udp port to	80	Usually, a config file starts with a few global settings (like the UDP
43	listen on), followed by node-specific sections that begin with a C<node =	81	port to listen on), followed by node-specific sections that begin with a
44	nickname> line.	82	C<node = nickname> line.
45		83
46	Every node that is part of the network must have a section that starts	84	Every node that is part of the network must have a section that starts
47	with C<node = nickname>. The number and order of the nodes is important	85	with C<node = nickname>. The number and order of the nodes is important
48	and must be the same on all nodes. It is not uncommon for node sections to	86	and must be the same on all nodes. It is not uncommon for node sections to
49	be completely empty - if the default values are right.	87	be completely empty - if the default values are right.
…		…
62		100
63	=over 4	101	=over 4
64		102
65	=item dns-forw-host = hostname/ip	103	=item dns-forw-host = hostname/ip
66		104
67	The dns server to forward dns requests to for the DNS tunnel protocol	105	The DNS server to forward DNS requests to for the DNS tunnel protocol
68	(default: C<127.0.0.1>, changing it is highly recommended).	106	(default: C<127.0.0.1>, changing it is highly recommended).
69		107
70	=item dns-forw-port = port-number	108	=item dns-forw-port = port-number
71		109
72	The port where the C<dns-forw-host> is to be contacted (default: C<53>,	110	The port where the C<dns-forw-host> is to be contacted (default: C<53>,
73	which is fine in most cases).	111	which is fine in most cases).
		112
		113	=item dns-case-preserving = yes\|true\|on \| no\|false\|off
		114
		115	Sets whether the DNS transport forwarding server preserves case (DNS
		116	servers have to, but some access systems are even more broken than others)
		117	(default: true).
		118
		119	Normally, when the forwarding server changes the case of domain names then
		120	GVPE will automatically set this to false.
74		121
75	=item dns-max-outstanding = integer-number-of-requests	122	=item dns-max-outstanding = integer-number-of-requests
76		123
77	The maximum number of outstanding DNS transport requests	124	The maximum number of outstanding DNS transport requests
78	(default: C<100>). GVPE will never issue more requests then the given	125	(default: C<100>). GVPE will never issue more requests then the given
79	limit without receiving replies. In heavily overloaded situations it might	126	limit without receiving replies. In heavily overloaded situations it might
80	help to set this to a low number (e.g. C<3> or even C<1>) to limit the	127	help to set this to a low number (e.g. C<3> or even C<1>) to limit the
81	number of parallel requests.	128	number of parallel requests.
82		129
83	The default should be working ok for most links.	130	The default should be working OK for most links.
84		131
85	=item dns-overlap-factor = float	132	=item dns-overlap-factor = float
86		133
87	The DNS transport uses the minimum request latency (B<min_latency>) seen	134	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>,	135	during a connection as it's timing base. This factor (default: C<0.5>,
…		…
91	request might be generated every B<min_latency> seconds, which means on	138	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	139	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	140	C<0.5> means that GVPE will send requests twice as often as the minimum
94	latency measured.	141	latency measured.
95		142
96	For congested or picky dns forwarders you could use a value nearer to or	143	For congested or picky DNS forwarders you could use a value nearer to or
97	exceeding C<1>.	144	exceeding C<1>.
98		145
99	The default should be working ok for most links.	146	The default should be working OK for most links.
100		147
101	=item dns-send-interval = send-interval-in-seconds	148	=item dns-send-interval = send-interval-in-seconds
102		149
103	The minimum send interval (= maximum rate) that the DNS transport will	150	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	151	use to send new DNS requests. GVPE will not exceed this rate even when
…		…
106	not send more than 100 DNS requests per connection per second. For	153	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	154	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>,	155	congested or rate-limited links, you might want to go higher, say C<0.1>,
109	C<0.2> or even higher.	156	C<0.2> or even higher.
110		157
111	The default should be working ok for most links.	158	The default should be working OK for most links.
112		159
113	=item dns-timeout-factor = float	160	=item dns-timeout-factor = float
114		161
115	Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to	162	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	163	get request timeouts. The default of C<8> means that the DNS transport
…		…
120		167
121	For congested links a higher value might be necessary (e.g. C<30>). If	168	For congested links a higher value might be necessary (e.g. C<30>). If
122	the link is very stable lower values (e.g. C<2>) might work	169	the link is very stable lower values (e.g. C<2>) might work
123	nicely. Values near or below C<1> makes no sense whatsoever.	170	nicely. Values near or below C<1> makes no sense whatsoever.
124		171
125	The default should be working ok for most links but will result in low	172	The default should be working OK for most links but will result in low
126	throughput if packet loss is high.	173	throughput if packet loss is high.
127		174
128	=item if-up = relative-or-absolute-path	175	=item if-up = relative-or-absolute-path
129		176
130	Sets the path of a script that should be called immediately after the	177	Sets the path of a script that should be called immediately after the
131	network interface is initialized (but not neccessarily up). The following	178	network interface is initialized (but not necessarily up). The following
132	environment variables are passed to it (the values are just examples).	179	environment variables are passed to it (the values are just examples).
133		180
134	Variables that have the same value on all nodes:	181	Variables that have the same value on all nodes:
135		182
136	=over 4	183	=over 4
…		…
175	=item MAC=fe:fd:80:00:00:01	222	=item MAC=fe:fd:80:00:00:01
176		223
177	The MAC address the network interface has to use.	224	The MAC address the network interface has to use.
178		225
179	Might be used to initialize interfaces on platforms where GVPE does not	226	Might be used to initialize interfaces on platforms where GVPE does not
180	do this automatically. Please see the C<gvpe.osdep(5)> manpage for	227	do this automatically. Please see the C<gvpe.osdep(5)> man page for
181	platform-specific information.	228	platform-specific information.
182		229
183	=item NODENAME=branch1	230	=item NODENAME=branch1
184		231
185	The nickname of the node.	232	The nickname of the node.
…		…
202	ip link set $IFNAME up	249	ip link set $IFNAME up
203	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME	250	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
204	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME	251	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
205	ip route add 10.0.0.0/8 dev $IFNAME	252	ip route add 10.0.0.0/8 dev $IFNAME
206		253
207	More complicated examples (using routing to reduce arp traffic) can be	254	More complicated examples (using routing to reduce ARP traffic) can be
208	found in the etc/ subdirectory of the distribution.	255	found in the F<etc/> subdirectory of the distribution.
209		256
210	=item ifname = devname	257	=item ifname = devname
211		258
212	Sets the tun interface name to the given name. The default is OS-specific	259	Sets the tun interface name to the given name. The default is OS-specific
213	and most probably something like C<tun0>.	260	and most probably something like C<tun0>.
…		…
227	global option because all nodes must use the same protocol, and since	274	global option because all nodes must use the same protocol, and since
228	there are no port numbers, you cannot easily run more than one gvpe	275	there are no port numbers, you cannot easily run more than one gvpe
229	instance using the same protocol, nor can you share the protocol with	276	instance using the same protocol, nor can you share the protocol with
230	other programs.	277	other programs.
231		278
232	The default is 47 (GRE), which has a good chance of tunneling through	279	The default is 47 (GRE), which has a good chance of tunneling
233	firewalls (but note that the rawip protocol is not GRE compatible). Other	280	through firewalls (but note that gvpe's rawip protocol is not GRE
234	common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98	281	compatible). Other common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4
235	(ENCAP, rfc1241)	282	(IPIP tunnels) or 98 (ENCAP, rfc1241).
		283
		284	Many versions of Linux seem to have a bug that causes them to reorder
		285	packets for some ip protocols (GRE, ESP) but not for others (AH), so
		286	choose wisely (that is, use 51, AH).
236		287
237	=item http-proxy-host = hostname/ip	288	=item http-proxy-host = hostname/ip
238		289
239	The C<http-proxy-*> family of options are only available if gvpe was	290	The C<http-proxy-*> family of options are only available if gvpe was
240	compiled with the C<--enable-http-proxy> option and enable tunneling of	291	compiled with the C<--enable-http-proxy> option and enable tunneling of
…		…
243	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and	294	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
244	port number of the proxy server. See C<http-proxy-loginpw> if your proxy	295	port number of the proxy server. See C<http-proxy-loginpw> if your proxy
245	requires authentication.	296	requires authentication.
246		297
247	Please note that gvpe will still try to resolve all hostnames in the	298	Please note that gvpe will still try to resolve all hostnames in the
248	configuration file, so if you are behind a proxy without access to a dns	299	configuration file, so if you are behind a proxy without access to a DNS
249	server better use numerical IP addresses.	300	server better use numerical IP addresses.
250		301
251	To make best use of this option disable all protocols except tcp in your	302	To make best use of this option disable all protocols except TCP in your
252	config file and make sure your routers (or all other nodes) are listening	303	config file and make sure your routers (or all other nodes) are listening
253	on a port that the proxy allows (443, https, is a common choice).	304	on a port that the proxy allows (443, https, is a common choice).
254		305
255	If you have a router, connecting to it will suffice. Otherwise tcp must be	306	If you have a router, connecting to it will suffice. Otherwise TCP must be
256	enabled on all nodes.	307	enabled on all nodes.
257		308
258	Example:	309	Example:
259		310
260	http-proxy-host = proxy.example.com	311	http-proxy-host = proxy.example.com
…		…
266	The port where your proxy server listens.	317	The port where your proxy server listens.
267		318
268	=item http-proxy-auth = login:password	319	=item http-proxy-auth = login:password
269		320
270	The optional login and password used to authenticate to the proxy server,	321	The optional login and password used to authenticate to the proxy server,
271	seperated by a literal colon (C<:>). Only basic authentication is	322	separated by a literal colon (C<:>). Only basic authentication is
272	currently supported.	323	currently supported.
273		324
274	=item keepalive = seconds	325	=item keepalive = seconds
275		326
276	Sets the keepalive probe interval in seconds (default: C<60>). After this	327	Sets the keepalive probe interval in seconds (default: C<60>). After this
277	many seconds of inactivity the daemon will start to send keepalive probe	328	many seconds of inactivity the daemon will start to send keepalive probe
278	every 5 seconds until it receives a reply from the other end. If no reply	329	every 3 seconds until it receives a reply from the other end. If no reply
279	is received within 30 seconds, the peer is considered unreachable and the	330	is received within 15 seconds, the peer is considered unreachable and the
280	connection is closed.	331	connection is closed.
281		332
282	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	333	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
283		334
284	Set the logging level. Connection established messages are logged at level	335	Set the logging level. Connection established messages are logged at level
…		…
286		337
287	=item mtu = bytes	338	=item mtu = bytes
288		339
289	Sets the maximum MTU that should be used on outgoing packets (basically	340	Sets the maximum MTU that should be used on outgoing packets (basically
290	the MTU of the outgoing interface) The daemon will automatically calculate	341	the MTU of the outgoing interface) The daemon will automatically calculate
291	maximum overhead (e.g. udp header size, encryption blocksize...) and pass	342	maximum overhead (e.g. UDP header size, encryption blocksize...) and pass
292	this information to the C<if-up> script.	343	this information to the C<if-up> script.
293		344
294	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	345	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
295		346
296	This value must be the minimum of the mtu values of all nodes.	347	This value must be the minimum of the MTU values of all nodes.
297		348
298	=item node = nickname	349	=item node = nickname
299		350
300	Not really a config setting but introduces a node section. The nickname is	351	Not really a config setting but introduces a node section. The nickname is
301	used to select the right configuration section and must be passed as an	352	used to select the right configuration section and must be passed as an
…		…
307	is established (even on rekeying operations). Note that node-up/down	358	is established (even on rekeying operations). Note that node-up/down
308	scripts will be run asynchronously, but execution is serialised, so there	359	scripts will be run asynchronously, but execution is serialised, so there
309	will only ever be one such script running.	360	will only ever be one such script running.
310		361
311	In addition to all the variables passed to C<if-up> scripts, the following	362	In addition to all the variables passed to C<if-up> scripts, the following
312	environment variables will be set:	363	environment variables will be set (values are just examples):
313		364
314	=over 4	365	=over 4
315		366
316	=item DESTNODE=branch2	367	=item DESTNODE=branch2
317		368
318	The name of the remote node.	369	The name of the remote node.
319		370
320	=item DESTID=2	371	=item DESTID=2
321		372
322	The node id of the remote node.	373	The node id of the remote node.
		374
		375	=item DESTSI=rawip/88.99.77.55:0
		376
		377	The "socket info" of the target node, protocol dependent but usually in
		378	the format protocol/ip:port.
323		379
324	=item DESTIP=188.13.66.8	380	=item DESTIP=188.13.66.8
325		381
326	The numerical IP address of the remote node (gvpe accepts connections from	382	The numerical IP address of the remote node (gvpe accepts connections from
327	everywhere, as long as the other node can authenticate itself).	383	everywhere, as long as the other node can authenticate itself).
328		384
329	=item DESTPORT=655 # deprecated	385	=item DESTPORT=655 # deprecated
330		386
331	The UDP port used by the other side.	387	The protocol port used by the other side, if applicable.
332		388
333	=item STATE=UP	389	=item STATE=up
334		390
335	Node-up scripts get called with STATE=UP, node-down scripts get called	391	Node-up scripts get called with STATE=up, node-change scripts get called
336	with STATE=DOWN.	392	with STATE=change and node-down scripts get called with STATE=down.
337		393
338	=back	394	=back
339		395
340	Here is a nontrivial example that uses nsupdate to update the name => ip	396	Here is a nontrivial example that uses nsupdate to update the name => ip
341	mapping in some dns zone:	397	mapping in some DNS zone:
342		398
343	#!/bin/sh	399	#!/bin/sh
344	{	400	{
345	echo update delete $DESTNODE.lowttl.example.net. a	401	echo update delete $DESTNODE.lowttl.example.net. a
346	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	402	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
347	echo	403	echo
348	} \| nsupdate -d -k $CONFBASE:key.example.net.	404	} \| nsupdate -d -k $CONFBASE:key.example.net.
349		405
		406	=item node-change = relative-or-absolute-path
		407
		408	Same as C<node-change>, but gets called whenever something about a
		409	connection changes (such as the source IP address).
		410
350	=item node-down = relative-or-absolute-path	411	=item node-down = relative-or-absolute-path
351		412
352	Same as C<node-up>, but gets called whenever a connection is lost.	413	Same as C<node-up>, but gets called whenever a connection is lost.
353		414
354	=item pid-file = path	415	=item pid-file = path
…		…
363	be doubled. A single C<%s> is replaced by the hostname, so you could	424	be doubled. A single C<%s> is replaced by the hostname, so you could
364	use paths like C<hostkeys/%s> to fetch the files at the location where	425	use paths like C<hostkeys/%s> to fetch the files at the location where
365	C<gvpectrl> puts them.	426	C<gvpectrl> puts them.
366		427
367	Since only the private key file of the current node is used and the	428	Since only the private key file of the current node is used and the
368	private key file should be kept secret per-node to avoid spoofings, it is	429	private key file should be kept secret per-node to avoid spoofing, it is
369	not recommended to use this feature.	430	not recommended to use this feature.
370		431
371	=item rekey = seconds	432	=item rekey = seconds
372		433
373	Sets the rekeying interval in seconds (default: C<3600>). Connections are	434	Sets the rekeying interval in seconds (default: C<3600>). Connections are
374	reestablished every C<rekey> seconds.	435	reestablished every C<rekey> seconds, making them use a new encryption
		436	key.
		437
		438	=item nfmark = integer
		439
		440	This advanced option, when set to a nonzero value (default: C<0>), tries
		441	to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
		442	send packets.
		443
		444	This can be used to make gvpe use a different set of routing rules. For
		445	example, on GNU/Linux, the C<if-up> could set C<nfmark> to 1000 and then
		446	put all routing rules into table C<99> and then use an ip rule to make
		447	gvpe traffic avoid that routing table, in effect routing normal traffic
		448	via gvpe and gvpe traffic via the normal system routing tables:
		449
		450	ip rule add not fwmark 1000 lookup 99
375		451
376	=back	452	=back
377		453
378	=head2 NODE SPECIFIC SETTINGS	454	=head2 NODE SPECIFIC SETTINGS
379		455
…		…
388		464
389	Allow direct connections to this node. See C<deny-direct> for more info.	465	Allow direct connections to this node. See C<deny-direct> for more info.
390		466
391	=item compress = yes\|true\|on \| no\|false\|off	467	=item compress = yes\|true\|on \| no\|false\|off
392		468
		469	For the current node, this specified whether it will accept compressed
		470	packets, and for all other nodes, this specifies whether to try to
393	Wether to compress data packets sent to this node (default: C<yes>).	471	compress data packets sent to this node (default: C<yes>). Compression is
394	Compression is really cheap even on slow computers and has no size	472	really cheap even on slow computers, has no size overhead at all and will
395	overhead at all, so enabling this is a good idea.	473	only be used when the other side supports compression, so enabling this is
		474	often a good idea.
396		475
397	=item connect = ondemand \| never \| always \| disabled	476	=item connect = ondemand \| never \| always \| disabled
398		477
399	Sets the connect mode (default: C<always>). It can be C<always> (always	478	Sets the connect mode (default: C<always>). It can be C<always> (always
400	try to establish and keep a connection to the given node), C<never>	479	try to establish and keep a connection to the given node), C<never>
…		…
413	C<allow-direct> and C<deny-direct> statements. This only makes sense in	492	C<allow-direct> and C<deny-direct> statements. This only makes sense in
414	networks with routers, as routers are required for indirect connections.	493	networks with routers, as routers are required for indirect connections.
415		494
416	Sometimes, a node cannot reach some other nodes for reasons of network	495	Sometimes, a node cannot reach some other nodes for reasons of network
417	connectivity. For example, a node behind a firewall that only allows	496	connectivity. For example, a node behind a firewall that only allows
418	conenctions to/from a single other node in the network. In this case one	497	connections to/from a single other node in the network. In this case one
419	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other	498	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
420	node I<must> be a router for this to work).	499	node I<must> be a router for this to work).
421		500
422	The algorithm to check wether a connection may be direct is as follows:	501	The algorithm to check whether a connection may be direct is as follows:
423		502
424	1. Other node mentioned in a C<allow-direct>? If yes, allow the connection.	503	1. Other node mentioned in an C<allow-direct>? If yes, allow the connection.
425		504
426	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.	505	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
427		506
428	3. Allow the connection.	507	3. Allow the connection.
429		508
…		…
469		548
470	=item enable-icmp = yes\|true\|on \| no\|false\|off	549	=item enable-icmp = yes\|true\|on \| no\|false\|off
471		550
472	See gvpe.protocol(7) for a description of the ICMP transport protocol.	551	See gvpe.protocol(7) for a description of the ICMP transport protocol.
473		552
474	Enable the ICMP transport using icmp packets of type C<icmp-type> on this	553	Enable the ICMP transport using ICMP packets of type C<icmp-type> on this
475	node.	554	node.
476		555
477	=item enable-rawip = yes\|true\|on \| no\|false\|off	556	=item enable-rawip = yes\|true\|on \| no\|false\|off
478		557
479	See gvpe.protocol(7) for a description of the RAW IP transport protocol.	558	See gvpe.protocol(7) for a description of the RAW IP transport protocol.
…		…
491		570
492	=item enable-udp = yes\|true\|on \| no\|false\|off	571	=item enable-udp = yes\|true\|on \| no\|false\|off
493		572
494	See gvpe.protocol(7) for a description of the UDP transport protocol.	573	See gvpe.protocol(7) for a description of the UDP transport protocol.
495		574
496	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,	575	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>).
497	unless no other protocol is enabled for a node, in which case this
498	protocol is enabled automatically).
499
500	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
501	it might get switched on automatically, as some future version might
502	default to another default protocol.
503		576
504	=item hostname = hostname \| ip [can not be defaulted]	577	=item hostname = hostname \| ip [can not be defaulted]
505		578
506	Forces the address of this node to be set to the given dns hostname or ip	579	Forces the address of this node to be set to the given DNS hostname or IP
507	address. It will be resolved before each connect request, so dyndns should	580	address. It will be resolved before each connect request, so dyndns should
508	work fine. If this setting is not specified and a router is available,	581	work fine. If this setting is not specified and a router is available,
509	then the router will be queried for the address of this node. Otherwise,	582	then the router will be queried for the address of this node. Otherwise,
510	the connection attempt will fail.	583	the connection attempt will fail.
511		584
		585	Note that DNS resolving is done synchronously, pausing the daemon. If that
		586	is an issue you need to specify IP addresses.
		587
512	=item icmp-type = integer	588	=item icmp-type = integer
513		589
514	Sets the type value to be used for outgoing (and incoming) packets sent	590	Sets the type value to be used for outgoing (and incoming) packets sent
515	via the ICMP transport.	591	via the ICMP transport.
516		592
517	The default is C<0> (which is C<echo-reply>, also known as	593	The default is C<0> (which is C<echo-reply>, also known as
518	"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.	594	"ping-reply"). Other useful values include C<8> (C<echo-request>, a.k.a.
519	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.	595	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
520		596
521	=item if-up-data = value	597	=item if-up-data = value
522		598
523	The value specified using this directive will be passed to the C<if-up>	599	The value specified using this directive will be passed to the C<if-up>
524	script in the environment variable C<IFUPDATA>.	600	script in the environment variable C<IFUPDATA>.
525		601
526	=item inherit-tos = yes\|true\|on \| no\|false\|off	602	=item inherit-tos = yes\|true\|on \| no\|false\|off
527		603
528	Wether to inherit the TOS settings of packets sent to the tunnel when	604	Whether to inherit the TOS settings of packets sent to the tunnel when
529	sending packets to this node (default: C<yes>). If set to C<yes> then	605	sending packets to this node (default: C<yes>). If set to C<yes> then
530	outgoing tunnel packets will have the same TOS setting as the packets sent	606	outgoing tunnel packets will have the same TOS setting as the packets sent
531	to the tunnel device, which is usually what you want.	607	to the tunnel device, which is usually what you want.
532		608
533	=item max-retry = positive-number	609	=item max-retry = positive-number
534		610
535	The maximum interval in seconds (default: C<3600>, one hour) between	611	The maximum interval in seconds (default: C<3600>, one hour) between
536	retries to establish a connection to this node. When a connection cannot	612	retries to establish a connection to this node. When a connection cannot
537	be established, gvpe uses exponential backoff capped at this value. It's	613	be established, gvpe uses exponential back-off capped at this value. It's
538	sometimes useful to set this to a much lower value (e.g. C<120>) on	614	sometimes useful to set this to a much lower value (e.g. C<120>) on
539	connections to routers that usually are stable but sometimes are down, to	615	connections to routers that usually are stable but sometimes are down, to
540	assure quick reconnections even after longer downtimes.	616	assure quick reconnections even after longer downtimes.
541		617
542	=item max-ttl = seconds	618	=item max-ttl = seconds
…		…
596		672
597	The default (or recommended) directory layout for the config directory is:	673	The default (or recommended) directory layout for the config directory is:
598		674
599	=over 4	675	=over 4
600		676
601	=item X<gvpe.conf>	677	=item gvpe.conf
602		678
603	The config file.	679	The config file.
604		680
605	=item X<if-up>	681	=item if-up
606		682
607	The if-up script	683	The if-up script
608		684
609	=item X<node-up>, X<node-down>	685	=item node-up, node-down
610		686
611	If used the node up or node-down scripts.	687	If used the node up or node-down scripts.
612		688
613	=item X<hostkey>	689	=item hostkey
614		690
615	The private key (taken from C<hostkeys/nodename>) of the current host.	691	The private key (taken from C<hostkeys/nodename>) of the current host.
616		692
617	=item X<pubkey/nodename>	693	=item pubkey/nodename
618		694
619	The public keys of the other nodes, one file per node.	695	The public keys of the other nodes, one file per node.
620		696
621	=back	697	=back
622		698

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC vs. Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC vs.
Revision 1.28 by root, Sun Mar 6 19:40:27 2011 UTC