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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs.
Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC

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

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs. Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.5 by pcg, Tue Mar 1 06:27:20 2005 UTC vs.
Revision 1.20 by pcg, Sun Aug 10 22:18:58 2008 UTC