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