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