git.tinc-vpn.org Git - tinc/blob - doc/tincd.8.in

   1 .Dd 2013-01-14
   2 .Dt TINCD 8
   3 .\" Manual page created by:
   4 .\" Ivo Timmermans
   5 .\" Guus Sliepen <guus@tinc-vpn.org>
   6 .Sh NAME
   7 .Nm tincd
   8 .Nd tinc VPN daemon
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Op Fl cdDKnsoLRU
  12 .Op Fl -config Ns = Ns Ar DIR
  13 .Op Fl -no-detach
  14 .Op Fl -debug Ns Op = Ns Ar LEVEL
  15 .Op Fl -net Ns = Ns Ar NETNAME
  16 .Op Fl -option Ns = Ns Ar [HOST.]KEY=VALUE
  17 .Op Fl -mlock
  18 .Op Fl -logfile Ns Op = Ns Ar FILE
  19 .Op Fl -syslog
  20 .Op Fl -bypass-security
  21 .Op Fl -chroot
  22 .Op Fl -user Ns = Ns Ar USER
  23 .Op Fl -help
  24 .Op Fl -version
  25 .Sh DESCRIPTION
  26 This is the daemon of tinc, a secure virtual private network (VPN) project.
  27 When started,
  28 .Nm
  29 will read it's configuration file to determine what virtual subnets it has to serve
  30 and to what other tinc daemons it should connect.
  31 It will connect to the ethertap or tun/tap device
  32 and set up a socket for incoming connections.
  33 Optionally a script will be executed to further configure the virtual device.
  34 If that succeeds,
  35 it will detach from the controlling terminal and continue in the background,
  36 accepting and setting up connections to other tinc daemons
  37 that are part of the virtual private network.
  38 Under Windows (not Cygwin) tinc will install itself as a service,
  39 which will be restarted automatically after reboots.
  40 .Sh OPTIONS
  41 .Bl -tag -width indent
  42 .It Fl c, -config Ns = Ns Ar DIR
  43 Read configuration files from
  44 .Ar DIR
  45 instead of
  46 .Pa @sysconfdir@/tinc/ .
  47 .It Fl D, -no-detach
  48 Don't fork and detach.
  49 This will also disable the automatic restart mechanism for fatal errors.
  50 If not mentioned otherwise, this will show log messages on the standard error output.
  51 .It Fl d, -debug Ns Op = Ns Ar LEVEL
  52 Increase debug level or set it to
  53 .Ar LEVEL
  54 (see below).
  55 .It Fl n, -net Ns = Ns Ar NETNAME
  56 Connect to net
  57 .Ar NETNAME .
  58 This will let tinc read all configuration files from
  59 .Pa @sysconfdir@/tinc/ Ar NETNAME .
  60 Specifying
  61 .Li .
  62 for
  63 .Ar NETNAME
  64 is the same as not specifying any
  65 .Ar NETNAME .
  66 .It Fl o, -option Ns = Ns Ar [HOST.]KEY=VALUE
  67 Without specifying a
  68 .Ar HOST ,
  69 this will set server configuration variable
  70 .Ar KEY
  71 to
  72 .Ar VALUE .
  73 If specified as
  74 .Ar HOST.KEY=VALUE ,
  75 this will set the host configuration variable
  76 .Ar KEY
  77 of the host named
  78 .Ar HOST
  79 to
  80 .Ar VALUE .
  81 This option can be used more than once to specify multiple configuration variables.
  82 .It Fl L, -mlock
  83 Lock tinc into main memory.
  84 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
  85 This option is not supported on all platforms.
  86 .It Fl -logfile Ns Op = Ns Ar FILE
  87 Write log entries to a file instead of to the system logging facility.
  88 If
  89 .Ar FILE
  90 is omitted, the default is
  91 .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.
  92 .It Fl s, -syslog
  93 When this option is is set, tinc uses syslog instead of stderr in --no-detach mode.
  94 .It Fl -pidfile Ns = Ns Ar FILENAME
  95 Store a cookie in
  96 .Ar FILENAME
  97 which allows
  98 .Xr tinc 8
  99 to authenticate.
 100 If
 101 .Ar FILE
 102 is omitted, the default is
 103 .Pa @runstatedir@/tinc. Ns Ar NETNAME Ns Pa .pid.
 104 .It Fl -bypass-security
 105 Disables encryption and authentication of the meta protocol.
 106 Only useful for debugging.
 107 .It Fl R, -chroot
 108 With this option tinc chroots into the directory where network
 109 config is located (@sysconfdir@/tinc/NETNAME if -n option is used,
 110 or to the directory specified with -c option) after initialization.
 111 This option is not supported on all platforms.
 112 .It Fl U, -user Ns = Ns Ar USER
 113 setuid to the specified
 114 .Ar USER
 115 after initialization.
 116 This option is not supported on all platforms.
 117 .It Fl -help
 118 Display short list of options.
 119 .It Fl -version
 120 Output version information and exit.
 121 .El
 122 .Sh SIGNALS
 123 .Bl -tag -width indent
 124 .It ALRM
 125 Forces
 126 .Nm
 127 to try to connect to all uplinks immediately.
 128 Usually
 129 .Nm
 130 attempts to do this itself,
 131 but increases the time it waits between the attempts each time it failed,
 132 and if
 133 .Nm
 134 didn't succeed to connect to an uplink the first time after it started,
 135 it defaults to the maximum time of 15 minutes.
 136 .It HUP
 137 Partially rereads configuration files.
 138 Connections to hosts whose host config file are removed are closed.
 139 New outgoing connections specified in
 140 .Pa tinc.conf
 141 will be made.
 142 If the
 143 .Fl -logfile
 144 option is used, this will also close and reopen the log file,
 145 useful when log rotation is used.
 146 .El
 147 .Sh DEBUG LEVELS
 148 The tinc daemon can send a lot of messages to the syslog.
 149 The higher the debug level,
 150 the more messages it will log.
 151 Each level inherits all messages of the previous level:
 152 .Bl -tag -width indent
 153 .It 0
 154 This will log a message indicating
 155 .Nm
 156 has started along with a version number.
 157 It will also log any serious error.
 158 .It 1
 159 This will log all connections that are made with other tinc daemons.
 160 .It 2
 161 This will log status and error messages from scripts and other tinc daemons.
 162 .It 3
 163 This will log all requests that are exchanged with other tinc daemons. These include
 164 authentication, key exchange and connection list updates.
 165 .It 4
 166 This will log a copy of everything received on the meta socket.
 167 .It 5
 168 This will log all network traffic over the virtual private network.
 169 .El
 170 .Sh FILES
 171 .Bl -tag -width indent
 172 .It Pa @sysconfdir@/tinc/
 173 Directory containing the configuration files tinc uses.
 174 For more information, see
 175 .Xr tinc.conf 5 .
 176 .It Pa @runstatedir@/tinc. Ns Ar NETNAME Ns Pa .pid
 177 The PID of the currently running
 178 .Nm
 179 is stored in this file.
 180 .El
 181 .Sh BUGS
 182 The
 183 .Va BindToInterface
 184 option may not work correctly.
 185 .Pp
 186 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
 187 .Pp
 188 If you find any bugs, report them to tinc@tinc-vpn.org.
 189 .Sh TODO
 190 A lot, especially security auditing.
 191 .Sh SEE ALSO
 192 .Xr tinc 8 ,
 193 .Xr tinc.conf 5 ,
 194 .Pa https://www.tinc-vpn.org/ ,
 195 .Pa http://www.cabal.org/ .
 196 .Pp
 197 The full documentation for tinc is maintained as a Texinfo manual.
 198 If the info and tinc programs are properly installed at your site,
 199 the command
 200 .Ic info tinc
 201 should give you access to the complete manual.
 202 .Pp
 203 tinc comes with ABSOLUTELY NO WARRANTY.
 204 This is free software, and you are welcome to redistribute it under certain conditions;
 205 see the file COPYING for details.
 206 .Sh AUTHORS
 207 .An "Ivo Timmermans"
 208 .An "Guus Sliepen" Aq guus@tinc-vpn.org
 209 .Pp
 210 And thanks to many others for their contributions to tinc!