… | |
… | |
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 "2004-06-11" "1.7" "GNU Virtual Private Ethernet" |
132 | .TH GVPE.CONF 5 "2005-03-06" "1.8" "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 4 |
137 | .Vb 3 |
138 | \& enable-udp = yes |
|
|
139 | \& udp-port = 407 |
138 | \& udp-port = 407 |
140 | \& mtu = 1492 |
139 | \& mtu = 1492 |
141 | \& ifname = vpn0 |
140 | \& ifname = vpn0 |
142 | .Ve |
141 | .Ve |
143 | .PP |
142 | .PP |
… | |
… | |
195 | .IX Subsection "GLOBAL SETTINGS" |
194 | .IX Subsection "GLOBAL SETTINGS" |
196 | 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 |
197 | 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 |
198 | 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 |
199 | the gvpe daemon and all connections it creates. |
198 | the gvpe daemon and all connections it creates. |
200 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
199 | .IP "dns-forw-host = hostname/ip" 4 |
201 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
200 | .IX Item "dns-forw-host = hostname/ip" |
202 | 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 |
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. |
202 | (default: \f(CW127.0.0.1\fR, changing it is highly recommended). |
204 | .IP "node = nickname" 4 |
203 | .IP "dns-forw-port = port-number" 4 |
205 | .IX Item "node = nickname" |
204 | .IX Item "dns-forw-port = port-number" |
206 | 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, |
207 | used to select the right configuration section and must be passed as an |
206 | which is fine in most cases). |
208 | argument to the gvpe daemon. |
|
|
209 | .IP "private-key = relative-path-to-key" 4 |
|
|
210 | .IX Item "private-key = relative-path-to-key" |
|
|
211 | Sets the path (relative to the config directory) to the private key |
|
|
212 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
|
|
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 |
|
|
217 | Since only the private key file of the current node is used and the |
|
|
218 | private key file should be kept secret per-host to avoid spoofings, it is |
|
|
219 | not recommended to use this feature. |
|
|
220 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
|
|
221 | .IX Item "ifpersist = yes|true|on | no|false|off" |
|
|
222 | 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 |
|
|
224 | problems sending packets when gvpe is restarted in persistent mode, so |
|
|
225 | 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 |
|
|
227 | device. |
|
|
228 | .IP "ifname = devname" 4 |
|
|
229 | .IX Item "ifname = devname" |
|
|
230 | Sets the tun interface name to the given name. The default is OS-specific |
|
|
231 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
|
|
232 | .IP "rekey = seconds" 4 |
|
|
233 | .IX Item "rekey = seconds" |
|
|
234 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
|
|
235 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
|
|
236 | .IP "keepalive = seconds" 4 |
|
|
237 | .IX Item "keepalive = seconds" |
|
|
238 | 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 |
|
|
240 | every 5 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 |
|
|
242 | connection is closed. |
|
|
243 | .IP "mtu = bytes" 4 |
|
|
244 | .IX Item "mtu = bytes" |
|
|
245 | 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 |
|
|
247 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
|
|
248 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
|
|
249 | .Sp |
|
|
250 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
|
|
251 | .Sp |
|
|
252 | This value must be the minimum of the mtu values of all hosts. |
|
|
253 | .IP "ip-proto = numerical-ip-protocol" 4 |
|
|
254 | .IX Item "ip-proto = numerical-ip-protocol" |
|
|
255 | Sets the protocol number to be used for the rawip protocol. This is a |
|
|
256 | global option because all hosts must use the same protocol, and since |
|
|
257 | there are no port numbers, you cannot easily run more than one gvpe |
|
|
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 |
207 | .IP "if-up = relative-or-absolute-path" 4 |
266 | .IX Item "if-up = relative-or-absolute-path" |
208 | .IX Item "if-up = relative-or-absolute-path" |
267 | Sets the path of a script that should be called immediately after the |
209 | Sets the path of a script that should be called immediately after the |
268 | network interface is initialized (but not neccessarily up). The following |
210 | network interface is initialized (but not neccessarily up). The following |
269 | environment variables are passed to it (the values are just examples): |
211 | environment variables are passed to it (the values are just examples): |
… | |
… | |
319 | .Ve |
261 | .Ve |
320 | .Sp |
262 | .Sp |
321 | More complicated examples (using routing to reduce arp traffic) can be |
263 | More complicated examples (using routing to reduce arp traffic) can be |
322 | found in the etc/ subdirectory of the distribution. |
264 | found in the etc/ subdirectory of the distribution. |
323 | .RE |
265 | .RE |
|
|
266 | .IP "ifname = devname" 4 |
|
|
267 | .IX Item "ifname = devname" |
|
|
268 | Sets the tun interface name to the given name. The default is OS-specific |
|
|
269 | and most probably something like \f(CW\*(C`tun0\*(C'\fR. |
|
|
270 | .IP "ifpersist = yes|true|on | no|false|off" 4 |
|
|
271 | .IX Item "ifpersist = yes|true|on | no|false|off" |
|
|
272 | Should the tun/tap device be made persistent, that is, should the device |
|
|
273 | stay up even when gvpe exits? Some versions of the tunnel device have |
|
|
274 | problems sending packets when gvpe is restarted in persistent mode, so |
|
|
275 | if the connections can be established but you cannot send packets from |
|
|
276 | the local node, try to set this to \f(CW\*(C`off\*(C'\fR and do an ifconfig down on the |
|
|
277 | device. |
|
|
278 | .IP "ip-proto = numerical-ip-protocol" 4 |
|
|
279 | .IX Item "ip-proto = numerical-ip-protocol" |
|
|
280 | Sets the protocol number to be used for the rawip protocol. This is a |
|
|
281 | global option because all hosts must use the same protocol, and since |
|
|
282 | there are no port numbers, you cannot easily run more than one gvpe |
|
|
283 | instance using the same protocol, nor can you share the protocol with |
|
|
284 | other programs. |
|
|
285 | .Sp |
|
|
286 | The default is 47 (\s-1GRE\s0), which has a good chance of tunneling through |
|
|
287 | firewalls (but note that the rawip protocol is not \s-1GRE\s0 compatible). Other |
|
|
288 | common choices are 50 (\s-1IPSEC\s0, \s-1ESP\s0), 51 (\s-1IPSEC\s0, \s-1AH\s0), 4 (\s-1IPIP\s0 tunnels) or 98 |
|
|
289 | (\s-1ENCAP\s0, rfc1241) |
|
|
290 | .IP "http-proxy-host = hostname/ip" 4 |
|
|
291 | .IX Item "http-proxy-host = hostname/ip" |
|
|
292 | The \f(CW\*(C`http\-proxy\-*\*(C'\fR family of options are only available if gvpe was |
|
|
293 | compiled with the \f(CW\*(C`\-\-enable\-http\-proxy\*(C'\fR option and enable tunneling of |
|
|
294 | tcp connections through a http proxy server. |
|
|
295 | .Sp |
|
|
296 | \&\f(CW\*(C`http\-proxy\-host\*(C'\fR and \f(CW\*(C`http\-proxy\-port\*(C'\fR should specify the hostname and |
|
|
297 | port number of the proxy server. See \f(CW\*(C`http\-proxy\-loginpw\*(C'\fR if your proxy |
|
|
298 | requires authentication. |
|
|
299 | .Sp |
|
|
300 | Please note that gvpe will still try to resolve all hostnames in the |
|
|
301 | configuration file, so if you are behind a proxy without access to a dns |
|
|
302 | server better use numerical \s-1IP\s0 addresses. |
|
|
303 | .Sp |
|
|
304 | To make best use of this option disable all protocols except tcp in your |
|
|
305 | config file and make sure your routers (or all other hosts) are listening |
|
|
306 | on a port that the proxy allows (443, https, is a common choice). |
|
|
307 | .Sp |
|
|
308 | If you have a router, connecting to it will suffice. Otherwise tcp must be |
|
|
309 | enabled on all hosts. |
|
|
310 | .Sp |
|
|
311 | Example: |
|
|
312 | .Sp |
|
|
313 | .Vb 3 |
|
|
314 | \& http-proxy-host = proxy.example.com |
|
|
315 | \& http-proxy-port = 3128 # 8080 is another common choice |
|
|
316 | \& http-proxy-auth = schmorp:grumbeere |
|
|
317 | .Ve |
|
|
318 | .IP "http-proxy-port = proxy-tcp-port" 4 |
|
|
319 | .IX Item "http-proxy-port = proxy-tcp-port" |
|
|
320 | The port where your proxy server listens. |
|
|
321 | .IP "http-proxy-auth = login:password" 4 |
|
|
322 | .IX Item "http-proxy-auth = login:password" |
|
|
323 | The optional login and password used to authenticate to the proxy server, |
|
|
324 | seperated by a literal colon (\f(CW\*(C`:\*(C'\fR). Only basic authentication is |
|
|
325 | currently supported. |
|
|
326 | .IP "keepalive = seconds" 4 |
|
|
327 | .IX Item "keepalive = seconds" |
|
|
328 | Sets the keepalive probe interval in seconds (default: \f(CW60\fR). After this |
|
|
329 | many seconds of inactivity the daemon will start to send keepalive probe |
|
|
330 | every 5 seconds until it receives a reply from the other end. If no reply |
|
|
331 | is received within 30 seconds, the peer is considered unreachable and the |
|
|
332 | connection is closed. |
|
|
333 | .IP "loglevel = noise|trace|debug|info|notice|warn|error|critical" 4 |
|
|
334 | .IX Item "loglevel = noise|trace|debug|info|notice|warn|error|critical" |
|
|
335 | Set the logging level. Connection established messages are logged at level |
|
|
336 | \&\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. |
|
|
337 | .IP "mtu = bytes" 4 |
|
|
338 | .IX Item "mtu = bytes" |
|
|
339 | Sets the maximum \s-1MTU\s0 that should be used on outgoing packets (basically |
|
|
340 | the \s-1MTU\s0 of the outgoing interface) The daemon will automatically calculate |
|
|
341 | maximum overhead (e.g. udp header size, encryption blocksize...) and pass |
|
|
342 | this information to the \f(CW\*(C`if\-up\*(C'\fR script. |
|
|
343 | .Sp |
|
|
344 | Recommended values are 1500 (ethernet), 1492 (pppoe), 1472 (pptp). |
|
|
345 | .Sp |
|
|
346 | This value must be the minimum of the mtu values of all hosts. |
|
|
347 | .IP "node = nickname" 4 |
|
|
348 | .IX Item "node = nickname" |
|
|
349 | Not really a config setting but introduces a node section. The nickname is |
|
|
350 | used to select the right configuration section and must be passed as an |
|
|
351 | argument to the gvpe daemon. |
324 | .IP "node-up = relative-or-absolute-path" 4 |
352 | .IP "node-up = relative-or-absolute-path" 4 |
325 | .IX Item "node-up = relative-or-absolute-path" |
353 | .IX Item "node-up = relative-or-absolute-path" |
326 | Sets a command (default: no script) that should be called whenever a |
354 | Sets a command (default: no script) that should be called whenever a |
327 | connection is established (even on rekeying operations). In addition |
355 | connection is established (even on rekeying operations). In addition |
328 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
356 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
… | |
… | |
361 | .Ve |
389 | .Ve |
362 | .RE |
390 | .RE |
363 | .IP "node-down = relative-or-absolute-path" 4 |
391 | .IP "node-down = relative-or-absolute-path" 4 |
364 | .IX Item "node-down = relative-or-absolute-path" |
392 | .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. |
393 | 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 |
394 | .IP "pid-file = path" 4 |
403 | .IX Item "pid-file = path" |
395 | .IX Item "pid-file = path" |
404 | The path to the pid file to check and create (Default: |
396 | The path to the pid file to check and create |
|
|
397 | (default: \f(CW\*(C`LOCALSTATEDIR/run/gvpe.pid\*(C'\fR). |
|
|
398 | .IP "private-key = relative-path-to-key" 4 |
|
|
399 | .IX Item "private-key = relative-path-to-key" |
|
|
400 | Sets the path (relative to the config directory) to the private key |
|
|
401 | (default: \f(CW\*(C`hostkey\*(C'\fR). This is a printf format string so every \f(CW\*(C`%\*(C'\fR must |
|
|
402 | be doubled. A single \f(CW%s\fR is replaced by the hostname, so you could |
|
|
403 | use paths like \f(CW\*(C`hostkeys/%s\*(C'\fR to fetch the files at the location where |
|
|
404 | \&\f(CW\*(C`gvpectrl\*(C'\fR puts them. |
|
|
405 | .Sp |
|
|
406 | Since only the private key file of the current node is used and the |
|
|
407 | private key file should be kept secret per-host to avoid spoofings, it is |
|
|
408 | not recommended to use this feature. |
|
|
409 | .IP "rekey = seconds" 4 |
|
|
410 | .IX Item "rekey = seconds" |
|
|
411 | Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are |
|
|
412 | reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. |
405 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
413 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
406 | .IX Subsection "NODE SPECIFIC SETTINGS" |
414 | .IX Subsection "NODE SPECIFIC SETTINGS" |
407 | The following settings are node\-specific, that is, every node can have |
415 | The following settings are node\-specific, that is, every node can have |
408 | different settings, even within the same gvpe instance. Settings that are |
416 | different settings, even within the same gvpe instance. Settings that are |
409 | executed before the first node section set the defaults, settings that are |
417 | executed before the first node section set the defaults, settings that are |
410 | executed within a node section only apply to the given node. |
418 | executed within a node section only apply to the given node. |
|
|
419 | .IP "compress = yes|true|on | no|false|off" 4 |
|
|
420 | .IX Item "compress = yes|true|on | no|false|off" |
|
|
421 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
|
|
422 | Compression is really cheap even on slow computers and has no size |
|
|
423 | overhead at all, so enabling this is a good idea. |
|
|
424 | .IP "connect = ondemand | never | always | disabled" 4 |
|
|
425 | .IX Item "connect = ondemand | never | always | disabled" |
|
|
426 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
|
|
427 | try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR |
|
|
428 | (never initiate a connection to the given host, but accept connections), |
|
|
429 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
|
|
430 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
|
|
431 | don't talk to it). |
|
|
432 | .IP "dns-domain = domain-suffix" 4 |
|
|
433 | .IX Item "dns-domain = domain-suffix" |
|
|
434 | The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server. Needs to be |
|
|
435 | set on both client and server. |
|
|
436 | .Sp |
|
|
437 | The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, |
|
|
438 | i.e. |
|
|
439 | .Sp |
|
|
440 | .Vb 2 |
|
|
441 | \& dns-domainname = tunnel.example.net |
|
|
442 | \& dns-hostname = tunnel-server.example.net |
|
|
443 | .Ve |
|
|
444 | .Sp |
|
|
445 | Corresponds to the following \s-1DNS\s0 entries in the \f(CW\*(C`example.net\*(C'\fR domain: |
|
|
446 | .Sp |
|
|
447 | .Vb 2 |
|
|
448 | \& tunnel.example.net. NS tunnel-server.example.net. |
|
|
449 | \& tunnel-server.example.net. A 13.13.13.13 |
|
|
450 | .Ve |
|
|
451 | .IP "dns-hostname = hostname/ip" 4 |
|
|
452 | .IX Item "dns-hostname = hostname/ip" |
|
|
453 | The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, |
|
|
454 | but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might |
|
|
455 | change. |
411 | .IP "udp-port = port-number" 4 |
456 | .IP "dns-port = port-number" 4 |
412 | .IX Item "udp-port = port-number" |
457 | .IX Item "dns-port = port-number" |
413 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
458 | The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW0\fR on all \s-1DNS\s0 tunnel |
414 | officially assigned by \s-1IANA\s0!). |
459 | clients and \f(CW53\fR on the server. |
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 |
460 | .IP "enable-rawip = yes|true|on | no|false|off" 4 |
419 | .IX Item "enable-rawip = yes|true|on | no|false|off" |
461 | .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 |
462 | 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 |
463 | (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+). |
464 | 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 |
465 | .IP "enable-tcp = yes|true|on | no|false|off" 4 |
432 | .IX Item "enable-tcp = yes|true|on | no|false|off" |
466 | .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 |
467 | 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 |
468 | (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 |
469 | 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 |
470 | use this transport unless you really must, it is horribly ineffiecent and |
437 | resource-intensive compared to the other transports. |
471 | resource-intensive compared to the other transports. |
438 | .IP "router-priority = positive-number" 4 |
472 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
439 | .IX Item "router-priority = positive-number" |
473 | .IX Item "enable-udp = yes|true|on | no|false|off" |
440 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
474 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
441 | some host tries to connect to another host without a hostname, it asks |
475 | unless no other protocol is enabled for a node, in which case this |
442 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
476 | protocol is enabled automatically). This is a good general choice since |
443 | highest priority that is currently reachable. Make sure all clients always |
477 | \&\s-1UDP\s0 tunnels well through many firewalls. |
444 | connect to the router hosts, otherwise conencting to them is impossible. |
478 | .Sp |
445 | .IP "connect = ondemand|never|always|disabled" 4 |
479 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though |
446 | .IX Item "connect = ondemand|never|always|disabled" |
480 | it might get switched on automatically, as some future version might |
447 | Sets the connect mode (default: \f(CW\*(C`always\*(C'\fR). It can be \f(CW\*(C`always\*(C'\fR (always |
481 | default to another default protocol. |
448 | try to establish and keep a conenction to the given host), \f(CW\*(C`never\*(C'\fR |
|
|
449 | (nevr initiate a connection to the given host, but accept connections), |
|
|
450 | \&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and |
|
|
451 | take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, |
|
|
452 | don't talk to it). |
|
|
453 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
482 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
454 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
483 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
455 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
484 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
456 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
485 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
457 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
486 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
458 | to the tunnel device, which is usually what you want. |
487 | to the tunnel device, which is usually what you want. |
459 | .IP "compress = yes|true|on | no|false|off" 4 |
|
|
460 | .IX Item "compress = yes|true|on | no|false|off" |
|
|
461 | Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). |
|
|
462 | Compression is really cheap even on slow computers and has no size |
|
|
463 | overhead at all, so enabling this is a good idea. |
|
|
464 | .IP "max-retry = positive-number" 4 |
488 | .IP "max-retry = positive-number" 4 |
465 | .IX Item "max-retry = positive-number" |
489 | .IX Item "max-retry = positive-number" |
466 | The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between |
490 | The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between |
467 | retries to establish a connection to this node. When a connection cannot |
491 | retries to establish a connection to this node. When a connection cannot |
468 | be established, gvpe uses exponential backoff capped at this value. It's |
492 | be established, gvpe uses exponential backoff capped at this value. It's |
469 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
493 | sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on |
470 | connections to routers that usually are stable but sometimes are down, to |
494 | connections to routers that usually are stable but sometimes are down, to |
471 | assure quick reconnections. |
495 | assure quick reconnections. |
|
|
496 | .IP "router-priority = 0 | 1 | positive\-number>2" 4 |
|
|
497 | .IX Item "router-priority = 0 | 1 | positive-number>2" |
|
|
498 | Sets the router priority of the given host (default: \f(CW0\fR, disabled). If |
|
|
499 | some host tries to connect to another host without a hostname, it asks |
|
|
500 | the router host for it's \s-1IP\s0 address. The router host is the one with the |
|
|
501 | highest priority larger than \f(CW1\fR that is currently reachable. |
|
|
502 | .Sp |
|
|
503 | Make sure all hosts always connect (\f(CW\*(C`connect = always\*(C'\fR) to the router |
|
|
504 | hosts, otherwise connecting to them might be impossible. |
|
|
505 | .Sp |
|
|
506 | The special value \f(CW1\fR allows other hosts to route through the router |
|
|
507 | host, but they will never route through it by default. The value \f(CW0\fR |
|
|
508 | disables routing. The idea behind this is that some hosts can, if |
|
|
509 | required, bump the \f(CW\*(C`router\-priority\*(C'\fR setting to higher than \f(CW1\fR in their |
|
|
510 | local config to route through specific hosts. If \f(CW\*(C`router\-priority\*(C'\fR is |
|
|
511 | \&\f(CW0\fR, then routing will be refused, so \f(CW1\fR serves as a \*(L"enable, but do |
|
|
512 | not use by default\*(R" switch. |
|
|
513 | .IP "tcp-port = port-number" 4 |
|
|
514 | .IX Item "tcp-port = port-number" |
|
|
515 | Similar to \f(CW\*(C`udp\-port\*(C'\fR (default: \f(CW655\fR), but sets the \s-1TCP\s0 port number. |
|
|
516 | .IP "udp-port = port-number" 4 |
|
|
517 | .IX Item "udp-port = port-number" |
|
|
518 | Sets the port number used by the \s-1UDP\s0 protocol (default: \f(CW655\fR, not |
|
|
519 | officially assigned by \s-1IANA\s0!). |
472 | .SH "CONFIG DIRECTORY LAYOUT" |
520 | .SH "CONFIG DIRECTORY LAYOUT" |
473 | .IX Header "CONFIG DIRECTORY LAYOUT" |
521 | .IX Header "CONFIG DIRECTORY LAYOUT" |
474 | The default (or recommended) directory layout for the config directory is: |
522 | The default (or recommended) directory layout for the config directory is: |
475 | .IP "gvpe.conf" 4 |
523 | .IP "\(bu" 4 |
476 | .IX Item "gvpe.conf" |
524 | .IX Xref "gvpe.conf" |
477 | The config file. |
525 | The config file. |
478 | .IP "if-up" 4 |
526 | .IP "\(bu" 4 |
479 | .IX Item "if-up" |
527 | .IX Xref "if-up" |
480 | The if-up script |
528 | The if-up script |
481 | .IP "node\-up, node-down" 4 |
529 | .IP "," 4 |
482 | .IX Item "node-up, node-down" |
530 | .IX Xref "node-up node-down" |
483 | If used the node up or node-down scripts. |
531 | If used the node up or node-down scripts. |
484 | .IP "hostkey" 4 |
532 | .IP "\(bu" 4 |
485 | .IX Item "hostkey" |
533 | .IX Xref "hostkey" |
486 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
534 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
487 | .IP "pubkey/nodename" 4 |
535 | .IP "\(bu" 4 |
488 | .IX Item "pubkey/nodename" |
536 | .IX Xref "pubkey nodename" |
489 | The public keys of the other nodes, one file per node. |
537 | The public keys of the other nodes, one file per node. |
490 | .SH "SEE ALSO" |
538 | .SH "SEE ALSO" |
491 | .IX Header "SEE ALSO" |
539 | .IX Header "SEE ALSO" |
492 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
540 | \&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). |
493 | .SH "AUTHOR" |
541 | .SH "AUTHOR" |