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

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.26 by root, Sat Feb 12 04:15:29 2011 UTC vs.
Revision 1.29 by root, Tue Dec 4 10:29:43 2012 UTC

… …
28= value> pairs. Empty lines are ignored. Comments start with a C<#> and 28= value> pairs. Empty lines are ignored. Comments start with a C<#> and
29extend to the end of the line. They can be used on their own lines, or 29extend to the end of the line. They can be used on their own lines, or
30after any directives. Whitespace is allowed around the C<=> sign or after 30after any directives. Whitespace is allowed around the C<=> sign or after
31values, but not within the variable names or values themselves. 31values, but not within the variable names or values themselves.
32 32
33The only exception to the above is the "on" directive that can prefix any 33All settings are applied "in order", that is, later settings of the same
34C<name = value> setting and will only "execute" it on the named node, or 34variable overwrite earlier ones.
35(if the nodename starts with "!") on all nodes except the named one.
36 35
36The only exceptions to the above are the "on" and "include" directives:
37
38=over 4
39
40=item on nodename ...
41
42=item on !nodename ...
43
44You can prefix any configuration directive with C<on> and a nodename. GVPE
45will will only "execute" it on the named node, or (if the nodename starts
46with C<!>) on all nodes except the named one.
47
37For example, set the MTU to C<1450> everywhere, loglevel to C<noise> on 48Example: set the MTU to C<1450> everywhere, C<loglevel> to C<noise> on
38branch1, and connect to C<ondemand> everywhere but on branch2: 49C<branch1>, and C<connect> to C<ondemand> everywhere but on branch2.
39 50
40 mtu = 1450 51 mtu = 1450
41 on branch1 loglevel = noise 52 on branch1 loglevel = noise
42 on !branch2 connect = ondemand 53 on !branch2 connect = ondemand
43 54
44All settings are applied "in order", that is, later settings of the same 55=item include relative-or-absolute-path
45variable overwrite earlier ones. 56
57Reads the specified file (the path must not contain whitespace or C<=>
58characters) and evaluate all config directives in it as if they were
59spelled out in place of the C<include> directive.
60
61The path is a printf format string, that is, you must escape any C<%>
62by doubling it, and you can have a single C<%s> inside, which will be
63replaced by the current nodename.
64
65Relative paths are interpreted relative to the GVPE config directory.
66
67Example: include the file F<local.conf> in the config directory on every
68node.
69
70 include local.conf
71
72Example: include a file F<conf/>nodenameF<.conf>
73
74 include conf/%s.conf
75
76=back
46 77
47=head1 ANATOMY OF A CONFIG FILE 78=head1 ANATOMY OF A CONFIG FILE
48 79
49Usually, a config file starts with a few global settings (like the UDP 80Usually, a config file starts with a few global settings (like the UDP
50port to listen on), followed by node-specific sections that begin with a 81port to listen on), followed by node-specific sections that begin with a
… …
67values on different nodes using C<on>), but will affect the behaviour of 98values on different nodes using C<on>), but will affect the behaviour of
68the gvpe daemon and all connections it creates. 99the gvpe daemon and all connections it creates.
69 100
70=over 4 101=over 4
71 102
103=item chroot = path or /
104
105Tells GVPE to chroot(2) to the specified path after reading all necessary
106files, binding to sockets and running the C<if-up> script, but before
107running C<node-up> or any other scripts.
108
109The special path F</> instructs GVPE to create (and remove) an empty
110temporary directory to use as new root. This is most secure, but makes it
111impossible to use any scripts other than the C<if-up> one.
112
113=item chuid = numerical-uid
114
115=item chgid = numerical-gid
116
117These two options tell GVPE to change to the given user and/or group id
118after reading all necessary files, binding to sockets and running the
119C<if-up> script.
120
121Other scripts, such as C<node-up>, are run with the new user id or group id.
122
123=item chuser = username
124
125Alternative to C<chuid> and C<chgid>: Sets both C<chuid> and C<chgid>
126to the user and (primary) group ids of the specified user (for example,
127C<nobody>).
128
72=item dns-forw-host = hostname/ip 129=item dns-forw-host = hostname/ip
73 130
74The DNS server to forward DNS requests to for the DNS tunnel protocol 131The DNS server to forward DNS requests to for the DNS tunnel protocol
75(default: C<127.0.0.1>, changing it is highly recommended). 132(default: C<127.0.0.1>, changing it is highly recommended).
76 133
77=item dns-forw-port = port-number 134=item dns-forw-port = port-number
78 135
79The port where the C<dns-forw-host> is to be contacted (default: C<53>, 136The port where the C<dns-forw-host> is to be contacted (default: C<53>,
80which is fine in most cases). 137which is fine in most cases).
138
139=item dns-case-preserving = yes|true|on | no|false|off
140
141Sets whether the DNS transport forwarding server preserves case (DNS
142servers have to, but some access systems are even more broken than others)
143(default: true).
144
145Normally, when the forwarding server changes the case of domain names then
146GVPE will automatically set this to false.
81 147
82=item dns-max-outstanding = integer-number-of-requests 148=item dns-max-outstanding = integer-number-of-requests
83 149
84The maximum number of outstanding DNS transport requests 150The maximum number of outstanding DNS transport requests
85(default: C<100>). GVPE will never issue more requests then the given 151(default: C<100>). GVPE will never issue more requests then the given
… …
284 350
285=item keepalive = seconds 351=item keepalive = seconds
286 352
287Sets the keepalive probe interval in seconds (default: C<60>). After this 353Sets the keepalive probe interval in seconds (default: C<60>). After this
288many seconds of inactivity the daemon will start to send keepalive probe 354many seconds of inactivity the daemon will start to send keepalive probe
289every 3 seconds until it receives a reply from the other end. If no reply 355every 3 seconds until it receives a reply from the other end. If no reply
290is received within 15 seconds, the peer is considered unreachable and the 356is received within 15 seconds, the peer is considered unreachable and the
291connection is closed. 357connection is closed.
292 358
293=item loglevel = noise|trace|debug|info|notice|warn|error|critical 359=item loglevel = noise|trace|debug|info|notice|warn|error|critical
294 360
… …
530 596
531=item enable-udp = yes|true|on | no|false|off 597=item enable-udp = yes|true|on | no|false|off
532 598
533See gvpe.protocol(7) for a description of the UDP transport protocol. 599See gvpe.protocol(7) for a description of the UDP transport protocol.
534 600
535Enable the UDPv4 transport using the C<udp-port> port (default: C<no>, 601Enable the UDPv4 transport using the C<udp-port> port (default: C<no>).
536unless no other protocol is enabled for a node, in which case this
537protocol is enabled automatically).
538
539NOTE: Please specify C<enable-udp = yes> if you want to use it even though
540it might get switched on automatically, as some future version might
541default to another default protocol.
542 602
543=item hostname = hostname | ip [can not be defaulted] 603=item hostname = hostname | ip [can not be defaulted]
544 604
545Forces the address of this node to be set to the given DNS hostname or IP 605Forces the address of this node to be set to the given DNS hostname or IP
546address. It will be resolved before each connect request, so dyndns should 606address. It will be resolved before each connect request, so dyndns should

Diff Legend

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