www.tinc-vpn.org Git - tinc/blob - README.md

   1 # About tinc
   2
   3 Tinc is a peer-to-peer VPN daemon that supports VPNs with an arbitrary number of
   4 nodes. Instead of configuring tunnels, you give tinc the location and public key
   5 of a few nodes in the VPN. After making the initial connections to those nodes,
   6 tinc will learn about all other nodes on the VPN, and will make connections
   7 automatically. When direct connections are not possible, data will be forwarded
   8 by intermediate nodes.
   9
  10 Tinc can operate in several routing modes. In the default mode, "router", every
  11 node is associated with one or more IPv4 and/or IPv6 Subnets. The other two
  12 modes, "switch" and "hub", let the tinc daemons work together to form a virtual
  13 Ethernet network switch or hub.
  14
  15 ## This is a pre-release
  16
  17 Please note that this is NOT a stable release. Until version 1.1.0 is released,
  18 please use one of the 1.0.x versions if you need a stable version of tinc.
  19
  20 Although tinc 1.1 will be protocol compatible with tinc 1.0.x, the functionality
  21 of the tinc program may still change, and the control socket protocol is not
  22 fixed yet.
  23
  24 # Documentation
  25
  26 See [QUICKSTART.md](QUICKSTART.md) for a quick guide to get tinc up and running.
  27 Read the [manual](https://www.tinc-vpn.org/documentation-1.1/) for more detailed
  28 information.
  29
  30 # Getting tinc
  31
  32 ## From your distribution
  33
  34 Many operating system distributions have packaged tinc. Check your package
  35 manager first.
  36
  37 ## Nightly builds
  38
  39 You can download pre-built binary packages for multiple Linux distributions and
  40 Windows here:
  41
  42 - [development version](https://github.com/gsliepen/tinc/releases/tag/latest)
  43 - [latest release](https://github.com/gsliepen/tinc/releases/latest)
  44
  45 Note that these packages have not been heavily tested and are not officially
  46 supported by the project. Use them at your own risk. You are advised to use tinc
  47 shipped by your distribution, or build from source.
  48
  49 ## Build it from source
  50
  51 See the file [INSTALL.md](INSTALL.md) for instructions of how to build and
  52 install tinc from source.
  53
  54 # Copyright
  55
  56 tinc is Copyright © 1998-2022 Ivo Timmermans, Guus Sliepen <guus@tinc-vpn.org>,
  57 and others.
  58
  59 For a complete list of authors see the [AUTHORS](AUTHORS) file.
  60
  61 This program is free software; you can redistribute it and/or modify it under
  62 the terms of the GNU General Public License as published by the Free Software
  63 Foundation; either version 2 of the License, or (at your option) any later
  64 version. See the file COPYING for more details.