ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.conf.5
(Generate patch)

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.27 by root, Tue Feb 15 13:31:22 2011 UTC vs.
Revision 1.30 by root, Tue Dec 4 10:29:43 2012 UTC

… …
122.\} 122.\}
123.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
124.\" ======================================================================== 124.\" ========================================================================
125.\" 125.\"
126.IX Title "GVPE.CONF 5" 126.IX Title "GVPE.CONF 5"
127.TH GVPE.CONF 5 "2011-02-12" "2.24" "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 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
130.if n .ad l 130.if n .ad l
131.nh 131.nh
132.SH "NAME" 132.SH "NAME"
… …
158= 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
159extend to the end of the line. They can be used on their own lines, or 159extend to the end of the line. They can be used on their own lines, or
160after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after 160after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after
161values, but not within the variable names or values themselves. 161values, but not within the variable names or values themselves.
162.PP 162.PP
163The only exception to the above is the \*(L"on\*(R" directive that can prefix any 163All settings are applied \*(L"in order\*(R", that is, later settings of the same
164\&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or 164variable overwrite earlier ones.
165(if the nodename starts with \*(L"!\*(R") on all nodes except the named one.
166.PP 165.PP
166The 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
173You can prefix any configuration directive with \f(CW\*(C`on\*(C'\fR and a nodename. \s-1GVPE\s0
174will will only \*(L"execute\*(R" it on the named node, or (if the nodename starts
175with \f(CW\*(C`!\*(C'\fR) on all nodes except the named one.
176.Sp
167For example, set the \s-1MTU\s0 to \f(CW1450\fR everywhere, loglevel to \f(CW\*(C`noise\*(C'\fR on 177Example: set the \s-1MTU\s0 to \f(CW1450\fR everywhere, \f(CW\*(C`loglevel\*(C'\fR to \f(CW\*(C`noise\*(C'\fR on
168branch1, and connect to \f(CW\*(C`ondemand\*(C'\fR everywhere but on branch2: 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.
169.PP 179.Sp
170.Vb 3 180.Vb 3
171\& mtu = 1450 181\& mtu = 1450
172\& on branch1 loglevel = noise 182\& on branch1 loglevel = noise
173\& on !branch2 connect = ondemand 183\& on !branch2 connect = ondemand
174.Ve 184.Ve
175.PP 185.IP "include relative-or-absolute-path" 4
176All settings are applied \*(L"in order\*(R", that is, later settings of the same 186.IX Item "include relative-or-absolute-path"
177variable overwrite earlier ones. 187Reads the specified file (the path must not contain whitespace or \f(CW\*(C`=\*(C'\fR
188characters) and evaluate all config directives in it as if they were
189spelled out in place of the \f(CW\*(C`include\*(C'\fR directive.
190.Sp
191The path is a printf format string, that is, you must escape any \f(CW\*(C`%\*(C'\fR
192by doubling it, and you can have a single \f(CW%s\fR inside, which will be
193replaced by the current nodename.
194.Sp
195Relative paths are interpreted relative to the \s-1GVPE\s0 config directory.
196.Sp
197Example: include the file \fIlocal.conf\fR in the config directory on every
198node.
199.Sp
200.Vb 1
201\& include local.conf
202.Ve
203.Sp
204Example: include a file \fIconf/\fRnodename\fI.conf\fR
205.Sp
206.Vb 1
207\& include conf/%s.conf
208.Ve
178.SH "ANATOMY OF A CONFIG FILE" 209.SH "ANATOMY OF A CONFIG FILE"
179.IX Header "ANATOMY OF A CONFIG FILE" 210.IX Header "ANATOMY OF A CONFIG FILE"
180Usually, a config file starts with a few global settings (like the \s-1UDP\s0 211Usually, a config file starts with a few global settings (like the \s-1UDP\s0
181port to listen on), followed by node-specific sections that begin with a 212port to listen on), followed by node-specific sections that begin with a
182\&\f(CW\*(C`node = nickname\*(C'\fR line. 213\&\f(CW\*(C`node = nickname\*(C'\fR line.
… …
202(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 233(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
203.IP "dns-forw-port = port-number" 4 234.IP "dns-forw-port = port-number" 4
204.IX Item "dns-forw-port = port-number" 235.IX Item "dns-forw-port = port-number"
205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 236The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
206which is fine in most cases). 237which is fine in most cases).
238.IP "dns-case-preserving = yes|true|on | no|false|off" 4
239.IX Item "dns-case-preserving = yes|true|on | no|false|off"
240Sets whether the \s-1DNS\s0 transport forwarding server preserves case (\s-1DNS\s0
241servers have to, but some access systems are even more broken than others)
242(default: true).
243.Sp
244Normally, when the forwarding server changes the case of domain names then
245\&\s-1GVPE\s0 will automatically set this to false.
207.IP "dns-max-outstanding = integer-number-of-requests" 4 246.IP "dns-max-outstanding = integer-number-of-requests" 4
208.IX Item "dns-max-outstanding = integer-number-of-requests" 247.IX Item "dns-max-outstanding = integer-number-of-requests"
209The maximum number of outstanding \s-1DNS\s0 transport requests 248The maximum number of outstanding \s-1DNS\s0 transport requests
210(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given 249(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
211limit without receiving replies. In heavily overloaded situations it might 250limit without receiving replies. In heavily overloaded situations it might
… …
393currently supported. 432currently supported.
394.IP "keepalive = seconds" 4 433.IP "keepalive = seconds" 4
395.IX Item "keepalive = seconds" 434.IX Item "keepalive = seconds"
396Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this 435Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this
397many seconds of inactivity the daemon will start to send keepalive probe 436many seconds of inactivity the daemon will start to send keepalive probe
398every 3 seconds until it receives a reply from the other end. If no reply 437every 3 seconds until it receives a reply from the other end. If no reply
399is received within 15 seconds, the peer is considered unreachable and the 438is received within 15 seconds, the peer is considered unreachable and the
400connection is closed. 439connection is closed.
401.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 440.IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4
402.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" 441.IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical"
403Set the logging level. Connection established messages are logged at level 442Set the logging level. Connection established messages are logged at level
… …
614when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. 653when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
615.IP "enable-udp = yes|true|on | no|false|off" 4 654.IP "enable-udp = yes|true|on | no|false|off" 4
616.IX Item "enable-udp = yes|true|on | no|false|off" 655.IX Item "enable-udp = yes|true|on | no|false|off"
617See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. 656See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
618.Sp 657.Sp
619Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 658Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR).
620unless no other protocol is enabled for a node, in which case this
621protocol is enabled automatically).
622.Sp
623\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though
624it might get switched on automatically, as some future version might
625default to another default protocol.
626.IP "hostname = hostname | ip [can not be defaulted]" 4 659.IP "hostname = hostname | ip [can not be defaulted]" 4
627.IX Item "hostname = hostname | ip [can not be defaulted]" 660.IX Item "hostname = hostname | ip [can not be defaulted]"
628Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 661Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0
629address. It will be resolved before each connect request, so dyndns should 662address. It will be resolved before each connect request, so dyndns should
630work fine. If this setting is not specified and a router is available, 663work fine. If this setting is not specified and a router is available,

Diff Legend

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