www.tinc-vpn.org Git - tinc/blob - doc/tinc.conf.5

   1 .TH TINC 5 "May 2000" "tinc version 1.0" "FSF"
   2 .SH NAME
   3 tincd.conf \- tinc daemon configuration
   4 .SH "DESCRIPTION"
   5 The files in the \fI/etc/tinc\fR directory contain runtime and
   6 security information for the \fBtinc\fR(8) daemon.
   7 .PP
   8 .SH "NETWORKS"
   9 It is perfectly ok for you to run more than one tinc daemon. However,
  10 in its default form, you will soon notice that you can't use two
  11 different configuration files without the \fI-c\fR option.
  12
  13 We have thought of another way of dealing with this: network
  14 names. This means that you call \fBtincd\fR with the \fI-n\fR argument,
  15 which will assign a name to this daemon.
  16
  17 The effect of this is that the daemon will set its configuration
  18 ``root'' to \fI/etc/tinc/\fBnn\fI/\fR, where \fBnn\fR is your argument
  19 to the \fI-n\fR option. You'll notice that it appears in syslog as
  20 ``tincd.\fBnn\fR''.
  21
  22 However, it is not strictly necessary that you call tinc with the -n
  23 option. In this case, the network name would just be empty, and it
  24 will be used as such. tinc now looks for files in \fI/etc/tinc/\fR,
  25 instead of \fI/etc/tinc/\fBnn\fI/\fR; the configuration file should be
  26 \fI/etc/tinc/tincd.conf\fR, and the passphrases are now expected to be
  27 in \fI/etc/tinc/passphrases/\fR.
  28
  29 But it is highly recommended that you use this feature of tinc,
  30 because it will be so much clearer whom your daemon talks to. Hence,
  31 we will assume that you use it.
  32 .PP
  33 .SH "PASSPHRASES"
  34 You should use the \fBgenauth\fR(8) program to generate passphrases.
  35 with, it accepts a single parameter, which is the number of bits the
  36 passphrase should be. Its output should be stored in
  37 \fI/etc/tinc/\fBnn\fI/passphrases/local\fR \-\- where \fBnn\fR stands
  38 for the network (See under \fBNETWORKS\fR) above.
  39
  40 Please see the manpage for \fBgenauth\fR to learn more about setting
  41 up an authentication scheme.
  42 .PP
  43 .SH "CONFIGURATION"
  44 The actual configuration of the daemon is done in the file
  45 \fI/etc/tinc/\fBnn\fI/tincd.conf\fR.
  46
  47 This file consists of comments (lines started with a \fB#\fR) or
  48 assignments in the form of
  49 .PP
  50 .Vb 1
  51 \&    \fIVariable \fB= \fIValue\fR.
  52 .Ve
  53 .PP
  54 The variable names are case insensitive, and any spaces, tabs,
  55 newlines and carriage returns are ignored. \fINote\fR: it is not
  56 required that you put in the \fB=\fR sign, but doing so improves
  57 readability. If you leave it out, remember to replace it with at least
  58 one space character.
  59 .PP
  60 .SH "VARIABLES"
  61 .PP
  62 Here are all valid variables, listed in alphabetical order. The default
  63 value, required or optional is given between parentheses.
  64 .TP
  65 \fBConnectPort\fR = <\fIport\fR> (655)
  66 Connect to the upstream host (given with the \fBConnectTo\fR directive) on
  67 port \fIport\fR. port may be given in decimal (default), octal (when preceded
  68 by a single zero) or hexadecimal (prefixed with 0x). \fIport\fR is the port
  69 number for both the UDP and the TCP (meta) connections.
  70 .TP
  71 \fBConnectTo\fR = <\fIIP address|hostname\fR> (optional)
  72 Specifies which host to connect to on startup. Multiple \fBConnectTo\fR variables
  73 may be specified, if connecting to the first one fails then tinc will try
  74 the next one, and so on. It is possible to specify hostnames for dynamic IP
  75 addresses (like those given on dyndns.org), tinc will not cache the resolved
  76 IP address.
  77
  78 If you don't specify a host with \fBConnectTo\fR, regardless of whether a
  79 value for \fBConnectPort\fR is given, tinc won't connect at all, and will
  80 instead just listen for incoming connections.
  81 .TP
  82 \fBHostnames\fR = <\fIyes|no\fR> (no)
  83 This option selects whether IP addresses (both real and on the VPN) should
  84 be resolved. Since DNS lookups are blocking, it might affect tinc's
  85 efficiency, even stopping the daemon for a few seconds everytime it does
  86 a lookup if your DNS server is not responding.
  87
  88 This does not affect resolving hostnames to IP addresses from the configuration
  89 file.
  90 .TP
  91 \fBIndirectData\fR = <\fIyes|no\fR> (no)
  92 This option specifies whether other tinc daemons besides the one you
  93 specified with \fBConnectTo\fR can make a direct connection to you. This is
  94 especially useful if you are behind a firewall and it is impossible
  95 to make a connection from the outside to your tinc daemon. Otherwise,
  96 it is best to leave this option out or set it to no.
  97 .TP
  98 \fBInterface\fR = <\fIdevice\fR> (optional)
  99 If you have more than one network interface in your computer, tinc will by
 100 default listen on all of them for incoming connections. It is possible to
 101 bind tinc to a single interface like eth0 or ppp0 with this variable.
 102 .TP
 103 \fBInterfaceIP\fR = <\fIlocal address\fR> (optional)
 104 If your computer has more than one IP address on a single interface (for example
 105 if you are running virtual hosts), tinc will by default listen on all of them for
 106 incoming connections. It is possible to bind tinc to a single IP address with
 107 this variable. It is still possible to listen on several interfaces at the same
 108 time though, if they share the same IP address.
 109 .TP
 110 \fBKeyExpire\fR = <\fIseconds\fR> (3600)
 111 This option controls the time the encryption keys used to encrypt the data
 112 are valid. It is common practice to change keys at regular intervals to
 113 make it even harder for crackers, even though it is thought to be nearly
 114 impossible to crack a single key.
 115 .TP
 116 \fBListenPort\fR = <\fIport\fR> (655)
 117 Listen on local port \fIport\fR. The computer connecting to this daemon should
 118 use this number as the argument for his \fBConnectPort\fR.
 119 .TP
 120 \fBMyOwnVPNIP\fR = <\fIlocal address[/maskbits]\fR> (required)
 121 The \fIlocal address\fR is the number that the daemon will propagate to
 122 other daemons on the network when it is identifying itself. Hence this
 123 will be the file name of the passphrase file that the other end expects
 124 to find the passphrase in.
 125
 126 The local address is the IP address of the tap device, not the real IP
 127 address of the host running tincd. Due to changes in recent kernels, it
 128 is also necessary that you make the ethernet (also known as MAC) address
 129 equal to the IP address (see the example).
 130
 131 \fImaskbits\fR is the number of bits set to 1 in the netmask part.
 132 .TP
 133 \fBMyVirtualIP\fR = <\fIlocal address[/maskbits]>
 134 This is an alias for \fBMyOwnVPNIP\fR.
 135 .TP
 136 \fBPassphrases\fR = <\fIdirectory\fR> (/etc/tinc/NETNAME/passphrases)
 137 The directory where tinc will look for passphrases when someone tries to
 138 connect. Please see the manpage for genauth(8) for more information
 139 about passphrases as used by tinc.
 140 .TP
 141 \fBPingTimeout\fR = <\fIseconds\fR> (5)
 142 The number of seconds of inactivity that tinc will wait before sending a
 143 probe to the other end. If that other end doesn't answer within that
 144 same amount of seconds, the connection is terminated, and the others
 145 will be notified of this.
 146 .TP
 147 \fBTapDevice\fR = <\fIdevice\fR> (/dev/tap0)
 148 The ethertap device to use. Note that you can only use one device per
 149 daemon. The info pages of the tinc package contain more information
 150 about configuring an ethertap device for Linux.
 151 .TP
 152 \fBTCPonly\fR = <\fIyes|no\fR> (no, experimental)
 153 If this variable is set to yes, then the packets are tunnelled over a TCP
 154 connection instead of a UDP connection. This is especially useful for those
 155 who want to run a tinc daemon from behind a masquerading firewall, or if
 156 UDP packet routing is disabled somehow. This is experimental code,
 157 try this at your own risk.
 158 .TP
 159 \fBVpnMask\fR = <\fImask\fR> (optional)
 160 The mask that defines the scope of the entire VPN. This option is not used
 161 by the tinc daemon itself, but can be used by startup scripts to configure
 162 the ethertap devices correctly.
 163 .PP
 164 .SH "FILES"
 165 .TP
 166 \fI/etc/tinc/\fR
 167 The top directory for configuration files.
 168 .TP
 169 \fI/etc/tinc/\fBnn\fI/tincd.conf\fR
 170 The default name of the configuration file for net
 171 \fBnn\fR.
 172 .TP
 173 \fI/etc/tinc/\fBnn\fI/passphrases/\fR
 174 Passphrases are kept in this directory. (See the section
 175 \fBPASSPHRASES\fR above).
 176 .PP
 177 .SH "SEE ALSO"
 178 \fBtincd\fR(8), \fBgenauth\fR(8)
 179 .TP
 180 \fBhttp://tinc.nl.linux.org/\fR
 181 .PP
 182 The full documentation for
 183 .B tinc
 184 is maintained as a Texinfo manual.  If the
 185 .B info
 186 and
 187 .B tinc
 188 programs are properly installed at your site, the command
 189 .IP
 190 .B info tinc
 191 .PP
 192 should give you access to the complete manual.
 193 .PP
 194 tinc comes with ABSOLUTELY NO WARRANTY.  This is free software,
 195 and you are welcome to redistribute it under certain conditions;
 196 see the file COPYING for details.