sys/man/8/tinc

   1 .TH TINC 8
   2 .SH NAME
   3 tinc - mesh peer to peer VPN
   4 .SH SYNOPSIS
   5 .B ip/tinc
   6 [
   7 .B -d
   8 ] [
   9 .B -p
  10 .I maxprocs
  11 ] [
  12 .B -x
  13 .I inside
  14 ] [
  15 .B -o
  16 .I outside
  17 ] [
  18 .B -c
  19 .I confdir
  20 ] [
  21 .B -n
  22 .I myname
  23 ]
  24 .I localip
  25 .I localmask
  26 [
  27 .I hosts...
  28 ]
  29 .SH DESCRIPTION
  30 Tinc implements the mesh peer to peer VPN protocol from
  31 .I https://www.tinc-vpn.org/
  32 as of version 1.0.32. Within a tinc VPN one can reach all
  33 the subnets of all hosts within the network even when not
  34 directly connected to the owning host of the subnet.
  35 .PP
  36 Each host that is directly connected to us has its own hostfile under
  37 .IR confdir /hosts/ hostname
  38 containing its public address, owned subnets, options and RSA public key.
  39 The hostfile format is the same as the original tinc implementation.
  40 The
  41 .I confdir
  42 is specified with the
  43 .B -c
  44 option or defaults to the current working directory.
  45 Other hosts might exist behind these directly connected nodes but
  46 this information is distributed automatically within the protocol.
  47 .PP
  48 On startup,
  49 .I tinc
  50 creates an ip interface with the address
  51 .I localip
  52 and network mask
  53 .I localmask
  54 on the
  55 .I inside
  56 ip stack (specified with
  57 .B -x
  58 option) and starts listening for incoming connections on the
  59 .I outside
  60 ip stack (specified with the
  61 .B -o
  62 option). When optional
  63 .I hosts
  64 are specified on the command line, then it will also do outgoing connections
  65 using the
  66 .I outside
  67 ip stack. The
  68 .I localmask
  69 usually is a supernet of all the subnets within the VPN. Our own hostname
  70 .I myhost
  71 can be specified with
  72 .B -n
  73 option or is assumed to be the
  74 .I sysname
  75 when not specified.
  76 This host's RSA private key needs to be present in factotum and tagged with
  77 .BR "service=tinc"
  78 and
  79 .BI "host=" myhost .
  80 .PP
  81 The options:
  82 .TP
  83 .B -d
  84 Enable debug output and do not fork to the background.
  85 .TP
  86 .B -p
  87 Limit the number of client processes (incoming and
  88 outgoing connections per protocol) to
  89 .IR  maxprocs .
  90 .TP
  91 .B -x
  92 Specifies the
  93 .I inside
  94 and
  95 .I outside
  96 network stack directory where the tinc ip interface is bound. Defaults to
  97 .BR /net .
  98 .TP
  99 .B -o
 100 Specifies the
 101 .I outside
 102 network stack directory where incoming and outgoing tinc connections
 103 are made. Defaults to
 104 .BR inside .
 105 .TP
 106 .B -c
 107 Specifies the configuration directory
 108 .I confdir
 109 for the VPN.
 110 .TP
 111 .B -n
 112 Sets our hostname to
 113 .IR myhost .
 114 .SH "SEE ALSO"
 115 .IR rsa (8),
 116 .IR ip (3)
 117 .br
 118 .I https://www.tinc-vpn.org/documentation/
 119 .SH SOURCE
 120 .B /sys/src/cmd/ip/tinc.c
 121 .SH HISTORY
 122 .I Tinc
 123 first appeared in 9front (October, 2017).