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