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