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