# Continuous Integration
-This directory contains scripts and other files used by the continuous integration system.
+This directory contains scripts and other files used by the continuous
+integration system.
You probably should not run them manually.
-
## Required
-Before you can start compiling tinc from a fresh git clone, you have
-to install the very latest versions of the following packages:
+Before you can start compiling tinc from a fresh git clone, you have to install
+the very latest versions of the following packages:
- `meson` or `muon` (read below)
- `ninja` or `samurai`
- `pkgconf` or `pkg-config`
-- `GCC` or `Clang` (any version with C11 support, although older versions might work)
-- `OpenSSL`\* (1.1.0+) or `LibreSSL` or `libgcrypt` (not needed if legacy protocol is disabled)
+- `GCC` or `Clang` (any version with C11 support, although older versions might
+ work)
+- `OpenSSL`\* (1.1.0+) or `LibreSSL` or `libgcrypt` (not needed if legacy
+ protocol is disabled)
### No Python?
-If you're on a constrained system that doesn't have (or cannot run) Python, you can try building tinc with [muon][muon],
-which is a pure C reimplementation of the same idea.
-Please note that `meson` is considered to be the main way of building tinc, and `muon` is supported on a best-effort basis.
+If you're on a constrained system that doesn't have (or cannot run) Python, you
+can try building tinc with [muon][muon], which is a pure C reimplementation of
+the same idea. Please note that `meson` is considered to be the main way of
+building tinc, and `muon` is supported on a best-effort basis.
[muon]: https://git.sr.ht/~lattis/muon
## Optional
-Plus a few optional dependencies. Support for them will be enabled if they're present:
+Plus a few optional dependencies. Support for them will be enabled if they're
+present:
- `ncurses` or `PDCurses`
- `readline`
- `LZO`\*
- `LZ4`\*
-If packages marked by `*` are not available, tinc will fall back to its own vendored copies.
-This behavior can be disabled by setting the appropriate meson option to `disabled`.
+If packages marked by `*` are not available, tinc will fall back to its own
+vendored copies. This behavior can be disabled by setting the appropriate meson
+option to `disabled`.
To build `info` documentation you'll also need these packages:
- `texinfo` or `makeinfo`
-You might also need some additional command-line utilities to be able to run the integration test suite:
+You might also need some additional command-line utilities to be able to run the
+integration test suite:
- `diffutils`
- `procps`
## Windows
-You can build tinc using either the native [Windows SDK][sdk-ms] (which comes with Visual Studio),
-or with the Unix-like [msys2 environment][sdk-msys2]. Install either one of them, plus
-the latest version of [meson][meson-release].
+You can build tinc using either the native [Windows SDK][sdk-ms] (which comes
+with Visual Studio), or with the Unix-like [msys2 environment][sdk-msys2].
+Install either one of them, plus the latest version of [meson][meson-release].
-If you prefer the native SDK, you might want to work on tinc (or build it) under Visual Studio.
-To do so, follow [these instructions][meson-vs].
+If you prefer the native SDK, you might want to work on tinc (or build it) under
+Visual Studio. To do so, follow [these instructions][meson-vs].
-By default, tinc produces a static Windows build, so you don't need to install anything
-in order to _run_ the compiled binaries.
+By default, tinc produces a static Windows build, so you don't need to install
+anything in order to _run_ the compiled binaries.
[sdk-ms]: https://visualstudio.com/
[sdk-msys2]: https://msys2.org/
### Setup
-Tinc's functionality can vary greatly depending on how you configure it.
-Have a look at the available options in [`meson_options.txt`](meson_options.txt), or run:
+Tinc's functionality can vary greatly depending on how you configure it. Have a
+look at the available options in [`meson_options.txt`](meson_options.txt), or
+run:
- $ meson configure
+```sh
+meson configure
+```
-First you need to create a build directory. If you want the default experience, run:
+First you need to create a build directory. If you want the default experience,
+run:
- $ meson setup builddir
+```sh
+meson setup builddir
+```
-or with configuration options (your shell can probably autocomplete them on `Tab`, try it):
+or with configuration options (your shell can probably autocomplete them on
+`Tab`, try it):
- $ meson setup builddir -Dprefix=/usr/local -Dbuildtype=release
+```sh
+meson setup builddir -Dprefix=/usr/local -Dbuildtype=release
+```
-(For autotools users: this is a rough equivalent of `autoreconf -fsi && ./configure --prefix=/usr/local --with-foobar`).
+(For autotools users: this is a rough equivalent of
+`autoreconf -fsi && ./configure --prefix=/usr/local --with-foobar`).
-This creates a build directory (named `builddir`) with build type set to `release`
-(which enables compiler optimizations) and path prefix set to `/usr/local`.
+This creates a build directory (named `builddir`) with build type set to
+`release` (which enables compiler optimizations) and path prefix set to
+`/usr/local`.
-Pass any additional options in the same way. Typically, this is not needed: tinc will
-autodetect available libraries and adjust its functionality accordingly.
+Pass any additional options in the same way. Typically, this is not needed: tinc
+will autodetect available libraries and adjust its functionality accordingly.
-If you'd like to reconfigure the project after running `setup`, you can either remove
-the build directory and start anew, or use:
+If you'd like to reconfigure the project after running `setup`, you can either
+remove the build directory and start anew, or use:
- $ meson configure builddir -Dlzo=disabled -Dlz4=enabled
+```sh
+meson configure builddir -Dlzo=disabled -Dlz4=enabled
+```
### Compile
You then need to build the project:
- $ meson compile -C builddir
+```sh
+meson compile -C builddir
+```
(For autotools users: this is an equivalent of `make -j$(nproc)`).
You might want to run the test suite to ensure tinc is working correctly:
- $ meson test -C builddir
+```sh
+meson test -C builddir
+```
(For autotools users: this is an equivalent of `make -j$(nproc) test`).
To install tinc to your system, run:
- $ meson install -C builddir
+```sh
+meson install -C builddir
+```
(For autotools users: this is an equivalent of `make install`).
-Please be aware that this is not the best method of installing software
-because it will not be tracked by your operating system's package manager. You
-should use packages provided by your operating system, or build your own
-(this is a large and complicated topic which is out of the scope of this document).
+Please be aware that this is not the best method of installing software because
+it will not be tracked by your operating system's package manager. You should
+use packages provided by your operating system, or build your own (this is a
+large and complicated topic which is out of the scope of this document).
### Uninstall
To uninstall tinc, run:
- # ninja -C builddir uninstall
+```sh
+ninja -C builddir uninstall
+```
(For autotools users: this is an equivalent of `make uninstall`).
### Linux to Linux
-Cross-compilation is easy to do on Debian or its derivatives.
-Set `$HOST` to your target architecture and install the cross-compilation toolchain and `-dev` versions of all libraries you'd like to link:
+Cross-compilation is easy to do on Debian or its derivatives. Set `$HOST` to
+your target architecture and install the cross-compilation toolchain and `-dev`
+versions of all libraries you'd like to link:
- $ HOST=armhf
- $ dpkg --add-architecture $HOST
- $ apt update
- $ apt install -y crossbuild-essential-$HOST zlib1g-dev:$HOST …
+```sh
+HOST=armhf
+dpkg --add-architecture $HOST
+apt update
+apt install -y crossbuild-essential-$HOST zlib1g-dev:$HOST …
+```
If you'd like to run tests on emulated hardware, install `qemu-user`:
- $ apt install -y qemu-user
- $ update-binfmts --enable
+```sh
+apt install -y qemu-user
+update-binfmts --enable
+```
-Set two environment variables: the C compiler, and pkg-config, and then proceed as usual:
+Set two environment variables: the C compiler, and pkg-config, and then proceed
+as usual:
- $ export CC=arm-linux-gnueabihf-gcc
- $ export PKG_CONFIG=arm-linux-gnueabihf-pkg-config
- $ meson setup build --cross-file /dev/null
+```sh
+export CC=arm-linux-gnueabihf-gcc
+export PKG_CONFIG=arm-linux-gnueabihf-pkg-config
+meson setup build --cross-file /dev/null
+```
-or put the names into a [cross file][cross] and pass it to meson:
+Or put the names into a [cross file][cross] and pass it to meson:
- $ cat >cross-armhf <<EOF
- [binaries]
- c = 'arm-linux-gnueabihf-gcc'
- pkgconfig = 'arm-linux-gnueabihf-pkg-config'
- EOF
+```sh
+cat >cross-armhf <<EOF
+[binaries]
+c = 'arm-linux-gnueabihf-gcc'
+pkgconfig = 'arm-linux-gnueabihf-pkg-config'
+EOF
- $ meson setup build --cross-file cross-armhf
+meson setup build --cross-file cross-armhf
+```
[cross]: https://mesonbuild.com/Cross-compilation.html
Install cross-compilation toolchain:
- $ apt install -y mingw-w64 mingw-w64-tools
+```sh
+apt install -y mingw-w64 mingw-w64-tools
+```
-tinc will use its own vendored libraries, so you don't need to install or build anything manually.
+tinc will use its own vendored libraries, so you don't need to install or build
+anything manually.
-Prepare the [cross file][cross] to let meson know you're building binaries for a different operating system.
-Take a look at the [file](.ci/cross/windows/amd64) used by CI for an example, or refer to examples provided
-by the meson project: [x86][mingw32], [x86_64][mingw64].
+Prepare the [cross file][cross] to let meson know you're building binaries for a
+different operating system. Take a look at the [file](.ci/cross/windows/amd64)
+used by CI for an example, or refer to examples provided by the meson project:
+[x86][mingw32],[x86_64][mingw64].
-Then build as usual. Because Windows binaries are built with static linkage by default,
-you might want to enable link-time optimization. It is much slower than building without LTO,
-but produces binaries that are 80%+ smaller:
+Then build as usual. Because Windows binaries are built with static linkage by
+default, you might want to enable link-time optimization. It is much slower than
+building without LTO, but produces binaries that are 80%+ smaller:
- $ meson setup build -Dbuildtype=release -Db_lto=true --cross-file cross-windows
- $ ninja -C build
+```sh
+meson setup build -Dbuildtype=release -Db_lto=true --cross-file cross-windows
+ninja -C build
+```
[mingw64]: https://github.com/mesonbuild/meson/blob/master/cross/linux-mingw-w64-64bit.txt
[mingw32]: https://github.com/mesonbuild/meson/blob/master/cross/linux-mingw-w64-32bit.txt
Then build as usual:
- $ export ANDROID_NDK_ROOT=/tmp/ndk/android-ndk-r24
- $ export PATH=$ANDROID_NDK_ROOT/toolchains/llvm/prebuilt/linux-x86_64/bin:$PATH
- $ meson setup android-aarch64 -Dcrypto=nolegacy --cross-file android
- $ ninja -C android-aarch64
+```sh
+export ANDROID_NDK_ROOT=/tmp/ndk/android-ndk-r24
+export PATH=$ANDROID_NDK_ROOT/toolchains/llvm/prebuilt/linux-x86_64/bin:$PATH
+meson setup android-aarch64 -Dcrypto=nolegacy --cross-file android
+ninja -C android-aarch64
+```
### macOS to iOS
-The same instructions should work for iOS.
-Refer to this [cross file][ios] for an example.
+The same instructions should work for iOS. Refer to this [cross file][ios] for
+an example.
[ios]: https://github.com/mesonbuild/meson/blob/master/cross/iphone.txt
- 10.0.0.0/8
- fd00::/8
-Make sure the [IP range](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
-you are choosing is large enough for all the nodes you want to add to the VPN,
-and also consider that some of these private address ranges might also be used
-on local area networks, so check in advance that you won't conflict with any
-range that is already in use by any of the participants. When in doubt, just
-pick one and try it out. For this quickstart guide, we will use 172.16.0.0/16
-as the range of the VPN.
+Make sure the [IP range](https://en.wikipedia.org/wiki/CIDR) you are choosing is
+large enough for all the nodes you want to add to the VPN, and also consider
+that some of these private address ranges might also be used on local area
+networks, so check in advance that you won't conflict with any range that is
+already in use by any of the participants. When in doubt, just pick one and try
+it out. For this quickstart guide, we will use 172.16.0.0/16 as the range of the
+VPN.
Also think of a name for your whole VPN. This will be used as the "netname"
parameter for tinc, and on Linux this will then also automatically be used as
contain letters, numbers and underscores. Apart from that you can choose
whatever you want. Now we can create the first node:
-```
+```sh
sudo tinc -n myvpn init first
```
This creates the initial configuration for the node, but has not started tinc
yet. Before we do that, two things have to be done first. We have to tell tinc
-which part of the IP range of the VPN belongs to *this* particular node. We
-will use 172.168.1.0/24 for this example. We then have to give this command:
+which part of the IP range of the VPN belongs to *this* particular node. We will
+use 172.168.1.0/24 for this example. We then have to give this command:
-```
+```sh
sudo tinc -n myvpn add Subnet 172.168.1.0/24
```
However, tinc itself will not actually configure the virtual network interface
-for you. You have to create a script named `tinc-up` that does this. To do
-this, run the command:
+for you. You have to create a script named `tinc-up` that does this. To do this,
+run the command:
-```
+```sh
sudo tinc -n myvpn edit tinc-up
```
-This should start an editor. When you ran the `init` command, a dummy script
-was already created. Edit it to make sure it looks like this:
+This should start an editor. When you ran the `init` command, a dummy script was
+already created. Edit it to make sure it looks like this:
-```
+```sh
#!/bin/sh
ifconfig $INTERFACE 172.168.1.1/16
```
Note that the literal text `$INTERFACE` should be in the script, tinc will make
sure that environment variable is set correctly when the script is run. The
-address should be that of the node itself, but the netmask or prefix length
-(the `/16` in this case) you provide must be that of the *whole* VPN. This
-tells the kernel that everything for the VPN's IP range should go to tinc's
-virtual network interface, from then on tinc will handle it and route it to the
-right node based on the `Subnet`s that you configured.
+address should be that of the node itself, but the netmask or prefix length (the
+`/16` in this case) you provide must be that of the *whole* VPN. This tells the
+kernel that everything for the VPN's IP range should go to tinc's virtual
+network interface, from then on tinc will handle it and route it to the right
+node based on the `Subnet`s that you configured.
To start tinc run:
-```
+```sh
sudo tinc -n myvpn start
```
This will start running tinc in the background. You can also run it in the
foreground with debugging enabled using this command:
-```
+```sh
sudo tinc -n myvpn start -d5 -D
```
One way to do it is to create a second node just like you created the first
node. Just make sure it has a different name (let's call it "second"), and that
-it gets a different IP range for itself (let's use 172.168.2.0/24). So on the second node run:
+it gets a different IP range for itself (let's use 172.168.2.0/24). So on the
+second node run:
-```
+```sh
sudo tinc -n myvpn init second
sudo tinc -n myvpn add Subnet 172.168.2.0/24
sudo tinc -n myvpn edit tinc-up
And make sure the second node's tinc up contains:
-```
+```sh
#!/bin/sh
ifconfig $INTERFACE 172.168.2.1/16
```
have a public IP address. Let's assume the first node has public IP address
93.184.216.34. You would then give this command on the first node:
-```
+```sh
sudo tinc -n myvpn add Address 93.184.216.34
```
Note that if you have a public domain name, you can also use that domain name
instead of a numeric IP address. Now run the following on the first node:
-```
+```sh
sudo tinc -n myvpn export
```
-This outputs a small amount of text that contains the node's public keys and
-the public address. On the second node, run this:
+This outputs a small amount of text that contains the node's public keys and the
+public address. On the second node, run this:
-```
+```sh
sudo tinc -n myvpn import
```
And copy&paste the output from the first node, then press ctrl-D on a new line.
-If done correctly it should tell you that it has imported the host
-configuration file. Now you have to do the same but in the other direction: use
-the `export` command on the second node, and then use `import` on the first
-node. Now that both nodes know each other, they should be able to connect. This
-should happen automatically after a while.
+If done correctly it should tell you that it has imported the host configuration
+file. Now you have to do the same but in the other direction: use the `export`
+command on the second node, and then use `import` on the first node. Now that
+both nodes know each other, they should be able to connect. This should happen
+automatically after a while.
Note that instead of copy&pasting the text manually, you could also redirect it
-to a text file, send it via email, pipe it through an SSH connection, or use
-any other way to exchange the host config files. For more information, see the
+to a text file, send it via email, pipe it through an SSH connection, or use any
+other way to exchange the host config files. For more information, see the
[manual](https://www.tinc-vpn.org/documentation-1.1/How-to-configure.html).
## Using invitations
Another way to add more nodes is to have an existing node generate an
-[invitation](https://www.tinc-vpn.org/documentation-1.1/Invitations.html)
-for another node. A prerequisite is that the node generating the invitation
-should have a public IP address to the invitee will be able to connect to it.
-Again, let's assume the first node has public IP address 93.184.216.34:
+[invitation](https://www.tinc-vpn.org/documentation-1.1/Invitations.html) for
+another node. A prerequisite is that the node generating the invitation should
+have a public IP address to the invitee will be able to connect to it. Again,
+let's assume the first node has public IP address 93.184.216.34:
-```
+```sh
sudo tinc -n myvpn add Address 93.184.216.34
```
Then on the first node, generate in invitation for the second node:
-```
+```sh
sudo tinc -n myvpn invite second
```
On the second node, don't using `init` to create the initial configuration.
Instead, run the following command:
-```
+```sh
sudo tinc -n myvpn join 93.184.216.34:655/R4BU9VMzdY4S_EIuAhW1-B0XV50HqooyEv6EUfl4k6Z9_zrq
```
asking tinc the status of a given node. So for example, on the first node, you
can run:
-```
+```sh
sudo tinc -n myvpn info second
```
You can also dump a list of connections:
-```
+```sh
sudo tinc -n myvpn dump connections
```
-Or `dump nodes` to get a list of known nodes, `dump subnets` to see all
-subnets. If you ran tinc in the background, you can get still get log output
-like so:
+Or `dump nodes` to get a list of known nodes, `dump subnets` to see all subnets.
+If you ran tinc in the background, you can get still get log output like so:
-```
+```sh
sudo tinc -n myvpn log 5
```
-Finally, if the problem is not with tinc, using `tcpdump` to look at the
-traffic on your real and virtual interfaces might help determine what the
-problem is.
+Finally, if the problem is not with tinc, using `tcpdump` to look at the traffic
+on your real and virtual interfaces might help determine what the problem is.
# About tinc
-Tinc is a peer-to-peer VPN daemon that supports VPNs with an arbitrary number
-of nodes. Instead of configuring tunnels, you give tinc the location and
-public key of a few nodes in the VPN. After making the initial connections to
-those nodes, tinc will learn about all other nodes on the VPN, and will make
-connections automatically. When direct connections are not possible, data will
-be forwarded by intermediate nodes.
+Tinc is a peer-to-peer VPN daemon that supports VPNs with an arbitrary number of
+nodes. Instead of configuring tunnels, you give tinc the location and public key
+of a few nodes in the VPN. After making the initial connections to those nodes,
+tinc will learn about all other nodes on the VPN, and will make connections
+automatically. When direct connections are not possible, data will be forwarded
+by intermediate nodes.
Tinc can operate in several routing modes. In the default mode, "router", every
node is associated with one or more IPv4 and/or IPv6 Subnets. The other two
Please note that this is NOT a stable release. Until version 1.1.0 is released,
please use one of the 1.0.x versions if you need a stable version of tinc.
-Although tinc 1.1 will be protocol compatible with tinc 1.0.x, the
-functionality of the tinc program may still change, and the control socket
-protocol is not fixed yet.
+Although tinc 1.1 will be protocol compatible with tinc 1.0.x, the functionality
+of the tinc program may still change, and the control socket protocol is not
+fixed yet.
# Documentation
-See [QUICKSTART.md](QUICKSTART.md) for a quick guide to get tinc up and
-running. Read the [manual](https://www.tinc-vpn.org/documentation-1.1/) for
-more detailed information.
+See [QUICKSTART.md](QUICKSTART.md) for a quick guide to get tinc up and running.
+Read the [manual](https://www.tinc-vpn.org/documentation-1.1/) for more detailed
+information.
# Getting tinc
- [latest release](https://github.com/gsliepen/tinc/releases/latest)
Note that these packages have not been heavily tested and are not officially
-supported by the project. Use them at your own risk. You are advised to use
-tinc shipped by your distribution, or build from source.
+supported by the project. Use them at your own risk. You are advised to use tinc
+shipped by your distribution, or build from source.
## Build it from source
# Copyright
-tinc is Copyright © 1998-2022 Ivo Timmermans, Guus Sliepen <guus@tinc-vpn.org>, and others.
+tinc is Copyright © 1998-2022 Ivo Timmermans, Guus Sliepen <guus@tinc-vpn.org>,
+and others.
For a complete list of authors see the [AUTHORS](AUTHORS) file.
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or (at
-your option) any later version. See the file COPYING for more details.
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version. See the file COPYING for more details.
Currently we support the 1.0.x and 1.1.x branches of tinc.
-| Version | Supported |
-| ------- | ---------- |
-| 1.1.x | yes |
-| 1.0.x | yes |
+| Version | Supported |
+|---------|-----------|
+| 1.1.x | yes |
+| 1.0.x | yes |
projects / tinc / commitdiff