git.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:
  63 .TP
  64 \fBConnectPort = \fIport\fR
  65 Connect to the upstream host (given with the \fBConnectTo\fR
  66 directive) on port \fIport\fR. \fIport\fR may be given in decimal
  67 (default), octal (when preceded by a single zero) or hexadecimal
  68 (prefixed with \fB0x\fR). \fIport\fR is the port number for both the
  69 UDP and the TCP (meta) connections.
  70 .TP
  71 \fBConnectTo = \fB(\fIIP address\fB|\fIhostname\fB)\fR
  72 Specifies which host to connect to on startup. If the
  73 \fBConnectPort\fR variable is omitted, then tinc will try to connect
  74 to port 655.
  75
  76 If you don't specify a host with \fBConnectTo\fR, tinc won't connect
  77 at all, and will instead just listen for incoming connections. Only
  78 the initiator of a tinc VPN should need this.
  79 .TP
  80 \fBKeyExpire = \fIs\fR
  81 The secret (and public) key expires after \fIs\fR seconds. The default
  82 is 3600 seconds, or one hour.
  83
  84 If you make it shorter, a lot of time and bandwidth is spent
  85 negotiating over the new keys. If you make it longer, you make
  86 yourself more vulnerable to crackers, because they have more data to
  87 work with. The best value depends on the speed of the link, and the
  88 amount of data that goes over it.
  89 .TP
  90 \fBListenPort = \fIport\fR
  91 Listen on local port \fIport\fR. The computer connecting to this
  92 daemon should use this number as the argument for his
  93 \fBConnectPort\fR. Again, the default is 655.
  94 .TP
  95 \fBMyOwnVPNIP = \fInetwork address\fR[\fB/\fImaskbits\fR]
  96 The \fInetwork address\fR is the number that the daemon will propagate
  97 to other daemons on the network when it is identifying itself. Hence
  98 this will be the file name of the passphrase file that the other end
  99 expects to find the passphrase in.
 100
 101 \fImaskbits\fR is the number of bits set to 1 in the netmask part.
 102 .TP
 103 \fBMyVirtualIP = \fInetwork address\fR[\fB/\fImaskbits\fR]
 104 This is an alias for \fBMyOwnVPNIP\fR.
 105 .TP
 106 \fBPassphrases = \fIdirectory\fR
 107 The directory where tinc will look for passphrases when someone tries
 108 to cennect. Please see the manpage for \fBgenauth\fR(8) for more
 109 information about passphrases as used by tinc.
 110 .TP
 111 \fBPingTimeout = \fInumber\fR
 112 The number of seconds of inactivity that tinc will wait before sending
 113 a probe to the other end. If that other end doesn't answer within that
 114 same amount of seconds, the connection is terminated, and the others
 115 will be notified of this.
 116 .TP
 117 \fBTapDevice = \fIdevice\fR
 118 The ethertap device to use. Note that you can only use one device per
 119 daemon. The info pages of the tinc package contain more information
 120 about configuring an ethertap device for linux.
 121 .TP
 122 \fBNetMask = \fImask\fR
 123 The mask that defines the scope of the entire VPN. This option is not used
 124 by the tinc daemon itself, but can be used by startup scripts to configure
 125 the ethertap devices correctly.
 126 .PP
 127 .SH "FILES"
 128 .TP
 129 \fI/etc/tinc/\fR
 130 The top directory for configuration files.
 131 .TP
 132 \fI/etc/tinc/\fBnn\fI/tincd.conf\fR
 133 The default name of the configuration file for net
 134 \fBnn\fR.
 135 .TP
 136 \fI/etc/tinc/\fBnn\fI/passphrases/\fR
 137 Passphrases are kept in this directory. (See the section
 138 \fBPASSPHRASES\fR above).
 139 .PP
 140 .SH "SEE ALSO"
 141 \fBtincd\fR(8), \fBgenauth\fR(8)
 142 .TP
 143 \fBhttp://tinc.nl.linux.org/\fR
 144 .PP
 145 The full documentation for
 146 .B tinc
 147 is maintained as a Texinfo manual.  If the
 148 .B info
 149 and
 150 .B tinc
 151 programs are properly installed at your site, the command
 152 .IP
 153 .B info tinc
 154 .PP
 155 should give you access to the complete manual.
 156 .PP
 157 tinc comes with ABSOLUTELY NO WARRANTY.  This is free software,
 158 and you are welcome to redistribute it under certain conditions;
 159 see the file COPYING for details.