Updated dutch translation.
[tinc] / doc / tinc.conf.5.in
1 .Dd 2002-04-09
3 .\" Manual page created by:
4 .\" Ivo Timmermans <ivo@tinc-vpn.org>
5 .\" Guus Sliepen <guus@tinc-vpn.org>
6 .Sh NAME
7 .Nm tinc.conf
8 .Nd tinc daemon configuration
10 The files in the
11 .Pa @sysconfdir@/tinc/
12 directory contain runtime and security information for the tinc daemon.
14 It is perfectly ok for you to run more than one tinc daemon.
15 However, in its default form,
16 you will soon notice that you can't use two different configuration files without the
17 .Fl c
18 option.
19 .Pp
20 We have thought of another way of dealing with this: network names.
21 This means that you call
22 .Nm
23 with the
24 .Fl n
25 option, which will assign a name to this daemon.
26 .Pp
27 The effect of this is that the daemon will set its configuration root to
28 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ,
29 where 
31 is your argument to the
32 .Fl n
33 option.
34 You'll notice that messages appear in syslog as coming from
35 .Nm tincd. Ns Ar NETNAME .
36 .Pp
37 However, it is not strictly necessary that you call tinc with the
38 .Fl n
39 option.
40 In this case, the network name would just be empty,
41 and it will be used as such.
42 .Nm tinc
43 now looks for files in
44 .Pa @sysconfdir@/tinc/ ,
45 instead of 
46 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa / ;
47 the configuration file should be
48 .Pa @sysconfdir@/tinc/tinc.conf ,
49 and the host configuration files are now expected to be in
50 .Pa @sysconfdir@/tinc/hosts/ .
51 .Pp
52 But it is highly recommended that you use this feature of
53 .Nm tinc ,
54 because it will be so much clearer whom your daemon talks to.
55 Hence, we will assume that you use it.
56 .Sh NAMES
57 Each tinc daemon should have a name that is unique in the network which it will be part of.
58 The name will be used by other tinc daemons for identification.
59 The name has to be declared in the
60 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
61 file.
62 .Pp
63 To make things easy,
64 choose something that will give unique and easy to remember names to your tinc daemon(s).
65 You could try things like hostnames, owner surnames or location names.
67 You should use 
68 .Ic tincd -K
69 to generate public/private keypairs.
70 It will generate two keys.
71 The private key should be stored in a separate file
72 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv
73 \-\- where 
75 stands for the network (see 
77 above.
78 The public key should be stored in the host configuration file
79 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Va NAME
80 \-\- where
81 .Va NAME
82 stands for the name of the local tinc daemon (see
83 .Sx NAMES ) .
85 The server configuration of the daemon is done in the file
86 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf .
87 This file consists of comments (lines started with a
88 .Li # )
89 or assignments in the form of:
90 .Pp
91 .Va Variable Li = Ar Value .
92 .Pp
93 The variable names are case insensitive, and any spaces, tabs,
94 newlines and carriage returns are ignored.
95 Note: it is not required that you put in the 
96 .Li =
97 sign, but doing so improves readability.
98 If you leave it out, remember to replace it with at least one space character.
99 .Pp
100 Here are all valid variables, listed in alphabetical order.
101 The default value is given between parentheses.
102 .Bl -tag -width indent
103 .It Va AddressFamily Li = ipv4 | ipv6 | any Pq any
104 This option affects the address family of listening and outgoing sockets.
105 If
106 .Qq any
107 is selected, then depending on the operating system both IPv4 and IPv6 or just
108 IPv6 listening sockets will be created.
109 .It Va BindToAddress Li = Ar address Bq experimental
110 If your computer has more than one IPv4 or IPv6 address,
111 .Nm tinc
112 will by default listen on all of them for incoming connections.
113 It is possible to bind only to a single address with this variable.
114 .Pp
115 This option may not work on all platforms.
116 .It Va BindToInterface Li = Ar interface Bq experimental
117 If your computer has more than one network interface,
118 .Nm tinc
119 will by default listen on all of them for incoming connections.
120 It is possible to bind only to a single interface with this variable.
121 .Pp
122 This option may not work on all platforms.
123 .It Va BlockingTCP Li = yes | no Po no Pc Bq experimental
124 This options selects whether TCP connections, when established, should use blocking writes.
125 When turned off, tinc will never block when a TCP connection becomes congested, but will have to terminate that connection instead.
126 If turned on, tinc will not terminate connections but will block, thereby unable to process data to/from other connections.
127 Turn this option on if you also use
128 .Va TCPOnly
129 and tinc terminates connections frequently.
130 .It Va ConnectTo Li = Ar name
131 Specifies which other tinc daemon to connect to on startup.
132 Multiple
133 .Va ConnectTo
134 variables may be specified,
135 in which case outgoing connections to each specified tinc daemon are made.
136 The names should be known to this tinc daemon
137 (i.e., there should be a host configuration file for the name on the
138 .Va ConnectTo
139 line).
140 .Pp
141 If you don't specify a host with
142 .Va ConnectTo ,
143 .Nm tinc
144 won't try to connect to other daemons at all,
145 and will instead just listen for incoming connections.
146 .It Va Device Li = Ar device Po Pa /dev/tap0 , Pa /dev/net/tun No or other depending on platform Pc
147 The virtual network device to use.
148 .Nm tinc
149 will automatically detect what kind of device it is.
150 Note that you can only use one device per daemon.
151 Under Windows, use
152 .Va Interface
153 instead of
154 .Va Device .
155 The info pages of the tinc package contain more information
156 about configuring the virtual network device.
157 .It Va Hostnames Li = yes | no Pq no
158 This option selects whether IP addresses (both real and on the VPN) should
159 be resolved. Since DNS lookups are blocking, it might affect tinc's
160 efficiency, even stopping the daemon for a few seconds every time it does
161 a lookup if your DNS server is not responding.
162 .Pp
163 This does not affect resolving hostnames to IP addresses from the
164 host configuration files.
165 .It Va Interface Li = Ar interface
166 Defines the name of the interface corresponding to the virtual network device.
167 Depending on the operating system and the type of device this may or may not actually set the name of the interface.
168 Under Windows, this variable is used to select which network interface will be used.
169 If you specified a
170 .Va Device ,
171 this variable is almost always already correctly set.
172 .It Va KeyExpire Li = Ar seconds Pq 3600
173 This option controls the period the encryption keys used to encrypt the data are valid.
174 It is common practice to change keys at regular intervals to make it even harder for crackers,
175 even though it is thought to be nearly impossible to crack a single key.
176 .It Va MACExpire Li = Ar seconds Pq 600
177 This option controls the amount of time MAC addresses are kept before they are removed.
178 This only has effect when
179 .Va Mode
180 is set to
181 .Qq switch .
182 .It Va MaxTimeout Li = Ar seconds Pq 900
183 This is the maximum delay before trying to reconnect to other tinc daemons.
184 .It Va Mode Li = router | switch | hub Pq router
185 This option selects the way packets are routed to other daemons.
186 .Bl -tag -width indent
187 .It router
188 In this mode
189 .Va Subnet
190 variables in the host configuration files will be used to form a routing table.
191 Only unicast packets of routable protocols (IPv4 and IPv6) are supported in this mode.
192 .Pp
193 This is the default mode, and unless you really know you need another mode, don't change it.
194 .It switch
195 In this mode the MAC addresses of the packets on the VPN will be used to
196 dynamically create a routing table just like an Ethernet switch does.
197 Unicast, multicast and broadcast packets of every protocol that runs over Ethernet are supported in this mode
198 at the cost of frequent broadcast ARP requests and routing table updates.
199 .Pp
200 This mode is primarily useful if you want to bridge Ethernet segments.
201 .It hub
202 This mode is almost the same as the switch mode, but instead
203 every packet will be broadcast to the other daemons
204 while no routing table is managed.
205 .El
206 .It Va Name Li = Ar name Bq required
207 This is the name which identifies this tinc daemon.
208 It must be unique for the virtual private network this daemon will connect to.
209 .It Va PingTimeout Li = Ar seconds Pq 60
210 The number of seconds of inactivity that
211 .Nm tinc
212 will wait before sending a probe to the other end.
213 If that other end doesn't answer within that same amount of time,
214 the connection is terminated,
215 and the others will be notified of this.
216 .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental
217 When this option is enabled the value of the TOS field of tunneled IPv4 packets
218 will be inherited by the UDP packets that are sent out.
219 .It Va PrivateKey Li = Ar key Bq obsolete
220 The private RSA key of this tinc daemon.
221 It will allow this tinc daemon to authenticate itself to other daemons.
222 .It Va PrivateKeyFile Li = Ar filename Po Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /rsa_key.priv Pc
223 The file in which the private RSA key of this tinc daemon resides.
224 Note that there must be exactly one of
225 .Va PrivateKey
226 or
227 .Va PrivateKeyFile
228 specified in the configuration file.
229 .It Va TunnelServer Li = yes | no Po no Pc Bq experimental
230 When this option is enabled tinc will no longer forward information between other tinc daemons,
231 and will only allow nodes and subnets on the VPN which are present in the
232 .Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
233 directory.
234 .El
236 The host configuration files contain all information needed
237 to establish a connection to those hosts.
238 A host configuration file is also required for the local tinc daemon,
239 it will use it to read in it's listen port, public key and subnets.
240 .Pp
241 The idea is that these files are portable.
242 You can safely mail your own host configuration file to someone else.
243 That other person can then copy it to his own hosts directory,
244 and now his tinc daemon will be able to connect to your tinc daemon.
245 Since host configuration files only contain public keys,
246 no secrets are revealed by sending out this information.
247 .Bl -tag -width indent
248 .It Va Address Li = Ar address Bq recommended
249 The IP address or hostname of this tinc daemon on the real network.
250 This wil only be used when trying to make an outgoing connection to this tinc daemon.
251 Multiple
252 .Va Address
253 variables can be specified, in which case each address will be tried until a working
254 connection has been established.
255 .It Va Cipher Li = Ar cipher Pq blowfish
256 The symmetric cipher algorithm used to encrypt UDP packets.
257 Any cipher supported by OpenSSL is recognised.
258 Furthermore, specifying
259 .Qq none
260 will turn off packet encryption.
261 It is best to use only those ciphers which support CBC mode.
262 .It Va Compression Li = Ar level Pq 0
263 This option sets the level of compression used for UDP packets.
264 Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib),
265 10 (fast lzo) and 11 (best lzo).
266 .It Va Digest Li = Ar digest Pq sha1
267 The digest algorithm used to authenticate UDP packets.
268 Any digest supported by OpenSSL is recognised.
269 Furthermore, specifying
270 .Qq none
271 will turn off packet authentication.
272 .It Va IndirectData Li = yes | no Pq no
273 This option specifies whether other tinc daemons besides the one you specified with
274 .Va ConnectTo
275 can make a direct connection to you.
276 This is especially useful if you are behind a firewall
277 and it is impossible to make a connection from the outside to your tinc daemon.
278 Otherwise, it is best to leave this option out or set it to no.
279 .It Va MACLength Li = Ar length Pq 4
280 The length of the message authentication code used to authenticate UDP packets.
281 Can be anything from
282 .Qq 0
283 up to the length of the digest produced by the digest algorithm.
284 .It Va PMTU Li = Ar mtu Po 1514 Pc Bq experimental
285 This option controls the initial path MTU to this node.
286 .It Va PMTUDiscovery Li = yes | no Po no Pc Bq experimental
287 When this option is enabled, tinc will try to discover the path MTU to this node.
288 After the path MTU has been discovered, it will be enforced on the VPN.
289 .It Va Port Li = Ar port Pq 655
290 The port number on which this tinc daemon is listening for incoming connections.
291 .It Va PublicKey Li = Ar key Bq obsolete
292 The public RSA key of this tinc daemon.
293 It will be used to cryptographically verify it's identity and to set up a secure connection.
294 .It Va PublicKeyFile Li = Ar filename Bq obsolete
295 The file in which the public RSA key of this tinc daemon resides.
296 .Pp
297 From version 1.0pre4 on
298 .Nm tinc
299 will store the public key directly into the host configuration file in PEM format,
300 the above two options then are not necessary.
301 Either the PEM format is used, or exactly one of the above two options must be specified
302 in each host configuration file,
303 if you want to be able to establish a connection with that host.
304 .It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength
305 The subnet which this tinc daemon will serve.
306 .Nm tinc
307 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
308 If the packet matches a subnet,
309 it will be sent to the daemon who has this subnet in his host configuration file.
310 Multiple
311 .Va Subnet
312 variables can be specified.
313 .Pp
314 Subnets can either be single MAC, IPv4 or IPv6 addresses,
315 in which case a subnet consisting of only that single address is assumed,
316 or they can be a IPv4 or IPv6 network address with a prefixlength.
317 Shorthand notations are not supported.
318 For example, IPv4 subnets must be in a form like,
319 where is the network address and 24 is the number of bits set in the netmask.
320 Note that subnets like are invalid!
321 Read a networking HOWTO/FAQ/guide if you don't understand this.
322 IPv6 subnets are notated like fec0:0:0:1:0:0:0:0/64.
323 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
324 .It Va TCPOnly Li = yes | no Pq no
325 If this variable is set to yes,
326 then the packets are tunnelled over the TCP connection instead of a UDP connection.
327 This is especially useful for those who want to run a tinc daemon
328 from behind a masquerading firewall,
329 or if UDP packet routing is disabled somehow.
330 Setting this options also implicitly sets IndirectData.
331 .El
333 Apart from reading the server and host configuration files,
334 tinc can also run scripts at certain moments.
335 Under Windows (not Cygwin), the scripts should have the extension
336 .Pa .bat .
337 .Bl -tag -width indent
338 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
339 This is the most important script.
340 If it is present it will be executed right after the tinc daemon has been started and has connected to the virtual network device.
341 It should be used to set up the corresponding network interface,
342 but can also be used to start other things.
343 Under Windows you can use the Network Connections control panel instead of creating this script.
344 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
345 This script is started right before the tinc daemon quits.
346 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -up
347 This script is started when the tinc daemon with name
348 .Ar HOST
349 becomes reachable.
350 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar HOST Ns Pa -down
351 This script is started when the tinc daemon with name
352 .Ar HOST
353 becomes unreachable.
354 .El
355 .Pp
356 The scripts are started without command line arguments, but can make use of certain environment variables.
357 Under UNIX like operating systems the names of environment variables must be preceded by a
358 .Li $ 
359 in scripts.
360 Under Windows, in
361 .Pa .bat
362 files, they have to be put between
363 .Li %
364 signs.
365 .Bl -tag -width indent
366 .It Ev NETNAME
367 If a netname was specified, this environment variable contains it.
368 .It Ev NAME
369 Contains the name of this tinc daemon.
370 .It Ev DEVICE
371 Contains the name of the virtual network device that tinc uses.
373 Contains the name of the virtual network interface that tinc uses.
374 This should be used for commands like
375 .Pa ifconfig .
376 .It Ev NODE
377 When a host becomes (un)reachable, this is set to its name.
379 When a host becomes (un)reachable, this is set to its real address.
381 When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons.
382 .El
383 .Sh FILES
384 The most important files are:
385 .Bl -tag -width indent
386 .It Pa @sysconfdir@/tinc/
387 The top directory for configuration files.
388 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
389 The default name of the server configuration file for net
390 .Ar NETNAME .
391 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/
392 Host configuration files are kept in this directory.
393 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
394 If an executable file with this name exists,
395 it will be executed right after the tinc daemon has connected to the virtual network device.
396 It can be used to set up the corresponding network interface.
397 .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
398 If an executable file with this name exists,
399 it will be executed right before the tinc daemon is going to close
400 its connection to the virtual network device.
401 .El
402 .Sh SEE ALSO
403 .Xr tincd 8 ,
404 .Pa http://www.tinc-vpn.org/ ,
405 .Pa http://www.linuxdoc.org/LDP/nag2/ .
406 .Pp
407 The full documentation for
408 .Nm tinc
409 is maintained as a Texinfo manual.
410 If the info and tinc programs are properly installed at your site, the command
411 .Ic info tinc
412 should give you access to the complete manual.
413 .Pp
414 .Nm tinc
416 This is free software, and you are welcome to redistribute it under certain conditions;
417 see the file COPYING for details.