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