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