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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.18 by pcg, Thu Aug 7 17:30:27 2008 UTC vs.
Revision 1.30 by root, Tue Dec 4 13:23:17 2012 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 hosts. 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.
50		88
51	Node-specific settings can be used at any time. If used before the first	89	Node-specific settings can be used at any time. If used before the first
52	node section they will set the default values for all following nodes.	90	node section they will set the default values for all following nodes.
53		91
…		…
60	values on different nodes using C<on>), but will affect the behaviour of	98	values on different nodes using C<on>), but will affect the behaviour of
61	the gvpe daemon and all connections it creates.	99	the gvpe daemon and all connections it creates.
62		100
63	=over 4	101	=over 4
64		102
		103	=item chroot = path or /
		104
		105	Tells GVPE to chroot(2) to the specified path after reading all necessary
		106	files, binding to sockets and running the C<if-up> script, but before
		107	running C<node-up> or any other scripts.
		108
		109	The special path F</> instructs GVPE to create (and remove) an empty
		110	temporary directory to use as new root. This is most secure, but makes it
		111	impossible to use any scripts other than the C<if-up> one.
		112
		113	=item chuid = numerical-uid
		114
		115	=item chgid = numerical-gid
		116
		117	These two options tell GVPE to change to the given user and/or group id
		118	after reading all necessary files, binding to sockets and running the
		119	C<if-up> script.
		120
		121	Other scripts, such as C<node-up>, are run with the new user id or group id.
		122
		123	=item chuser = username
		124
		125	Alternative to C<chuid> and C<chgid>: Sets both C<chuid> and C<chgid>
		126	to the user and (primary) group ids of the specified user (for example,
		127	C<nobody>).
		128
65	=item dns-forw-host = hostname/ip	129	=item dns-forw-host = hostname/ip
66		130
67	The dns server to forward dns requests to for the DNS tunnel protocol	131	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).	132	(default: C<127.0.0.1>, changing it is highly recommended).
69		133
70	=item dns-forw-port = port-number	134	=item dns-forw-port = port-number
71		135
72	The port where the C<dns-forw-host> is to be contacted (default: C<53>,	136	The port where the C<dns-forw-host> is to be contacted (default: C<53>,
73	which is fine in most cases).	137	which is fine in most cases).
		138
		139	=item dns-case-preserving = yes\|true\|on \| no\|false\|off
		140
		141	Sets whether the DNS transport forwarding server preserves case (DNS
		142	servers have to, but some access systems are even more broken than others)
		143	(default: true).
		144
		145	Normally, when the forwarding server changes the case of domain names then
		146	GVPE will automatically set this to false.
74		147
75	=item dns-max-outstanding = integer-number-of-requests	148	=item dns-max-outstanding = integer-number-of-requests
76		149
77	The maximum number of outstanding DNS transport requests	150	The maximum number of outstanding DNS transport requests
78	(default: C<100>). GVPE will never issue more requests then the given	151	(default: C<100>). GVPE will never issue more requests then the given
79	limit without receiving replies. In heavily overloaded situations it might	152	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	153	help to set this to a low number (e.g. C<3> or even C<1>) to limit the
81	number of parallel requests.	154	number of parallel requests.
82		155
83	The default should be working ok for most links.	156	The default should be working OK for most links.
84		157
85	=item dns-overlap-factor = float	158	=item dns-overlap-factor = float
86		159
87	The DNS transport uses the minimum request latency (B<min_latency>) seen	160	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>,	161	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	164	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	165	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	166	C<0.5> means that GVPE will send requests twice as often as the minimum
94	latency measured.	167	latency measured.
95		168
96	For congested or picky dns forwarders you could use a value nearer to or	169	For congested or picky DNS forwarders you could use a value nearer to or
97	exceeding C<1>.	170	exceeding C<1>.
98		171
99	The default should be working ok for most links.	172	The default should be working OK for most links.
100		173
101	=item dns-send-interval = send-interval-in-seconds	174	=item dns-send-interval = send-interval-in-seconds
102		175
103	The minimum send interval (= maximum rate) that the DNS transport will	176	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	177	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	179	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	180	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>,	181	congested or rate-limited links, you might want to go higher, say C<0.1>,
109	C<0.2> or even higher.	182	C<0.2> or even higher.
110		183
111	The default should be working ok for most links.	184	The default should be working OK for most links.
112		185
113	=item dns-timeout-factor = float	186	=item dns-timeout-factor = float
114		187
115	Factor to multiply the C<min_latency> (see C<dns-overlap-factor>) by to	188	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	189	get request timeouts. The default of C<8> means that the DNS transport
…		…
120		193
121	For congested links a higher value might be necessary (e.g. C<30>). If	194	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	195	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.	196	nicely. Values near or below C<1> makes no sense whatsoever.
124		197
125	The default should be working ok for most links but will result in low	198	The default should be working OK for most links but will result in low
126	throughput if packet loss is high.	199	throughput if packet loss is high.
127		200
128	=item if-up = relative-or-absolute-path	201	=item if-up = relative-or-absolute-path
129		202
130	Sets the path of a script that should be called immediately after the	203	Sets the path of a script that should be called immediately after the
131	network interface is initialized (but not neccessarily up). The following	204	network interface is initialized (but not necessarily up). The following
132	environment variables are passed to it (the values are just examples).	205	environment variables are passed to it (the values are just examples).
133		206
134	Variables that have the same value on all nodes:	207	Variables that have the same value on all nodes:
135		208
136	=over 4	209	=over 4
…		…
152	select the correct syntax to use for network-related commands.	225	select the correct syntax to use for network-related commands.
153		226
154	=item MTU=1436	227	=item MTU=1436
155		228
156	The MTU to set the interface to. You can use lower values (if done	229	The MTU to set the interface to. You can use lower values (if done
157	consistently on all hosts), but this is usually ineffective.	230	consistently on all nodes), but this is usually either inefficient or
		231	simply ineffective.
158		232
159	=item NODES=5	233	=item NODES=5
160		234
161	The number of nodes in this GVPE network.	235	The number of nodes in this GVPE network.
162		236
…		…
174	=item MAC=fe:fd:80:00:00:01	248	=item MAC=fe:fd:80:00:00:01
175		249
176	The MAC address the network interface has to use.	250	The MAC address the network interface has to use.
177		251
178	Might be used to initialize interfaces on platforms where GVPE does not	252	Might be used to initialize interfaces on platforms where GVPE does not
179	do this automatically. Please see the C<gvpe.osdep(5)> manpage for	253	do this automatically. Please see the C<gvpe.osdep(5)> man page for
180	platform-specific information.	254	platform-specific information.
181		255
182	=item NODENAME=branch1	256	=item NODENAME=branch1
183		257
184	The nickname of the node.	258	The nickname of the node.
…		…
201	ip link set $IFNAME up	275	ip link set $IFNAME up
202	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME	276	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
203	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME	277	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
204	ip route add 10.0.0.0/8 dev $IFNAME	278	ip route add 10.0.0.0/8 dev $IFNAME
205		279
206	More complicated examples (using routing to reduce arp traffic) can be	280	More complicated examples (using routing to reduce ARP traffic) can be
207	found in the etc/ subdirectory of the distribution.	281	found in the F<etc/> subdirectory of the distribution.
208		282
209	=item ifname = devname	283	=item ifname = devname
210		284
211	Sets the tun interface name to the given name. The default is OS-specific	285	Sets the tun interface name to the given name. The default is OS-specific
212	and most probably something like C<tun0>.	286	and most probably something like C<tun0>.
…		…
221	device.	295	device.
222		296
223	=item ip-proto = numerical-ip-protocol	297	=item ip-proto = numerical-ip-protocol
224		298
225	Sets the protocol number to be used for the rawip protocol. This is a	299	Sets the protocol number to be used for the rawip protocol. This is a
226	global option because all hosts must use the same protocol, and since	300	global option because all nodes must use the same protocol, and since
227	there are no port numbers, you cannot easily run more than one gvpe	301	there are no port numbers, you cannot easily run more than one gvpe
228	instance using the same protocol, nor can you share the protocol with	302	instance using the same protocol, nor can you share the protocol with
229	other programs.	303	other programs.
230		304
231	The default is 47 (GRE), which has a good chance of tunneling through	305	The default is 47 (GRE), which has a good chance of tunneling
232	firewalls (but note that the rawip protocol is not GRE compatible). Other	306	through firewalls (but note that gvpe's rawip protocol is not GRE
233	common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4 (IPIP tunnels) or 98	307	compatible). Other common choices are 50 (IPSEC, ESP), 51 (IPSEC, AH), 4
234	(ENCAP, rfc1241)	308	(IPIP tunnels) or 98 (ENCAP, rfc1241).
		309
		310	Many versions of Linux seem to have a bug that causes them to reorder
		311	packets for some ip protocols (GRE, ESP) but not for others (AH), so
		312	choose wisely (that is, use 51, AH).
235		313
236	=item http-proxy-host = hostname/ip	314	=item http-proxy-host = hostname/ip
237		315
238	The C<http-proxy-*> family of options are only available if gvpe was	316	The C<http-proxy-*> family of options are only available if gvpe was
239	compiled with the C<--enable-http-proxy> option and enable tunneling of	317	compiled with the C<--enable-http-proxy> option and enable tunneling of
…		…
242	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and	320	C<http-proxy-host> and C<http-proxy-port> should specify the hostname and
243	port number of the proxy server. See C<http-proxy-loginpw> if your proxy	321	port number of the proxy server. See C<http-proxy-loginpw> if your proxy
244	requires authentication.	322	requires authentication.
245		323
246	Please note that gvpe will still try to resolve all hostnames in the	324	Please note that gvpe will still try to resolve all hostnames in the
247	configuration file, so if you are behind a proxy without access to a dns	325	configuration file, so if you are behind a proxy without access to a DNS
248	server better use numerical IP addresses.	326	server better use numerical IP addresses.
249		327
250	To make best use of this option disable all protocols except tcp in your	328	To make best use of this option disable all protocols except TCP in your
251	config file and make sure your routers (or all other hosts) are listening	329	config file and make sure your routers (or all other nodes) are listening
252	on a port that the proxy allows (443, https, is a common choice).	330	on a port that the proxy allows (443, https, is a common choice).
253		331
254	If you have a router, connecting to it will suffice. Otherwise tcp must be	332	If you have a router, connecting to it will suffice. Otherwise TCP must be
255	enabled on all hosts.	333	enabled on all nodes.
256		334
257	Example:	335	Example:
258		336
259	http-proxy-host = proxy.example.com	337	http-proxy-host = proxy.example.com
260	http-proxy-port = 3128 # 8080 is another common choice	338	http-proxy-port = 3128 # 8080 is another common choice
…		…
265	The port where your proxy server listens.	343	The port where your proxy server listens.
266		344
267	=item http-proxy-auth = login:password	345	=item http-proxy-auth = login:password
268		346
269	The optional login and password used to authenticate to the proxy server,	347	The optional login and password used to authenticate to the proxy server,
270	seperated by a literal colon (C<:>). Only basic authentication is	348	separated by a literal colon (C<:>). Only basic authentication is
271	currently supported.	349	currently supported.
272		350
273	=item keepalive = seconds	351	=item keepalive = seconds
274		352
275	Sets the keepalive probe interval in seconds (default: C<60>). After this	353	Sets the keepalive probe interval in seconds (default: C<60>). After this
276	many seconds of inactivity the daemon will start to send keepalive probe	354	many seconds of inactivity the daemon will start to send keepalive probe
277	every 5 seconds until it receives a reply from the other end. If no reply	355	every 3 seconds until it receives a reply from the other end. If no reply
278	is received within 30 seconds, the peer is considered unreachable and the	356	is received within 15 seconds, the peer is considered unreachable and the
279	connection is closed.	357	connection is closed.
280		358
281	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical	359	=item loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical
282		360
283	Set the logging level. Connection established messages are logged at level	361	Set the logging level. Connection established messages are logged at level
…		…
285		363
286	=item mtu = bytes	364	=item mtu = bytes
287		365
288	Sets the maximum MTU that should be used on outgoing packets (basically	366	Sets the maximum MTU that should be used on outgoing packets (basically
289	the MTU of the outgoing interface) The daemon will automatically calculate	367	the MTU of the outgoing interface) The daemon will automatically calculate
290	maximum overhead (e.g. udp header size, encryption blocksize...) and pass	368	maximum overhead (e.g. UDP header size, encryption blocksize...) and pass
291	this information to the C<if-up> script.	369	this information to the C<if-up> script.
292		370
293	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	371	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
294		372
295	This value must be the minimum of the mtu values of all hosts.	373	This value must be the minimum of the MTU values of all nodes.
296		374
297	=item node = nickname	375	=item node = nickname
298		376
299	Not really a config setting but introduces a node section. The nickname is	377	Not really a config setting but introduces a node section. The nickname is
300	used to select the right configuration section and must be passed as an	378	used to select the right configuration section and must be passed as an
301	argument to the gvpe daemon.	379	argument to the gvpe daemon.
302		380
303	=item node-up = relative-or-absolute-path	381	=item node-up = relative-or-absolute-path
304		382
305	Sets a command (default: no script) that should be called whenever a	383	Sets a command (default: none) that should be called whenever a connection
306	connection is established (even on rekeying operations). In addition to	384	is established (even on rekeying operations). Note that node-up/down
		385	scripts will be run asynchronously, but execution is serialised, so there
		386	will only ever be one such script running.
		387
307	all the variables passed to C<if-up> scripts, the following environment	388	In addition to all the variables passed to C<if-up> scripts, the following
308	variables will be set:	389	environment variables will be set (values are just examples):
309		390
310	=over 4	391	=over 4
311		392
312	=item DESTNODE=branch2	393	=item DESTNODE=branch2
313		394
…		…
315		396
316	=item DESTID=2	397	=item DESTID=2
317		398
318	The node id of the remote node.	399	The node id of the remote node.
319		400
		401	=item DESTSI=rawip/88.99.77.55:0
		402
		403	The "socket info" of the target node, protocol dependent but usually in
		404	the format protocol/ip:port.
		405
320	=item DESTIP=188.13.66.8	406	=item DESTIP=188.13.66.8
321		407
322	The numerical IP address of the remote host (gvpe accepts connections from	408	The numerical IP address of the remote node (gvpe accepts connections from
323	everywhere, as long as the other host can authenticate itself).	409	everywhere, as long as the other node can authenticate itself).
324		410
325	=item DESTPORT=655 # deprecated	411	=item DESTPORT=655 # deprecated
326		412
327	The UDP port used by the other side.	413	The protocol port used by the other side, if applicable.
328		414
329	=item STATE=UP	415	=item STATE=up
330		416
331	Node-up scripts get called with STATE=UP, node-down scripts get called	417	Node-up scripts get called with STATE=up, node-change scripts get called
332	with STATE=DOWN.	418	with STATE=change and node-down scripts get called with STATE=down.
333		419
334	=back	420	=back
335		421
336	Here is a nontrivial example that uses nsupdate to update the name => ip	422	Here is a nontrivial example that uses nsupdate to update the name => ip
337	mapping in some dns zone:	423	mapping in some DNS zone:
338		424
339	#!/bin/sh	425	#!/bin/sh
340	{	426	{
341	echo update delete $DESTNODE.lowttl.example.net. a	427	echo update delete $DESTNODE.lowttl.example.net. a
342	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	428	echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
343	echo	429	echo
344	} \| nsupdate -d -k $CONFBASE:key.example.net.	430	} \| nsupdate -d -k $CONFBASE:key.example.net.
		431
		432	=item node-change = relative-or-absolute-path
		433
		434	Same as C<node-change>, but gets called whenever something about a
		435	connection changes (such as the source IP address).
345		436
346	=item node-down = relative-or-absolute-path	437	=item node-down = relative-or-absolute-path
347		438
348	Same as C<node-up>, but gets called whenever a connection is lost.	439	Same as C<node-up>, but gets called whenever a connection is lost.
349		440
…		…
359	be doubled. A single C<%s> is replaced by the hostname, so you could	450	be doubled. A single C<%s> is replaced by the hostname, so you could
360	use paths like C<hostkeys/%s> to fetch the files at the location where	451	use paths like C<hostkeys/%s> to fetch the files at the location where
361	C<gvpectrl> puts them.	452	C<gvpectrl> puts them.
362		453
363	Since only the private key file of the current node is used and the	454	Since only the private key file of the current node is used and the
364	private key file should be kept secret per-host to avoid spoofings, it is	455	private key file should be kept secret per-node to avoid spoofing, it is
365	not recommended to use this feature.	456	not recommended to use this feature.
366		457
367	=item rekey = seconds	458	=item rekey = seconds
368		459
369	Sets the rekeying interval in seconds (default: C<3600>). Connections are	460	Sets the rekeying interval in seconds (default: C<3600>). Connections are
370	reestablished every C<rekey> seconds.	461	reestablished every C<rekey> seconds, making them use a new encryption
		462	key.
		463
		464	=item nfmark = integer
		465
		466	This advanced option, when set to a nonzero value (default: C<0>), tries
		467	to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
		468	send packets.
		469
		470	This can be used to make gvpe use a different set of routing rules. For
		471	example, on GNU/Linux, the C<if-up> could set C<nfmark> to 1000 and then
		472	put all routing rules into table C<99> and then use an ip rule to make
		473	gvpe traffic avoid that routing table, in effect routing normal traffic
		474	via gvpe and gvpe traffic via the normal system routing tables:
		475
		476	ip rule add not fwmark 1000 lookup 99
371		477
372	=back	478	=back
373		479
374	=head2 NODE SPECIFIC SETTINGS	480	=head2 NODE SPECIFIC SETTINGS
375		481
…		…
384		490
385	Allow direct connections to this node. See C<deny-direct> for more info.	491	Allow direct connections to this node. See C<deny-direct> for more info.
386		492
387	=item compress = yes\|true\|on \| no\|false\|off	493	=item compress = yes\|true\|on \| no\|false\|off
388		494
		495	For the current node, this specified whether it will accept compressed
		496	packets, and for all other nodes, this specifies whether to try to
389	Wether to compress data packets sent to this host (default: C<yes>).	497	compress data packets sent to this node (default: C<yes>). Compression is
390	Compression is really cheap even on slow computers and has no size	498	really cheap even on slow computers, has no size overhead at all and will
391	overhead at all, so enabling this is a good idea.	499	only be used when the other side supports compression, so enabling this is
		500	often a good idea.
392		501
393	=item connect = ondemand \| never \| always \| disabled	502	=item connect = ondemand \| never \| always \| disabled
394		503
395	Sets the connect mode (default: C<always>). It can be C<always> (always	504	Sets the connect mode (default: C<always>). It can be C<always> (always
396	try to establish and keep a connection to the given host), C<never>	505	try to establish and keep a connection to the given node), C<never>
397	(never initiate a connection to the given host, but accept connections),	506	(never initiate a connection to the given host, but accept connections),
398	C<ondemand> (try to establish a connection when there are outstanding	507	C<ondemand> (try to establish a connection when there are outstanding
399	packets in the queue and take it down after the keepalive interval) or	508	packets in the queue and take it down after the keepalive interval) or
400	C<disabled> (node is bad, don't talk to it).	509	C<disabled> (node is bad, don't talk to it).
401		510
		511	Routers will automatically be forced to C<always> unless they are
		512	C<disabled>, to ensure all nodes can talk to each other.
		513
402	=item deny-direct = nodename \| *	514	=item deny-direct = nodename \| *
403		515
404	Deny direct connections to the specified node (or all nodes when C<*>	516	Deny direct connections to the specified node (or all nodes when C<*>
405	is given). Only one node can be specified, but you can use multiple	517	is given). Only one node can be specified, but you can use multiple
406	C<allow-direct> and C<deny-direct> statements. This only makes sense in	518	C<allow-direct> and C<deny-direct> statements. This only makes sense in
407	networks with routers, as routers are required for indirect connections.	519	networks with routers, as routers are required for indirect connections.
408		520
409	Sometimes, a node cannot reach some other nodes for reasons of network	521	Sometimes, a node cannot reach some other nodes for reasons of network
410	connectivity. For example, a node behind a firewall that only allows	522	connectivity. For example, a node behind a firewall that only allows
411	conenctions to/from a single other node in the network. In this case one	523	connections to/from a single other node in the network. In this case one
412	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other	524	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
413	node I<must> be a router for this to work).	525	node I<must> be a router for this to work).
414		526
415	The algorithm to check wether a connection may be direct is as follows:	527	The algorithm to check whether a connection may be direct is as follows:
416		528
417	1. Other node mentioned in a C<allow-direct>? If yes, allow the connection.	529	1. Other node mentioned in an C<allow-direct>? If yes, allow the connection.
418		530
419	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.	531	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
420		532
421	3. Allow the connection.	533	3. Allow the connection.
422		534
…		…
462		574
463	=item enable-icmp = yes\|true\|on \| no\|false\|off	575	=item enable-icmp = yes\|true\|on \| no\|false\|off
464		576
465	See gvpe.protocol(7) for a description of the ICMP transport protocol.	577	See gvpe.protocol(7) for a description of the ICMP transport protocol.
466		578
467	Enable the ICMP transport using icmp packets of type C<icmp-type> on this	579	Enable the ICMP transport using ICMP packets of type C<icmp-type> on this
468	node.	580	node.
469		581
470	=item enable-rawip = yes\|true\|on \| no\|false\|off	582	=item enable-rawip = yes\|true\|on \| no\|false\|off
471		583
472	See gvpe.protocol(7) for a description of the RAW IP transport protocol.	584	See gvpe.protocol(7) for a description of the RAW IP transport protocol.
…		…
484		596
485	=item enable-udp = yes\|true\|on \| no\|false\|off	597	=item enable-udp = yes\|true\|on \| no\|false\|off
486		598
487	See gvpe.protocol(7) for a description of the UDP transport protocol.	599	See gvpe.protocol(7) for a description of the UDP transport protocol.
488		600
489	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>,	601	Enable the UDPv4 transport using the C<udp-port> port (default: C<no>).
490	unless no other protocol is enabled for a node, in which case this
491	protocol is enabled automatically).
492
493	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
494	it might get switched on automatically, as some future version might
495	default to another default protocol.
496		602
497	=item hostname = hostname \| ip [can not be defaulted]	603	=item hostname = hostname \| ip [can not be defaulted]
498		604
499	Forces the address of this node to be set to the given dns hostname or ip	605	Forces the address of this node to be set to the given DNS hostname or IP
500	address. It will be resolved before each connect request, so dyndns should	606	address. It will be resolved before each connect request, so dyndns should
501	work fine. If this setting is not specified and a router is available,	607	work fine. If this setting is not specified and a router is available,
502	then the router will be queried for the address of this node. Otherwise,	608	then the router will be queried for the address of this node. Otherwise,
503	the connection attempt will fail.	609	the connection attempt will fail.
504		610
		611	Note that DNS resolving is done synchronously, pausing the daemon. If that
		612	is an issue you need to specify IP addresses.
		613
505	=item icmp-type = integer	614	=item icmp-type = integer
506		615
507	Sets the type value to be used for outgoing (and incoming) packets sent	616	Sets the type value to be used for outgoing (and incoming) packets sent
508	via the ICMP transport.	617	via the ICMP transport.
509		618
510	The default is C<0> (which is C<echo-reply>, also known as	619	The default is C<0> (which is C<echo-reply>, also known as
511	"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.	620	"ping-reply"). Other useful values include C<8> (C<echo-request>, a.k.a.
512	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.	621	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
513		622
514	=item if-up-data = value	623	=item if-up-data = value
515		624
516	The value specified using this directive will be passed to the C<if-up>	625	The value specified using this directive will be passed to the C<if-up>
517	script in the environment variable C<IFUPDATA>.	626	script in the environment variable C<IFUPDATA>.
518		627
519	=item inherit-tos = yes\|true\|on \| no\|false\|off	628	=item inherit-tos = yes\|true\|on \| no\|false\|off
520		629
521	Wether to inherit the TOS settings of packets sent to the tunnel when	630	Whether to inherit the TOS settings of packets sent to the tunnel when
522	sending packets to this node (default: C<yes>). If set to C<yes> then	631	sending packets to this node (default: C<yes>). If set to C<yes> then
523	outgoing tunnel packets will have the same TOS setting as the packets sent	632	outgoing tunnel packets will have the same TOS setting as the packets sent
524	to the tunnel device, which is usually what you want.	633	to the tunnel device, which is usually what you want.
525		634
526	=item max-retry = positive-number	635	=item max-retry = positive-number
527		636
528	The maximum interval in seconds (default: C<3600>, one hour) between	637	The maximum interval in seconds (default: C<3600>, one hour) between
529	retries to establish a connection to this node. When a connection cannot	638	retries to establish a connection to this node. When a connection cannot
530	be established, gvpe uses exponential backoff capped at this value. It's	639	be established, gvpe uses exponential back-off capped at this value. It's
531	sometimes useful to set this to a much lower value (e.g. C<120>) on	640	sometimes useful to set this to a much lower value (e.g. C<120>) on
532	connections to routers that usually are stable but sometimes are down, to	641	connections to routers that usually are stable but sometimes are down, to
533	assure quick reconnections even after longer downtimes.	642	assure quick reconnections even after longer downtimes.
534		643
535	=item max-ttl = seconds	644	=item max-ttl = seconds
…		…
538	(default: C<60>). Gvpe will normally queue packets for a node without an	647	(default: C<60>). Gvpe will normally queue packets for a node without an
539	active connection, in the hope of establishing a connection soon. This	648	active connection, in the hope of establishing a connection soon. This
540	value specifies the maximum lifetime a packet will stay in the queue, if a	649	value specifies the maximum lifetime a packet will stay in the queue, if a
541	packet gets older, it will be thrown away.	650	packet gets older, it will be thrown away.
542		651
543	=item max-queue = positive-number	652	=item max-queue = positive-number>=1
544		653
545	The maximum number of packets that will be queued (default: C<512>)	654	The maximum number of packets that will be queued (default: C<512>)
546	for this node. If more packets are sent then earlier packets will be	655	for this node. If more packets are sent then earlier packets will be
547	expired. See C<max-ttl>, above.	656	expired. See C<max-ttl>, above.
548		657
549	=item router-priority = 0 \| 1 \| positive-number>=2	658	=item router-priority = 0 \| 1 \| positive-number>=2
550		659
551	Sets the router priority of the given host (default: C<0>, disabled). If	660	Sets the router priority of the given node (default: C<0>, disabled).
552	some host tries to connect to another host without a hostname, it asks
553	the router host for it's IP address. The router host is the one with the
554	highest priority larger than C<1> that is currently reachable.
555		661
556	Make sure all hosts always connect (C<connect = always>) to the router	662	If some node tries to connect to another node but it doesn't have a
557	hosts, otherwise connecting to them might be impossible.	663	hostname, it asks a router node for it's IP address. The router node
		664	chosen is the one with the highest priority larger than C<1> that is
		665	currently reachable. This is called a I<mediated> connection, as the
		666	connection itself will still be direct, but it uses another node to
		667	mediate between the two nodes.
		668
		669	The value C<0> disables routing, that means if the node receives a packet
		670	not for itself it will not forward it but instead drop it.
558		671
559	The special value C<1> allows other hosts to route through the router	672	The special value C<1> allows other hosts to route through the router
560	host, but they will never route through it by default. The value C<0>	673	host, but they will never route through it by default (i.e. the config
561	disables routing. The idea behind this is that some hosts can, if	674	file of another node needs to specify a router priority higher than one
		675	to choose such a node for routing).
		676
		677	The idea behind this is that some hosts can, if required, bump the
562	required, bump the C<router-priority> setting to higher than C<1> in their	678	C<router-priority> setting to higher than C<1> in their local config to
563	local config to route through specific hosts. If C<router-priority> is	679	route through specific hosts. If C<router-priority> is C<0>, then routing
564	C<0>, then routing will be refused, so C<1> serves as a "enable, but do	680	will be refused, so C<1> serves as a "enable, but do not use by default"
565	not use by default" switch.	681	switch.
		682
		683	Nodes with C<router-priority> set to C<2> or higher will always be forced
		684	to C<connect> = C<always> (unless they are C<disabled>).
566		685
567	=item tcp-port = port-number	686	=item tcp-port = port-number
568		687
569	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.	688	Similar to C<udp-port> (default: C<655>), but sets the TCP port number.
570		689
…		…
579		698
580	The default (or recommended) directory layout for the config directory is:	699	The default (or recommended) directory layout for the config directory is:
581		700
582	=over 4	701	=over 4
583		702
584	=item X<gvpe.conf>	703	=item gvpe.conf
585		704
586	The config file.	705	The config file.
587		706
588	=item X<if-up>	707	=item if-up
589		708
590	The if-up script	709	The if-up script
591		710
592	=item X<node-up>, X<node-down>	711	=item node-up, node-down
593		712
594	If used the node up or node-down scripts.	713	If used the node up or node-down scripts.
595		714
596	=item X<hostkey>	715	=item hostkey
597		716
598	The private key (taken from C<hostkeys/nodename>) of the current host.	717	The private key (taken from C<hostkeys/nodename>) of the current host.
599		718
600	=item X<pubkey/nodename>	719	=item pubkey/nodename
601		720
602	The public keys of the other nodes, one file per node.	721	The public keys of the other nodes, one file per node.
603		722
604	=back	723	=back
605		724

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.18 by pcg, Thu Aug 7 17:30:27 2008 UTC vs. Revision 1.30 by root, Tue Dec 4 13:23:17 2012 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.18 by pcg, Thu Aug 7 17:30:27 2008 UTC vs.
Revision 1.30 by root, Tue Dec 4 13:23:17 2012 UTC