| … | |
… | |
| 127 | .\} |
127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
| 130 | .\" |
130 | .\" |
| 131 | .IX Title "GVPE.CONF 5" |
131 | .IX Title "GVPE.CONF 5" |
| 132 | .TH GVPE.CONF 5 "2005-03-01" "1.7" "GNU Virtual Private Ethernet" |
132 | .TH GVPE.CONF 5 "2005-12-05" "1.9" "GNU Virtual Private Ethernet" |
| 133 | .SH "NAME" |
133 | .SH "NAME" |
| 134 | gvpe.conf \- configuration file for the GNU VPE daemon |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
| 135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 3 |
137 | .Vb 3 |
| … | |
… | |
| 158 | .SH "DESCRIPTION" |
158 | .SH "DESCRIPTION" |
| 159 | .IX Header "DESCRIPTION" |
159 | .IX Header "DESCRIPTION" |
| 160 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
160 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
| 161 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
161 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
| 162 | extend to the end of the line. They can be used on their own lines, or |
162 | extend to the end of the line. They can be used on their own lines, or |
| 163 | after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or |
163 | after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after |
| 164 | after values, but not within the variable names or values themselves. |
164 | values, but not within the variable names or values themselves. |
| 165 | .PP |
165 | .PP |
| 166 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
166 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
| 167 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
167 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
| 168 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
168 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
| 169 | .PP |
169 | .PP |
| … | |
… | |
| 194 | .IX Subsection "GLOBAL SETTINGS" |
194 | .IX Subsection "GLOBAL SETTINGS" |
| 195 | Global settings will affect the behaviour of the running gvpe daemon, that |
195 | Global settings will affect the behaviour of the running gvpe daemon, that |
| 196 | is, they are in some sense node-specific (config files can set different |
196 | is, they are in some sense node-specific (config files can set different |
| 197 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
197 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
| 198 | the gvpe daemon and all connections it creates. |
198 | the gvpe daemon and all connections it creates. |
| 199 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
199 | .IP "dns-forw-host = hostname/ip" 4 |
| 200 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
200 | .IX Item "dns-forw-host = hostname/ip" |
| 201 | Set the logging level. Connection established messages are logged at level |
201 | The dns server to forward dns requests to for the \s-1DNS\s0 tunnel protocol |
| 202 | \&\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. |
202 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
| 203 | .IP "node = nickname" 4 |
203 | .IP "dns-forw-port = port-number" 4 |
| 204 | .IX Item "node = nickname" |
204 | .IX Item "dns-forw-port = port-number" |
| 205 | Not really a config setting but introduces a node section. The nickname is |
205 | The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, |
| 206 | used to select the right configuration section and must be passed as an |
206 | which is fine in most cases). |
| 207 | argument to the gvpe daemon. |
207 | .IP "dns-max-outstanding = integer-number-of-requests" 4 |
| 208 | .IP "private-key = relative-path-to-key" 4 |
208 | .IX Item "dns-max-outstanding = integer-number-of-requests" |
| 209 | .IX Item "private-key = relative-path-to-key" |
209 | The maximum number of outstanding \s-1DNS\s0 transport requests |
| 210 | Sets the path (relative to the config directory) to the private key |
210 | (default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given |
| 211 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
211 | limit without receiving replies. In heavily overloaded situations it might |
| 212 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
212 | help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the |
| 213 | use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
213 | number of parallel requests. |
| 214 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
|
|
| 215 | .Sp |
214 | .Sp |
| 216 | Since only the private key file of the current node is used and the |
215 | The default should be working ok for most links. |
| 217 | private key file should be kept secret per-host to avoid spoofings, it is |
216 | .IP "dns-overlap-factor = float" 4 |
| 218 | not recommended to use this feature. |
217 | .IX Item "dns-overlap-factor = float" |
|
|
218 | The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen |
|
|
219 | during a connection as it's timing base. This factor (default: \f(CW0.5\fR, |
|
|
220 | must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending |
|
|
221 | rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new |
|
|
222 | request might be generated every \fBmin_latency\fR seconds, which means on |
|
|
223 | average there should only ever be one outstanding request. A factor of |
|
|
224 | \&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum |
|
|
225 | latency measured. |
|
|
226 | .Sp |
|
|
227 | For congested or picky dns forwarders you could use a value nearer to or |
|
|
228 | exceeding \f(CW1\fR. |
|
|
229 | .Sp |
|
|
230 | The default should be working ok for most links. |
|
|
231 | .IP "dns-send-interval = send-interval-in-seconds" 4 |
|
|
232 | .IX Item "dns-send-interval = send-interval-in-seconds" |
|
|
233 | The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will |
|
|
234 | use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when |
|
|
235 | the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will |
|
|
236 | not send more than 100 \s-1DNS\s0 requests per connection per second. For |
|
|
237 | high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For |
|
|
238 | congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR, |
|
|
239 | \&\f(CW0.2\fR or even higher. |
|
|
240 | .Sp |
|
|
241 | The default should be working ok for most links. |
|
|
242 | .IP "dns-timeout-factor = float" 4 |
|
|
243 | .IX Item "dns-timeout-factor = float" |
|
|
244 | Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to |
|
|
245 | get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport |
|
|
246 | will resend the request when no reply has been received for longer than |
|
|
247 | eight times the minimum (= expected) latency, assuming the request or |
|
|
248 | reply has been lost. |
|
|
249 | .Sp |
|
|
250 | For congested links a higher value might be necessary (e.g. \f(CW30\fR). If the |
|
|
251 | link is very stable lower values (e.g. \f(CW2\fR) might work nicely. Values |
|
|
252 | near or below \f(CW1\fR makes no sense whatsoever. |
|
|
253 | .Sp |
|
|
254 | The default should be working ok for most links. |
|
|
255 | .IP "if-up = relative-or-absolute-path" 4 |
|
|
256 | .IX Item "if-up = relative-or-absolute-path" |
|
|
257 | Sets the path of a script that should be called immediately after the |
|
|
258 | network interface is initialized (but not neccessarily up). The following |
|
|
259 | environment variables are passed to it (the values are just examples). |
|
|
260 | .Sp |
|
|
261 | Variables that have the same value on all nodes: |
|
|
262 | .RS 4 |
|
|
263 | .IP "CONFBASE=/etc/gvpe" 4 |
|
|
264 | .IX Item "CONFBASE=/etc/gvpe" |
|
|
265 | The configuration base directory. |
|
|
266 | .IP "IFNAME=vpn0" 4 |
|
|
267 | .IX Item "IFNAME=vpn0" |
|
|
268 | The network interface to initialize. |
|
|
269 | .IP "IFTYPE=native # or tincd" 4 |
|
|
270 | .IX Item "IFTYPE=native # or tincd" |
|
|
271 | .PD 0 |
|
|
272 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
|
|
273 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
|
|
274 | .PD |
|
|
275 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the |
|
|
276 | \&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to |
|
|
277 | select the correct syntax to use for network-related commands. |
|
|
278 | .IP "MTU=1436" 4 |
|
|
279 | .IX Item "MTU=1436" |
|
|
280 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
281 | consistently on all hosts), but this is usually ineffective. |
|
|
282 | .IP "NODES=5" 4 |
|
|
283 | .IX Item "NODES=5" |
|
|
284 | The number of nodes in this \s-1GVPE\s0 network. |
|
|
285 | .RE |
|
|
286 | .RS 4 |
|
|
287 | .Sp |
|
|
288 | Variables that are node-specific and with values pertaining to the node |
|
|
289 | running this \s-1GVPE:\s0 |
|
|
290 | .IP "IFUPDATA=string" 4 |
|
|
291 | .IX Item "IFUPDATA=string" |
|
|
292 | The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR. |
|
|
293 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
294 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
295 | The \s-1MAC\s0 address the network interface has to use. |
|
|
296 | .Sp |
|
|
297 | Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not |
|
|
298 | do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for |
|
|
299 | platform-specific information. |
|
|
300 | .IP "NODENAME=branch1" 4 |
|
|
301 | .IX Item "NODENAME=branch1" |
|
|
302 | The nickname of the node. |
|
|
303 | .IP "NODEID=1" 4 |
|
|
304 | .IX Item "NODEID=1" |
|
|
305 | The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first |
|
|
306 | node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
|
|
307 | .RE |
|
|
308 | .RS 4 |
|
|
309 | .Sp |
|
|
310 | In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be |
|
|
311 | available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that |
|
|
312 | node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while |
|
|
313 | the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22. |
|
|
314 | .Sp |
|
|
315 | Here is a simple if-up script: |
|
|
316 | .Sp |
|
|
317 | .Vb 5 |
|
|
318 | \& #!/bin/sh |
|
|
319 | \& ip link set $IFNAME up |
|
|
320 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
|
|
321 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
|
|
322 | \& ip route add 10.0.0.0/8 dev $IFNAME |
|
|
323 | .Ve |
|
|
324 | .Sp |
|
|
325 | More complicated examples (using routing to reduce arp traffic) can be |
|
|
326 | found in the etc/ subdirectory of the distribution. |
|
|
327 | .RE |
|
|
328 | .IP "ifname = devname" 4 |
|
|
329 | .IX Item "ifname = devname" |
|
|
330 | Sets the tun interface name to the given name. The default is OS-specific |
|
|
331 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
| 219 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
332 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
| 220 | .IX Item "ifpersist = yes|true|on | no|false|off" |
333 | .IX Item "ifpersist = yes|true|on | no|false|off" |
| 221 | Should the tun/tap device be made persistent, that is, should the device |
334 | Should the tun/tap device be made persistent, that is, should the device |
| 222 | stay up even when gvpe exits? Some versions of the tunnel device have |
335 | stay up even when gvpe exits? Some versions of the tunnel device have |
| 223 | problems sending packets when gvpe is restarted in persistent mode, so |
336 | problems sending packets when gvpe is restarted in persistent mode, so |
| 224 | if the connections can be established but you cannot send packets from |
337 | if the connections can be established but you cannot send packets from |
| 225 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
338 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
| 226 | device. |
339 | device. |
| 227 | .IP "ifname = devname" 4 |
340 | .IP "ip-proto = numerical-ip-protocol" 4 |
| 228 | .IX Item "ifname = devname" |
341 | .IX Item "ip-proto = numerical-ip-protocol" |
| 229 | Sets the tun interface name to the given name. The default is OS-specific |
342 | Sets the protocol number to be used for the rawip protocol. This is a |
| 230 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
343 | global option because all hosts must use the same protocol, and since |
| 231 | .IP "rekey = seconds" 4 |
344 | there are no port numbers, you cannot easily run more than one gvpe |
| 232 | .IX Item "rekey = seconds" |
345 | instance using the same protocol, nor can you share the protocol with |
| 233 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
346 | other programs. |
| 234 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
347 | .Sp |
|
|
348 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
|
|
349 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
|
|
350 | common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 |
|
|
351 | (\s-1ENCAP\s0, rfc1241) |
|
|
352 | .IP "http-proxy-host = hostname/ip" 4 |
|
|
353 | .IX Item "http-proxy-host = hostname/ip" |
|
|
354 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
|
|
355 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
|
|
356 | tcp connections through a http proxy server. |
|
|
357 | .Sp |
|
|
358 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
|
|
359 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
|
|
360 | requires authentication. |
|
|
361 | .Sp |
|
|
362 | Please note that gvpe will still try to resolve all hostnames in the |
|
|
363 | configuration file, so if you are behind a proxy without access to a dns |
|
|
364 | server better use numerical \s-1IP\s0 addresses. |
|
|
365 | .Sp |
|
|
366 | To make best use of this option disable all protocols except tcp in your |
|
|
367 | config file and make sure your routers (or all other hosts) are listening |
|
|
368 | on a port that the proxy allows (443, https, is a common choice). |
|
|
369 | .Sp |
|
|
370 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
|
|
371 | enabled on all hosts. |
|
|
372 | .Sp |
|
|
373 | Example: |
|
|
374 | .Sp |
|
|
375 | .Vb 3 |
|
|
376 | \& http-proxy-host = proxy.example.com |
|
|
377 | \& http-proxy-port = 3128 # 8080 is another common choice |
|
|
378 | \& http-proxy-auth = schmorp:grumbeere |
|
|
379 | .Ve |
|
|
380 | .IP "http-proxy-port = proxy-tcp-port" 4 |
|
|
381 | .IX Item "http-proxy-port = proxy-tcp-port" |
|
|
382 | The port where your proxy server listens. |
|
|
383 | .IP "http-proxy-auth = login:password" 4 |
|
|
384 | .IX Item "http-proxy-auth = login:password" |
|
|
385 | The optional login and password used to authenticate to the proxy server, |
|
|
386 | seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
|
|
387 | currently supported. |
| 235 | .IP "keepalive = seconds" 4 |
388 | .IP "keepalive = seconds" 4 |
| 236 | .IX Item "keepalive = seconds" |
389 | .IX Item "keepalive = seconds" |
| 237 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
390 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
| 238 | many seconds of inactivity the daemon will start to send keepalive probe |
391 | many seconds of inactivity the daemon will start to send keepalive probe |
| 239 | every 5 seconds until it receives a reply from the other end. If no reply |
392 | every 5 seconds until it receives a reply from the other end. If no reply |
| 240 | is received within 30 seconds, the peer is considered unreachable and the |
393 | is received within 30 seconds, the peer is considered unreachable and the |
| 241 | connection is closed. |
394 | connection is closed. |
|
|
395 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
|
|
396 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
|
|
397 | Set the logging level. Connection established messages are logged at level |
|
|
398 | \&\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. |
| 242 | .IP "mtu = bytes" 4 |
399 | .IP "mtu = bytes" 4 |
| 243 | .IX Item "mtu = bytes" |
400 | .IX Item "mtu = bytes" |
| 244 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
401 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
| 245 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
402 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
| 246 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
403 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
| 247 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
404 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
| 248 | .Sp |
405 | .Sp |
| 249 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
406 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
| 250 | .Sp |
407 | .Sp |
| 251 | This value must be the minimum of the mtu values of all hosts. |
408 | This value must be the minimum of the mtu values of all hosts. |
| 252 | .IP "ip-proto = numerical-ip-protocol" 4 |
409 | .IP "node = nickname" 4 |
| 253 | .IX Item "ip-proto = numerical-ip-protocol" |
410 | .IX Item "node = nickname" |
| 254 | Sets the protocol number to be used for the rawip protocol. This is a |
411 | Not really a config setting but introduces a node section. The nickname is |
| 255 | global option because all hosts must use the same protocol, and since |
412 | used to select the right configuration section and must be passed as an |
| 256 | there are no port numbers, you cannot easily run more than one gvpe |
413 | argument to the gvpe daemon. |
| 257 | instance using the same protocol, nor can you share the protocol with |
|
|
| 258 | other programs. |
|
|
| 259 | .Sp |
|
|
| 260 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
|
|
| 261 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
|
|
| 262 | common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 |
|
|
| 263 | (\s-1ENCAP\s0, rfc1241) |
|
|
| 264 | .IP "if-up = relative-or-absolute-path" 4 |
|
|
| 265 | .IX Item "if-up = relative-or-absolute-path" |
|
|
| 266 | Sets the path of a script that should be called immediately after the |
|
|
| 267 | network interface is initialized (but not neccessarily up). The following |
|
|
| 268 | environment variables are passed to it (the values are just examples): |
|
|
| 269 | .RS 4 |
|
|
| 270 | .IP "CONFBASE=/etc/gvpe" 4 |
|
|
| 271 | .IX Item "CONFBASE=/etc/gvpe" |
|
|
| 272 | The configuration base directory. |
|
|
| 273 | .IP "IFNAME=vpn0" 4 |
|
|
| 274 | .IX Item "IFNAME=vpn0" |
|
|
| 275 | The interface to initialize. |
|
|
| 276 | .IP "MTU=1436" 4 |
|
|
| 277 | .IX Item "MTU=1436" |
|
|
| 278 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
| 279 | consistently on all hosts), but this is usually ineffective. |
|
|
| 280 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
| 281 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
| 282 | The \s-1MAC\s0 address to set the interface to. The script *must* set the |
|
|
| 283 | interface \s-1MAC\s0 to this value. You will most likely use one of these: |
|
|
| 284 | .Sp |
|
|
| 285 | .Vb 2 |
|
|
| 286 | \& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
|
|
| 287 | \& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
|
|
| 288 | .Ve |
|
|
| 289 | .Sp |
|
|
| 290 | Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information. |
|
|
| 291 | .IP "IFTYPE=native # or tincd" 4 |
|
|
| 292 | .IX Item "IFTYPE=native # or tincd" |
|
|
| 293 | .PD 0 |
|
|
| 294 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
|
|
| 295 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
|
|
| 296 | .PD |
|
|
| 297 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os |
|
|
| 298 | name in lowercase) that this gvpe was configured for. Can be used to select |
|
|
| 299 | the correct syntax to use for network-related commands. |
|
|
| 300 | .IP "NODENAME=branch1" 4 |
|
|
| 301 | .IX Item "NODENAME=branch1" |
|
|
| 302 | The nickname of the current node, as passed to the gvpe daemon. |
|
|
| 303 | .IP "NODEID=1" 4 |
|
|
| 304 | .IX Item "NODEID=1" |
|
|
| 305 | The numerical node id of the current node. The first node mentioned in the |
|
|
| 306 | config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
|
|
| 307 | .RE |
|
|
| 308 | .RS 4 |
|
|
| 309 | .Sp |
|
|
| 310 | Here is a simple if-up script: |
|
|
| 311 | .Sp |
|
|
| 312 | .Vb 5 |
|
|
| 313 | \& #!/bin/sh |
|
|
| 314 | \& ip link set $IFNAME address $MAC mtu $MTU up |
|
|
| 315 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
|
|
| 316 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
|
|
| 317 | \& ip route add 10.0.0.0/8 dev $IFNAME |
|
|
| 318 | .Ve |
|
|
| 319 | .Sp |
|
|
| 320 | More complicated examples (using routing to reduce arp traffic) can be |
|
|
| 321 | found in the etc/ subdirectory of the distribution. |
|
|
| 322 | .RE |
|
|
| 323 | .IP "node-up = relative-or-absolute-path" 4 |
414 | .IP "node-up = relative-or-absolute-path" 4 |
| 324 | .IX Item "node-up = relative-or-absolute-path" |
415 | .IX Item "node-up = relative-or-absolute-path" |
| 325 | Sets a command (default: no script) that should be called whenever a |
416 | Sets a command (default: no script) that should be called whenever a |
| 326 | connection is established (even on rekeying operations). In addition |
417 | connection is established (even on rekeying operations). In addition to |
| 327 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
418 | all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
| 328 | variables will be set: |
419 | variables will be set: |
| 329 | .RS 4 |
420 | .RS 4 |
| 330 | .IP "DESTNODE=branch2" 4 |
421 | .IP "DESTNODE=branch2" 4 |
| 331 | .IX Item "DESTNODE=branch2" |
422 | .IX Item "DESTNODE=branch2" |
| 332 | The name of the remote node. |
423 | The name of the remote node. |
| … | |
… | |
| 360 | .Ve |
451 | .Ve |
| 361 | .RE |
452 | .RE |
| 362 | .IP "node-down = relative-or-absolute-path" 4 |
453 | .IP "node-down = relative-or-absolute-path" 4 |
| 363 | .IX Item "node-down = relative-or-absolute-path" |
454 | .IX Item "node-down = relative-or-absolute-path" |
| 364 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
455 | Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. |
| 365 | .IP "http-proxy-host = hostname/ip" 4 |
|
|
| 366 | .IX Item "http-proxy-host = hostname/ip" |
|
|
| 367 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
|
|
| 368 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
|
|
| 369 | tcp connections through a http proxy server. |
|
|
| 370 | .Sp |
|
|
| 371 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
|
|
| 372 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
|
|
| 373 | requires authentication. |
|
|
| 374 | .Sp |
|
|
| 375 | Please note that gvpe will still try to resolve all hostnames in the |
|
|
| 376 | configuration file, so if you are behind a proxy without access to a dns |
|
|
| 377 | server better use numerical \s-1IP\s0 addresses. |
|
|
| 378 | .Sp |
|
|
| 379 | To make best use of this option disable all protocols except tcp in your |
|
|
| 380 | config file and make sure your routers (or all other hosts) are listening |
|
|
| 381 | on a port that the proxy allows (443, https, is a common choice). |
|
|
| 382 | .Sp |
|
|
| 383 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
|
|
| 384 | enabled on all hosts. |
|
|
| 385 | .Sp |
|
|
| 386 | Example: |
|
|
| 387 | .Sp |
|
|
| 388 | .Vb 3 |
|
|
| 389 | \& http-proxy-host = proxy.example.com |
|
|
| 390 | \& http-proxy-port = 3128 # 8080 is another common choice |
|
|
| 391 | \& http-proxy-auth = schmorp:grumbeere |
|
|
| 392 | .Ve |
|
|
| 393 | .IP "http-proxy-port = proxy-tcp-port" 4 |
|
|
| 394 | .IX Item "http-proxy-port = proxy-tcp-port" |
|
|
| 395 | The port where your proxy server listens. |
|
|
| 396 | .IP "http-proxy-auth = login:password" 4 |
|
|
| 397 | .IX Item "http-proxy-auth = login:password" |
|
|
| 398 | The optional login and password used to authenticate to the proxy server, |
|
|
| 399 | seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
|
|
| 400 | currently supported. |
|
|
| 401 | .IP "pid-file = path" 4 |
456 | .IP "pid-file = path" 4 |
| 402 | .IX Item "pid-file = path" |
457 | .IX Item "pid-file = path" |
| 403 | The path to the pid file to check and create (Default: |
458 | The path to the pid file to check and create |
|
|
459 | (default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). |
|
|
460 | .IP "private-key = relative-path-to-key" 4 |
|
|
461 | .IX Item "private-key = relative-path-to-key" |
|
|
462 | Sets the path (relative to the config directory) to the private key |
|
|
463 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
|
|
464 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
|
|
465 | use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
|
|
466 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
|
|
467 | .Sp |
|
|
468 | Since only the private key file of the current node is used and the |
|
|
469 | private key file should be kept secret per-host to avoid spoofings, it is |
|
|
470 | not recommended to use this feature. |
|
|
471 | .IP "rekey = seconds" 4 |
|
|
472 | .IX Item "rekey = seconds" |
|
|
473 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
|
|
474 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
| 404 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
475 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
| 405 | .IX Subsection "NODE SPECIFIC SETTINGS" |
476 | .IX Subsection "NODE SPECIFIC SETTINGS" |
| 406 | The following settings are node\-specific, that is, every node can have |
477 | The following settings are node\-specific, that is, every node can have |
| 407 | different settings, even within the same gvpe instance. Settings that are |
478 | different settings, even within the same gvpe instance. Settings that are |
| 408 | executed before the first node section set the defaults, settings that are |
479 | set before the first node section set the defaults, settings that are |
| 409 | executed within a node section only apply to the given node. |
480 | set within a node section only apply to the given node. |
| 410 | .IP "udp-port = port-number" 4 |
481 | .IP "allow-direct = nodename" 4 |
| 411 | .IX Item "udp-port = port-number" |
482 | .IX Item "allow-direct = nodename" |
| 412 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
483 | Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info. |
| 413 | officially assigned by \s-1IANA\s0!). |
|
|
| 414 | .IP "tcp-port = port-number" 4 |
|
|
| 415 | .IX Item "tcp-port = port-number" |
|
|
| 416 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
|
|
| 417 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
|
|
| 418 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
|
|
| 419 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
|
|
| 420 | (default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet |
|
|
| 421 | is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+). |
|
|
| 422 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
484 | .IP "compress = yes|true|on | no|false|off" 4 |
| 423 | .IX Item "enable-udp = yes|true|on | no|false|off" |
485 | .IX Item "compress = yes|true|on | no|false|off" |
| 424 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
486 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
| 425 | unless no other protocol is enabled for a node, in which case this |
487 | Compression is really cheap even on slow computers and has no size |
| 426 | protocol is enabled automatically). This is a good general choice since |
488 | overhead at all, so enabling this is a good idea. |
| 427 | \&\s-1UDP\s0 tunnels well through many firewalls. |
|
|
| 428 | .Sp |
|
|
| 429 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
|
|
| 430 | it might get switched on automatically, as some future version might |
|
|
| 431 | default to another default protocol. |
|
|
| 432 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
|
|
| 433 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
|
|
| 434 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
|
|
| 435 | (default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only |
|
|
| 436 | available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never |
|
|
| 437 | use this transport unless you really must, it is horribly ineffiecent and |
|
|
| 438 | resource-intensive compared to the other transports. |
|
|
| 439 | .IP "router-priority = 0 | 1 | positive\-number>2" 4 |
|
|
| 440 | .IX Item "router-priority = 0 | 1 | positive-number>2" |
|
|
| 441 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
|
|
| 442 | some host tries to connect to another host without a hostname, it asks |
|
|
| 443 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
|
|
| 444 | highest priority larger than \f(CW1\fR that is currently reachable. |
|
|
| 445 | .Sp |
|
|
| 446 | Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router |
|
|
| 447 | hosts, otherwise connecting to them might be impossible. |
|
|
| 448 | .Sp |
|
|
| 449 | The special value \f(CW1\fR allows other hosts to route through the router |
|
|
| 450 | host, but they will never route through it by default. The value \f(CW0\fR |
|
|
| 451 | disables routing. The idea behind this is that some hosts can, if |
|
|
| 452 | required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their |
|
|
| 453 | local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is |
|
|
| 454 | \&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do |
|
|
| 455 | not use by default\*(R" switch. |
|
|
| 456 | .IP "connect = ondemand | never | always | disabled" 4 |
489 | .IP "connect = ondemand | never | always | disabled" 4 |
| 457 | .IX Item "connect = ondemand | never | always | disabled" |
490 | .IX Item "connect = ondemand | never | always | disabled" |
| 458 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
491 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
| 459 | try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR |
492 | try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR |
| 460 | (never initiate a connection to the given host, but accept connections), |
493 | (never initiate a connection to the given host, but accept connections), |
| 461 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
494 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
| 462 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
495 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
| 463 | don't talk to it). |
496 | don't talk to it). |
|
|
497 | .IP "deny-direct = nodename | *" 4 |
|
|
498 | .IX Item "deny-direct = nodename | *" |
|
|
499 | Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR |
|
|
500 | is given). Only one node can be specified, but you can use multiple |
|
|
501 | \&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in |
|
|
502 | networks with routers, as routers are required for indirect connections. |
|
|
503 | .Sp |
|
|
504 | Sometimes, a node cannot reach some other nodes for reasons of network |
|
|
505 | connectivity. For example, a node behind a firewall that only allows |
|
|
506 | conenctions to/from a single other node in the network. In this case one |
|
|
507 | should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other |
|
|
508 | node \fImust\fR be a router for this to work). |
|
|
509 | .Sp |
|
|
510 | The algorithm to check wether a connection may be direct is as follows: |
|
|
511 | .Sp |
|
|
512 | 1. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection. |
|
|
513 | .Sp |
|
|
514 | 2. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections. |
|
|
515 | .Sp |
|
|
516 | 3. Allow the connection. |
|
|
517 | .Sp |
|
|
518 | That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precende over \f(CW\*(C`deny\-direct\*(C'\fR. |
|
|
519 | .Sp |
|
|
520 | The check is done in both directions, i.e. both nodes must allow a direct |
|
|
521 | connection before one is attempted, so you only need to specify connect |
|
|
522 | limitations on one node. |
|
|
523 | .IP "dns-domain = domain-suffix" 4 |
|
|
524 | .IX Item "dns-domain = domain-suffix" |
|
|
525 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node. |
|
|
526 | .Sp |
|
|
527 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
|
|
528 | i.e. |
|
|
529 | .Sp |
|
|
530 | .Vb 2 |
|
|
531 | \& dns-domainname = tunnel.example.net |
|
|
532 | \& dns-hostname = tunnel-server.example.net |
|
|
533 | .Ve |
|
|
534 | .Sp |
|
|
535 | Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
|
|
536 | .Sp |
|
|
537 | .Vb 2 |
|
|
538 | \& tunnel.example.net. NS tunnel-server.example.net. |
|
|
539 | \& tunnel-server.example.net. A 13.13.13.13 |
|
|
540 | .Ve |
|
|
541 | .IP "dns-hostname = hostname/ip" 4 |
|
|
542 | .IX Item "dns-hostname = hostname/ip" |
|
|
543 | The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
|
|
544 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
|
|
545 | change. |
|
|
546 | .IP "dns-port = port-number" 4 |
|
|
547 | .IX Item "dns-port = port-number" |
|
|
548 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers. |
|
|
549 | .IP "enable-dns = yes|true|on | no|false|off" 4 |
|
|
550 | .IX Item "enable-dns = yes|true|on | no|false|off" |
|
|
551 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport |
|
|
552 | protocol. Avoid this protocol if you can. |
|
|
553 | .Sp |
|
|
554 | Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as |
|
|
555 | client. Support for this transport protocol is only available when gvpe |
|
|
556 | was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option. |
|
|
557 | .IP "enable-icmp = yes|true|on | no|false|off" 4 |
|
|
558 | .IX Item "enable-icmp = yes|true|on | no|false|off" |
|
|
559 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol. |
|
|
560 | .Sp |
|
|
561 | Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this |
|
|
562 | node. |
|
|
563 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
|
|
564 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
|
|
565 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol. |
|
|
566 | .Sp |
|
|
567 | Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol |
|
|
568 | (default: \f(CW\*(C`no\*(C'\fR). |
|
|
569 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
|
|
570 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
|
|
571 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol. |
|
|
572 | .Sp |
|
|
573 | Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port |
|
|
574 | (default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available |
|
|
575 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
|
|
576 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
|
|
577 | .IX Item "enable-udp = yes|true|on | no|false|off" |
|
|
578 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
|
|
579 | .Sp |
|
|
580 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
|
|
581 | unless no other protocol is enabled for a node, in which case this |
|
|
582 | protocol is enabled automatically). |
|
|
583 | .Sp |
|
|
584 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
|
|
585 | it might get switched on automatically, as some future version might |
|
|
586 | default to another default protocol. |
|
|
587 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
|
|
588 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
|
|
589 | Forces the address of this node to be set to the given dns hostname or ip |
|
|
590 | address. It will be resolved before each connect request, so dyndns should |
|
|
591 | work fine. If this setting is not specified and a router is available, |
|
|
592 | then the router will be queried for the address of this node. Otherwise, |
|
|
593 | the connection attempt will fail. |
|
|
594 | .IP "icmp-type = integer" 4 |
|
|
595 | .IX Item "icmp-type = integer" |
|
|
596 | Sets the type value to be used for outgoing (and incoming) packets sent |
|
|
597 | via the \s-1ICMP\s0 transport. |
|
|
598 | .Sp |
|
|
599 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
|
|
600 | \&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
|
|
601 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
|
|
602 | .IP "if-up-data = value" 4 |
|
|
603 | .IX Item "if-up-data = value" |
|
|
604 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
|
|
605 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
| 464 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
606 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
| 465 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
607 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
| 466 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
608 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
| 467 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
609 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
| 468 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
610 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
| 469 | to the tunnel device, which is usually what you want. |
611 | to the tunnel device, which is usually what you want. |
| 470 | .IP "compress = yes|true|on | no|false|off" 4 |
|
|
| 471 | .IX Item "compress = yes|true|on | no|false|off" |
|
|
| 472 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
|
|
| 473 | Compression is really cheap even on slow computers and has no size |
|
|
| 474 | overhead at all, so enabling this is a good idea. |
|
|
| 475 | .IP "max-retry = positive-number" 4 |
612 | .IP "max-retry = positive-number" 4 |
| 476 | .IX Item "max-retry = positive-number" |
613 | .IX Item "max-retry = positive-number" |
| 477 | The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between |
614 | The maximum interval in seconds (default: \f(CW3600\fR, one hour) between |
| 478 | retries to establish a connection to this node. When a connection cannot |
615 | retries to establish a connection to this node. When a connection cannot |
| 479 | be established, gvpe uses exponential backoff capped at this value. It's |
616 | be established, gvpe uses exponential backoff capped at this value. It's |
| 480 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
617 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
| 481 | connections to routers that usually are stable but sometimes are down, to |
618 | connections to routers that usually are stable but sometimes are down, to |
| 482 | assure quick reconnections. |
619 | assure quick reconnections even after longer downtimes. |
|
|
620 | .IP "router-priority = 0 | 1 | positive\-number>=2" 4 |
|
|
621 | .IX Item "router-priority = 0 | 1 | positive-number>=2" |
|
|
622 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
|
|
623 | some host tries to connect to another host without a hostname, it asks |
|
|
624 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
|
|
625 | highest priority larger than \f(CW1\fR that is currently reachable. |
|
|
626 | .Sp |
|
|
627 | Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router |
|
|
628 | hosts, otherwise connecting to them might be impossible. |
|
|
629 | .Sp |
|
|
630 | The special value \f(CW1\fR allows other hosts to route through the router |
|
|
631 | host, but they will never route through it by default. The value \f(CW0\fR |
|
|
632 | disables routing. The idea behind this is that some hosts can, if |
|
|
633 | required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their |
|
|
634 | local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is |
|
|
635 | \&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do |
|
|
636 | not use by default\*(R" switch. |
|
|
637 | .IP "tcp-port = port-number" 4 |
|
|
638 | .IX Item "tcp-port = port-number" |
|
|
639 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
|
|
640 | .IP "udp-port = port-number" 4 |
|
|
641 | .IX Item "udp-port = port-number" |
|
|
642 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
|
|
643 | officially assigned by \s-1IANA\s0!). |
| 483 | .SH "CONFIG DIRECTORY LAYOUT" |
644 | .SH "CONFIG DIRECTORY LAYOUT" |
| 484 | .IX Header "CONFIG DIRECTORY LAYOUT" |
645 | .IX Header "CONFIG DIRECTORY LAYOUT" |
| 485 | The default (or recommended) directory layout for the config directory is: |
646 | The default (or recommended) directory layout for the config directory is: |
| 486 | .IP "\(bu" 4 |
647 | .IP "\(bu" 4 |
| 487 | .IX Xref "gvpe.conf" |
648 | .IX Xref "gvpe.conf" |
| … | |
… | |
| 501 | .SH "SEE ALSO" |
662 | .SH "SEE ALSO" |
| 502 | .IX Header "SEE ALSO" |
663 | .IX Header "SEE ALSO" |
| 503 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
664 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
| 504 | .SH "AUTHOR" |
665 | .SH "AUTHOR" |
| 505 | .IX Header "AUTHOR" |
666 | .IX Header "AUTHOR" |
| 506 | Marc Lehmann <gvpe@plan9.de> |
667 | Marc Lehmann <gvpe@schmorp.de> |
