EasyTier

简体中文 | English

✨ A simple, secure, decentralized virtual private network solution powered by Rust and Tokio

📚 Full Documentation | 🖥️ Web Console | 📝 Download Releases | Nightly | 🧩 Third Party Tools | ❤️ Sponsor

Features

Core Features

• 🔒 Decentralized: Nodes are equal and independent, no centralized services required
• 🚀 Easy to Use: Multiple operation methods via web, client, and command line
• 🌍 Cross-Platform: Supports Win/MacOS/Linux/FreeBSD/Android and X86/ARM/MIPS architectures
• 🔐 Secure: AES-GCM or WireGuard encryption, prevents man-in-the-middle attacks

Advanced Capabilities

• 🔌 Efficient NAT Traversal: Supports UDP and IPv6 traversal, works with NAT4-NAT4 networks
• 🌐 Subnet Proxy: Nodes can share subnets for other nodes to access
• 🔄 Intelligent Routing: Latency priority and automatic route selection for best network experience
• ⚡ High Performance: Zero-copy throughout the entire link, supports TCP/UDP/WSS/WG protocols

Network Optimization

• 📊 UDP Loss Resistance: KCP/QUIC proxy optimizes latency and bandwidth in high packet loss environments
• 🔧 Web Management: Easy configuration and monitoring through web interface
• 🛠️ Zero Config: Simple deployment with statically linked executables

Quick Start

📥 Installation

Choose the installation method that best suits your needs:

Linux (Recommended):

curl -fsSL "https://github.com/EasyTier/EasyTier/blob/main/script/install.sh?raw=true" | sudo bash -s install

Homebrew (MacOS/Linux):

brew tap brewforge/chinese
brew install --cask easytier-gui

Windows (Recommended, run with administrator privileges):

irm "https://github.com/EasyTier/EasyTier/blob/main/script/install.ps1?raw=true" | iex

Install via cargo (Latest development version):

cargo install --git https://github.com/EasyTier/EasyTier.git easytier

Install prebuilt CLI tools with cargo-binstall (specify an existing release version):

cargo binstall --git https://github.com/EasyTier/EasyTier.git --version 2.6.4 easytier

This installs easytier-core and easytier-cli using the repository's metadata, independently of crates.io publication. On Windows, also copy the DLL and driver files from the matching release ZIP beside the installed binaries; binstall only installs executables.

Install pre-built binary (Recommended, All platforms supported)

For a smaller executable, try easytier-mini, which supports basic TCP/UDP networking. See its documentation for supported features and usage.

Install via Docker

Install OpenWrt ipk package

Additional steps:

One-Click Register Service (Automatically start when the system boots and run in the background)

🚀 Basic Usage

Quick Networking with Shared Nodes

EasyTier supports quick networking using shared public nodes. When you don't have a public IP, you can use the free shared nodes provided by the EasyTier community. Nodes will automatically attempt NAT traversal and establish P2P connections. When P2P fails, data will be relayed through shared nodes.

When using shared nodes, each node entering the network needs to provide the same --network-name and --network-secret parameters as the unique identifier of the network.

Taking two nodes as an example (Please use more complex network name to avoid conflicts):

1. Run on Node A:

# Run with administrator privileges
sudo easytier-core -d --network-name abc --network-secret abc -p tcp://<SharedNodeIP>:11010

2. Run on Node B:

# Run with administrator privileges
sudo easytier-core -d --network-name abc --network-secret abc -p tcp://<SharedNodeIP>:11010

After successful execution, you can check the network status using easytier-cli:

This is the beginning of the README. Read the rest at the original. Read the full README ↗