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

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.5 by pcg, Tue Feb 22 23:00:57 2005 UTC vs.
Revision 1.30 by root, Tue Dec 4 10:29:43 2012 UTC

…		…
1	.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14	1	.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
2	.\"	2	.\"
3	.\" Standard preamble:	3	.\" Standard preamble:
4	.\" ========================================================================	4	.\" ========================================================================
5	.de Sh \" Subsection heading
6	.br
7	.if t .Sp
8	.ne 5
9	.PP
10	\fB\\$1\fR
11	.PP
12	..
13	.de Sp \" Vertical space (when we can't use .PP)	5	.de Sp \" Vertical space (when we can't use .PP)
14	.if t .sp .5v	6	.if t .sp .5v
15	.if n .sp	7	.if n .sp
16	..	8	..
17	.de Vb \" Begin verbatim text	9	.de Vb \" Begin verbatim text
23	.ft R	15	.ft R
24	.fi	16	.fi
25	..	17	..
26	.\" Set up some character translations and predefined strings. \*(-- will	18	.\" Set up some character translations and predefined strings. \*(-- will
27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left	19	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
28	.\" double quote, and \*(R" will give a right double quote. \| will give a	20	.\" double quote, and \(R" will give a right double quote. \(C+ will
29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to	21	.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'	22	.\" therefore won't be available. \(C` and \(C' expand to `' in nroff,
31	.\" expand to `' in nroff, nothing in troff, for use with C<>.	23	.\" nothing in troff, for use with C<>.
32	.tr \(W-\|\(bv\(Tr	24	.tr \(*W-
33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'	25	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34	.ie n \{\	26	.ie n \{\
35	. ds -- \(*W-	27	. ds -- \(*W-
36	. ds PI pi	28	. ds PI pi
37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch	29	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
…		…
46	. ds PI \(*p	38	. ds PI \(*p
47	. ds L" ``	39	. ds L" ``
48	. ds R" ''	40	. ds R" ''
49	'br\}	41	'br\}
50	.\"	42	.\"
		43	.\" Escape single quotes in literal strings from groff's Unicode transform.
		44	.ie \n(.g .ds Aq \(aq
		45	.el .ds Aq '
		46	.\"
51	.\" If the F register is turned on, we'll generate index entries on stderr for	47	.\" If the F register is turned on, we'll generate index entries on stderr for
52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index	48	.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53	.\" entries marked with X<> in POD. Of course, you'll have to process the	49	.\" entries marked with X<> in POD. Of course, you'll have to process the
54	.\" output yourself in some meaningful fashion.	50	.\" output yourself in some meaningful fashion.
55	.if \nF \{\	51	.ie \nF \{\
56	. de IX	52	. de IX
57	. tm Index:\\$1\t\\n%\t"\\$2"	53	. tm Index:\\$1\t\\n%\t"\\$2"
58	..	54	..
59	. nr % 0	55	. nr % 0
60	. rr F	56	. rr F
61	.\}	57	.\}
62	.\"	58	.el \{\
63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes	59	. de IX
64	.\" way too many mistakes in technical documents.	60	..
65	.hy 0	61	.\}
66	.if n .na
67	.\"	62	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).	63	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.	64	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff	65	. \" fudge factors for nroff and troff
71	.if n \{\	66	.if n \{\
…		…
127	.\}	122	.\}
128	.rm #[ #] #H #V #F C	123	.rm #[ #] #H #V #F C
129	.\" ========================================================================	124	.\" ========================================================================
130	.\"	125	.\"
131	.IX Title "GVPE.CONF 5"	126	.IX Title "GVPE.CONF 5"
132	.TH GVPE.CONF 5 "2005-02-22" "1.7" "GNU Virtual Private Ethernet"	127	.TH GVPE.CONF 5 "2012-07-06" "2.24" "GNU Virtual Private Ethernet"
		128	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
		129	.\" way too many mistakes in technical documents.
		130	.if n .ad l
		131	.nh
133	.SH "NAME"	132	.SH "NAME"
134	gvpe.conf \- configuration file for the GNU VPE daemon	133	gvpe.conf \- configuration file for the GNU VPE daemon
135	.SH "SYNOPSIS"	134	.SH "SYNOPSIS"
136	.IX Header "SYNOPSIS"	135	.IX Header "SYNOPSIS"
137	.Vb 4	136	.Vb 4
138	\& enable-udp = yes	137	\& # global options for all nodes
139	\& udp-port = 407	138	\& udp\-port = 407
140	\& mtu = 1492	139	\& mtu = 1492
141	\& ifname = vpn0	140	\& ifname = vpn0
142	.Ve	141	\&
143	.PP	142	\& # first node is named branch1 and is at 1.2.3.4
144	.Vb 2
145	\& node = branch1	143	\& node = branch1
146	\& hostname = 1.2.3.4	144	\& hostname = 1.2.3.4
147	.Ve	145	\&
148	.PP	146	\& # second node uses dns to resolve the address
149	.Vb 3
150	\& node = branch2	147	\& node = branch2
151	\& hostname = www.example.net	148	\& hostname = www.example.net
152	\& udp-port = 500 # this host uses a different udp-port	149	\& udp\-port = 500 # this host uses a different udp\-port
153	.Ve	150	\&
154	.PP	151	\& # third node has no fixed ip address
155	.Vb 2
156	\& node = branch3	152	\& node = branch3
157	\& connect = ondemand	153	\& connect = ondemand
158	.Ve	154	.Ve
159	.SH "DESCRIPTION"	155	.SH "DESCRIPTION"
160	.IX Header "DESCRIPTION"	156	.IX Header "DESCRIPTION"
161	The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable	157	The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable
162	= value\(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\(C`#\*(C'\fR and	158	= value\(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\(C`#\*(C'\fR and
163	extend to the end of the line. They can be used on their own lines, or	159	extend to the end of the line. They can be used on their own lines, or
164	after any directives. Spaces are allowed before or after the \f(CW\(C`=\(C'\fR sign or	160	after any directives. Whitespace is allowed around the \f(CW\(C`=\(C'\fR sign or after
165	after values, but not within the variable names or values themselves.	161	values, but not within the variable names or values themselves.
166	.PP	162	.PP
167	The only exception to the above is the \(L"on\(R" directive that can prefix any	163	All settings are applied \(L"in order\(R", that is, later settings of the same
168	\&\f(CW\(C`name = value\(C'\fR setting and will only \(L"execute\(R" it on the named node, or	164	variable overwrite earlier ones.
169	(if the nodename starts with \(L"!\(R") on all nodes except the named one.
170	.PP	165	.PP
		166	The only exceptions to the above are the \(L"on\(R" and \(L"include\(R" directives:
		167	.IP "on nodename ..." 4
		168	.IX Item "on nodename ..."
		169	.PD 0
		170	.IP "on !nodename ..." 4
		171	.IX Item "on !nodename ..."
		172	.PD
		173	You can prefix any configuration directive with \f(CW\(C`on\(C'\fR and a nodename. \s-1GVPE\s0
		174	will will only \(L"execute\(R" it on the named node, or (if the nodename starts
		175	with \f(CW\(C`!\(C'\fR) on all nodes except the named one.
		176	.Sp
		177	Example: set the \s-1MTU\s0 to \f(CW1450\fR everywhere, \f(CW\(C`loglevel\(C'\fR to \f(CW\(C`noise\(C'\fR on
		178	\&\f(CW\(C`branch1\(C'\fR, and \f(CW\(C`connect\(C'\fR to \f(CW\(C`ondemand\(C'\fR everywhere but on branch2.
		179	.Sp
171	.Vb 3	180	.Vb 3
172	\& name = value	181	\& mtu = 1450
173	\& on branch1 loglevel = noise	182	\& on branch1 loglevel = noise
174	\& on !branch2 connect = ondemand	183	\& on !branch2 connect = ondemand
175	.Ve	184	.Ve
176	.PP	185	.IP "include relative-or-absolute-path" 4
177	All settings are executed \(L"in order\(R", that is, later settings of the same	186	.IX Item "include relative-or-absolute-path"
178	variable overwrite earlier ones.	187	Reads the specified file (the path must not contain whitespace or \f(CW\(C`=\(C'\fR
		188	characters) and evaluate all config directives in it as if they were
		189	spelled out in place of the \f(CW\(C`include\(C'\fR directive.
		190	.Sp
		191	The path is a printf format string, that is, you must escape any \f(CW\(C`%\(C'\fR
		192	by doubling it, and you can have a single \f(CW%s\fR inside, which will be
		193	replaced by the current nodename.
		194	.Sp
		195	Relative paths are interpreted relative to the \s-1GVPE\s0 config directory.
		196	.Sp
		197	Example: include the file \fIlocal.conf\fR in the config directory on every
		198	node.
		199	.Sp
		200	.Vb 1
		201	\& include local.conf
		202	.Ve
		203	.Sp
		204	Example: include a file \fIconf/\fRnodename\fI.conf\fR
		205	.Sp
		206	.Vb 1
		207	\& include conf/%s.conf
		208	.Ve
179	.SH "ANATOMY OF A CONFIG FILE"	209	.SH "ANATOMY OF A CONFIG FILE"
180	.IX Header "ANATOMY OF A CONFIG FILE"	210	.IX Header "ANATOMY OF A CONFIG FILE"
181	Usually, a config file starts with global settings (like the udp port to	211	Usually, a config file starts with a few global settings (like the \s-1UDP\s0
182	listen on), followed by node-specific sections that begin with a \f(CW\*(C`node =	212	port to listen on), followed by node-specific sections that begin with a
183	nickname\*(C'\fR line.	213	\&\f(CW\(C`node = nickname\(C'\fR line.
184	.PP	214	.PP
185	Every node that is part of the network must have a section that starts	215	Every node that is part of the network must have a section that starts
186	with \f(CW\(C`node = nickname\(C'\fR. The number and order of the nodes is important	216	with \f(CW\(C`node = nickname\(C'\fR. The number and order of the nodes is important
187	and must be the same on all hosts. It is not uncommon for node sections to	217	and must be the same on all nodes. It is not uncommon for node sections to
188	be completely empty \- if the default values are right.	218	be completely empty \- if the default values are right.
189	.PP	219	.PP
190	Node-specific settings can be used at any time. If used before the first	220	Node-specific settings can be used at any time. If used before the first
191	node section they will set the default values for all following nodes.	221	node section they will set the default values for all following nodes.
192	.SH "CONFIG VARIABLES"	222	.SH "CONFIG VARIABLES"
193	.IX Header "CONFIG VARIABLES"	223	.IX Header "CONFIG VARIABLES"
194	.Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0"	224	.SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0"
195	.IX Subsection "GLOBAL SETTINGS"	225	.IX Subsection "GLOBAL SETTINGS"
196	Global settings will affect the behaviour of the running gvpe daemon, that	226	Global settings will affect the behaviour of the running gvpe daemon, that
197	is, they are in some sense node-specific (config files can set different	227	is, they are in some sense node-specific (config files can set different
198	values on different nodes using \f(CW\(C`on\(C'\fR), but will affect the behaviour of	228	values on different nodes using \f(CW\(C`on\(C'\fR), but will affect the behaviour of
199	the gvpe daemon and all connections it creates.	229	the gvpe daemon and all connections it creates.
200	.IP "loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical" 4	230	.IP "dns-forw-host = hostname/ip" 4
201	.IX Item "loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical"	231	.IX Item "dns-forw-host = hostname/ip"
202	Set the logging level. Connection established messages are logged at level	232	The \s-1DNS\s0 server to forward \s-1DNS\s0 requests to for the \s-1DNS\s0 tunnel protocol
203	\&\f(CW\(C`info\(C'\fR, notable errors are logged with \f(CW\(C`error\(C'\fR. Default is \f(CW\(C`info\(C'\fR.	233	(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
204	.IP "node = nickname" 4	234	.IP "dns-forw-port = port-number" 4
205	.IX Item "node = nickname"	235	.IX Item "dns-forw-port = port-number"
206	Not really a config setting but introduces a node section. The nickname is	236	The port where the \f(CW\(C`dns\-forw\-host\(C'\fR is to be contacted (default: \f(CW53\fR,
207	used to select the right configuration section and must be passed as an	237	which is fine in most cases).
208	argument to the gvpe daemon.	238	.IP "dns-case-preserving = yes\|true\|on \| no\|false\|off" 4
209	.IP "private-key = relative-path-to-key" 4	239	.IX Item "dns-case-preserving = yes\|true\|on \| no\|false\|off"
210	.IX Item "private-key = relative-path-to-key"	240	Sets whether the \s-1DNS\s0 transport forwarding server preserves case (\s-1DNS\s0
211	Sets the path (relative to the config directory) to the private key	241	servers have to, but some access systems are even more broken than others)
212	(default: \f(CW\(C`hostkey\(C'\fR). This is a printf format string so every \f(CW\(C`%\(C'\fR must	242	(default: true).
213	be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
214	use paths like \f(CW\(C`hostkeys/%s\(C'\fR to fetch the files at the location where
215	\&\f(CW\(C`gvpectrl\(C'\fR puts them.
216	.Sp	243	.Sp
217	Since only the private key file of the current node is used and the	244	Normally, when the forwarding server changes the case of domain names then
218	private key file should be kept secret per-host to avoid spoofings, it is	245	\&\s-1GVPE\s0 will automatically set this to false.
219	not recommended to use this feature.	246	.IP "dns-max-outstanding = integer-number-of-requests" 4
		247	.IX Item "dns-max-outstanding = integer-number-of-requests"
		248	The maximum number of outstanding \s-1DNS\s0 transport requests
		249	(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
		250	limit without receiving replies. In heavily overloaded situations it might
		251	help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
		252	number of parallel requests.
		253	.Sp
		254	The default should be working \s-1OK\s0 for most links.
		255	.IP "dns-overlap-factor = float" 4
		256	.IX Item "dns-overlap-factor = float"
		257	The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
		258	during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
		259	must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
		260	rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
		261	request might be generated every \fBmin_latency\fR seconds, which means on
		262	average there should only ever be one outstanding request. A factor of
		263	\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
		264	latency measured.
		265	.Sp
		266	For congested or picky \s-1DNS\s0 forwarders you could use a value nearer to or
		267	exceeding \f(CW1\fR.
		268	.Sp
		269	The default should be working \s-1OK\s0 for most links.
		270	.IP "dns-send-interval = send-interval-in-seconds" 4
		271	.IX Item "dns-send-interval = send-interval-in-seconds"
		272	The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
		273	use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
		274	the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
		275	not send more than 100 \s-1DNS\s0 requests per connection per second. For
		276	high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
		277	congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
		278	\&\f(CW0.2\fR or even higher.
		279	.Sp
		280	The default should be working \s-1OK\s0 for most links.
		281	.IP "dns-timeout-factor = float" 4
		282	.IX Item "dns-timeout-factor = float"
		283	Factor to multiply the \f(CW\(C`min_latency\(C'\fR (see \f(CW\(C`dns\-overlap\-factor\(C'\fR) by to
		284	get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
		285	will resend the request when no reply has been received for longer than
		286	eight times the minimum (= expected) latency, assuming the request or
		287	reply has been lost.
		288	.Sp
		289	For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
		290	the link is very stable lower values (e.g. \f(CW2\fR) might work
		291	nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
		292	.Sp
		293	The default should be working \s-1OK\s0 for most links but will result in low
		294	throughput if packet loss is high.
		295	.IP "if-up = relative-or-absolute-path" 4
		296	.IX Item "if-up = relative-or-absolute-path"
		297	Sets the path of a script that should be called immediately after the
		298	network interface is initialized (but not necessarily up). The following
		299	environment variables are passed to it (the values are just examples).
		300	.Sp
		301	Variables that have the same value on all nodes:
		302	.RS 4
		303	.IP "CONFBASE=/etc/gvpe" 4
		304	.IX Item "CONFBASE=/etc/gvpe"
		305	The configuration base directory.
		306	.IP "IFNAME=vpn0" 4
		307	.IX Item "IFNAME=vpn0"
		308	The network interface to initialize.
		309	.IP "IFTYPE=native # or tincd" 4
		310	.IX Item "IFTYPE=native # or tincd"
		311	.PD 0
		312	.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
		313	.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
		314	.PD
		315	The interface type (\f(CW\(C`native\(C'\fR or \f(CW\(C`tincd\(C'\fR) and the subtype (usually the
		316	\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
		317	select the correct syntax to use for network-related commands.
		318	.IP "MTU=1436" 4
		319	.IX Item "MTU=1436"
		320	The \s-1MTU\s0 to set the interface to. You can use lower values (if done
		321	consistently on all nodes), but this is usually either inefficient or
		322	simply ineffective.
		323	.IP "NODES=5" 4
		324	.IX Item "NODES=5"
		325	The number of nodes in this \s-1GVPE\s0 network.
		326	.RE
		327	.RS 4
		328	.Sp
		329	Variables that are node-specific and with values pertaining to the node
		330	running this \s-1GVPE:\s0
		331	.IP "IFUPDATA=string" 4
		332	.IX Item "IFUPDATA=string"
		333	The value of the configuration directive \f(CW\(C`if\-up\-data\(C'\fR.
		334	.IP "MAC=fe:fd:80:00:00:01" 4
		335	.IX Item "MAC=fe:fd:80:00:00:01"
		336	The \s-1MAC\s0 address the network interface has to use.
		337	.Sp
		338	Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
		339	do this automatically. Please see the \f(CW\(C`gvpe.osdep(5)\(C'\fR man page for
		340	platform-specific information.
		341	.IP "NODENAME=branch1" 4
		342	.IX Item "NODENAME=branch1"
		343	The nickname of the node.
		344	.IP "NODEID=1" 4
		345	.IX Item "NODEID=1"
		346	The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first
		347	node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
		348	.RE
		349	.RS 4
		350	.Sp
		351	In addition, all node-specific variables (except \f(CW\(C`NODEID\(C'\fR) will be
		352	available with a postfix of \f(CW\(C`_nodeid\(C'\fR, which contains the value for that
		353	node, e.g. the \f(CW\(C`MAC_1\(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
		354	the \f(CW\(C`NODENAME_22\(C'\fR variable contains the name of node #22.
		355	.Sp
		356	Here is a simple if-up script:
		357	.Sp
		358	.Vb 5
		359	\& #!/bin/sh
		360	\& ip link set $IFNAME up
		361	\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
		362	\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
		363	\& ip route add 10.0.0.0/8 dev $IFNAME
		364	.Ve
		365	.Sp
		366	More complicated examples (using routing to reduce \s-1ARP\s0 traffic) can be
		367	found in the \fIetc/\fR subdirectory of the distribution.
		368	.RE
		369	.IP "ifname = devname" 4
		370	.IX Item "ifname = devname"
		371	Sets the tun interface name to the given name. The default is OS-specific
		372	and most probably something like \f(CW\(C`tun0\(C'\fR.
220	.IP "ifpersist = yes\|true\|on \| no\|false\|off" 4	373	.IP "ifpersist = yes\|true\|on \| no\|false\|off" 4
221	.IX Item "ifpersist = yes\|true\|on \| no\|false\|off"	374	.IX Item "ifpersist = yes\|true\|on \| no\|false\|off"
222	Should the tun/tap device be made persistent, that is, should the device	375	Should the tun/tap device be made persistent, that is, should the device
223	stay up even when gvpe exits? Some versions of the tunnel device have	376	stay up even when gvpe exits? Some versions of the tunnel device have
224	problems sending packets when gvpe is restarted in persistent mode, so	377	problems sending packets when gvpe is restarted in persistent mode, so
225	if the connections can be established but you cannot send packets from	378	if the connections can be established but you cannot send packets from
226	the local node, try to set this to \f(CW\(C`off\(C'\fR and do an ifconfig down on the	379	the local node, try to set this to \f(CW\(C`off\(C'\fR and do an ifconfig down on the
227	device.	380	device.
228	.IP "ifname = devname" 4	381	.IP "ip-proto = numerical-ip-protocol" 4
229	.IX Item "ifname = devname"	382	.IX Item "ip-proto = numerical-ip-protocol"
230	Sets the tun interface name to the given name. The default is OS-specific	383	Sets the protocol number to be used for the rawip protocol. This is a
231	and most probably something like \f(CW\(C`tun0\(C'\fR.	384	global option because all nodes must use the same protocol, and since
232	.IP "rekey = seconds" 4	385	there are no port numbers, you cannot easily run more than one gvpe
233	.IX Item "rekey = seconds"	386	instance using the same protocol, nor can you share the protocol with
234	Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are	387	other programs.
235	reestablished every \f(CW\(C`rekey\(C'\fR seconds.	388	.Sp
		389	The default is 47 (\s-1GRE\s0), which has a good chance of tunneling
		390	through firewalls (but note that gvpe's rawip protocol is not \s-1GRE\s0
		391	compatible). Other common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4
		392	(\s-1IPIP\s0 tunnels) or 98 (\s-1ENCAP\s0, rfc1241).
		393	.Sp
		394	Many versions of Linux seem to have a bug that causes them to reorder
		395	packets for some ip protocols (\s-1GRE\s0, \s-1ESP\s0) but not for others (\s-1AH\s0), so
		396	choose wisely (that is, use 51, \s-1AH\s0).
		397	.IP "http-proxy-host = hostname/ip" 4
		398	.IX Item "http-proxy-host = hostname/ip"
		399	The \f(CW\(C`http\-proxy\-\*(C'\fR family of options are only available if gvpe was
		400	compiled with the \f(CW\(C`\-\-enable\-http\-proxy\(C'\fR option and enable tunneling of
		401	tcp connections through a http proxy server.
		402	.Sp
		403	\&\f(CW\(C`http\-proxy\-host\(C'\fR and \f(CW\(C`http\-proxy\-port\(C'\fR should specify the hostname and
		404	port number of the proxy server. See \f(CW\(C`http\-proxy\-loginpw\(C'\fR if your proxy
		405	requires authentication.
		406	.Sp
		407	Please note that gvpe will still try to resolve all hostnames in the
		408	configuration file, so if you are behind a proxy without access to a \s-1DNS\s0
		409	server better use numerical \s-1IP\s0 addresses.
		410	.Sp
		411	To make best use of this option disable all protocols except \s-1TCP\s0 in your
		412	config file and make sure your routers (or all other nodes) are listening
		413	on a port that the proxy allows (443, https, is a common choice).
		414	.Sp
		415	If you have a router, connecting to it will suffice. Otherwise \s-1TCP\s0 must be
		416	enabled on all nodes.
		417	.Sp
		418	Example:
		419	.Sp
		420	.Vb 3
		421	\& http\-proxy\-host = proxy.example.com
		422	\& http\-proxy\-port = 3128 # 8080 is another common choice
		423	\& http\-proxy\-auth = schmorp:grumbeere
		424	.Ve
		425	.IP "http-proxy-port = proxy-tcp-port" 4
		426	.IX Item "http-proxy-port = proxy-tcp-port"
		427	The port where your proxy server listens.
		428	.IP "http-proxy-auth = login:password" 4
		429	.IX Item "http-proxy-auth = login:password"
		430	The optional login and password used to authenticate to the proxy server,
		431	separated by a literal colon (\f(CW\(C`:\(C'\fR). Only basic authentication is
		432	currently supported.
236	.IP "keepalive = seconds" 4	433	.IP "keepalive = seconds" 4
237	.IX Item "keepalive = seconds"	434	.IX Item "keepalive = seconds"
238	Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this	435	Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
239	many seconds of inactivity the daemon will start to send keepalive probe	436	many seconds of inactivity the daemon will start to send keepalive probe
240	every 5 seconds until it receives a reply from the other end. If no reply	437	every 3 seconds until it receives a reply from the other end. If no reply
241	is received within 30 seconds, the peer is considered unreachable and the	438	is received within 15 seconds, the peer is considered unreachable and the
242	connection is closed.	439	connection is closed.
		440	.IP "loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical" 4
		441	.IX Item "loglevel = noise\|trace\|debug\|info\|notice\|warn\|error\|critical"
		442	Set the logging level. Connection established messages are logged at level
		443	\&\f(CW\(C`info\(C'\fR, notable errors are logged with \f(CW\(C`error\(C'\fR. Default is \f(CW\(C`info\(C'\fR.
243	.IP "mtu = bytes" 4	444	.IP "mtu = bytes" 4
244	.IX Item "mtu = bytes"	445	.IX Item "mtu = bytes"
245	Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically	446	Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically
246	the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate	447	the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate
247	maximum overhead (e.g. udp header size, encryption blocksize...) and pass	448	maximum overhead (e.g. \s-1UDP\s0 header size, encryption blocksize...) and pass
248	this information to the \f(CW\(C`if\-up\(C'\fR script.	449	this information to the \f(CW\(C`if\-up\(C'\fR script.
249	.Sp	450	.Sp
250	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).	451	Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp).
251	.Sp	452	.Sp
252	This value must be the minimum of the mtu values of all hosts.	453	This value must be the minimum of the \s-1MTU\s0 values of all nodes.
253	.IP "ip-proto = numerical-ip-protocol" 4	454	.IP "node = nickname" 4
254	.IX Item "ip-proto = numerical-ip-protocol"	455	.IX Item "node = nickname"
255	Sets the protocol number to be used for the rawip protocol. This is a	456	Not really a config setting but introduces a node section. The nickname is
256	global option because all hosts must use the same protocol, and since	457	used to select the right configuration section and must be passed as an
257	there are no port numbers, you cannot easily run more than one gvpe	458	argument to the gvpe daemon.
258	instance using the same protocol, nor can you share the protocol with
259	other programs.
260	.Sp
261	The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through
262	firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other
263	common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98
264	(\s-1ENCAP\s0, rfc1241)
265	.IP "if-up = relative-or-absolute-path" 4
266	.IX Item "if-up = relative-or-absolute-path"
267	Sets the path of a script that should be called immediately after the
268	network interface is initialized (but not neccessarily up). The following
269	environment variables are passed to it (the values are just examples):
270	.RS 4
271	.IP "CONFBASE=/etc/gvpe" 4
272	.IX Item "CONFBASE=/etc/gvpe"
273	The configuration base directory.
274	.IP "IFNAME=vpn0" 4
275	.IX Item "IFNAME=vpn0"
276	The interface to initialize.
277	.IP "MTU=1436" 4
278	.IX Item "MTU=1436"
279	The \s-1MTU\s0 to set the interface to. You can use lower values (if done
280	consistently on all hosts), but this is usually ineffective.
281	.IP "MAC=fe:fd:80:00:00:01" 4
282	.IX Item "MAC=fe:fd:80:00:00:01"
283	The \s-1MAC\s0 address to set the interface to. The script must set the
284	interface \s-1MAC\s0 to this value. You will most likely use one of these:
285	.Sp
286	.Vb 2
287	\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
288	\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
289	.Ve
290	.Sp
291	Please see the \f(CW\(C`gvpe.osdep(5)\(C'\fR manpage for platform-specific information.
292	.IP "IFTYPE=native # or tincd" 4
293	.IX Item "IFTYPE=native # or tincd"
294	.PD 0
295	.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
296	.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
297	.PD
298	The interface type (\f(CW\(C`native\(C'\fR or \f(CW\(C`tincd\(C'\fR) and the subtype (usually the os
299	name in lowercase) that this gvpe was configured for. Can be used to select
300	the correct syntax to use for network-related commands.
301	.IP "NODENAME=branch1" 4
302	.IX Item "NODENAME=branch1"
303	The nickname of the current node, as passed to the gvpe daemon.
304	.IP "NODEID=1" 4
305	.IX Item "NODEID=1"
306	The numerical node id of the current node. The first node mentioned in the
307	config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
308	.RE
309	.RS 4
310	.Sp
311	Here is a simple if-up script:
312	.Sp
313	.Vb 5
314	\& #!/bin/sh
315	\& ip link set $IFNAME address $MAC mtu $MTU up
316	\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
317	\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
318	\& ip route add 10.0.0.0/8 dev $IFNAME
319	.Ve
320	.Sp
321	More complicated examples (using routing to reduce arp traffic) can be
322	found in the etc/ subdirectory of the distribution.
323	.RE
324	.IP "node-up = relative-or-absolute-path" 4	459	.IP "node-up = relative-or-absolute-path" 4
325	.IX Item "node-up = relative-or-absolute-path"	460	.IX Item "node-up = relative-or-absolute-path"
326	Sets a command (default: no script) that should be called whenever a	461	Sets a command (default: none) that should be called whenever a connection
327	connection is established (even on rekeying operations). In addition	462	is established (even on rekeying operations). Note that node\-up/down
		463	scripts will be run asynchronously, but execution is serialised, so there
		464	will only ever be one such script running.
		465	.Sp
328	to the variables passed to \f(CW\(C`if\-up\(C'\fR scripts, the following environment	466	In addition to all the variables passed to \f(CW\(C`if\-up\(C'\fR scripts, the following
329	variables will be set:	467	environment variables will be set (values are just examples):
330	.RS 4	468	.RS 4
331	.IP "DESTNODE=branch2" 4	469	.IP "DESTNODE=branch2" 4
332	.IX Item "DESTNODE=branch2"	470	.IX Item "DESTNODE=branch2"
333	The name of the remote node.	471	The name of the remote node.
334	.IP "DESTID=2" 4	472	.IP "DESTID=2" 4
335	.IX Item "DESTID=2"	473	.IX Item "DESTID=2"
336	The node id of the remote node.	474	The node id of the remote node.
		475	.IP "DESTSI=rawip/88.99.77.55:0" 4
		476	.IX Item "DESTSI=rawip/88.99.77.55:0"
		477	The \(L"socket info\(R" of the target node, protocol dependent but usually in
		478	the format protocol/ip:port.
337	.IP "DESTIP=188.13.66.8" 4	479	.IP "DESTIP=188.13.66.8" 4
338	.IX Item "DESTIP=188.13.66.8"	480	.IX Item "DESTIP=188.13.66.8"
339	The numerical \s-1IP\s0 address of the remote host (gvpe accepts connections from	481	The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
340	everywhere, as long as the other host can authenticate itself).	482	everywhere, as long as the other node can authenticate itself).
341	.IP "DESTPORT=655 # deprecated" 4	483	.IP "DESTPORT=655 # deprecated" 4
342	.IX Item "DESTPORT=655 # deprecated"	484	.IX Item "DESTPORT=655 # deprecated"
343	The \s-1UDP\s0 port used by the other side.	485	The protocol port used by the other side, if applicable.
344	.IP "STATE=UP" 4	486	.IP "STATE=up" 4
345	.IX Item "STATE=UP"	487	.IX Item "STATE=up"
346	Node-up scripts get called with STATE=UP, node-down scripts get called	488	Node-up scripts get called with STATE=up, node-change scripts get called
347	with STATE=DOWN.	489	with STATE=change and node-down scripts get called with STATE=down.
348	.RE	490	.RE
349	.RS 4	491	.RS 4
350	.Sp	492	.Sp
351	Here is a nontrivial example that uses nsupdate to update the name => ip	493	Here is a nontrivial example that uses nsupdate to update the name => ip
352	mapping in some dns zone:	494	mapping in some \s-1DNS\s0 zone:
353	.Sp	495	.Sp
354	.Vb 6	496	.Vb 6
355	\& #!/bin/sh	497	\& #!/bin/sh
356	\& {	498	\& {
357	\& echo update delete $DESTNODE.lowttl.example.net. a	499	\& echo update delete $DESTNODE.lowttl.example.net. a
358	\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP	500	\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
359	\& echo	501	\& echo
360	\& } \| nsupdate -d -k $CONFBASE:key.example.net.	502	\& } \| nsupdate \-d \-k $CONFBASE:key.example.net.
361	.Ve	503	.Ve
362	.RE	504	.RE
		505	.IP "node-change = relative-or-absolute-path" 4
		506	.IX Item "node-change = relative-or-absolute-path"
		507	Same as \f(CW\(C`node\-change\(C'\fR, but gets called whenever something about a
		508	connection changes (such as the source \s-1IP\s0 address).
363	.IP "node-down = relative-or-absolute-path" 4	509	.IP "node-down = relative-or-absolute-path" 4
364	.IX Item "node-down = relative-or-absolute-path"	510	.IX Item "node-down = relative-or-absolute-path"
365	Same as \f(CW\(C`node\-up\(C'\fR, but gets called whenever a connection is lost.	511	Same as \f(CW\(C`node\-up\(C'\fR, but gets called whenever a connection is lost.
366	.IP "http-proxy-host = hostname/ip" 4
367	.IX Item "http-proxy-host = hostname/ip"
368	The \f(CW\(C`http\-proxy\-\*(C'\fR family of options are only available if gvpe was
369	compiled with the \f(CW\(C`\-\-enable\-http\-proxy\(C'\fR option and enable tunneling of
370	tcp connections through a http proxy server.
371	.Sp
372	\&\f(CW\(C`http\-proxy\-host\(C'\fR and \f(CW\(C`http\-proxy\-port\(C'\fR should specify the hostname and
373	port number of the proxy server. See \f(CW\(C`http\-proxy\-loginpw\(C'\fR if your proxy
374	requires authentication.
375	.Sp
376	Please note that gvpe will still try to resolve all hostnames in the
377	configuration file, so if you are behind a proxy without access to a dns
378	server better use numerical \s-1IP\s0 addresses.
379	.Sp
380	To make best use of this option disable all protocols except tcp in your
381	config file and make sure your routers (or all other hosts) are listening
382	on a port that the proxy allows (443, https, is a common choice).
383	.Sp
384	If you have a router, connecting to it will suffice. Otherwise tcp must be
385	enabled on all hosts.
386	.Sp
387	Example:
388	.Sp
389	.Vb 3
390	\& http-proxy-host = proxy.example.com
391	\& http-proxy-port = 3128 # 8080 is another common choice
392	\& http-proxy-auth = schmorp:grumbeere
393	.Ve
394	.IP "http-proxy-port = proxy-tcp-port" 4
395	.IX Item "http-proxy-port = proxy-tcp-port"
396	The port where your proxy server listens.
397	.IP "http-proxy-auth = login:password" 4
398	.IX Item "http-proxy-auth = login:password"
399	The optional login and password used to authenticate to the proxy server,
400	seperated by a literal colon (\f(CW\(C`:\(C'\fR). Only basic authentication is
401	currently supported.
402	.IP "pid-file = path" 4	512	.IP "pid-file = path" 4
403	.IX Item "pid-file = path"	513	.IX Item "pid-file = path"
404	The path to the pid file to check and create (Default:	514	The path to the pid file to check and create
		515	(default: \f(CW\(C`LOCALSTATEDIR/run/gvpe.pid\(C'\fR).
		516	.IP "private-key = relative-path-to-key" 4
		517	.IX Item "private-key = relative-path-to-key"
		518	Sets the path (relative to the config directory) to the private key
		519	(default: \f(CW\(C`hostkey\(C'\fR). This is a printf format string so every \f(CW\(C`%\(C'\fR must
		520	be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could
		521	use paths like \f(CW\(C`hostkeys/%s\(C'\fR to fetch the files at the location where
		522	\&\f(CW\(C`gvpectrl\(C'\fR puts them.
		523	.Sp
		524	Since only the private key file of the current node is used and the
		525	private key file should be kept secret per-node to avoid spoofing, it is
		526	not recommended to use this feature.
		527	.IP "rekey = seconds" 4
		528	.IX Item "rekey = seconds"
		529	Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
		530	reestablished every \f(CW\(C`rekey\(C'\fR seconds, making them use a new encryption
		531	key.
		532	.IP "nfmark = integer" 4
		533	.IX Item "nfmark = integer"
		534	This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries
		535	to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
		536	send packets.
		537	.Sp
		538	This can be used to make gvpe use a different set of routing rules. For
		539	example, on GNU/Linux, the \f(CW\(C`if\-up\(C'\fR could set \f(CW\(C`nfmark\(C'\fR to 1000 and then
		540	put all routing rules into table \f(CW99\fR and then use an ip rule to make
		541	gvpe traffic avoid that routing table, in effect routing normal traffic
		542	via gvpe and gvpe traffic via the normal system routing tables:
		543	.Sp
		544	.Vb 1
		545	\& ip rule add not fwmark 1000 lookup 99
		546	.Ve
405	.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"	547	.SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
406	.IX Subsection "NODE SPECIFIC SETTINGS"	548	.IX Subsection "NODE SPECIFIC SETTINGS"
407	The following settings are node\-specific, that is, every node can have	549	The following settings are node-specific, that is, every node can have
408	different settings, even within the same gvpe instance. Settings that are	550	different settings, even within the same gvpe instance. Settings that are
409	executed before the first node section set the defaults, settings that are	551	set before the first node section set the defaults, settings that are
410	executed within a node section only apply to the given node.	552	set within a node section only apply to the given node.
		553	.IP "allow-direct = nodename" 4
		554	.IX Item "allow-direct = nodename"
		555	Allow direct connections to this node. See \f(CW\(C`deny\-direct\(C'\fR for more info.
		556	.IP "compress = yes\|true\|on \| no\|false\|off" 4
		557	.IX Item "compress = yes\|true\|on \| no\|false\|off"
		558	For the current node, this specified whether it will accept compressed
		559	packets, and for all other nodes, this specifies whether to try to
		560	compress data packets sent to this node (default: \f(CW\(C`yes\(C'\fR). Compression is
		561	really cheap even on slow computers, has no size overhead at all and will
		562	only be used when the other side supports compression, so enabling this is
		563	often a good idea.
		564	.IP "connect = ondemand \| never \| always \| disabled" 4
		565	.IX Item "connect = ondemand \| never \| always \| disabled"
		566	Sets the connect mode (default: \f(CW\(C`always\(C'\fR). It can be \f(CW\(C`always\(C'\fR (always
		567	try to establish and keep a connection to the given node), \f(CW\(C`never\(C'\fR
		568	(never initiate a connection to the given host, but accept connections),
		569	\&\f(CW\(C`ondemand\(C'\fR (try to establish a connection when there are outstanding
		570	packets in the queue and take it down after the keepalive interval) or
		571	\&\f(CW\(C`disabled\(C'\fR (node is bad, don't talk to it).
		572	.Sp
		573	Routers will automatically be forced to \f(CW\(C`always\(C'\fR unless they are
		574	\&\f(CW\(C`disabled\(C'\fR, to ensure all nodes can talk to each other.
		575	.IP "deny-direct = nodename \| *" 4
		576	.IX Item "deny-direct = nodename \| *"
		577	Deny direct connections to the specified node (or all nodes when \f(CW\(C`\*(C'\fR
		578	is given). Only one node can be specified, but you can use multiple
		579	\&\f(CW\(C`allow\-direct\(C'\fR and \f(CW\(C`deny\-direct\(C'\fR statements. This only makes sense in
		580	networks with routers, as routers are required for indirect connections.
		581	.Sp
		582	Sometimes, a node cannot reach some other nodes for reasons of network
		583	connectivity. For example, a node behind a firewall that only allows
		584	connections to/from a single other node in the network. In this case one
		585	should specify \f(CW\(C`deny\-direct = \(C'\fR and \f(CW\(C`allow\-direct = othernodename\*(C'\fR (the other
		586	node \fImust\fR be a router for this to work).
		587	.Sp
		588	The algorithm to check whether a connection may be direct is as follows:
		589	.Sp
		590	1. Other node mentioned in an \f(CW\(C`allow\-direct\(C'\fR? If yes, allow the connection.
		591	.Sp
		592	2. Other node mentioned in a \f(CW\(C`deny\-direct\(C'\fR? If yes, deny direct connections.
		593	.Sp
		594	3. Allow the connection.
		595	.Sp
		596	That is, \f(CW\(C`allow\-direct\(C'\fR takes precedence over \f(CW\(C`deny\-direct\(C'\fR.
		597	.Sp
		598	The check is done in both directions, i.e. both nodes must allow a direct
		599	connection before one is attempted, so you only need to specify connect
		600	limitations on one node.
		601	.IP "dns-domain = domain-suffix" 4
		602	.IX Item "dns-domain = domain-suffix"
		603	The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
		604	.Sp
		605	The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
		606	i.e.
		607	.Sp
		608	.Vb 2
		609	\& dns\-domainname = tunnel.example.net
		610	\& dns\-hostname = tunnel\-server.example.net
		611	.Ve
		612	.Sp
		613	Corresponds to the following \s-1DNS\s0 entries in the \f(CW\(C`example.net\(C'\fR domain:
		614	.Sp
		615	.Vb 2
		616	\& tunnel.example.net. NS tunnel\-server.example.net.
		617	\& tunnel\-server.example.net. A 13.13.13.13
		618	.Ve
		619	.IP "dns-hostname = hostname/ip" 4
		620	.IX Item "dns-hostname = hostname/ip"
		621	The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\(C`hostname\(C'\fR,
		622	but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
		623	change.
		624	.IP "dns-port = port-number" 4
		625	.IX Item "dns-port = port-number"
		626	The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
		627	.IP "enable-dns = yes\|true\|on \| no\|false\|off" 4
		628	.IX Item "enable-dns = yes\|true\|on \| no\|false\|off"
		629	See \fIgvpe.protocol\fR\\|(7) for a description of the \s-1DNS\s0 transport
		630	protocol. Avoid this protocol if you can.
		631	.Sp
		632	Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
		633	client. Support for this transport protocol is only available when gvpe
		634	was compiled using the \f(CW\(C`\-\-enable\-dns\(C'\fR option.
		635	.IP "enable-icmp = yes\|true\|on \| no\|false\|off" 4
		636	.IX Item "enable-icmp = yes\|true\|on \| no\|false\|off"
		637	See \fIgvpe.protocol\fR\\|(7) for a description of the \s-1ICMP\s0 transport protocol.
		638	.Sp
		639	Enable the \s-1ICMP\s0 transport using \s-1ICMP\s0 packets of type \f(CW\(C`icmp\-type\(C'\fR on this
		640	node.
		641	.IP "enable-rawip = yes\|true\|on \| no\|false\|off" 4
		642	.IX Item "enable-rawip = yes\|true\|on \| no\|false\|off"
		643	See \fIgvpe.protocol\fR\\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
		644	.Sp
		645	Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\(C`ip\-proto\(C'\fR protocol
		646	(default: \f(CW\(C`no\(C'\fR).
		647	.IP "enable-tcp = yes\|true\|on \| no\|false\|off" 4
		648	.IX Item "enable-tcp = yes\|true\|on \| no\|false\|off"
		649	See \fIgvpe.protocol\fR\\|(7) for a description of the \s-1TCP\s0 transport protocol.
		650	.Sp
		651	Enable the TCPv4 transport using the \f(CW\(C`tcp\-port\(C'\fR port
		652	(default: \f(CW\(C`no\(C'\fR). Support for this transport protocol is only available
		653	when gvpe was compiled using the \f(CW\(C`\-\-enable\-tcp\(C'\fR option.
		654	.IP "enable-udp = yes\|true\|on \| no\|false\|off" 4
		655	.IX Item "enable-udp = yes\|true\|on \| no\|false\|off"
		656	See \fIgvpe.protocol\fR\\|(7) for a description of the \s-1UDP\s0 transport protocol.
		657	.Sp
		658	Enable the UDPv4 transport using the \f(CW\(C`udp\-port\(C'\fR port (default: \f(CW\(C`no\(C'\fR).
		659	.IP "hostname = hostname \| ip [can not be defaulted]" 4
		660	.IX Item "hostname = hostname \| ip [can not be defaulted]"
		661	Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
		662	address. It will be resolved before each connect request, so dyndns should
		663	work fine. If this setting is not specified and a router is available,
		664	then the router will be queried for the address of this node. Otherwise,
		665	the connection attempt will fail.
		666	.Sp
		667	Note that \s-1DNS\s0 resolving is done synchronously, pausing the daemon. If that
		668	is an issue you need to specify \s-1IP\s0 addresses.
		669	.IP "icmp-type = integer" 4
		670	.IX Item "icmp-type = integer"
		671	Sets the type value to be used for outgoing (and incoming) packets sent
		672	via the \s-1ICMP\s0 transport.
		673	.Sp
		674	The default is \f(CW0\fR (which is \f(CW\(C`echo\-reply\(C'\fR, also known as
		675	\&\(L"ping-reply\(R"). Other useful values include \f(CW8\fR (\f(CW\(C`echo\-request\(C'\fR, a.k.a.
		676	\&\(L"ping\(R") and \f(CW11\fR (\f(CW\(C`time\-exceeded\(C'\fR), but any 8\-bit value can be used.
		677	.IP "if-up-data = value" 4
		678	.IX Item "if-up-data = value"
		679	The value specified using this directive will be passed to the \f(CW\(C`if\-up\(C'\fR
		680	script in the environment variable \f(CW\(C`IFUPDATA\(C'\fR.
		681	.IP "inherit-tos = yes\|true\|on \| no\|false\|off" 4
		682	.IX Item "inherit-tos = yes\|true\|on \| no\|false\|off"
		683	Whether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
		684	sending packets to this node (default: \f(CW\(C`yes\(C'\fR). If set to \f(CW\(C`yes\(C'\fR then
		685	outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
		686	to the tunnel device, which is usually what you want.
		687	.IP "max-retry = positive-number" 4
		688	.IX Item "max-retry = positive-number"
		689	The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
		690	retries to establish a connection to this node. When a connection cannot
		691	be established, gvpe uses exponential back-off capped at this value. It's
		692	sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
		693	connections to routers that usually are stable but sometimes are down, to
		694	assure quick reconnections even after longer downtimes.
		695	.IP "max-ttl = seconds" 4
		696	.IX Item "max-ttl = seconds"
		697	Expire packets that couldn't be sent after this many seconds
		698	(default: \f(CW60\fR). Gvpe will normally queue packets for a node without an
		699	active connection, in the hope of establishing a connection soon. This
		700	value specifies the maximum lifetime a packet will stay in the queue, if a
		701	packet gets older, it will be thrown away.
		702	.IP "max-queue = positive\-number>=1" 4
		703	.IX Item "max-queue = positive-number>=1"
		704	The maximum number of packets that will be queued (default: \f(CW512\fR)
		705	for this node. If more packets are sent then earlier packets will be
		706	expired. See \f(CW\(C`max\-ttl\(C'\fR, above.
		707	.IP "router-priority = 0 \| 1 \| positive\-number>=2" 4
		708	.IX Item "router-priority = 0 \| 1 \| positive-number>=2"
		709	Sets the router priority of the given node (default: \f(CW0\fR, disabled).
		710	.Sp
		711	If some node tries to connect to another node but it doesn't have a
		712	hostname, it asks a router node for it's \s-1IP\s0 address. The router node
		713	chosen is the one with the highest priority larger than \f(CW1\fR that is
		714	currently reachable. This is called a \fImediated\fR connection, as the
		715	connection itself will still be direct, but it uses another node to
		716	mediate between the two nodes.
		717	.Sp
		718	The value \f(CW0\fR disables routing, that means if the node receives a packet
		719	not for itself it will not forward it but instead drop it.
		720	.Sp
		721	The special value \f(CW1\fR allows other hosts to route through the router
		722	host, but they will never route through it by default (i.e. the config
		723	file of another node needs to specify a router priority higher than one
		724	to choose such a node for routing).
		725	.Sp
		726	The idea behind this is that some hosts can, if required, bump the
		727	\&\f(CW\(C`router\-priority\(C'\fR setting to higher than \f(CW1\fR in their local config to
		728	route through specific hosts. If \f(CW\(C`router\-priority\(C'\fR is \f(CW0\fR, then routing
		729	will be refused, so \f(CW1\fR serves as a \(L"enable, but do not use by default\(R"
		730	switch.
		731	.Sp
		732	Nodes with \f(CW\(C`router\-priority\(C'\fR set to \f(CW2\fR or higher will always be forced
		733	to \f(CW\(C`connect\(C'\fR = \f(CW\(C`always\(C'\fR (unless they are \f(CW\(C`disabled\(C'\fR).
		734	.IP "tcp-port = port-number" 4
		735	.IX Item "tcp-port = port-number"
		736	Similar to \f(CW\(C`udp\-port\(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
411	.IP "udp-port = port-number" 4	737	.IP "udp-port = port-number" 4
412	.IX Item "udp-port = port-number"	738	.IX Item "udp-port = port-number"
413	Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not	739	Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not
414	officially assigned by \s-1IANA\s0!).	740	officially assigned by \s-1IANA\s0!).
415	.IP "tcp-port = port-number" 4
416	.IX Item "tcp-port = port-number"
417	Similar to \f(CW\(C`udp\-port\(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number.
418	.IP "enable-rawip = yes\|true\|on \| no\|false\|off" 4
419	.IX Item "enable-rawip = yes\|true\|on \| no\|false\|off"
420	Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\(C`ip\-proto\(C'\fR protocol
421	(default: \f(CW\(C`no\(C'\fR). This is the best choice, since the overhead per packet
422	is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
423	.IP "enable-udp = yes\|true\|on \| no\|false\|off" 4
424	.IX Item "enable-udp = yes\|true\|on \| no\|false\|off"
425	Enable the UDPv4 transport using the \f(CW\(C`udp\-port\(C'\fR port (default: \f(CW\(C`yes\(C'\fR,
426	but this will change!). This is a good general choice since \s-1UDP\s0 tunnels
427	well through many firewalls.
428	.Sp
429	\&\s-1NOTE:\s0 Please specify \f(CW\(C`enable\-udp = yes\(C'\fR even though it is the default, as
430	some future version will have all protocols disabled by default.
431	.IP "enable-tcp = yes\|true\|on \| no\|false\|off" 4
432	.IX Item "enable-tcp = yes\|true\|on \| no\|false\|off"
433	Enable the TCPv4 transport using the \f(CW\(C`tcp\-port\(C'\fR port
434	(default: \f(CW\(C`no\(C'\fR). Support for this horribly unsuitable protocol is only
435	available when gvpe was compiled using the \f(CW\(C`\-\-enable\-tcp\(C'\fR option. Never
436	use this transport unless you really must, it is horribly ineffiecent and
437	resource-intensive compared to the other transports.
438	.IP "router-priority = 0 \| 1 \| positive\-number>2" 4
439	.IX Item "router-priority = 0 \| 1 \| positive-number>2"
440	Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
441	some host tries to connect to another host without a hostname, it asks
442	the router host for it's \s-1IP\s0 address. The router host is the one with the
443	highest priority larger than \f(CW1\fR that is currently reachable.
444	.Sp
445	Make sure all hosts always connect (\f(CW\(C`connect = always\(C'\fR) to the router
446	hosts, otherwise connecting to them might be impossible.
447	.Sp
448	The special value \f(CW1\fR allows other hosts to route through the router
449	host, but they will never route through it by default. The value \f(CW0\fR
450	disables routing. The idea behind this is that some hosts can, if
451	required, bump the \f(CW\(C`router\-priority\(C'\fR setting to higher than \f(CW1\fR in their
452	local config to route through specific hosts. If \f(CW\(C`router\-priority\(C'\fR is
453	\&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do
454	not use by default\*(R" switch.
455	.IP "connect = ondemand \| never \| always \| disabled" 4
456	.IX Item "connect = ondemand \| never \| always \| disabled"
457	Sets the connect mode (default: \f(CW\(C`always\(C'\fR). It can be \f(CW\(C`always\(C'\fR (always
458	try to establish and keep a connection to the given host), \f(CW\(C`never\(C'\fR
459	(never initiate a connection to the given host, but accept connections),
460	\&\f(CW\(C`ondemand\(C'\fR (try to establish a connection on the first packet sent, and
461	take it down after the keepalive interval) or \f(CW\(C`disabled\(C'\fR (node is bad,
462	don't talk to it).
463	.IP "inherit-tos = yes\|true\|on \| no\|false\|off" 4
464	.IX Item "inherit-tos = yes\|true\|on \| no\|false\|off"
465	Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
466	sending packets to this node (default: \f(CW\(C`yes\(C'\fR). If set to \f(CW\(C`yes\(C'\fR then
467	outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
468	to the tunnel device, which is usually what you want.
469	.IP "compress = yes\|true\|on \| no\|false\|off" 4
470	.IX Item "compress = yes\|true\|on \| no\|false\|off"
471	Wether to compress data packets sent to this host (default: \f(CW\(C`yes\(C'\fR).
472	Compression is really cheap even on slow computers and has no size
473	overhead at all, so enabling this is a good idea.
474	.IP "max-retry = positive-number" 4
475	.IX Item "max-retry = positive-number"
476	The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between
477	retries to establish a connection to this node. When a connection cannot
478	be established, gvpe uses exponential backoff capped at this value. It's
479	sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
480	connections to routers that usually are stable but sometimes are down, to
481	assure quick reconnections.
482	.SH "CONFIG DIRECTORY LAYOUT"	741	.SH "CONFIG DIRECTORY LAYOUT"
483	.IX Header "CONFIG DIRECTORY LAYOUT"	742	.IX Header "CONFIG DIRECTORY LAYOUT"
484	The default (or recommended) directory layout for the config directory is:	743	The default (or recommended) directory layout for the config directory is:
485	.IP "\(bu" 4	744	.IP "gvpe.conf" 4
486	.IX Xref "gvpe.conf"	745	.IX Item "gvpe.conf"
487	The config file.	746	The config file.
488	.IP "\(bu" 4	747	.IP "if-up" 4
489	.IX Xref "if-up"	748	.IX Item "if-up"
490	The if-up script	749	The if-up script
491	.IP "," 4	750	.IP "node-up, node-down" 4
492	.IX Xref "node-up node-down"	751	.IX Item "node-up, node-down"
493	If used the node up or node-down scripts.	752	If used the node up or node-down scripts.
494	.IP "\(bu" 4	753	.IP "hostkey" 4
495	.IX Xref "hostkey"	754	.IX Item "hostkey"
496	The private key (taken from \f(CW\(C`hostkeys/nodename\(C'\fR) of the current host.	755	The private key (taken from \f(CW\(C`hostkeys/nodename\(C'\fR) of the current host.
497	.IP "\(bu" 4	756	.IP "pubkey/nodename" 4
498	.IX Xref "pubkey nodename"	757	.IX Item "pubkey/nodename"
499	The public keys of the other nodes, one file per node.	758	The public keys of the other nodes, one file per node.
500	.SH "SEE ALSO"	759	.SH "SEE ALSO"
501	.IX Header "SEE ALSO"	760	.IX Header "SEE ALSO"
502	\&\fIgvpe\fR\\|(5), \fIgvpe\fR\\|(8), \fIgvpectrl\fR\\|(8).	761	\&\fIgvpe\fR\\|(5), \fIgvpe\fR\\|(8), \fIgvpectrl\fR\\|(8).
503	.SH "AUTHOR"	762	.SH "AUTHOR"
504	.IX Header "AUTHOR"	763	.IX Header "AUTHOR"
505	Marc Lehmann <gvpe@plan9.de>	764	Marc Lehmann <gvpe@schmorp.de>

Diff Legend

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

Comparing gvpe/doc/gvpe.conf.5 (file contents): Revision 1.5 by pcg, Tue Feb 22 23:00:57 2005 UTC vs. Revision 1.30 by root, Tue Dec 4 10:29:43 2012 UTC

Diff Legend

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.5 by pcg, Tue Feb 22 23:00:57 2005 UTC vs.
Revision 1.30 by root, Tue Dec 4 10:29:43 2012 UTC