fanyang89
714897b0fd
Refocus the repository homepage on visuals, quick start guidance, and documentation links so new users can understand EasyTier faster. Align the English and Chinese READMEs with the global and mainland documentation entry points.
6.1 KiB
EasyTier
✨ A simple, secure, decentralized SD-WAN solution powered by Rust and Tokio
🌐 Official Website | 📚 Documentation | 🚀 Get Started | 📝 Download Releases | 🇨🇳 China Site | ❤️ Sponsor
Get Started
Install
Linux:
curl -fsSL "https://github.com/EasyTier/EasyTier/blob/main/script/install.sh?raw=true" | sudo bash -s install
Windows (run with administrator privileges):
irm "https://github.com/EasyTier/EasyTier/blob/main/script/install.ps1?raw=true" | iex
Homebrew (macOS/Linux):
brew tap brewforge/chinese
brew install --cask easytier-gui
Install from source (latest development version):
cargo install --git https://github.com/EasyTier/EasyTier.git easytier
More installation options:
- CLI installation guide
- GUI installation guide
- Pre-built binaries
- OpenWrt package
- One-click register service
Quick Example
Join the same network from multiple nodes with a shared public node:
# Node A
sudo easytier-core -d --network-name demo --network-secret demo -p tcp://<SharedNodeIP>:11010
# Node B
sudo easytier-core -d --network-name demo --network-secret demo -p tcp://<SharedNodeIP>:11010
Use the same --network-name and --network-secret on every node to join the same network. After startup, check peers with easytier-cli peer, easytier-cli route, or easytier-cli node.
Why EasyTier
- 🔒 Decentralized: Nodes are equal and independent, with no centralized controller required.
- 🚀 Easy to Use: Use EasyTier from the web console, GUI clients, or the command line.
- 🌍 Cross-Platform: Supports Windows, macOS, Linux, FreeBSD, Android, and multiple CPU architectures.
- 🔐 Secure: Protects traffic with AES-GCM or WireGuard encryption.
- 🔌 Efficient NAT Traversal: Supports UDP and IPv6 traversal, including NAT4-to-NAT4 scenarios.
- 🌐 Subnet Proxy: Share private subnets with other nodes in the virtual network.
- 🔄 Intelligent Routing: Chooses lower-latency paths automatically for a better network experience.
- ⚡ High Performance: Uses zero-copy data paths and supports TCP, UDP, WS, WSS, WG, QUIC, and more.
Learn More
- Introduction
- Command line networking
- Decentralized networking
- Networking with web console
- WireGuard client access
- Subnet proxy (point-to-network)
- Bandwidth and latency optimization
- Hosting public shared nodes
- Third-party graphical interfaces
Community
- 💬 Telegram Group
- 👥 QQ Groups: No.1 949700262, No.2 837676408, No.3 957189589
License
EasyTier is released under the LGPL-3.0.
Sponsor
CDN acceleration and security protection for this project are sponsored by Tencent EdgeOne.
Special thanks to Langlang Cloud and RainCloud for sponsoring our public servers.
If you find EasyTier helpful, please consider sponsoring us. Software development and maintenance require time and effort, and your sponsorship helps us keep improving EasyTier.
