A Smart Ethernet Switch for Earth

zerotier.com

#network #mesh #nebula #tailscale #softnetwork #vpn #cpp

Sean OMeara a558bd9312 cache cago on github actions (#1819) 2 rokov pred
.github a558bd9312 cache cago on github actions (#1819) 2 rokov pred
artwork 298e1d5a74 Added 90x90 AppIcon 6 rokov pred
attic 01bf3b8245 1.8.1 merge of changes in master 3 rokov pred
ci 85da0b419c drone config 2 rokov pred
controller 98e0bf22d3 fix actual typo in config key code 2 rokov pred
debian 99c0ca621b 1.10.2 bump 2 rokov pred
doc 1e2ff042b4 fix typos in docs, comments, and strings 2 rokov pred
ext ad54d0ed52 1.10.2 bump in Advanced Installer 2 rokov pred
include 5b5f9a069a fix typos 2 rokov pred
java 065f42af1d Merge pull request #1807 from zerotier/cleanup/typos 2 rokov pred
node 5b5f9a069a fix typos 2 rokov pred
osdep 10170b41c3 Revert "Improve default route on macOS (#1680)" 2 rokov pred
pkg 98b190c626 Minor adjustment to packaging README 2 rokov pred
rule-compiler 06730c7d1d BSL date bump 5 rokov pred
service 5b5f9a069a fix typos 2 rokov pred
tcp-proxy b8eb9196e8 update tcp-relay README 2 rokov pred
windows 378e4ea34e Fix service installation MAX_PATH bug on Windows 3 rokov pred
zeroidc 9826c20d1a set zeroidc.running = false on token exchange error 2 rokov pred
.clang-format 63fd2cbaeb Add ZeroTier standard .clang-format -- Keeping tabs for 1.X line. Mostly based on LLVM format. 4 rokov pred
.dockerignore c9f942f79b can now build centos8 docker container with Redis support 5 rokov pred
.drone.jsonnet 85da0b419c drone config 2 rokov pred
.drone.yml 85da0b419c drone config 2 rokov pred
.gitattributes 6cfdd5b2c1 force eol=crlf for driver .inf files 4 rokov pred
.gitignore db1df58955 resurrect tcp proxy 2 rokov pred
AUTHORS.md 52a166a71f Relicense: GPLv3 -> ZeroTier BSL 1.1 6 rokov pred
CMakeLists.txt 12c621c230 Removed build flag in CMake script 7 rokov pred
COPYING 52a166a71f Relicense: GPLv3 -> ZeroTier BSL 1.1 6 rokov pred
Dockerfile.ci a9942ca412 more RELEASE-NOTES 4 rokov pred
Dockerfile.release 58e19e86f4 update dockerfile.release 3 rokov pred
LICENSE.txt 06730c7d1d BSL date bump 5 rokov pred
Makefile 127c19fecd betterized rpm spec and ci scripts 3 rokov pred
OFFICIAL-RELEASE-STEPS.md 2d8a54f05d Version bump -- still pre1.8 4 rokov pred
README.docker.md 788296ea29 Expand links in a few spots since this'll be used in the docker image 4 rokov pred
README.md 0d9d3a90de Revise README. 3 rokov pred
RELEASE-NOTES.md 5b5f9a069a fix typos 2 rokov pred
cycle_controllers.sh 0da2efa633 add application_name to pgbouncer connectio string 6 rokov pred
entrypoint.sh.release 8598f34ebf prettify the entrypoint log output 3 rokov pred
make-bsd.mk 2f5dc10399 Fix syntax error (#1806) 2 rokov pred
make-linux.mk 668ab8b85c fixing Makefile for armv6k (#1790) 2 rokov pred
make-mac.mk c4df88354b updates for macOS for inja support 3 rokov pred
make-netbsd.mk 18c9dc8a06 fix RTF_MULTICAST and g++ -w 8 rokov pred
objects.mk e1af003e4f Consolidation of multipath logic. Better system separation 4 rokov pred
one.cpp e1f60e3f83 Behavioral changes to multipath balance modes (See: #1745 and #1753) 2 rokov pred
selftest.cpp 5b5f9a069a fix typos 2 rokov pred
update_controllers.sh 3d21f0a91f update docker registry used 6 rokov pred
version.h 99c0ca621b 1.10.2 bump 2 rokov pred
windows-clean.bat 38058450ce Revise Windows build to VS2022. 3 rokov pred
zerotier-cli-completion.bash c92e030a4b Create a bash completion script. 5 rokov pred
zerotier-one.spec 99c0ca621b 1.10.2 bump 2 rokov pred

README.docker.md

ZeroTier One in a container!

NOTE: Most of this information pertains to the docker image only. For more information about ZeroTier, check out the repository: here or the commercial website.

ZeroTier is a smart programmable Ethernet switch for planet Earth. It allows all networked devices, VMs, containers, and applications to communicate as if they all reside in the same physical data center or cloud region.

This is accomplished by combining a cryptographically addressed and secure peer to peer network (termed VL1) with an Ethernet emulation layer somewhat similar to VXLAN (termed VL2). Our VL2 Ethernet virtualization layer includes advanced enterprise SDN features like fine grained access control rules for network micro-segmentation and security monitoring.

All ZeroTier traffic is encrypted end-to-end using secret keys that only you control. Most traffic flows peer to peer, though we offer free (but slow) relaying for users who cannot establish peer to peer connections.

The goals and design principles of ZeroTier are inspired by among other things the original Google BeyondCorp paper and the Jericho Forum with its notion of "deperimeterization."

Visit ZeroTier's site for more information and pre-built binary packages. Apps for Android and iOS are available for free in the Google Play and Apple app stores.

ZeroTier is licensed under the BSL version 1.1. See LICENSE.txt and the ZeroTier pricing page for details. ZeroTier is free to use internally in businesses and academic institutions and for non-commercial purposes. Certain types of commercial use such as building closed-source apps and devices based on ZeroTier or offering ZeroTier network controllers and network management as a SaaS service require a commercial license.

A small amount of third party code is also included in ZeroTier and is not subject to our BSL license. See AUTHORS.md for a list of third party code, where it is included, and the licenses that apply to it. All of the third party code in ZeroTier is liberally licensed (MIT, BSD, Apache, public domain, etc.).

Building the docker image

Due to the network being a substrate for most applications and not an application unto itself, it makes sense that many people would want to build their own image based on our formula.

The image is based on debian:buster.

The Dockerfile.release file contains build instructions for building the described image in the rest of the README. The build is multi-arch and multi-release capable.

These build arguments power the build:

  • PACKAGE_BASEURL: The base URL of the package repository to fetch from. (default: https://download.zerotier.com/debian/buster/pool/main/z/zerotier-one/)
  • ARCH: The architecture of the package, in debian format. Must match your image arch. (default: amd64)
  • VERSION: REQUIRED the version of ZeroTier to fetch.

You can build this image like so:

docker build -f Dockerfile.release -t mybuild --build-arg VERSION=1.6.5 .

Using the docker image

The entrypoint.sh in the docker image is a little different; zerotier will be spawned in the background and the "main process" is actually just a sleeping shell script. This allows zerotier-one to gracefully terminate in some situations largely unique to docker.

The zerotier/zerotier image requires the CAP_NET_ADMIN capability and the /dev/net/tun device must be forwarded to it.

To join a network, simply supply it on the command-line; you can supply multiple networks.

docker run --name myzerotier --rm --cap-add NET_ADMIN --device /dev/net/tun zerotier/zerotier:latest abcdefdeadbeef00

Once joining all the networks you have provided, it will sleep until terminated. Note that in ZeroTier, joining a network does not necessarily mean you have an IP or can do anything, really. You will want to probe the control socket:

docker exec myzerotier zerotier-cli listnetworks

To ensure you have a network available before trying to listen on it. Without pre-configuring the identity, this usually means going to the central admin panel and clicking the checkmark against your zerotier identity.

Environment Variables

You can control a few settings including the identity used and the authtoken used to interact with the control socket (which you can forward and access through localhost:9993).

  • ZEROTIER_API_SECRET: replaces the authtoken.secret before booting and allows you to manage the control socket's authentication key.
  • ZEROTIER_IDENTITY_PUBLIC: the identity.public file for zerotier-one. Use zerotier-idtool to generate one of these for you.
  • ZEROTIER_IDENTITY_SECRET: the identity.secret file for zerotier-one. Use zerotier-idtool to generate one of these for you.

Tips

  • Forwarding port <dockerip>:9993 to somewhere outside is probably a good idea for highly trafficked services.
  • Forwarding localhost:9993 to a control network where you can drive it remotely might be a good idea, just be sure to set your authtoken properly through environment variables.
  • Pre-generating your identities could be much simpler to do via our terraform plugin