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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.12 by pcg, Wed Mar 23 17:03:58 2005 UTC vs.
Revision 1.19 by pcg, Thu Aug 7 19:07:02 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
…		…
116	get request timeouts. The default of C<8> means that the DNS transport	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	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	118	eight times the minimum (= expected) latency, assuming the request or
119	reply has been lost.	119	reply has been lost.
120		120
121	For congested links a higher value might be necessary (e.g. C<30>). If the	121	For congested links a higher value might be necessary (e.g. C<30>). If
122	link is very stable lower values (e.g. C<2>) might work nicely. Values	122	the link is very stable lower values (e.g. C<2>) might work
123	near or below C<1> makes no sense whatsoever.	123	nicely. Values near or below C<1> makes no sense whatsoever.
124		124
125	The default should be working ok for most links.	125	The default should be working ok for most links but will result in low
		126	throughput if packet loss is high.
126		127
127	=item if-up = relative-or-absolute-path	128	=item if-up = relative-or-absolute-path
128		129
129	Sets the path of a script that should be called immediately after the	130	Sets the path of a script that should be called immediately after the
130	network interface is initialized (but not neccessarily up). The following	131	network interface is initialized (but not neccessarily up). The following
131	environment variables are passed to it (the values are just examples):	132	environment variables are passed to it (the values are just examples).
		133
		134	Variables that have the same value on all nodes:
132		135
133	=over 4	136	=over 4
134		137
135	=item CONFBASE=/etc/gvpe	138	=item CONFBASE=/etc/gvpe
136		139
137	The configuration base directory.	140	The configuration base directory.
138		141
139	=item IFNAME=vpn0	142	=item IFNAME=vpn0
140		143
141	The interface to initialize.	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.
142		153
143	=item MTU=1436	154	=item MTU=1436
144		155
145	The MTU to set the interface to. You can use lower values (if done	156	The MTU to set the interface to. You can use lower values (if done
146	consistently on all hosts), but this is usually ineffective.	157	consistently on all hosts), but this is usually ineffective.
147		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
148	=item MAC=fe:fd:80:00:00:01	174	=item MAC=fe:fd:80:00:00:01
149		175
150	The MAC address to set the interface to. The script must set the	176	The MAC address the network interface has to use.
151	interface MAC to this value. You will most likely use one of these:
152		177
153	ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux	178	Might be used to initialize interfaces on platforms where GVPE does not
154	ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD	179	do this automatically. Please see the C<gvpe.osdep(5)> manpage for
155		180	platform-specific information.
156	Please see the C<gvpe.osdep(5)> manpage for platform-specific information.
157
158	=item IFTYPE=native # or tincd
159
160	=item IFSUBTYPE=linux # or freebsd, darwin etc..
161
162	The interface type (C<native> or C<tincd>) and the subtype (usually the os
163	name in lowercase) that this gvpe was configured for. Can be used to select
164	the correct syntax to use for network-related commands.
165		181
166	=item NODENAME=branch1	182	=item NODENAME=branch1
167		183
168	The nickname of the current node, as passed to the gvpe daemon.	184	The nickname of the node.
169		185
170	=item NODEID=1	186	=item NODEID=1
171		187
172	The numerical node id of the current node. The first node mentioned in the	188	The numerical node ID of the node running this instance of GVPE. The first
173	config file gets ID 1, the second ID 2 and so on.	189	node mentioned in the config file gets ID 1, the second ID 2 and so on.
174		190
175	=back	191	=back
176		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
177	Here is a simple if-up script:	198	Here is a simple if-up script:
178		199
179	#!/bin/sh	200	#!/bin/sh
180	ip link set $IFNAME address $MAC mtu $MTU up	201	ip link set $IFNAME up
181	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME	202	[ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
182	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME	203	[ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
183	ip route add 10.0.0.0/8 dev $IFNAME	204	ip route add 10.0.0.0/8 dev $IFNAME
184		205
185	More complicated examples (using routing to reduce arp traffic) can be	206	More complicated examples (using routing to reduce arp traffic) can be
…		…
279	used to select the right configuration section and must be passed as an	300	used to select the right configuration section and must be passed as an
280	argument to the gvpe daemon.	301	argument to the gvpe daemon.
281		302
282	=item node-up = relative-or-absolute-path	303	=item node-up = relative-or-absolute-path
283		304
284	Sets a command (default: no script) that should be called whenever a	305	Sets a command (default: none) that should be called whenever a connection
285	connection is established (even on rekeying operations). In addition	306	is established (even on rekeying operations). Note that node-up/down
		307	scripts will be run asynchronously, but execution is serialised, so there
		308	will only ever be one such script running.
		309
286	to the variables passed to C<if-up> scripts, the following environment	310	In addition to all the variables passed to C<if-up> scripts, the following
287	variables will be set:	311	environment variables will be set:
288		312
289	=over 4	313	=over 4
290		314
291	=item DESTNODE=branch2	315	=item DESTNODE=branch2
292		316
…		…
352		376
353	=head2 NODE SPECIFIC SETTINGS	377	=head2 NODE SPECIFIC SETTINGS
354		378
355	The following settings are node-specific, that is, every node can have	379	The following settings are node-specific, that is, every node can have
356	different settings, even within the same gvpe instance. Settings that are	380	different settings, even within the same gvpe instance. Settings that are
357	executed before the first node section set the defaults, settings that are	381	set before the first node section set the defaults, settings that are
358	executed within a node section only apply to the given node.	382	set within a node section only apply to the given node.
359		383
360	=over 4	384	=over 4
		385
		386	=item allow-direct = nodename
		387
		388	Allow direct connections to this node. See C<deny-direct> for more info.
361		389
362	=item compress = yes\|true\|on \| no\|false\|off	390	=item compress = yes\|true\|on \| no\|false\|off
363		391
364	Wether to compress data packets sent to this host (default: C<yes>).	392	Wether to compress data packets sent to this host (default: C<yes>).
365	Compression is really cheap even on slow computers and has no size	393	Compression is really cheap even on slow computers and has no size
…		…
368	=item connect = ondemand \| never \| always \| disabled	396	=item connect = ondemand \| never \| always \| disabled
369		397
370	Sets the connect mode (default: C<always>). It can be C<always> (always	398	Sets the connect mode (default: C<always>). It can be C<always> (always
371	try to establish and keep a connection to the given host), C<never>	399	try to establish and keep a connection to the given host), C<never>
372	(never initiate a connection to the given host, but accept connections),	400	(never initiate a connection to the given host, but accept connections),
373	C<ondemand> (try to establish a connection on the first packet sent, and	401	C<ondemand> (try to establish a connection when there are outstanding
374	take it down after the keepalive interval) or C<disabled> (node is bad,	402	packets in the queue and take it down after the keepalive interval) or
375	don't talk to it).	403	C<disabled> (node is bad, don't talk to it).
		404
		405	=item deny-direct = nodename \| *
		406
		407	Deny direct connections to the specified node (or all nodes when C<*>
		408	is given). Only one node can be specified, but you can use multiple
		409	C<allow-direct> and C<deny-direct> statements. This only makes sense in
		410	networks with routers, as routers are required for indirect connections.
		411
		412	Sometimes, a node cannot reach some other nodes for reasons of network
		413	connectivity. For example, a node behind a firewall that only allows
		414	conenctions to/from a single other node in the network. In this case one
		415	should specify C<deny-direct = *> and C<allow-direct = othernodename> (the other
		416	node I<must> be a router for this to work).
		417
		418	The algorithm to check wether a connection may be direct is as follows:
		419
		420	1. Other node mentioned in a C<allow-direct>? If yes, allow the connection.
		421
		422	2. Other node mentioned in a C<deny-direct>? If yes, deny direct connections.
		423
		424	3. Allow the connection.
		425
		426	That is, C<allow-direct> takes precedence over C<deny-direct>.
		427
		428	The check is done in both directions, i.e. both nodes must allow a direct
		429	connection before one is attempted, so you only need to specify connect
		430	limitations on one node.
376		431
377	=item dns-domain = domain-suffix	432	=item dns-domain = domain-suffix
378		433
379	The DNS domain suffix that points to the DNS tunnel server for this node.	434	The DNS domain suffix that points to the DNS tunnel server for this node.
380		435
…		…
440		495
441	NOTE: Please specify C<enable-udp = yes> if you want t use it even though	496	NOTE: Please specify C<enable-udp = yes> if you want t use it even though
442	it might get switched on automatically, as some future version might	497	it might get switched on automatically, as some future version might
443	default to another default protocol.	498	default to another default protocol.
444		499
		500	=item hostname = hostname \| ip [can not be defaulted]
		501
		502	Forces the address of this node to be set to the given dns hostname or ip
		503	address. It will be resolved before each connect request, so dyndns should
		504	work fine. If this setting is not specified and a router is available,
		505	then the router will be queried for the address of this node. Otherwise,
		506	the connection attempt will fail.
		507
445	=item icmp-type = integer	508	=item icmp-type = integer
446		509
447	Sets the type value to be used for outgoing (and incoming) packets sent	510	Sets the type value to be used for outgoing (and incoming) packets sent
448	via the ICMP transport.	511	via the ICMP transport.
449		512
450	The default is C<0> (which is C<echo-reply>, also known as	513	The default is C<0> (which is C<echo-reply>, also known as
451	"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.	514	"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.
452	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.	515	"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
		516
		517	=item if-up-data = value
		518
		519	The value specified using this directive will be passed to the C<if-up>
		520	script in the environment variable C<IFUPDATA>.
453		521
454	=item inherit-tos = yes\|true\|on \| no\|false\|off	522	=item inherit-tos = yes\|true\|on \| no\|false\|off
455		523
456	Wether to inherit the TOS settings of packets sent to the tunnel when	524	Wether to inherit the TOS settings of packets sent to the tunnel when
457	sending packets to this node (default: C<yes>). If set to C<yes> then	525	sending packets to this node (default: C<yes>). If set to C<yes> then
…		…
464	retries to establish a connection to this node. When a connection cannot	532	retries to establish a connection to this node. When a connection cannot
465	be established, gvpe uses exponential backoff capped at this value. It's	533	be established, gvpe uses exponential backoff capped at this value. It's
466	sometimes useful to set this to a much lower value (e.g. C<120>) on	534	sometimes useful to set this to a much lower value (e.g. C<120>) on
467	connections to routers that usually are stable but sometimes are down, to	535	connections to routers that usually are stable but sometimes are down, to
468	assure quick reconnections even after longer downtimes.	536	assure quick reconnections even after longer downtimes.
		537
		538	=item max-ttl = seconds
		539
		540	Expire packets that couldn't be sent after this many seconds
		541	(default: C<60>). Gvpe will normally queue packets for a node without an
		542	active connection, in the hope of establishing a connection soon. This
		543	value specifies the maximum lifetime a packet will stay in the queue, if a
		544	packet gets older, it will be thrown away.
		545
		546	=item max-queue = positive-number
		547
		548	The maximum number of packets that will be queued (default: C<512>)
		549	for this node. If more packets are sent then earlier packets will be
		550	expired. See C<max-ttl>, above.
469		551
470	=item router-priority = 0 \| 1 \| positive-number>=2	552	=item router-priority = 0 \| 1 \| positive-number>=2
471		553
472	Sets the router priority of the given host (default: C<0>, disabled). If	554	Sets the router priority of the given host (default: C<0>, disabled). If
473	some host tries to connect to another host without a hostname, it asks	555	some host tries to connect to another host without a hostname, it asks
…		…
528		610
529	gvpe(5), gvpe(8), gvpectrl(8).	611	gvpe(5), gvpe(8), gvpectrl(8).
530		612
531	=head1 AUTHOR	613	=head1 AUTHOR
532		614
533	Marc Lehmann <gvpe@plan9.de>	615	Marc Lehmann <gvpe@schmorp.de>
534		616

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents): Revision 1.12 by pcg, Wed Mar 23 17:03:58 2005 UTC vs. Revision 1.19 by pcg, Thu Aug 7 19:07:02 2008 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.12 by pcg, Wed Mar 23 17:03:58 2005 UTC vs.
Revision 1.19 by pcg, Thu Aug 7 19:07:02 2008 UTC