zhangyang-zerotierone/doc/MANUAL.md

ZeroTier Planetary Switch Users Guide

This manual describes the design and operation of ZeroTier and its associated services, apps, and libraries. Its intended audience includes IT professionals, network administrators, information security experts, and developers.

ZeroTier Central, our enterprise web UI, has its own documentation that can be accessed through its interface. The high level ZeroTier rule description language used in Central also has its own documentation. This guide describes the core ZeroTier engine as deployed at endpoints as well as the deployment and operation of network controllers themselves.

Table of Contents

1. Introduction
2. How it Works
   1. VL1: The ZeroTier Peer to Peer Network
      1. ZeroTier Addressing System
      2. Encryption and Authentication
      3. Trust Relationships
      4. Global Roots and WAN Peer Discovery
      5. Direct vs. Relayed Communication
      6. LAN Peer Discovery
      7. Federated Roots ("Moons")
      8. Trusted Paths for Fast Local SDN
      9. Troubleshooting Connectivity Problems
   2. VL2: The Ethernet Virtualization Layer
      1. Networks Identifiers and Controllers
      2. Multicast
      3. Ethernet Bridging
      4. Certificates of Membership
      5. Revocations and Fast Propagation
      6. Rules Engine
      7. Capabilities
      8. Tags
3. ZeroTier One: The Network Virtualization Service
   1. Installation and Operation
      1. Joining and Leaving Networks
      2. Listing VL1 Peers for Network Troubleshooting
      3. Joining Federated Roots ("Orbiting Moons")
   2. Communicating With the Service
   3. Operating a Network Controller
      1. Controller Configuration
      2. High Availability
      3. Security Considerations
   4. Mobile Apps
   5. Advanced Topics
      1. Static Paths and Interface Exclusion
      2. Defining Trusted Paths
      3. Allowing Remote Administrative Requests
      4. Creating Federated Roots ("Moons")
      5. Clustering and Geo-Optimized Routing
4. Common Use Cases
   1. SDN and General Network Virtualization
   2. Replacing Conventional VPNs for Remote Access
      1. Layer 2 Bridge Deployment Strategy
      2. Layer 3 Router Deployment Strategy
      3. Full Tunnel / Default Gateway Override
   3. Multi-Site and Hybrid Cloud Backplane
      1. Configuring for Specific Cloud Providers
         1. Amazon
         2. Microsoft Azure
         3. Google Cloud
         4. Digital Ocean, Vultr, Linode, OVH, etc.
   4. SD-WAN for Site-to-Site Connectivity
      1. Layer 2 Bridge Deployment Strategy
      2. Layer 3 Router Deployment Strategy
   5. Deivce (IoT) and Application Peer-to-Peer Networking
      1. Running ZeroTier One in Containers and Virtual Appliances
      2. ZeroTier One on Linux or BSD Powered IoT Devices
5. For Developers: Connecting IoT Devices and Apps
   1. ZeroTier SDK for Apps
   2. ZeroTier Core
      1. Code Layout and Design
      2. Building and Using
6. Licensing

---

1. Introduction