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

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

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.2 by pcg, Sun Jul 25 18:11:40 2004 UTC vs. Revision 1.17 by pcg, Wed Nov 22 22:55:15 2006 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.2 by pcg, Sun Jul 25 18:11:40 2004 UTC vs.
Revision 1.17 by pcg, Wed Nov 22 22:55:15 2006 UTC