Remove text saying you must have one of PrivateKey or PrivateKeyFile in tinc.conf.
[oweals/tinc.git] / doc / tinc.conf.5.in
1 .Dd 2010-01-16
2 .Dt TINC.CONF 5
3 .\" Manual page created by:
4 .\" Ivo Timmermans
5 .\" Guus Sliepen <guus@tinc-vpn.org>
6 .Sh NAME
7 .Nm tinc.conf
8 .Nd tinc daemon configuration
9 .Sh DESCRIPTION
10 The files in the
11 .Pa @sysconfdir@/tinc/
12 directory contain runtime and security information for the tinc daemon.
13 .Sh NETWORKS
14 It is perfectly ok for you to run more than one tinc daemon.
15 However, in its default form,
16 you will soon notice that you can't use two different configuration files without the
17 .Fl c
18 option.
19 .Pp
20 We have thought of another way of dealing with this: network names.
21 This means that you call
22 .Nm
23 with the
24 .Fl n
25 option, which will assign a name to this daemon.
26 .Pp
27 The effect of this is that the daemon will set its configuration root to
28 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ,
29 where 
30 .Ar NETNAME
31 is your argument to the
32 .Fl n
33 option.
34 You'll notice that messages appear in syslog as coming from
35 .Nm tincd. Ns Ar NETNAME .
36 .Pp
37 However, it is not strictly necessary that you call tinc with the
38 .Fl n
39 option.
40 In this case, the network name would just be empty,
41 and it will be used as such.
42 .Nm tinc
43 now looks for files in
44 .Pa @sysconfdir@/tinc/ ,
45 instead of 
46 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ;
47 the configuration file should be
48 .Pa @sysconfdir@/tinc/tinc.conf ,
49 and the host configuration files are now expected to be in
50 .Pa @sysconfdir@/tinc/hosts/ .
51 .Pp
52 But it is highly recommended that you use this feature of
53 .Nm tinc ,
54 because it will be so much clearer whom your daemon talks to.
55 Hence, we will assume that you use it.
56 .Sh NAMES
57 Each tinc daemon should have a name that is unique in the network which it will be part of.
58 The name will be used by other tinc daemons for identification.
59 The name has to be declared in the
60 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
61 file.
62 .Pp
63 To make things easy,
64 choose something that will give unique and easy to remember names to your tinc daemon(s).
65 You could try things like hostnames, owner surnames or location names.
66 .Sh PUBLIC/PRIVATE KEYS
67 You should use 
68 .Ic tincd -K
69 to generate public/private keypairs.
70 It will generate two keys.
71 The private key should be stored in a separate file
72 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv
73 \-\- where 
74 .Ar NETNAME
75 stands for the network (see 
76 .Sx NETWORKS )
77 above.
78 The public key should be stored in the host configuration file
79 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME
80 \-\- where
81 .Va NAME
82 stands for the name of the local tinc daemon (see
83 .Sx NAMES ) .
84 .Sh SERVER CONFIGURATION
85 The server configuration of the daemon is done in the file
86 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf .
87 This file consists of comments (lines started with a
88 .Li # )
89 or assignments in the form of:
90 .Pp
91 .Va Variable Li = Ar Value .
92 .Pp
93 The variable names are case insensitive, and any spaces, tabs,
94 newlines and carriage returns are ignored.
95 Note: it is not required that you put in the 
96 .Li =
97 sign, but doing so improves readability.
98 If you leave it out, remember to replace it with at least one space character.
99 .Pp
100 The server configuration is complemented with host specific configuration (see the next section).
101 Although all configuration options for the local host listed in this document can also be put in
102 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf ,
103 it is recommended to put host specific configuration options in the host configuration file,
104 as this makes it easy to exchange with other nodes.
105 .Pp
106 Here are all valid variables, listed in alphabetical order.
107 The default value is given between parentheses.
108 .Bl -tag -width indent
109 .It Va AddressFamily Li = ipv4 | ipv6 | any Pq any
110 This option affects the address family of listening and outgoing sockets.
111 If
112 .Qq any
113 is selected, then depending on the operating system both IPv4 and IPv6 or just
114 IPv6 listening sockets will be created.
115 .It Va BindToAddress Li = Ar address Oo Ar port Oc Bq experimental
116 If your computer has more than one IPv4 or IPv6 address,
117 .Nm tinc
118 will by default listen on all of them for incoming connections.
119 Multiple
120 .Va BindToAddress
121 variables may be specified,
122 in which case listening sockets for each specified address are made.
123 .Pp
124 If no
125 .Ar port
126 is specified, the socket will be bound to the port specified by the
127 .Va Port
128 option, or to port 655 if neither is given.
129 To only bind to a specific port but not to a specific address, use
130 .Li *
131 for the
132 .Ar address .
133 .Pp
134 This option may not work on all platforms.
135 .It Va BindToInterface Li = Ar interface Bq experimental
136 If your computer has more than one network interface,
137 .Nm tinc
138 will by default listen on all of them for incoming connections.
139 It is possible to bind only to a single interface with this variable.
140 .Pp
141 This option may not work on all platforms.
142 Also, on some platforms it will not actually bind to an interface,
143 but rather to the address that the interface has at the moment a socket is created.
144 .It Va Broadcast Li = no | mst | direct Po mst Pc Bq experimental
145 This option selects the way broadcast packets are sent to other daemons.
146 NOTE: all nodes in a VPN must use the same
147 .Va Broadcast
148 mode, otherwise routing loops can form.
149 .Bl -tag -width indent
150 .It no
151 Broadcast packets are never sent to other nodes.
152 .It mst
153 Broadcast packets are sent and forwarded via the VPN's Minimum Spanning Tree.
154 This ensures broadcast packets reach all nodes.
155 .It direct
156 Broadcast packets are sent directly to all nodes that can be reached directly.
157 Broadcast packets received from other nodes are never forwarded.
158 If the IndirectData option is also set, broadcast packets will only be sent to nodes which we have a meta connection to.
159 .El
160 .It Va ConnectTo Li = Ar name
161 Specifies which other tinc daemon to connect to on startup.
162 Multiple
163 .Va ConnectTo
164 variables may be specified,
165 in which case outgoing connections to each specified tinc daemon are made.
166 The names should be known to this tinc daemon
167 (i.e., there should be a host configuration file for the name on the
168 .Va ConnectTo
169 line).
170 .Pp
171 If you don't specify a host with
172 .Va ConnectTo ,
173 .Nm tinc
174 won't try to connect to other daemons at all,
175 and will instead just listen for incoming connections.
176 .It Va DecrementTTL Li = yes | no Po no Pc Bq experimental
177 When enabled,
178 .Nm tinc
179 will decrement the Time To Live field in IPv4 packets, or the Hop Limit field in IPv6 packets,
180 before forwarding a received packet to the virtual network device or to another node,
181 and will drop packets that have a TTL value of zero,
182 in which case it will send an ICMP Time Exceeded packet back.
183 .Pp
184 Do not use this option if you use switch mode and want to use IPv6.
185 .It Va Device Li = Ar device Po Pa /dev/tap0 , Pa /dev/net/tun No or other depending on platform Pc
186 The virtual network device to use.
187 .Nm tinc
188 will automatically detect what kind of device it is.
189 Note that you can only use one device per daemon.
190 Under Windows, use
191 .Va Interface
192 instead of
193 .Va Device .
194 The info pages of the tinc package contain more information
195 about configuring the virtual network device.
196 .It Va DeviceType Li = Ar type Pq platform dependent
197 The type of the virtual network device.
198 Tinc will normally automatically select the right type of tun/tap interface, and this option should not be used.
199 However, this option can be used to select one of the special interface types, if support for them is compiled in.
200 .Bl -tag -width indent
201 .It dummy
202 Use a dummy interface.
203 No packets are ever read or written to a virtual network device.
204 Useful for testing, or when setting up a node that only forwards packets for other nodes.
205 .It raw_socket
206 Open a raw socket, and bind it to a pre-existing
207 .Va Interface
208 (eth0 by default).
209 All packets are read from this interface.
210 Packets received for the local node are written to the raw socket.
211 However, at least on Linux, the operating system does not process IP packets destined for the local host.
212 .It multicast
213 Open a multicast UDP socket and bind it to the address and port (separated by spaces) and optionally a TTL value specified using
214 .Va Device .
215 Packets are read from and written to this multicast socket.
216 This can be used to connect to UML, QEMU or KVM instances listening on the same multicast address.
217 Do NOT connect multiple
218 .Nm tinc 
219 daemons to the same multicast address, this will very likely cause routing loops.
220 Also note that this can cause decrypted VPN packets to be sent out on a real network if misconfigured.
221 .It uml Pq not compiled in by default
222 Create a UNIX socket with the filename specified by
223 .Va Device ,
224 or
225 .Pa @localstatedir@/run/ Ns Ar NETNAME Ns Pa .umlsocket
226 if not specified.
227 .Nm tinc
228 will wait for a User Mode Linux instance to connect to this socket.
229 .It vde Pq not compiled in by default
230 Uses the libvdeplug library to connect to a Virtual Distributed Ethernet switch,
231 using the UNIX socket specified by
232 .Va Device ,
233 or
234 .Pa @localstatedir@/run/vde.ctl
235 if not specified.
236 .El
237 Also, in case tinc does not seem to correctly interpret packets received from the virtual network device,
238 it can be used to change the way packets are interpreted:
239 .Bl -tag -width indent
240 .It tun Pq BSD and Linux
241 Set type to tun.
242 Depending on the platform, this can either be with or without an address family header (see below).
243 .It tunnohead Pq BSD
244 Set type to tun without an address family header.
245 Tinc will expect packets read from the virtual network device to start with an IP header.
246 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
247 .It tunifhead Pq BSD
248 Set type to tun with an address family header.
249 Tinc will expect packets read from the virtual network device
250 to start with a four byte header containing the address family,
251 followed by an IP header.
252 This mode should support both IPv4 and IPv6 packets.
253 .It tap Pq BSD and Linux
254 Set type to tap.
255 Tinc will expect packets read from the virtual network device
256 to start with an Ethernet header.
257 .El
258 .It Va DirectOnly Li = yes | no Po no Pc Bq experimental
259 When this option is enabled, packets that cannot be sent directly to the destination node,
260 but which would have to be forwarded by an intermediate node, are dropped instead.
261 When combined with the IndirectData option,
262 packets for nodes for which we do not have a meta connection with are also dropped.
263 .It Va Forwarding Li = off | internal | kernel Po internal Pc Bq experimental
264 This option selects the way indirect packets are forwarded.
265 .Bl -tag -width indent
266 .It off
267 Incoming packets that are not meant for the local node,
268 but which should be forwarded to another node, are dropped.
269 .It internal
270 Incoming packets that are meant for another node are forwarded by tinc internally.
271 .Pp
272 This is the default mode, and unless you really know you need another forwarding mode, don't change it.
273 .It kernel
274 Incoming packets are always sent to the TUN/TAP device, even if the packets are not for the local node.
275 This is less efficient, but allows the kernel to apply its routing and firewall rules on them,
276 and can also help debugging.
277 .El
278 .It Va GraphDumpFile Li = Ar filename Bq experimental
279 If this option is present,
280 .Nm tinc
281 will dump the current network graph to the file
282 .Ar filename
283 every minute, unless there were no changes to the graph.
284 The file is in a format that can be read by graphviz tools.
285 If
286 .Ar filename
287 starts with a pipe symbol |,
288 then the rest of the filename is interpreted as a shell command
289 that is executed, the graph is then sent to stdin.
290 .It Va Hostnames Li = yes | no Pq no
291 This option selects whether IP addresses (both real and on the VPN) should
292 be resolved. Since DNS lookups are blocking, it might affect tinc's
293 efficiency, even stopping the daemon for a few seconds every time it does
294 a lookup if your DNS server is not responding.
295 .Pp
296 This does not affect resolving hostnames to IP addresses from the
297 host configuration files, but whether hostnames should be resolved while logging.
298 .It Va IffOneQueue Li = yes | no Po no Pc Bq experimental
299 (Linux only) Set IFF_ONE_QUEUE flag on TUN/TAP devices.
300 .It Va Interface Li = Ar interface
301 Defines the name of the interface corresponding to the virtual network device.
302 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
303 Under Windows, this variable is used to select which network interface will be used.
304 If you specified a
305 .Va Device ,
306 this variable is almost always already correctly set.
307 .It Va KeyExpire Li = Ar seconds Pq 3600
308 This option controls the period the encryption keys used to encrypt the data are valid.
309 It is common practice to change keys at regular intervals to make it even harder for crackers,
310 even though it is thought to be nearly impossible to crack a single key.
311 .It Va LocalDiscovery Li = yes | no Po no Pc Bq experimental
312 When enabled,
313 .Nm tinc
314 will try to detect peers that are on the same local network.
315 This will allow direct communication using LAN addresses, even if both peers are behind a NAT
316 and they only ConnectTo a third node outside the NAT,
317 which normally would prevent the peers from learning each other's LAN address.
318 .Pp
319 Currently, local discovery is implemented by sending broadcast packets to the LAN during path MTU discovery.
320 This feature may not work in all possible situations.
321 .It Va MACExpire Li = Ar seconds Pq 600
322 This option controls the amount of time MAC addresses are kept before they are removed.
323 This only has effect when
324 .Va Mode
325 is set to
326 .Qq switch .
327 .It Va MaxTimeout Li = Ar seconds Pq 900
328 This is the maximum delay before trying to reconnect to other tinc daemons.
329 .It Va Mode Li = router | switch | hub Pq router
330 This option selects the way packets are routed to other daemons.
331 .Bl -tag -width indent
332 .It router
333 In this mode
334 .Va Subnet
335 variables in the host configuration files will be used to form a routing table.
336 Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
337 .Pp
338 This is the default mode, and unless you really know you need another mode, don't change it.
339 .It switch
340 In this mode the MAC addresses of the packets on the VPN will be used to
341 dynamically create a routing table just like an Ethernet switch does.
342 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
343 at the cost of frequent broadcast ARP requests and routing table updates.
344 .Pp
345 This mode is primarily useful if you want to bridge Ethernet segments.
346 .It hub
347 This mode is almost the same as the switch mode, but instead
348 every packet will be broadcast to the other daemons
349 while no routing table is managed.
350 .El
351 .It Va Name Li = Ar name Bq required
352 This is the name which identifies this tinc daemon.
353 It must be unique for the virtual private network this daemon will connect to.
354 The Name may only consist of alphanumeric and underscore characters.
355 If 
356 .Va Name
357 starts with a
358 .Li $ ,
359 then the contents of the environment variable that follows will be used.
360 In that case, invalid characters will be converted to underscores.
361 If
362 .Va Name
363 is
364 .Li $HOST ,
365 but no such environment variable exist, the hostname will be read using the gethostnname() system call.
366 .It Va PingInterval Li = Ar seconds Pq 60
367 The number of seconds of inactivity that
368 .Nm tinc
369 will wait before sending a probe to the other end.
370 .It Va PingTimeout Li = Ar seconds Pq 5
371 The number of seconds to wait for a response to pings or to allow meta
372 connections to block. If the other end doesn't respond within this time,
373 the connection is terminated,
374 and the others will be notified of this.
375 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
376 When this option is enabled the value of the TOS field of tunneled IPv4 packets
377 will be inherited by the UDP packets that are sent out.
378 .It Va PrivateKey Li = Ar key Bq obsolete
379 The private RSA key of this tinc daemon.
380 It will allow this tinc daemon to authenticate itself to other daemons.
381 .It Va PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv Pc
382 The file in which the private RSA key of this tinc daemon resides.
383 .It Va ProcessPriority Li = low | normal | high
384 When this option is used the priority of the tincd process will be adjusted.
385 Increasing the priority may help to reduce latency and packet loss on the VPN.
386 .It Va Proxy Li = socks4 | socks5 | http | exec Ar ... Bq experimental
387 Use a proxy when making outgoing connections.
388 The following proxy types are currently supported:
389 .Bl -tag -width indent
390 .It socks4 Ar address Ar port Op Ar username
391 Connects to the proxy using the SOCKS version 4 protocol.
392 Optionally, a
393 .Ar username
394 can be supplied which will be passed on to the proxy server.
395 Only IPv4 connections can be proxied using SOCKS 4.
396 .It socks5 Ar address Ar port Op Ar username Ar password
397 Connect to the proxy using the SOCKS version 5 protocol.
398 If a
399 .Ar username
400 and
401 .Ar password
402 are given, basic username/password authentication will be used,
403 otherwise no authentication will be used.
404 .It http Ar address Ar port
405 Connects to the proxy and sends a HTTP CONNECT request.
406 .It exec Ar command
407 Executes the given
408 .Ar command
409 which should set up the outgoing connection.
410 The environment variables
411 .Ev NAME ,
412 .Ev NODE ,
413 .Ev REMOTEADDRES
414 and
415 .Ev REMOTEPORT
416 are available.
417 .El
418 .It Va ReplayWindow Li = Ar bytes Pq 16
419 vhis is the size of the replay tracking window for each remote node, in bytes.
420 The window is a bitfield which tracks 1 packet per bit, so for example
421 the default setting of 16 will track up to 128 packets in the window.  In high
422 bandwidth scenarios, setting this to a higher value can reduce packet loss from
423 the interaction of replay tracking with underlying real packet loss and/or
424 reordering.  Setting this to zero will disable replay tracking completely and
425 pass all traffic, but leaves tinc vulnerable to replay-based attacks on your
426 traffic.
427 .It Va StrictSubnets Li = yes | no Po no Pc Bq experimental
428 When this option is enabled tinc will only use Subnet statements which are
429 present in the host config files in the local
430 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
431 directory.
432 .It Va TunnelServer Li = yes | no Po no Pc Bq experimental
433 When this option is enabled tinc will no longer forward information between other tinc daemons,
434 and will only allow connections with nodes for which host config files are present in the local
435 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
436 directory.
437 Setting this options also implicitly sets StrictSubnets.
438 .It Va UDPRcvBuf Li = Ar bytes Pq OS default
439 Sets the socket receive buffer size for the UDP socket, in bytes.
440 If unset, the default buffer size will be used by the operating system.
441 .It Va UDPSndBuf Li = Ar bytes Pq OS default
442 Sets the socket send buffer size for the UDP socket, in bytes.
443 If unset, the default buffer size will be used by the operating system.
444 .El
445 .Sh HOST CONFIGURATION FILES
446 The host configuration files contain all information needed
447 to establish a connection to those hosts.
448 A host configuration file is also required for the local tinc daemon,
449 it will use it to read in it's listen port, public key and subnets.
450 .Pp
451 The idea is that these files are portable.
452 You can safely mail your own host configuration file to someone else.
453 That other person can then copy it to his own hosts directory,
454 and now his tinc daemon will be able to connect to your tinc daemon.
455 Since host configuration files only contain public keys,
456 no secrets are revealed by sending out this information.
457 .Bl -tag -width indent
458 .It Va Address Li = Ar address Oo Ar port Oc Bq recommended
459 The IP address or hostname of this tinc daemon on the real network.
460 This will only be used when trying to make an outgoing connection to this tinc daemon.
461 Optionally, a port can be specified to use for this address.
462 Multiple
463 .Va Address
464 variables can be specified, in which case each address will be tried until a working
465 connection has been established.
466 .It Va Cipher Li = Ar cipher Pq blowfish
467 The symmetric cipher algorithm used to encrypt UDP packets.
468 Any cipher supported by OpenSSL is recognised.
469 Furthermore, specifying
470 .Qq none
471 will turn off packet encryption.
472 It is best to use only those ciphers which support CBC mode.
473 .It Va ClampMSS Li = yes | no Pq yes
474 This option specifies whether tinc should clamp the maximum segment size (MSS)
475 of TCP packets to the path MTU. This helps in situations where ICMP
476 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
477 .It Va Compression Li = Ar level Pq 0
478 This option sets the level of compression used for UDP packets.
479 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
480 10 (fast lzo) and 11 (best lzo).
481 .It Va Digest Li = Ar digest Pq sha1
482 The digest algorithm used to authenticate UDP packets.
483 Any digest supported by OpenSSL is recognised.
484 Furthermore, specifying
485 .Qq none
486 will turn off packet authentication.
487 .It Va IndirectData Li = yes | no Pq no
488 This option specifies whether other tinc daemons besides the one you specified with
489 .Va ConnectTo
490 can make a direct connection to you.
491 This is especially useful if you are behind a firewall
492 and it is impossible to make a connection from the outside to your tinc daemon.
493 Otherwise, it is best to leave this option out or set it to no.
494 .It Va MACLength Li = Ar length Pq 4
495 The length of the message authentication code used to authenticate UDP packets.
496 Can be anything from
497 .Qq 0
498 up to the length of the digest produced by the digest algorithm.
499 .It Va PMTU Li = Ar mtu Po 1514 Pc
500 This option controls the initial path MTU to this node.
501 .It Va PMTUDiscovery Li = yes | no Po yes Pc
502 When this option is enabled, tinc will try to discover the path MTU to this node.
503 After the path MTU has been discovered, it will be enforced on the VPN.
504 .It Va Port Li = Ar port Pq 655
505 The port number on which this tinc daemon is listening for incoming connections,
506 which is used if no port number is specified in an
507 .Va Address
508 statement.
509 .It Va PublicKey Li = Ar key Bq obsolete
510 The public RSA key of this tinc daemon.
511 It will be used to cryptographically verify it's identity and to set up a secure connection.
512 .It Va PublicKeyFile Li = Ar filename Bq obsolete
513 The file in which the public RSA key of this tinc daemon resides.
514 .Pp
515 From version 1.0pre4 on
516 .Nm tinc
517 will store the public key directly into the host configuration file in PEM format,
518 the above two options then are not necessary.
519 Either the PEM format is used, or exactly one of the above two options must be specified
520 in each host configuration file,
521 if you want to be able to establish a connection with that host.
522 .It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength Ns Op Li # Ns Ar weight
523 The subnet which this tinc daemon will serve.
524 .Nm tinc
525 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
526 If the packet matches a subnet,
527 it will be sent to the daemon who has this subnet in his host configuration file.
528 Multiple
529 .Va Subnet
530 variables can be specified.
531 .Pp
532 Subnets can either be single MAC, IPv4 or IPv6 addresses,
533 in which case a subnet consisting of only that single address is assumed,
534 or they can be a IPv4 or IPv6 network address with a prefixlength.
535 For example, IPv4 subnets must be in a form like 192.168.1.0/24,
536 where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask.
537 Note that subnets like 192.168.1.1/24 are invalid!
538 Read a networking HOWTO/FAQ/guide if you don't understand this.
539 IPv6 subnets are notated like fec0:0:0:1::/64.
540 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
541 .Pp
542 A Subnet can be given a weight to indicate its priority over identical Subnets
543 owned by different nodes.  The default weight is 10. Lower values indicate
544 higher priority. Packets will be sent to the node with the highest priority,
545 unless that node is not reachable, in which case the node with the next highest
546 priority will be tried, and so on.
547 .It Va TCPOnly Li = yes | no Pq no Bq obsolete
548 If this variable is set to yes,
549 then the packets are tunnelled over the TCP connection instead of a UDP connection.
550 This is especially useful for those who want to run a tinc daemon
551 from behind a masquerading firewall,
552 or if UDP packet routing is disabled somehow.
553 Setting this options also implicitly sets IndirectData.
554 .Pp
555 Since version 1.0.10, tinc will automatically detect whether communication via
556 UDP is possible or not.
557 .El
558 .Sh SCRIPTS
559 Apart from reading the server and host configuration files,
560 tinc can also run scripts at certain moments.
561 Under Windows (not Cygwin), the scripts should have the extension
562 .Pa .bat .
563 .Bl -tag -width indent
564 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
565 This is the most important script.
566 If it is present it will be executed right after the tinc daemon has been started and has connected to the virtual network device.
567 It should be used to set up the corresponding network interface,
568 but can also be used to start other things.
569 Under Windows you can use the Network Connections control panel instead of creating this script.
570 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
571 This script is started right before the tinc daemon quits.
572 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -up
573 This script is started when the tinc daemon with name
574 .Ar HOST
575 becomes reachable.
576 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -down
577 This script is started when the tinc daemon with name
578 .Ar HOST
579 becomes unreachable.
580 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up
581 This script is started when any host becomes reachable.
582 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down
583 This script is started when any host becomes unreachable.
584 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up
585 This script is started when a Subnet becomes reachable.
586 The Subnet and the node it belongs to are passed in environment variables.
587 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down
588 This script is started when a Subnet becomes unreachable.
589 .El
590 .Pp
591 The scripts are started without command line arguments, but can make use of certain environment variables.
592 Under UNIX like operating systems the names of environment variables must be preceded by a
593 .Li $ 
594 in scripts.
595 Under Windows, in
596 .Pa .bat
597 files, they have to be put between
598 .Li %
599 signs.
600 .Bl -tag -width indent
601 .It Ev NETNAME
602 If a netname was specified, this environment variable contains it.
603 .It Ev NAME
604 Contains the name of this tinc daemon.
605 .It Ev DEVICE
606 Contains the name of the virtual network device that tinc uses.
607 .It Ev INTERFACE
608 Contains the name of the virtual network interface that tinc uses.
609 This should be used for commands like
610 .Pa ifconfig .
611 .It Ev NODE
612 When a host becomes (un)reachable, this is set to its name.
613 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
614 .It Ev REMOTEADDRESS
615 When a host becomes (un)reachable, this is set to its real address.
616 .It Ev REMOTEPORT
617 When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons.
618 .It Ev SUBNET
619 When a subnet becomes (un)reachable, this is set to the subnet.
620 .It Ev WEIGHT
621 When a subnet becomes (un)reachable, this is set to the subnet weight.
622 .El
623 .Pp
624 Do not forget that under UNIX operating systems, you have to make the scripts executable, using the command
625 .Nm chmod Li a+x Pa script .
626 .Sh FILES
627 The most important files are:
628 .Bl -tag -width indent
629 .It Pa @sysconfdir@/tinc/
630 The top directory for configuration files.
631 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
632 The default name of the server configuration file for net
633 .Ar NETNAME .
634 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
635 Host configuration files are kept in this directory.
636 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
637 If an executable file with this name exists,
638 it will be executed right after the tinc daemon has connected to the virtual network device.
639 It can be used to set up the corresponding network interface.
640 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
641 If an executable file with this name exists,
642 it will be executed right before the tinc daemon is going to close
643 its connection to the virtual network device.
644 .El
645 .Sh SEE ALSO
646 .Xr tincd 8 ,
647 .Pa http://www.tinc-vpn.org/ ,
648 .Pa http://www.tldp.org/LDP/nag2/ .
649 .Pp
650 The full documentation for
651 .Nm tinc
652 is maintained as a Texinfo manual.
653 If the info and tinc programs are properly installed at your site, the command
654 .Ic info tinc
655 should give you access to the complete manual.
656 .Pp
657 .Nm tinc
658 comes with ABSOLUTELY NO WARRANTY.
659 This is free software, and you are welcome to redistribute it under certain conditions;
660 see the file COPYING for details.