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