Try harder to connect to unreachable nodes.
[tinc] / doc /
1 .Dd 2017-09-02
3 .\" Manual page created by:
4 .\" Ivo Timmermans
5 .\" Guus Sliepen <>
6 .Sh NAME
7 .Nm tinc.conf
8 .Nd tinc daemon configuration
10 The files in the
11 .Pa @sysconfdir@/tinc/
12 directory contain runtime and security information for the tinc daemon.
14 To distinguish multiple instances of tinc running on one computer,
15 you can use the
16 .Fl n
17 option to assign a network name to each tinc daemon.
18 .Pp
19 The effect of this option is that the daemon will set its configuration root to
20 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ,
21 where 
23 is your argument to the
24 .Fl n
25 option.
26 You'll notice that messages appear in syslog as coming from
27 .Nm tincd. Ns Ar NETNAME ,
28 and on Linux, unless specified otherwise, the name of the virtual network interface will be the same as the network name.
29 .Pp
30 It is recommended that you use network names even if you run only one instance of tinc.
31 However, you can choose not to use the
32 .Fl n
33 option.
34 In this case, the network name would just be empty, and
35 .Nm tinc
36 now looks for files in
37 .Pa @sysconfdir@/tinc/ ,
38 instead of 
39 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ;
40 the configuration file should be
41 .Pa @sysconfdir@/tinc/tinc.conf ,
42 and the host configuration files are now expected to be in
43 .Pa @sysconfdir@/tinc/hosts/ .
44 .Sh NAMES
45 Each tinc daemon must have a name that is unique in the network which it will be part of.
46 The name will be used by other tinc daemons for identification.
47 The name has to be declared in the
48 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
49 file.
50 .Pp
51 To make things easy,
52 choose something that will give unique and easy to remember names to your tinc daemon(s).
53 You could try things like hostnames, owner surnames or location names.
54 However, you are only allowed to use alphanumerical characters (a-z, A-Z, and 0-9) and underscores (_) in the name.
56 If you have not configured tinc yet, you can easily create a basic configuration using the following command:
57 .Bd -literal -offset indent
58 .Nm tinc Fl n Ar NETNAME Li init Ar NAME
59 .Ed
60 .Pp
61 You can further change the configuration as needed either by manually editing the configuration files,
62 or by using
63 .Xr tinc 8 .
65 The
66 .Nm tinc Li init
67 command will have generated both RSA and Ed25519 public/private keypairs.
68 The private keys should be stored in files named
69 .Pa rsa_key.priv
70 and
71 .Pa ed25519_key.priv
72 in the directory
73 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /
74 The public keys should be stored in the host configuration file
75 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME .
76 The RSA keys are used for backwards compatibility with tinc version 1.0.
77 If you are upgrading from version 1.0 to 1.1, you can keep the old configuration files,
78 but you will need to create Ed25519 keys using the following command:
79 .Bd -literal -offset indent
80 .Nm tinc Fl n Ar NETNAME Li generate-ed25519-keys
81 .Ed
83 The server configuration of the daemon is done in the file
84 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf .
85 This file consists of comments (lines started with a
86 .Li # )
87 or assignments in the form of:
88 .Pp
89 .Va Variable Li = Ar Value .
90 .Pp
91 The variable names are case insensitive, and any spaces, tabs,
92 newlines and carriage returns are ignored.
93 Note: it is not required that you put in the 
94 .Li =
95 sign, but doing so improves readability.
96 If you leave it out, remember to replace it with at least one space character.
97 .Pp
98 The server configuration is complemented with host specific configuration (see the next section).
99 Although all configuration options for the local host listed in this document can also be put in
100 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf ,
101 it is recommended to put host specific configuration options in the host configuration file,
102 as this makes it easy to exchange with other nodes.
103 .Pp
104 You can edit the config file manually, but it is recommended that you use
105 .Xr tinc 8
106 to change configuration variables for you.
107 .Pp
108 Here are all valid variables, listed in alphabetical order.
109 The default value is given between parentheses.
110 .Bl -tag -width indent
111 .It Va AddressFamily Li = ipv4 | ipv6 | any Pq any
112 This option affects the address family of listening and outgoing sockets.
113 If
114 .Qq any
115 is selected, then depending on the operating system both IPv4 and IPv6 or just
116 IPv6 listening sockets will be created.
117 .It Va AutoConnect Li = yes | no Pq yes
118 If set to yes,
119 .Nm tinc
120 will automatically set up meta connections to other nodes,
121 without requiring
122 .Va ConnectTo
123 variables.
124 .Pp
125 Note: it is not possible to connect to nodes using zero (system-assigned) ports in this way.
126 .It Va BindToAddress Li = Ar address Op Ar port
127 This is the same as
128 .Va ListenAddress ,
129 however the address given with the
130 .Va BindToAddress
131 option will also be used for outgoing connections. This is useful if your
132 computer has more than one IPv4 or IPv6 address, and you want 
133 .Nm tinc
134 to only use a specific one for outgoing packets.
135 .It Va BindToInterface Li = Ar interface Bq experimental
136 If your computer has more than one network interface,
137 .Nm tinc
138 will by default listen on all of them for incoming connections.
139 It is possible to bind only to a single interface with this variable.
140 .Pp
141 This option may not work on all platforms.
142 Also, on some platforms it will not actually bind to an interface,
143 but rather to the address that the interface has at the moment a socket is created.
144 .It Va Broadcast Li = no | mst | direct Po mst Pc Bq experimental
145 This option selects the way broadcast packets are sent to other daemons.
146 NOTE: all nodes in a VPN must use the same
147 .Va Broadcast
148 mode, otherwise routing loops can form.
149 .Bl -tag -width indent
150 .It no
151 Broadcast packets are never sent to other nodes.
152 .It mst
153 Broadcast packets are sent and forwarded via the VPN's Minimum Spanning Tree.
154 This ensures broadcast packets reach all nodes.
155 .It direct
156 Broadcast packets are sent directly to all nodes that can be reached directly.
157 Broadcast packets received from other nodes are never forwarded.
158 If the IndirectData option is also set, broadcast packets will only be sent to nodes which we have a meta connection to.
159 .El
160 .It Va BroadcastSubnet Li = Ar address Ns Op Li / Ns Ar prefixlength
161 Declares a broadcast subnet. Any packet with a destination address falling into such a subnet will be routed as a broadcast (provided all nodes have it declared).
162 This is most useful to declare subnet broadcast addresses (e.g., otherwise
163 .Nm tinc
164 won't know what to do with them.
165 .Pp
166 Note that global broadcast addresses (MAC ff:ff:ff:ff:ff:ff, IPv4, as well as multicast space (IPv4, IPv6 ff00::/8) are always considered broadcast addresses and don't need to be declared.
167 .It Va ConnectTo Li = Ar name
168 Specifies which other tinc daemon to connect to on startup.
169 Multiple
170 .Va ConnectTo
171 variables may be specified,
172 in which case outgoing connections to each specified tinc daemon are made.
173 The names should be known to this tinc daemon
174 (i.e., there should be a host configuration file for the name on the
175 .Va ConnectTo
176 line).
177 .Pp
178 If you don't specify a host with
179 .Va ConnectTo
180 and have disabled
181 .Va AutoConnect ,
182 .Nm tinc
183 won't try to connect to other daemons at all,
184 and will instead just listen for incoming connections.
185 .It Va DecrementTTL Li = yes | no Po no Pc Bq experimental
186 When enabled,
187 .Nm tinc
188 will decrement the Time To Live field in IPv4 packets, or the Hop Limit field in IPv6 packets,
189 before forwarding a received packet to the virtual network device or to another node,
190 and will drop packets that have a TTL value of zero,
191 in which case it will send an ICMP Time Exceeded packet back.
192 .Pp
193 Do not use this option if you use switch mode and want to use IPv6.
194 .It Va Device Li = Ar device Po Pa /dev/tap0 , Pa /dev/net/tun No or other depending on platform Pc
195 The virtual network device to use.
196 .Nm tinc
197 will automatically detect what kind of device it is.
198 Note that you can only use one device per daemon.
199 Under Windows, use
200 .Va Interface
201 instead of
202 .Va Device .
203 The info pages of the tinc package contain more information
204 about configuring the virtual network device.
205 .It Va DeviceStandby Li = yes | no Po no Pc
206 When disabled,
207 .Nm tinc
208 calls tinc-up on startup, and tinc-down on shutdown. When enabled,
209 .Nm tinc
210 will only call tinc-up when at least one node is reachable, and will call tinc-down as soon as no nodes are reachable.
211 On Windows, this also determines when the virtual network interface "cable" is "plugged".
212 .It Va DeviceType Li = Ar type Pq platform dependent
213 The type of the virtual network device.
214 Tinc will normally automatically select the right type of tun/tap interface, and this option should not be used.
215 However, this option can be used to select one of the special interface types, if support for them is compiled in.
216 .Bl -tag -width indent
217 .It dummy
218 Use a dummy interface.
219 No packets are ever read or written to a virtual network device.
220 Useful for testing, or when setting up a node that only forwards packets for other nodes.
221 .It raw_socket
222 Open a raw socket, and bind it to a pre-existing
223 .Va Interface
224 (eth0 by default).
225 All packets are read from this interface.
226 Packets received for the local node are written to the raw socket.
227 However, at least on Linux, the operating system does not process IP packets destined for the local host.
228 .It multicast
229 Open a multicast UDP socket and bind it to the address and port (separated by spaces) and optionally a TTL value specified using
230 .Va Device .
231 Packets are read from and written to this multicast socket.
232 This can be used to connect to UML, QEMU or KVM instances listening on the same multicast address.
233 Do NOT connect multiple
234 .Nm tinc 
235 daemons to the same multicast address, this will very likely cause routing loops.
236 Also note that this can cause decrypted VPN packets to be sent out on a real network if misconfigured.
237 .It fd
238 Use a file descriptor.
239 All packets are read from this interface.
240 Packets received for the local node are written to it.
241 .It uml Pq not compiled in by default
242 Create a UNIX socket with the filename specified by
243 .Va Device ,
244 or
245 .Pa @runstatedir@/ Ns Ar NETNAME Ns Pa .umlsocket
246 if not specified.
247 .Nm tinc
248 will wait for a User Mode Linux instance to connect to this socket.
249 .It vde Pq not compiled in by default
250 Uses the libvdeplug library to connect to a Virtual Distributed Ethernet switch,
251 using the UNIX socket specified by
252 .Va Device ,
253 or
254 .Pa @runstatedir@/vde.ctl
255 if not specified.
256 .El
257 Also, in case tinc does not seem to correctly interpret packets received from the virtual network device,
258 it can be used to change the way packets are interpreted:
259 .Bl -tag -width indent
260 .It tun Pq BSD and Linux
261 Set type to tun.
262 Depending on the platform, this can either be with or without an address family header (see below).
263 .It tunnohead Pq BSD
264 Set type to tun without an address family header.
265 Tinc will expect packets read from the virtual network device to start with an IP header.
266 On some platforms IPv6 packets cannot be read from or written to the device in this mode.
267 .It tunifhead Pq BSD
268 Set type to tun with an address family header.
269 Tinc will expect packets read from the virtual network device
270 to start with a four byte header containing the address family,
271 followed by an IP header.
272 This mode should support both IPv4 and IPv6 packets.
273 .It utun Pq OS X
274 Set type to utun.
275 This is only supported on OS X version 10.6.8 and higher, but doesn't require the tuntaposx module.
276 This mode should support both IPv4 and IPv6 packets.
277 .It tap Pq BSD and Linux
278 Set type to tap.
279 Tinc will expect packets read from the virtual network device
280 to start with an Ethernet header.
281 .El
282 .It Va DirectOnly Li = yes | no Po no Pc Bq experimental
283 When this option is enabled, packets that cannot be sent directly to the destination node,
284 but which would have to be forwarded by an intermediate node, are dropped instead.
285 When combined with the IndirectData option,
286 packets for nodes for which we do not have a meta connection with are also dropped.
287 .It Va Ed25519PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /ed25519_key.priv Pc
288 The file in which the private Ed25519 key of this tinc daemon resides.
289 This is only used if
290 .Va ExperimentalProtocol
291 is enabled.
292 .It Va ExperimentalProtocol Li = yes | no Pq yes
293 When this option is enabled, the SPTPS protocol will be used when connecting to nodes that also support it.
294 Ephemeral ECDH will be used for key exchanges,
295 and Ed25519 will be used instead of RSA for authentication.
296 When enabled, an Ed25519 key must have been generated before with
297 .Nm tinc generate-ed25519-keys .
298 .It Va Forwarding Li = off | internal | kernel Po internal Pc Bq experimental
299 This option selects the way indirect packets are forwarded.
300 .Bl -tag -width indent
301 .It off
302 Incoming packets that are not meant for the local node,
303 but which should be forwarded to another node, are dropped.
304 .It internal
305 Incoming packets that are meant for another node are forwarded by tinc internally.
306 .Pp
307 This is the default mode, and unless you really know you need another forwarding mode, don't change it.
308 .It kernel
309 Incoming packets using the legacy protocol are always sent to the TUN/TAP device,
310 even if the packets are not for the local node.
311 This is less efficient, but allows the kernel to apply its routing and firewall rules on them,
312 and can also help debugging.
313 Incoming packets using the SPTPS protocol are dropped, since they are end-to-end encrypted.
314 .El
315 .It Va FWMark Li = Ar value Po 0 Pc Bq experimental
316 When set to a non-zero value, all TCP and UDP sockets created by tinc will use the given value as the firewall mark.
317 This can be used for mark-based routing or for packet filtering.
318 This option is currently only supported on Linux.
319 .It Va Hostnames Li = yes | no Pq no
320 This option selects whether IP addresses (both real and on the VPN) should
321 be resolved. Since DNS lookups are blocking, it might affect tinc's
322 efficiency, even stopping the daemon for a few seconds every time it does
323 a lookup if your DNS server is not responding.
324 .Pp
325 This does not affect resolving hostnames to IP addresses from the
326 host configuration files, but whether hostnames should be resolved while logging.
327 .It Va IffOneQueue Li = yes | no Po no Pc Bq experimental
328 (Linux only) Set IFF_ONE_QUEUE flag on TUN/TAP devices.
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 .It Va InvitationExpire Li = Ar seconds Pq 604800
337 This option controls the period invitations are valid.
338 .It Va KeyExpire Li = Ar seconds Pq 3600
339 This option controls the period the encryption keys used to encrypt the data are valid.
340 It is common practice to change keys at regular intervals to make it even harder for crackers,
341 even though it is thought to be nearly impossible to crack a single key.
342 .It Va ListenAddress Li = Ar address Op Ar port
343 If your computer has more than one IPv4 or IPv6 address,
344 .Nm tinc
345 will by default listen on all of them for incoming connections.
346 This option can be used to restrict which addresses tinc listens on.
347 Multiple
348 .Va ListenAddress
349 variables may be specified,
350 in which case listening sockets for each specified address are made.
351 .Pp
352 If no
353 .Ar port
354 is specified, the socket will listen on the port specified by the
355 .Va Port
356 option, or to port 655 if neither is given.
357 To only listen on a specific port but not on a specific address, use
358 .Li *
359 for the
360 .Ar address .
361 .Pp
362 If
363 .Ar port
364 is set to zero, it will be randomly assigned by the system. This is useful to randomize source ports of UDP packets, which can improve UDP hole punching reliability. In this case it is recommended to set
365 .Va AddressFamily
366 as well, otherwise
367 .Nm tinc
368 will assign different ports to different address families but other nodes can only know of one.
369 .It Va LocalDiscovery Li = yes | no Pq yes
370 When enabled,
371 .Nm tinc
372 will try to detect peers that are on the same local network.
373 This will allow direct communication using LAN addresses, even if both peers are behind a NAT
374 and they only ConnectTo a third node outside the NAT,
375 which normally would prevent the peers from learning each other's LAN address.
376 .Pp
377 Currently, local discovery is implemented by sending some packets to the local address of the node during UDP discovery. This will not work with old nodes that don't transmit their local address.
378 .It Va LogLevel Li = level Pq 0
379 This option controls the verbosity of the logging. The higher the debug level, the more messages it will log.
380 .It Va MACExpire Li = Ar seconds Pq 600
381 This option controls the amount of time MAC addresses are kept before they are removed.
382 This only has effect when
383 .Va Mode
384 is set to
385 .Qq switch .
386 .It Va MaxConnectionBurst Li = Ar count Pq 100
387 This option controls how many connections tinc accepts in quick succession.
388 If there are more connections than the given number in a short time interval,
389 tinc will reduce the number of accepted connections to only one per second,
390 until the burst has passed.
391 .It Va MaxTimeout Li = Ar seconds Pq 900
392 This is the maximum delay before trying to reconnect to other tinc daemons.
393 .It Va Mode Li = router | switch | hub Pq router
394 This option selects the way packets are routed to other daemons.
395 .Bl -tag -width indent
396 .It router
397 In this mode
398 .Va Subnet
399 variables in the host configuration files will be used to form a routing table.
400 Only packets of routable protocols (IPv4 and IPv6) are supported in this mode.
401 .Pp
402 This is the default mode, and unless you really know you need another mode, don't change it.
403 .It switch
404 In this mode the MAC addresses of the packets on the VPN will be used to
405 dynamically create a routing table just like an Ethernet switch does.
406 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
407 at the cost of frequent broadcast ARP requests and routing table updates.
408 .Pp
409 This mode is primarily useful if you want to bridge Ethernet segments.
410 .It hub
411 This mode is almost the same as the switch mode, but instead
412 every packet will be broadcast to the other daemons
413 while no routing table is managed.
414 .El
415 .It Va Name Li = Ar name Bq required
416 This is the name which identifies this tinc daemon.
417 It must be unique for the virtual private network this daemon will connect to.
418 .Va Name
419 may only consist of alphanumeric and underscore characters (a-z, A-Z, 0-9 and _), and is case sensitive.
420 If 
421 .Va Name
422 starts with a
423 .Li $ ,
424 then the contents of the environment variable that follows will be used.
425 In that case, invalid characters will be converted to underscores.
426 If
427 .Va Name
428 is
429 .Li $HOST ,
430 but no such environment variable exist, the hostname will be read using the gethostname() system call.
431 .It Va PingInterval Li = Ar seconds Pq 60
432 The number of seconds of inactivity that
433 .Nm tinc
434 will wait before sending a probe to the other end.
435 .It Va PingTimeout Li = Ar seconds Pq 5
436 The number of seconds to wait for a response to pings or to allow meta
437 connections to block. If the other end doesn't respond within this time,
438 the connection is terminated,
439 and the others will be notified of this.
440 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
441 When this option is enabled the value of the TOS field of tunneled IPv4 packets
442 will be inherited by the UDP packets that are sent out.
443 .It Va PrivateKey Li = Ar key Bq obsolete
444 The private RSA key of this tinc daemon.
445 It will allow this tinc daemon to authenticate itself to other daemons.
446 .It Va PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv Pc
447 The file in which the private RSA key of this tinc daemon resides.
448 .It Va ProcessPriority Li = low | normal | high
449 When this option is used the priority of the 
450 .Nm tincd
451 process will be adjusted.
452 Increasing the priority may help to reduce latency and packet loss on the VPN.
453 .It Va Proxy Li = socks4 | socks5 | http | exec Ar ... Bq experimental
454 Use a proxy when making outgoing connections.
455 The following proxy types are currently supported:
456 .Bl -tag -width indent
457 .It socks4 Ar address Ar port Op Ar username
458 Connects to the proxy using the SOCKS version 4 protocol.
459 Optionally, a
460 .Ar username
461 can be supplied which will be passed on to the proxy server.
462 Only IPv4 connections can be proxied using SOCKS 4.
463 .It socks5 Ar address Ar port Op Ar username Ar password
464 Connect to the proxy using the SOCKS version 5 protocol.
465 If a
466 .Ar username
467 and
468 .Ar password
469 are given, basic username/password authentication will be used,
470 otherwise no authentication will be used.
471 .It http Ar address Ar port
472 Connects to the proxy and sends a HTTP CONNECT request.
473 .It exec Ar command
474 Executes the given
475 .Ar command
476 which should set up the outgoing connection.
477 The environment variables
478 .Ev NAME ,
479 .Ev NODE ,
481 and
483 are available.
484 .El
485 .It Va ReplayWindow Li = Ar bytes Pq 32
486 This is the size of the replay tracking window for each remote node, in bytes.
487 The window is a bitfield which tracks 1 packet per bit, so for example
488 the default setting of 32 will track up to 256 packets in the window. In high
489 bandwidth scenarios, setting this to a higher value can reduce packet loss from
490 the interaction of replay tracking with underlying real packet loss and/or
491 reordering. Setting this to zero will disable replay tracking completely and
492 pass all traffic, but leaves tinc vulnerable to replay-based attacks on your
493 traffic.
494 .It Va StrictSubnets Li = yes | no Po no Pc Bq experimental
495 When this option is enabled tinc will only use Subnet statements which are
496 present in the host config files in the local
497 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
498 directory. Subnets learned via connections to other nodes and which are not
499 present in the local host config files are ignored.
500 .It Va TunnelServer Li = yes | no Po no Pc Bq experimental
501 When this option is enabled tinc will no longer forward information between other tinc daemons,
502 and will only allow connections with nodes for which host config files are present in the local
503 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
504 directory.
505 Setting this options also implicitly sets StrictSubnets.
506 .It Va UDPDiscovery Li = yes | no Po yes Pc
507 When this option is enabled tinc will try to establish UDP connectivity to nodes,
508 using TCP while it determines if a node is reachable over UDP. If it is disabled,
509 tinc always assumes a node is reachable over UDP.
510 Note that tinc will never use UDP with nodes that have
511 .Va TCPOnly
512 enabled.
513 .It Va UDPDiscoveryKeepaliveInterval Li = Ar seconds Pq 9
514 The minimum amount of time between sending UDP ping datagrams to check UDP connectivity once it has been established.
515 Note that these pings are large, since they are used to verify link MTU as well.
516 .It Va UDPDiscoveryInterval Li = Ar seconds Pq 2
517 The minimum amount of time between sending UDP ping datagrams to try to establish UDP connectivity.
518 .It Va UDPDiscoveryTimeout Li = Ar seconds Pq 30
519 If tinc doesn't receive any UDP ping replies over the specified interval,
520 it will assume UDP communication is broken and will fall back to TCP.
521 .It Va UDPInfoInterval Li = Ar seconds Pq 5
522 The minimum amount of time between sending periodic updates about UDP addresses, which are mostly useful for UDP hole punching.
523 .It Va UDPRcvBuf Li = Ar bytes Pq 1048576
524 Sets the socket receive buffer size for the UDP socket, in bytes.
525 If set to zero, the default buffer size will be used by the operating system.
526 Note: this setting can have a significant impact on performance, especially raw throughput.
527 .It Va UDPSndBuf Li = Ar bytes Pq 1048576
528 Sets the socket send buffer size for the UDP socket, in bytes.
529 If set to zero, the default buffer size will be used by the operating system.
530 Note: this setting can have a significant impact on performance, especially raw throughput.
531 .It Va UPnP Li = yes | udponly | no Po no Pc
532 If this option is enabled then tinc will search for UPnP-IGD devices on the local network.
533 It will then create and maintain port mappings for tinc's listening TCP and UDP ports.
534 If set to "udponly", tinc will only create a mapping for its UDP (data) port, not for its TCP (metaconnection) port.
535 Note that tinc must have been built with miniupnpc support for this feature to be available.
536 Furthermore, be advised that enabling this can have security implications, because the miniupnpc library that
537 tinc uses might not be well-hardened with regard to malicious UPnP replies.
538 .It Va UPnPDiscoverWait Li = Ar seconds Pq 5
539 The amount of time to wait for replies when probing the local network for UPnP devices.
540 .It Va UPnPRefreshPeriod Li = Ar seconds Pq 60
541 How often tinc will re-add the port mapping, in case it gets reset on the UPnP device. This also controls the duration of the port mapping itself, which will be set to twice that duration.
542 .El
544 The host configuration files contain all information needed
545 to establish a connection to those hosts.
546 A host configuration file is also required for the local tinc daemon,
547 it will use it to read in it's listen port, public key and subnets.
548 .Pp
549 The idea is that these files are portable.
550 You can safely mail your own host configuration file to someone else.
551 That other person can then copy it to his own hosts directory,
552 and now his tinc daemon will be able to connect to your tinc daemon.
553 Since host configuration files only contain public keys,
554 no secrets are revealed by sending out this information.
555 .Bl -tag -width indent
556 .It Va Address Li = Ar address Oo Ar port Oc Bq recommended
557 The IP address or hostname of this tinc daemon on the real network.
558 This will only be used when trying to make an outgoing connection to this tinc daemon.
559 Optionally, a port can be specified to use for this address.
560 Multiple
561 .Va Address
562 variables can be specified, in which case each address will be tried until a working
563 connection has been established.
564 .It Va Cipher Li = Ar cipher Pq blowfish
565 The symmetric cipher algorithm used to encrypt UDP packets.
566 Any cipher supported by LibreSSL or OpenSSL is recognised.
567 Furthermore, specifying
568 .Qq none
569 will turn off packet encryption.
570 It is best to use only those ciphers which support CBC mode.
571 This option has no effect for connections between nodes using
572 .Va ExperimentalProtocol .
573 .It Va ClampMSS Li = yes | no Pq yes
574 This option specifies whether tinc should clamp the maximum segment size (MSS)
575 of TCP packets to the path MTU. This helps in situations where ICMP
576 Fragmentation Needed or Packet too Big messages are dropped by firewalls.
577 .It Va Compression Li = Ar level Pq 0
578 This option sets the level of compression used for UDP packets.
579 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
580 10 (fast lzo) and 11 (best lzo).
581 .It Va Digest Li = Ar digest Pq sha1
582 The digest algorithm used to authenticate UDP packets.
583 Any digest supported by LibreSSL or OpenSSL is recognised.
584 Furthermore, specifying
585 .Qq none
586 will turn off packet authentication.
587 This option has no effect for connections between nodes using
588 .Va ExperimentalProtocol .
589 .It Va IndirectData Li = yes | no Pq no
590 When set to yes, only nodes which already have a meta connection to you
591 will try to establish direct communication with you.
592 It is best to leave this option out or set it to no.
593 .It Va MACLength Li = Ar length Pq 4
594 The length of the message authentication code used to authenticate UDP packets.
595 Can be anything from
596 .Qq 0
597 up to the length of the digest produced by the digest algorithm.
598 This option has no effect for connections between nodes using
599 .Va ExperimentalProtocol .
600 .It Va PMTU Li = Ar mtu Po 1514 Pc
601 This option controls the initial path MTU to this node.
602 .It Va PMTUDiscovery Li = yes | no Po yes Pc
603 When this option is enabled, tinc will try to discover the path MTU to this node.
604 After the path MTU has been discovered, it will be enforced on the VPN.
605 .It Va MTUInfoInterval Li = Ar seconds Pq 5
606 The minimum amount of time between sending periodic updates about relay path MTU. Useful for quickly determining MTU to indirect nodes.
607 .It Va Port Li = Ar port Pq 655
608 The port number on which this tinc daemon is listening for incoming connections,
609 which is used if no port number is specified in an
610 .Va Address
611 statement.
612 .Pp
613 If this is set to zero, the port will be randomly assigned by the system. This is useful to randomize source ports of UDP packets, which can improve UDP hole punching reliability. When setting
614 .Va Port
615 to zero it is recommended to set
616 .Va AddressFamily
617 as well, otherwise
618 .Nm tinc
619 will assign different ports to different address families but other nodes can only know of one.
620 .It Va PublicKey Li = Ar key Bq obsolete
621 The public RSA key of this tinc daemon.
622 It will be used to cryptographically verify it's identity and to set up a secure connection.
623 .It Va PublicKeyFile Li = Ar filename Bq obsolete
624 The file in which the public RSA key of this tinc daemon resides.
625 .Pp
626 From version 1.0pre4 on
627 .Nm tinc
628 will store the public key directly into the host configuration file in PEM format,
629 the above two options then are not necessary.
630 Either the PEM format is used, or exactly one of the above two options must be specified
631 in each host configuration file,
632 if you want to be able to establish a connection with that host.
633 .It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength Ns Op Li # Ns Ar weight
634 The subnet which this tinc daemon will serve.
635 .Nm tinc
636 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
637 If the packet matches a subnet,
638 it will be sent to the daemon who has this subnet in his host configuration file.
639 Multiple
640 .Va Subnet
641 variables can be specified.
642 .Pp
643 Subnets can either be single MAC, IPv4 or IPv6 addresses,
644 in which case a subnet consisting of only that single address is assumed,
645 or they can be a IPv4 or IPv6 network address with a prefixlength.
646 For example, IPv4 subnets must be in a form like,
647 where is the network address and 24 is the number of bits set in the netmask.
648 Note that subnets like are invalid!
649 Read a networking HOWTO/FAQ/guide if you don't understand this.
650 IPv6 subnets are notated like fec0:0:0:1::/64.
651 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
652 .Pp
653 A Subnet can be given a weight to indicate its priority over identical Subnets
654 owned by different nodes. The default weight is 10. Lower values indicate
655 higher priority. Packets will be sent to the node with the highest priority,
656 unless that node is not reachable, in which case the node with the next highest
657 priority will be tried, and so on.
658 .It Va TCPOnly Li = yes | no Pq no Bq obsolete
659 If this variable is set to yes,
660 then the packets are tunnelled over the TCP connection instead of a UDP connection.
661 This is especially useful for those who want to run a tinc daemon
662 from behind a masquerading firewall,
663 or if UDP packet routing is disabled somehow.
664 Setting this options also implicitly sets IndirectData.
665 .Pp
666 Since version 1.0.10, tinc will automatically detect whether communication via
667 UDP is possible or not.
668 .It Va Weight Li = Ar weight
669 If this variable is set, it overrides the weight given to connections made with
670 another host. A higher
671 .Ar weight
672 means a lower priority is given to this connection when broadcasting or
673 forwarding packets.
674 .El
676 Apart from reading the server and host configuration files,
677 tinc can also run scripts at certain moments.
678 Below is a list of filenames of scripts and a description of when they are run.
679 A script is only run if it exists and if it is executable.
680 .Pp
681 Scripts are run synchronously;
682 this means that tinc will temporarily stop processing packets until the called script finishes executing.
683 This guarantees that scripts will execute in the exact same order as the events that trigger them.
684 If you need to run commands asynchronously, you have to ensure yourself that they are being run in the background.
685 .Pp
686 Under Windows, the scripts must have the extension
687 .Pa .bat
688 or
689 .Pa .cmd .
690 .Bl -tag -width indent
691 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
692 This is the most important script.
693 If it is present it will be executed right after the tinc daemon has been started and has connected to the virtual network device (or when the first node becomes reachable if
694 .Va DeviceStandby
695 is used).
696 It should be used to set up the corresponding network interface,
697 but can also be used to start other things.
698 .Pp
699 Under Windows you can use the Network Connections control panel instead of creating this script.
700 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
701 This script is started right before the tinc daemon quits (or when the last node becomes unreachable if
702 .Va DeviceStandby
703 is used).
704 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -up
705 This script is started when the tinc daemon with name
706 .Ar HOST
707 becomes reachable.
708 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -down
709 This script is started when the tinc daemon with name
710 .Ar HOST
711 becomes unreachable.
712 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up
713 This script is started when any host becomes reachable.
714 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down
715 This script is started when any host becomes unreachable.
716 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up
717 This script is started when a Subnet becomes reachable.
718 The Subnet and the node it belongs to are passed in environment variables.
719 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down
720 This script is started when a Subnet becomes unreachable.
721 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitation-created
722 This script is started when a new invitation has been created.
723 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitation-accepted
724 This script is started when an invitation has been used.
725 .El
726 .Pp
727 The scripts are started without command line arguments, but can make use of certain environment variables.
728 Under UNIX like operating systems the names of environment variables must be preceded by a
729 .Li $ 
730 in scripts.
731 Under Windows, in
732 .Pa .bat
733 or
734 .Pa .cmd
735 files, they have to be put between
736 .Li %
737 signs.
738 .Bl -tag -width indent
739 .It Ev NETNAME
740 If a netname was specified, this environment variable contains it.
741 .It Ev NAME
742 Contains the name of this tinc daemon.
743 .It Ev DEVICE
744 Contains the name of the virtual network device that tinc uses.
746 Contains the name of the virtual network interface that tinc uses.
747 This should be used for commands like
748 .Pa ifconfig .
749 .It Ev NODE
750 When a host becomes (un)reachable, this is set to its name.
751 If a subnet becomes (un)reachable, this is set to the owner of that subnet.
753 When a host becomes (un)reachable, this is set to its real address.
755 When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons.
756 .It Ev SUBNET
757 When a subnet becomes (un)reachable, this is set to the subnet.
758 .It Ev WEIGHT
759 When a subnet becomes (un)reachable, this is set to the subnet weight.
761 When the
762 .Pa invitation-created
763 script is called, this is set to the file where the invitation details will be stored.
765 When the
766 .Pa invitation-created
767 script is called, this is set to the invitation URL that has been created.
768 .El
769 .Pp
770 Do not forget that under UNIX operating systems, you have to make the scripts executable, using the command
771 .Nm chmod Li a+x Pa script .
772 .Sh FILES
773 The most important files are:
774 .Bl -tag -width indent
775 .It Pa @sysconfdir@/tinc/
776 The top directory for configuration files.
777 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
778 The default name of the server configuration file for net
779 .Ar NETNAME .
780 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /conf.d/
781 Optional directory from which any .conf file will be loaded
782 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
783 Host configuration files are kept in this directory.
784 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
785 If an executable file with this name exists,
786 it will be executed right after the tinc daemon has connected to the virtual network device.
787 It can be used to set up the corresponding network interface.
788 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
789 If an executable file with this name exists,
790 it will be executed right before the tinc daemon is going to close
791 its connection to the virtual network device.
792 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitations/
793 This directory contains outstanding invitations.
794 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /invitation-data
795 After a successful join, this file contains a copy of the invitation data received.
796 .El
797 .Sh SEE ALSO
798 .Xr tincd 8 ,
799 .Xr tinc 8 ,
800 .Pa ,
801 .Pa .
802 .Pp
803 The full documentation for
804 .Nm tinc
805 is maintained as a Texinfo manual.
806 If the info and tinc programs are properly installed at your site, the command
807 .Ic info tinc
808 should give you access to the complete manual.
809 .Pp
810 .Nm tinc
812 This is free software, and you are welcome to redistribute it under certain conditions;
813 see the file COPYING for details.