From 819fecec5b68a64a17389d0b4ce2c4de5b0553a5 Mon Sep 17 00:00:00 2001 From: fanyang Date: Sun, 14 Jun 2026 14:33:42 +0800 Subject: [PATCH 1/4] docs: format markdown with flowmark --- en/guide/contact.md | 6 +- en/guide/gui/astral-game.md | 26 +++-- en/guide/gui/basic.md | 8 +- en/guide/gui/easytier-game.md | 46 +++++--- en/guide/gui/easytier-manager.md | 48 +++++--- en/guide/gui/index.md | 6 +- en/guide/gui/qteasytier.md | 64 ++++++---- en/guide/gui/subnet_proxy.md | 12 +- en/guide/gui/vpn_portal.md | 8 +- en/guide/license.md | 3 +- en/guide/network/host-public-server.md | 38 ++++-- .../network/install-as-a-systemd-service.md | 12 +- en/guide/network/no-root.md | 11 +- en/guide/network/socks5.md | 9 +- en/guide/perf.md | 54 +++++---- en/guide/privacy.md | 110 +++++++++++++++--- guide/gui/astral-game.md | 18 +-- guide/gui/easytier-game.md | 13 +-- guide/gui/easytier-manager.md | 5 +- guide/gui/qteasytier.md | 26 +++-- guide/gui/subnet_proxy.md | 3 +- guide/network/install-as-a-macos-service.md | 1 - guide/network/install-as-a-systemd-service.md | 2 +- guide/network/install-as-a-windows-service.md | 2 + guide/network/no-root.md | 3 +- guide/network/socks5.md | 3 +- guide/perf.md | 49 ++++---- guide/privacy.md | 26 +++-- 28 files changed, 411 insertions(+), 201 deletions(-) diff --git a/en/guide/contact.md b/en/guide/contact.md index 14dc2ac6..80d638d7 100644 --- a/en/guide/contact.md +++ b/en/guide/contact.md @@ -1,6 +1,8 @@ # Contact Information -- Ask questions or report issues: [GitHub Issues](https://github.com/EasyTier/EasyTier/issues) -- Discussion and communication: [GitHub Discussions](https://github.com/EasyTier/EasyTier/discussions) +- Ask questions or report issues: + [GitHub Issues](https://github.com/EasyTier/EasyTier/issues) +- Discussion and communication: + [GitHub Discussions](https://github.com/EasyTier/EasyTier/discussions) - QQ Group: [949700262](https://qm.qq.com/q/LDxBN5L3kA) - Telegram: https://t.me/easytier diff --git a/en/guide/gui/astral-game.md b/en/guide/gui/astral-game.md index f859207f..d6ca1ee8 100644 --- a/en/guide/gui/astral-game.md +++ b/en/guide/gui/astral-game.md @@ -4,26 +4,32 @@ [![AstralGame](https://img.shields.io/badge/wiki-AstralGame-blue)](https://astral.fan/) ## Preview -![manage-step1](/assets/AstralET1.png) -![manage-step1](/assets/AstralET2.png) -![manage-step1](/assets/AstralET3.png) -![manage-step1](/assets/AstralET4.png) + +![manage-step1](/assets/AstralET1.png) ![manage-step1](/assets/AstralET2.png) +![manage-step1](/assets/AstralET3.png) ![manage-step1](/assets/AstralET4.png) ![manage-step1](/assets/AstralET5.png) ## Usage Tutorial + - https://astral.fan/quick-start/what-is-astral/ ## Introduction -AstralGame is a lightweight game networking tool developed based on **Flutter** and **EasyTier**, designed to provide players with a simple and efficient online gaming experience. +AstralGame is a lightweight game networking tool developed based on **Flutter** and +**EasyTier**, designed to provide players with a simple and efficient online gaming +experience. ## Features -- **Built-in EasyTier**: Directly integrates EasyTier into AstralGame, eliminating the need for additional installations and leaving no background processes. -- **Plug-and-Play**: Launch the app when connecting, close it when done—simple and convenient. -- **Actively Maintained**: Regular updates ensure quick issue resolution and continuous feature optimization (a productivity boost during work breaks). +- **Built-in EasyTier**: Directly integrates EasyTier into AstralGame, eliminating the + need for additional installations and leaving no background processes. +- **Plug-and-Play**: Launch the app when connecting, close it when done—simple and + convenient. +- **Actively Maintained**: Regular updates ensure quick issue resolution and continuous + feature optimization (a productivity boost during work breaks). ## Contact & Support -- **QQ Group**: [Join Our QQ Community](https://qm.qq.com/q/r4VsExDDt6) -- **GitHub Issues**: [Report Bugs or Suggest Features](https://github.com/ldoubil/astral/issues) \ No newline at end of file +- **QQ Group**: [Join Our QQ Community](https://qm.qq.com/q/r4VsExDDt6) +- **GitHub Issues**: + [Report Bugs or Suggest Features](https://github.com/ldoubil/astral/issues) diff --git a/en/guide/gui/basic.md b/en/guide/gui/basic.md index 890e5cc5..b3360eed 100644 --- a/en/guide/gui/basic.md +++ b/en/guide/gui/basic.md @@ -1,9 +1,13 @@ # Quick Networking -The configuration method is shown in the figure. EasyTier nodes do not distinguish between server and client. As long as the nodes can directly connect to each other or connect through an initial node (similar to plugging in a network cable), they can join the network. +The configuration method is shown in the figure. +EasyTier nodes do not distinguish between server and client. +As long as the nodes can directly connect to each other or connect through an initial +node (similar to plugging in a network cable), they can join the network. ![Configuration Interface](/assets/cn/config.png) -After the configuration is complete, click the Run Network button. The interface after the network runs successfully is shown in the figure. +After the configuration is complete, click the Run Network button. +The interface after the network runs successfully is shown in the figure. ![Running](/assets/cn/running.png) diff --git a/en/guide/gui/easytier-game.md b/en/guide/gui/easytier-game.md index 33c46349..d45e45da 100644 --- a/en/guide/gui/easytier-game.md +++ b/en/guide/gui/easytier-game.md @@ -2,40 +2,56 @@ ## Introduction -EasyTier Game Launcher is developed with `nuxt3`, `typescript`, `rust`, and `tauri`. It has a simple interface and comes with the latest EasyTier core. When playing multiplayer games, it provides the most comfortable experience both psychologically and practically. It also supports custom configuration file startup to meet various needs. +EasyTier Game Launcher is developed with `nuxt3`, `typescript`, `rust`, and `tauri`. It +has a simple interface and comes with the latest EasyTier core. +When playing multiplayer games, it provides the most comfortable experience both +psychologically and practically. +It also supports custom configuration file startup to meet various needs. ## Download -GitHub Releases: [https://github.com/EasyTier/EasytierGame/releases](https://github.com/EasyTier/EasytierGame/releases) +GitHub Releases: https://github.com/EasyTier/EasytierGame/releases -- Only green zip packages are available. Personally, I don't like installers that write to the registry. Just extract and use, keeping the directory clean and tidy. +- Only green zip packages are available. + Personally, I don’t like installers that write to the registry. + Just extract and use, keeping the directory clean and tidy. ![game-step1](/assets/game-step1.png) ## Tutorial -- For the first use, enter a "hostname" and click to start the connection. Later, you can create your own server or use servers provided by kind community members. - ![game-step2](/assets/game-step2.png) +- For the first use, enter a “hostname” and click to start the connection. + Later, you can create your own server or use servers provided by kind community + members. ![game-step2](/assets/game-step2.png) ![game-step3](/assets/game-step3.png) -- There are some special configurations in the advanced options that you can choose from. - ![game-step4](/assets/game-step4.png) +- There are some special configurations in the advanced options that you can choose + from. ![game-step4](/assets/game-step4.png) -- If your needs are still not met, you can use a configuration file to start. For details on how to configure, refer to the documentation [Configuration File](/guide/network/config-file.html). +- If your needs are still not met, you can use a configuration file to start. + For details on how to configure, refer to the documentation + [Configuration File](/guide/network/config-file.html). ![game-step5](/assets/game-step5.png) -- After upgrading the EasyTier core, you can click the update plugin button to update. However, you need to use a VPN. If you cannot update, you can get the update from the community. - ![game-step6](/assets/game-step6.png) +- After upgrading the EasyTier core, you can click the update plugin button to update. + However, you need to use a VPN. If you cannot update, you can get the update from the + community. ![game-step6](/assets/game-step6.png) ## Features - Developed based on the EasyTier networking tool with a clear and simple interface. -- Built-in "Update" button. When the EasyTier networking tool releases a new version, just click update (requires VPN). -- For the first use, enter a "hostname" and click to start the connection. Later, you can create your own server or use community servers. -- Simple configuration with advanced features, also supports custom configuration file startup. -- **WinIPBroadcast** is enabled by default, no longer afraid of not finding rooms when connecting (e.g., Borderlands 3). -- Tested with **Elden Ring learning version**, **Borderlands 3**, **Deep Rock Galactic**, **Monster Hunter World**, etc., all can be played stably. +- Built-in “Update” button. + When the EasyTier networking tool releases a new version, just click update (requires + VPN). +- For the first use, enter a “hostname” and click to start the connection. + Later, you can create your own server or use community servers. +- Simple configuration with advanced features, also supports custom configuration file + startup. +- **WinIPBroadcast** is enabled by default, no longer afraid of not finding rooms when + connecting (e.g., Borderlands 3). +- Tested with **Elden Ring learning version**, **Borderlands 3**, **Deep Rock + Galactic**, **Monster Hunter World**, etc., all can be played stably. ## System Support diff --git a/en/guide/gui/easytier-manager.md b/en/guide/gui/easytier-manager.md index 46751024..75f88fea 100644 --- a/en/guide/gui/easytier-manager.md +++ b/en/guide/gui/easytier-manager.md @@ -2,13 +2,14 @@ ## Download -GitHub Releases: [https://github.com/xlc520/easytier-manager/releases](https://github.com/xlc520/easytier-manager/releases) +GitHub Releases: https://github.com/xlc520/easytier-manager/releases #### Package Descriptions - `exe`: Installer, must be installed before use - `zip`: Portable, extract and use directly -- `easytier-manager-win_2.0.0.exe`: Universal installer for 64-bit and 32-bit Windows systems +- `easytier-manager-win_2.0.0.exe`: Universal installer for 64-bit and 32-bit Windows + systems - `easytier-manager-win-x64_2.0.0.exe`: 64-bit Windows system installer - `easytier-manager-win-ia32_2.0.0.exe`: 32-bit Windows system installer - `easytier-manager-win7-x64_2.0.0.exe`: 64-bit Windows 7 system installer @@ -16,13 +17,16 @@ GitHub Releases: [https://github.com/xlc520/easytier-manager/releases](https://g ## Tutorial -- **1. [Important] Settings page: Check if the kernel exists, if not, download the kernel, then install it, and check again if the kernel exists** (only needed for first use, subsequent confirmations can run directly) +- **1. [Important] Settings page: Check if the kernel exists, if not, download the + kernel, then install it, and check again if the kernel exists** (only needed for first + use, subsequent confirmations can run directly) ![manage-step1](/assets/manage-step1.png) ![manage-step2](/assets/manage-step2.png) -- 2. Configuration page: Create new network configurations, providing both direct code editing and form filling methods +- 2. Configuration page: Create new network configurations, providing both direct code + editing and form filling methods ![manage-step3](/assets/manage-step3.png) @@ -36,9 +40,12 @@ GitHub Releases: [https://github.com/xlc520/easytier-manager/releases](https://g ![manage-step7](/assets/manage-step7.png) -- 4. [Optional] After successful networking, if the connection is fine, you can exit the manager. The core program will run in the background (right-click the tray icon to "Exit") +- 4. [Optional] After successful networking, if the connection is fine, you can exit the + manager. The core program will run in the background (right-click the tray icon to + “Exit”) -- 5. [Optional] On the configuration page, install specified configurations as system services +- 5. [Optional] On the configuration page, install specified configurations as system + services ![manage-step8](/assets/manage-step8.png) @@ -46,25 +53,36 @@ GitHub Releases: [https://github.com/xlc520/easytier-manager/releases](https://g ## Introduction -EasyTier Manager integrates Vue3 + Vite5 + Electron33 + Element-Plus. It is a free and open-source network manager based on `element-plus`. It is developed using the latest mainstream technologies such as `vue3`, `vite5`, `TypeScript`, etc. +EasyTier Manager integrates Vue3 + Vite5 + Electron33 + Element-Plus. +It is a free and open-source network manager based on `element-plus`. It is developed +using the latest mainstream technologies such as `vue3`, `vite5`, `TypeScript`, etc. ## Features -- **Memory Usage**: After successful networking, you can directly exit the manager without affecting the network, so it won't occupy memory or cause memory leaks due to various issues -- **Multi-Configuration Startup**: Supports running and managing multiple network configurations -- **System Service Installation**: One-click installation as a system service with visual interface, auto-start on boot -- **Visual Configuration Addition**: Provides form-based visual addition of network configurations, simple and convenient +- **Memory Usage**: After successful networking, you can directly exit the manager + without affecting the network, so it won’t occupy memory or cause memory leaks due to + various issues +- **Multi-Configuration Startup**: Supports running and managing multiple network + configurations +- **System Service Installation**: One-click installation as a system service with + visual interface, auto-start on boot +- **Visual Configuration Addition**: Provides form-based visual addition of network + configurations, simple and convenient - **Visual Log Viewing**: View logs of current network configurations on the home page -- **One-Click Download and Install**: One-click download and installation of the kernel with built-in accelerated sources, no manual download required -- **Latest Tech Stack**: Developed using cutting-edge frontend technologies like Electron33/Vue3/vite5 +- **One-Click Download and Install**: One-click download and installation of the kernel + with built-in accelerated sources, no manual download required +- **Latest Tech Stack**: Developed using cutting-edge frontend technologies like + Electron33/Vue3/vite5 - **TypeScript**: Application-level JavaScript language - **Internationalization**: Built-in comprehensive internationalization solution ## Bug Reports & Suggestions -> Tending towards stability, may not develop new features, only fix vulnerabilities and such +> Tending towards stability, may not develop new features, only fix vulnerabilities and +> such -You can check [TODO](https://github.com/xlc520/easytier-manager/blob/master/TODO.md) to see if it's already recorded to avoid duplication +You can check [TODO](https://github.com/xlc520/easytier-manager/blob/master/TODO.md) to +see if it’s already recorded to avoid duplication [Submit Bug | Feature Request](https://github.com/xlc520/easytier-manager/issues/new/choose) diff --git a/en/guide/gui/index.md b/en/guide/gui/index.md index e0e5300b..a3718578 100644 --- a/en/guide/gui/index.md +++ b/en/guide/gui/index.md @@ -1,8 +1,10 @@ # Graphical User Interface (GUI) Networking -The graphical interface program can also be downloaded from the GitHub Release page, with the prefix easytier-gui. +The graphical interface program can also be downloaded from the GitHub Release page, +with the prefix easytier-gui. -Note that after installation on MacOS, you need to execute the following command in the terminal, otherwise, it will mistakenly report that the file is damaged. +Note that after installation on MacOS, you need to execute the following command in the +terminal, otherwise, it will mistakenly report that the file is damaged. ```bash xattr -c /Applications/easytier-gui.app diff --git a/en/guide/gui/qteasytier.md b/en/guide/gui/qteasytier.md index 9b2ddc18..1cf06df9 100644 --- a/en/guide/gui/qteasytier.md +++ b/en/guide/gui/qteasytier.md @@ -2,8 +2,10 @@ ## Project Introduction -QtEasyTier is a cross-region networking tool developed based on the Qt framework, designed for creating and managing virtual network connections. -It provides an intuitive graphical interface, helping users easily configure and manage virtual networks to achieve secure communication across network devices. +QtEasyTier is a cross-region networking tool developed based on the Qt framework, +designed for creating and managing virtual network connections. +It provides an intuitive graphical interface, helping users easily configure and manage +virtual networks to achieve secure communication across network devices. Project Address: https://gitee.com/viagrahuang/qt-easy-tier @@ -11,56 +13,76 @@ Project Address: https://gitee.com/viagrahuang/qt-easy-tier ## Features -- **Fast:** The program is developed using pure Qt C++, features system-native rendering, does not rely on Chromium or Webview, daily frontend memory usage stays under 50MB, ensuring efficient and fast operation. -- **Beautiful:** The UI style utilizes the Breeze style ported from KDE, providing a clean, aesthetically pleasing, and modern user interface. The program's UI layout is simple, logical, and intuitive, making it easy to learn, especially suitable for scenarios running multiple networks simultaneously. +- **Fast:** The program is developed using pure Qt C++, features system-native + rendering, does not rely on Chromium or Webview, daily frontend memory usage stays + under 50MB, ensuring efficient and fast operation. +- **Beautiful:** The UI style utilizes the Breeze style ported from KDE, providing a + clean, aesthetically pleasing, and modern user interface. + The program’s UI layout is simple, logical, and intuitive, making it easy to learn, + especially suitable for scenarios running multiple networks simultaneously. ## Platform Support - Windows 10/11 - Linux support is planned for the future -- Mac currently has no support plan (primarily because the author doesn't have a Macbook), but contributions from experts are welcome +- Mac currently has no support plan (primarily because the author doesn’t have a + Macbook), but contributions from experts are welcome ## Quick Start -For details, please visit the [Help Documentation](https://gitee.com/viagrahuang/qt-easy-tier/blob/master/assets/help.md) + +For details, please visit the +[Help Documentation](https://gitee.com/viagrahuang/qt-easy-tier/blob/master/assets/help.md) - Double-click `QtEasyTier.exe` to launch the application - Click the plus sign in the bottom right corner to create a network configuration -- Enter basic information such as network name, username, password, or click 'Import Configuration' below +- Enter basic information such as network name, username, password, or click ‘Import + Configuration’ below - Configure advanced options (optional) -- Click the "Run Network" button to initiate the network connection +- Click the “Run Network” button to initiate the network connection ## Related Projects This Program Depends On or Uses ### EasyTier -A simple, secure, decentralized cross-region networking solution powered by Rust and Tokio. -- Official Website: [https://easytier.cn/](https://easytier.cn/) +A simple, secure, decentralized cross-region networking solution powered by Rust and +Tokio. +- Official Website: https://easytier.cn/ ### Qt Framework -Qt is a cross-platform C++ application development framework used for creating graphical user interfaces (GUIs) and other applications. -- Official Website: [https://www.qt.io/](https://www.qt.io/) +Qt is a cross-platform C++ application development framework used for creating graphical +user interfaces (GUIs) and other applications. +- Official Website: https://www.qt.io/ ### Breeze -Breeze is the default theme for the KDE Plasma desktop environment. This program incorporates its style library adapted for the Qt framework to provide users with a beautiful interface. -- Official Website: [https://kde.org/](https://kde.org/) +Breeze is the default theme for the KDE Plasma desktop environment. +This program incorporates its style library adapted for the Qt framework to provide +users with a beautiful interface. +- Official Website: https://kde.org/ ## Contact the Author -- Project Address: [https://gitee.com/viagrahuang/qt-easy-tier](https://gitee.com/viagrahuang/qt-easy-tier) + +- Project Address: https://gitee.com/viagrahuang/qt-easy-tier - Issue Reporting: Welcome to submit Issues and PRs - Contact Methods: - - The author is active in the EasyTier Support Group 3, feel free to join for discussion: 957189589 + - The author is active in the EasyTier Support Group 3, feel free to join for + discussion: 957189589 - Bilibili Space: [space.bilibili.com/558600071](https://space.bilibili.com/558600071) ## License -This project is licensed under the GNU General Public License v3.0 (GPLv3). For details, please see the LICENSE file. +This project is licensed under the GNU General Public License v3.0 (GPLv3). For details, +please see the LICENSE file. ## Sponsorship and Support -Software development is not easy. Your sponsorship and support are vital motivation for the continuous development and maintenance of this project, and they also recognize the author's ongoing efforts. -If you find this project helpful, please consider supporting it through the following methods. +Software development is not easy. +Your sponsorship and support are vital motivation for the continuous development and +maintenance of this project, and they also recognize the author’s ongoing efforts. +If you find this project helpful, please consider supporting it through the following +methods. -1. Contribute a public server: Contact via email viagrahuang@88.com -2. Help fix bugs, add features, port to other platforms, etc.: [Project Address](https://gitee.com/viagrahuang/qt-easy-tier) \ No newline at end of file +1. Contribute a public server: Contact via email viagrahuang@88.com +2. Help fix bugs, add features, port to other platforms, etc.: + [Project Address](https://gitee.com/viagrahuang/qt-easy-tier) diff --git a/en/guide/gui/subnet_proxy.md b/en/guide/gui/subnet_proxy.md index a635ddd0..c516c28e 100644 --- a/en/guide/gui/subnet_proxy.md +++ b/en/guide/gui/subnet_proxy.md @@ -1,12 +1,18 @@ # Subnet Proxy -By setting up a subnet proxy, you can connect the local area network and the virtual local area network. +By setting up a subnet proxy, you can connect the local area network and the virtual +local area network. -Assuming the devices at home are in the 192.168.1.0/24 subnet, and you want to access any device at home from the company, you can start an EasyTier node at home and add a subnet proxy for 192.168.1.0/24. No additional configuration is needed on the company's devices; simply connect to the home node successfully, and you can access any device at home. +Assuming the devices at home are in the 192.168.1.0/24 subnet, and you want to access +any device at home from the company, you can start an EasyTier node at home and add a +subnet proxy for 192.168.1.0/24. No additional configuration is needed on the company’s +devices; simply connect to the home node successfully, and you can access any device at +home. ![Subnet Proxy Configuration](/assets/cn/subnet.png) -Note: After entering the subnet, you need to click on the list item to confirm. After successful confirmation, the subnet will be displayed in card format. +Note: After entering the subnet, you need to click on the list item to confirm. +After successful confirmation, the subnet will be displayed in card format. Subnet proxy can perform subnet mapping. diff --git a/en/guide/gui/vpn_portal.md b/en/guide/gui/vpn_portal.md index cca4cabd..46162eee 100644 --- a/en/guide/gui/vpn_portal.md +++ b/en/guide/gui/vpn_portal.md @@ -1,11 +1,15 @@ # WireGuard Access -Each node in EasyTier can act as a WireGuard server, allowing mobile devices such as Android and iOS to easily access devices in the virtual LAN. +Each node in EasyTier can act as a WireGuard server, allowing mobile devices such as +Android and iOS to easily access devices in the virtual LAN. Configuration method as shown in the figure. ![Wireguard Portal Config](/assets/cn/portal.png) -Click the "Show WireGuard Portal Configuration" button on the network success page to view the client configuration file. Import this configuration file into a third-party client on your phone to allow the phone to access the virtual LAN. +Click the “Show WireGuard Portal Configuration” button on the network success page to +view the client configuration file. +Import this configuration file into a third-party client on your phone to allow the +phone to access the virtual LAN. ![Client Config](/assets/cn/portal_config.png) diff --git a/en/guide/license.md b/en/guide/license.md index 91b9c35d..8d0d445b 100644 --- a/en/guide/license.md +++ b/en/guide/license.md @@ -1,3 +1,4 @@ # License -EasyTier is released under the [LGPL 3.0](https://github.com/EasyTier/EasyTier/blob/main/LICENSE). +EasyTier is released under the +[LGPL 3.0](https://github.com/EasyTier/EasyTier/blob/main/LICENSE). diff --git a/en/guide/network/host-public-server.md b/en/guide/network/host-public-server.md index f9919a75..a3941b52 100644 --- a/en/guide/network/host-public-server.md +++ b/en/guide/network/host-public-server.md @@ -1,22 +1,41 @@ # Setting Up a Shared Node -Users can use their own public nodes to set up a public shared node for networking without a public IP, making it easier for other users without a public IP to network. Simply start EasyTier without any parameters, and the node can be used as a public server (no root privileges required): +Users can use their own public nodes to set up a public shared node for networking +without a public IP, making it easier for other users without a public IP to network. +Simply start EasyTier without any parameters, and the node can be used as a public +server (no root privileges required): ``` easytier-core ``` -Additionally, EasyTier supports shared node clusters. Each virtual network (created with the same network name and key) can act as a shared node cluster, and nodes from other networks can connect to any node in the shared node cluster, discovering each other without a public IP. Running a self-built public server cluster is the same as running a virtual network, but you can skip configuring the IPv4 address. +Additionally, EasyTier supports shared node clusters. +Each virtual network (created with the same network name and key) can act as a shared +node cluster, and nodes from other networks can connect to any node in the shared node +cluster, discovering each other without a public IP. Running a self-built public server +cluster is the same as running a virtual network, but you can skip configuring the IPv4 +address. -If you wish to contribute a public server to the EasyTier community, you can contact the administrator, and we will inform you how to add your node to the community shared node list. Of course, this requires your node to have a certain level of bandwidth and stability. +If you wish to contribute a public server to the EasyTier community, you can contact the +administrator, and we will inform you how to add your node to the community shared node +list. Of course, this requires your node to have a certain level of bandwidth and +stability. ## Disable Forwarding -By default, each EasyTier node allows forwarding services for other virtual networks, even if the node has specified a network name (`--network-name`) and network key (`--network-secret`), and has joined a virtual network. +By default, each EasyTier node allows forwarding services for other virtual networks, +even if the node has specified a network name (`--network-name`) and network key +(`--network-secret`), and has joined a virtual network. -To change this behavior, you can use the `--relay-network-whitelist` parameter to specify a whitelist of network names that can be forwarded (a space-separated list of wildcards, such as `"ab* abc"`). When this parameter's list is empty, it will not provide forwarding services for any other networks. +To change this behavior, you can use the `--relay-network-whitelist` parameter to +specify a whitelist of network names that can be forwarded (a space-separated list of +wildcards, such as `"ab* abc"`). When this parameter’s list is empty, it will not +provide forwarding services for any other networks. -EasyTier can avoid forwarding network packets for other virtual networks and only help them establish P2P links by setting the whitelist to empty and configuring it to only forward RPC traffic. The reference command is: +EasyTier can avoid forwarding network packets for other virtual networks and only help +them establish P2P links by setting the whitelist to empty and configuring it to only +forward RPC traffic. +The reference command is: ``` easytier-core --relay-network-whitelist --relay-all-peer-rpc @@ -24,10 +43,13 @@ easytier-core --relay-network-whitelist --relay-all-peer-rpc ## Private Mode -If you want EasyTier to only provide services in your virtual network and don't want nodes from other virtual networks to connect to your node, you can start EasyTier with the `--private-mode true` parameter. +If you want EasyTier to only provide services in your virtual network and don’t want +nodes from other virtual networks to connect to your node, you can start EasyTier with +the `--private-mode true` parameter. ``` sudo easytier-core --private-mode true --network-name my-network --network-secret my-secret ``` -This will only allow nodes with network name `my-network` and key `my-secret` to connect to this EasyTier node. +This will only allow nodes with network name `my-network` and key `my-secret` to connect +to this EasyTier node. diff --git a/en/guide/network/install-as-a-systemd-service.md b/en/guide/network/install-as-a-systemd-service.md index e7c9bd03..4b01fc8f 100644 --- a/en/guide/network/install-as-a-systemd-service.md +++ b/en/guide/network/install-as-a-systemd-service.md @@ -1,8 +1,10 @@ # Install the Service as a Linux Systemd Service -On Linux distributions that support systemd, you can configure the service to start with the system by following these steps: +On Linux distributions that support systemd, you can configure the service to start with +the system by following these steps: -1. Create a new service file `/etc/systemd/system/easytier.service` and modify the command line parameters after `ExecStart` as needed. +1. Create a new service file `/etc/systemd/system/easytier.service` and modify the + command line parameters after `ExecStart` as needed. ```shell [Unit] @@ -18,7 +20,8 @@ ExecStart=/root/easytier-core --ipv4 x.x.x.x --network-name xxx --network-secret WantedBy=multi-user.target ``` -2. After saving the file, run the following command in the terminal to enable the service: +2. After saving the file, run the following command in the terminal to enable the + service: ```sh systemctl enable easytier.service @@ -31,4 +34,5 @@ systemctl start easytier.service systemctl stop easytier.service ``` -Please note that using the `systemctl` command instead of the `service` command is a more modern approach and is recommended on systems that support systemd. +Please note that using the `systemctl` command instead of the `service` command is a +more modern approach and is recommended on systems that support systemd. diff --git a/en/guide/network/no-root.md b/en/guide/network/no-root.md index a2556320..fac0ca1f 100644 --- a/en/guide/network/no-root.md +++ b/en/guide/network/no-root.md @@ -1,7 +1,12 @@ # No TUN Mode (No Root Permission Required) -Since creating a TUN device requires ROOT permissions, EasyTier provides a method that does not rely on TUN for environments where Root permissions cannot be obtained. Simply add the `--no-tun` parameter when starting EasyTier. +Since creating a TUN device requires ROOT permissions, EasyTier provides a method that +does not rely on TUN for environments where Root permissions cannot be obtained. +Simply add the `--no-tun` parameter when starting EasyTier. -When using the no TUN mode for networking, nodes can be accessed via virtual IP (TCP, UDP, and ICMP are all supported), and can also act as subnet proxies (using the -n parameter). However, they cannot actively initiate access to other nodes. +When using the no TUN mode for networking, nodes can be accessed via virtual IP (TCP, +UDP, and ICMP are all supported), and can also act as subnet proxies (using the -n +parameter). However, they cannot actively initiate access to other nodes. -To actively access other nodes in no TUN mode, you can use EasyTier's [SOCKS5 server feature](/guide/network/socks5). +To actively access other nodes in no TUN mode, you can use EasyTier’s +[SOCKS5 server feature](/guide/network/socks5). diff --git a/en/guide/network/socks5.md b/en/guide/network/socks5.md index b5083c6f..28442c98 100644 --- a/en/guide/network/socks5.md +++ b/en/guide/network/socks5.md @@ -1,5 +1,10 @@ # SOCKS5 -EasyTier supports creating SOCKS5 servers. Other programs on the node can access the virtual network and other proxy subnets within the virtual network by setting the proxy to EasyTier's SOCKS5 service. +EasyTier supports creating SOCKS5 servers. +Other programs on the node can access the virtual network and other proxy subnets within +the virtual network by setting the proxy to EasyTier’s SOCKS5 service. -The parameter to enable the SOCKS5 service is `--socks5 12333`. Adding this parameter to the easytier-core startup command will allow the local 12333 port to serve SOCKS5 clients. Currently, the SOCKS5 server does not require username and password authentication and can be used directly. +The parameter to enable the SOCKS5 service is `--socks5 12333`. Adding this parameter to +the easytier-core startup command will allow the local 12333 port to serve SOCKS5 +clients. Currently, the SOCKS5 server does not require username and password +authentication and can be used directly. diff --git a/en/guide/perf.md b/en/guide/perf.md index 2c176eb6..7174f52f 100644 --- a/en/guide/perf.md +++ b/en/guide/perf.md @@ -1,11 +1,12 @@ # Performance Testing -Software and versions involved in the test (to avoid bias and for fair treatment, use "X" as a placeholder): +Software and versions involved in the test (to avoid bias and for fair treatment, use +“X” as a placeholder): -| Software | Version | Link | -| ----------------- | ----------------- | ------------------------------------ | -| EasyTier | 1.2.1 | https://github.com/EasyTier/EasyTier | -| Networking Tool A | July 2024 Version | | +| Software | Version | Link | +| --- | --- | --- | +| EasyTier | 1.2.1 | https://github.com/EasyTier/EasyTier | +| Networking Tool A | July 2024 Version | | To be tested: @@ -15,32 +16,33 @@ To be tested: ## X86 -| | | -| ------------- | -------------------------------------------- | -| Machine Model | Alibaba Cloud ecs.ic5.2xlarge | -| vCPU | 8 vCPU | -| RAM | 8G | -| CPU Model | Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz | -| OS | Ubuntu 22.04 64-bit | +| | | +| --- | --- | +| Machine Model | Alibaba Cloud ecs.ic5.2xlarge | +| vCPU | 8 vCPU | +| RAM | 8G | +| CPU Model | Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz | +| OS | Ubuntu 22.04 64-bit | ## Test Results -| Software | Test Item | Performance ( No -R / With -R ) Gbit/s | -| :---------------: | :---------------: | :------------------------------------: | -| LoopBack Device | | 28.3 / 28.3 | -| EasyTier | UDP No Encryption | 1.43 / 1.46 | -| EasyTier | UDP AES-128-GCM | 1.36 / 1.37 | -| EasyTier | TCP No Encryption | 1.31 / 1.41 | -| EasyTier | TCP AES-128-GCM | 1.42 / 1.41 | -| | | | -| Networking Tool A | UDP No Encryption | 1.10 / 1.11 | -| Networking Tool A | UDP AES-128-GCM | 0.93 / 0.98 | +| Software | Test Item | Performance ( No -R / With -R ) Gbit/s | +| :---: | :---: | :---: | +| LoopBack Device | | 28.3 / 28.3 | +| EasyTier | UDP No Encryption | 1.43 / 1.46 | +| EasyTier | UDP AES-128-GCM | 1.36 / 1.37 | +| EasyTier | TCP No Encryption | 1.31 / 1.41 | +| EasyTier | TCP AES-128-GCM | 1.42 / 1.41 | +| | | | +| Networking Tool A | UDP No Encryption | 1.10 / 1.11 | +| Networking Tool A | UDP AES-128-GCM | 0.93 / 0.98 | ## Reproduction Method ### Basic Preparation -The test is based on Linux network namespace functionality and can be performed using Ubuntu virtual machines, physical machines, Docker containers, etc. +The test is based on Linux network namespace functionality and can be performed using +Ubuntu virtual machines, physical machines, Docker containers, etc. Initialization commands (execute with root privileges) @@ -86,9 +88,11 @@ iptables --policy FORWARD ACCEPT nohup ip netns exec red iperf3 -s & ``` -Additionally, ensure that the programs to be tested are in the PATH environment variable. +Additionally, ensure that the programs to be tested are in the PATH environment +variable. -The following iperf3 command does not include -R; in actual tests, data with -R will be measured. +The following iperf3 command does not include -R; in actual tests, data with -R will be +measured. ### LoopBack diff --git a/en/guide/privacy.md b/en/guide/privacy.md index fe7d43e0..af8b7371 100644 --- a/en/guide/privacy.md +++ b/en/guide/privacy.md @@ -2,68 +2,146 @@ **Effective Date: January 18, 2026** -EasyTier is a simple, secure, decentralized tool for intranet penetration and remote networking. This Privacy Policy explains how we handle relevant privacy information during the installation and use of the EasyTier software. +EasyTier is a simple, secure, decentralized tool for intranet penetration and remote +networking. This Privacy Policy explains how we handle relevant privacy information +during the installation and use of the EasyTier software. -_This policy applies only to first-party software released by EasyTier and officially maintained servers, and does not apply to any third-party services or software._ +*This policy applies only to first-party software released by EasyTier and officially +maintained servers, and does not apply to any third-party services or software.* -_The original version of this policy is written in Chinese. In the event of any discrepancies in interpretation, the Chinese version shall prevail._ +*The original version of this policy is written in Chinese. +In the event of any discrepancies in interpretation, the Chinese version shall prevail.* ## 1. Information Related to Inter-Node Communication ### 1.1 Node Discovery Information -In networking scenarios other than “Standalone” mode, in order to enable interconnection between devices across networks and perform NAT traversal, EasyTier will access networking servers manually specified by the user. When initiating a network or searching for peer nodes, the client program sends connection requests to the server. Such requests may include, but are not limited to, the local node’s network configuration parameters and virtual IP address. Based on these requests, the server identifies and returns the client’s public-facing IP address and port information, and announces the necessary metadata to authorized peer nodes whose network configurations are compatible. +In networking scenarios other than “Standalone” mode, in order to enable interconnection +between devices across networks and perform NAT traversal, EasyTier will access +networking servers manually specified by the user. +When initiating a network or searching for peer nodes, the client program sends +connection requests to the server. +Such requests may include, but are not limited to, the local node’s network +configuration parameters and virtual IP address. +Based on these requests, the server identifies and returns the client’s public-facing IP +address and port information, and announces the necessary metadata to authorized peer +nodes whose network configurations are compatible. ### 1.2 Network Connection Information -To optimize data transmission efficiency and automatically select the best paths, the software dynamically processes local network topology information during operation, including but not limited to peer node latency, connection path status, and packet loss rates, and announces this information to peer nodes. Such technical information is maintained in real time only in device memory, solely to ensure network stability and performance. It is not uploaded to any central server, nor is it persistently stored across sessions. +To optimize data transmission efficiency and automatically select the best paths, the +software dynamically processes local network topology information during operation, +including but not limited to peer node latency, connection path status, and packet loss +rates, and announces this information to peer nodes. +Such technical information is maintained in real time only in device memory, solely to +ensure network stability and performance. +It is not uploaded to any central server, nor is it persistently stored across sessions. ### 1.3 Statement on Information Processing -The data described in this section may contain information capable of identifying a user’s personal identity. For public servers and relay nodes, the client may transmit such data in plaintext. We do not take responsibility for the security of data during transmission; please be aware of the associated risks. For public servers provided by this software, we process such data only to the extent necessary for node discovery, connection establishment, and network maintenance. We do not persistently store the data, nor do we use it for any other purposes. For third-party servers, we do not control their data processing policies and assume no responsibility for them. +The data described in this section may contain information capable of identifying a +user’s personal identity. +For public servers and relay nodes, the client may transmit such data in plaintext. +We do not take responsibility for the security of data during transmission; please be +aware of the associated risks. +For public servers provided by this software, we process such data only to the extent +necessary for node discovery, connection establishment, and network maintenance. +We do not persistently store the data, nor do we use it for any other purposes. +For third-party servers, we do not control their data processing policies and assume no +responsibility for them. ## 2. Traffic and Security ### 2.1 Data Encryption -EasyTier uses industry-standard symmetric encryption algorithms (such as AES-GCM or ChaCha20-Poly1305) by default to protect all transmitted traffic. Users are required to configure a consistent pre-shared key (PSK) among networking nodes. All data transmitted through this software is encrypted before leaving the sender, ensuring that only legitimate nodes holding the correct key can decrypt and read the communication content. We do not possess your private keys and therefore cannot access any of your communication data. +EasyTier uses industry-standard symmetric encryption algorithms (such as AES-GCM or +ChaCha20-Poly1305) by default to protect all transmitted traffic. +Users are required to configure a consistent pre-shared key (PSK) among networking +nodes. +All data transmitted through this software is encrypted before leaving the sender, +ensuring that only legitimate nodes holding the correct key can decrypt and read the +communication content. +We do not possess your private keys and therefore cannot access any of your +communication data. ### 2.2 Data Handling in Relay Mechanisms -In complex network environments where direct P2P connections cannot be established, encrypted traffic may be forwarded through relay nodes. Even in such scenarios, the traffic remains symmetrically encrypted. Relay nodes are responsible only for packet forwarding and routing, do not have decryption capabilities, and cannot access or analyze the encrypted original data content. +In complex network environments where direct P2P connections cannot be established, +encrypted traffic may be forwarded through relay nodes. +Even in such scenarios, the traffic remains symmetrically encrypted. +Relay nodes are responsible only for packet forwarding and routing, do not have +decryption capabilities, and cannot access or analyze the encrypted original data +content. ## 3. Servers ### 3.1 Public Servers -To assist with NAT detection and hole punching, this software provides public EasyTier servers hosted by third-party service providers for user access. When the software interacts with these servers, your public IP address, port information, and basic network metadata may be exposed to those third-party service providers. The processing of such data is governed by the respective providers’ own privacy policies. We recommend that you review the relevant policies of those parties. +To assist with NAT detection and hole punching, this software provides public EasyTier +servers hosted by third-party service providers for user access. +When the software interacts with these servers, your public IP address, port +information, and basic network metadata may be exposed to those third-party service +providers. The processing of such data is governed by the respective providers’ own +privacy policies. We recommend that you review the relevant policies of those parties. ### 3.2 Third-Party Servers -This software allows users to specify and connect to networking servers or relay nodes operated by third parties. Users should be aware that connecting to such servers means that your connection metadata (such as IP address and network information) will be visible to the server operator. The developer assumes no responsibility for the security, data handling practices, or service stability of any third-party servers, nor any direct or indirect legal liability arising therefrom. +This software allows users to specify and connect to networking servers or relay nodes +operated by third parties. +Users should be aware that connecting to such servers means that your connection +metadata (such as IP address and network information) will be visible to the server +operator. The developer assumes no responsibility for the security, data handling +practices, or service stability of any third-party servers, nor any direct or indirect +legal liability arising therefrom. ## 4. Data Retention and Storage ### 4.1 Local Configuration Storage -This software stores network configuration files (including virtual IP addresses, pre-shared symmetric keys, node public/private keys, and peer addresses) on your local device. The software does not provide any form of cloud backup or synchronization services. Such sensitive configuration information will never be automatically synchronized or uploaded to any central server. Users are responsible for managing the security of their local configuration files. +This software stores network configuration files (including virtual IP addresses, +pre-shared symmetric keys, node public/private keys, and peer addresses) on your local +device. The software does not provide any form of cloud backup or synchronization +services. Such sensitive configuration information will never be automatically +synchronized or uploaded to any central server. +Users are responsible for managing the security of their local configuration files. ### 4.2 Logs and Analytical Data -This software does not collect or transmit user operation logs, behavioral patterns, or traffic analysis data. All runtime data used to maintain network connections is stored only in local memory. Once the program is closed or the process terminates, such temporary data is immediately cleared and leaves no trace on local disks or remote servers. +This software does not collect or transmit user operation logs, behavioral patterns, or +traffic analysis data. +All runtime data used to maintain network connections is stored only in local memory. +Once the program is closed or the process terminates, such temporary data is immediately +cleared and leaves no trace on local disks or remote servers. ### 4.3 Server-Side Data Storage -For official public networking servers provided by us, we temporarily maintain node discovery and network connection information in memory only when necessary. Such data becomes invalid as soon as a node goes offline or a connection is established. Unless explicitly required by laws, regulations, or regulatory authorities, we do not persistently store such data, nor do we use it for any purpose other than connection establishment. For third-party servers specified by users, we cannot control their data storage policies and assume no responsibility for their storage practices. +For official public networking servers provided by us, we temporarily maintain node +discovery and network connection information in memory only when necessary. +Such data becomes invalid as soon as a node goes offline or a connection is established. +Unless explicitly required by laws, regulations, or regulatory authorities, we do not +persistently store such data, nor do we use it for any purpose other than connection +establishment. For third-party servers specified by users, we cannot control their data +storage policies and assume no responsibility for their storage practices. ## 5. Children’s Privacy Protection -EasyTier is a network utility software and is not designed to attract or target children. As the software does not implement an account system and does not collect personal identity information by design, we do not knowingly collect, process, or store any personal data of children under the age of 13 (or the applicable age as defined by local laws). +EasyTier is a network utility software and is not designed to attract or target +children. As the software does not implement an account system and does not collect +personal identity information by design, we do not knowingly collect, process, or store +any personal data of children under the age of 13 (or the applicable age as defined by +local laws). ## 6. Policy Revisions -As software features evolve or the legal environment changes, we may revise this Privacy Policy from time to time. Any revisions will be updated on this page and marked with a revised effective date. We recommend that you review this policy periodically to stay informed about our latest practices regarding technical data handling and privacy protection. Your continued use of the software after policy revisions indicates that you have read and accepted the updated policy. +As software features evolve or the legal environment changes, we may revise this Privacy +Policy from time to time. +Any revisions will be updated on this page and marked with a revised effective date. +We recommend that you review this policy periodically to stay informed about our latest +practices regarding technical data handling and privacy protection. +Your continued use of the software after policy revisions indicates that you have read +and accepted the updated policy. ## 7. Contact Us -If you have any questions about this Privacy Policy or EasyTier’s data handling practices, please contact us via [Contact Information](contact). +If you have any questions about this Privacy Policy or EasyTier’s data handling +practices, please contact us via [Contact Information](contact). diff --git a/guide/gui/astral-game.md b/guide/gui/astral-game.md index 91179502..9478204d 100644 --- a/guide/gui/astral-game.md +++ b/guide/gui/astral-game.md @@ -1,17 +1,17 @@ # AstralGame 游戏联机工具 + [![GitHub](https://img.shields.io/badge/GitHub-AstralET-blue)](https://github.com/ldoubil/astral) [![AstralGame](https://img.shields.io/badge/wiki-AstralGame-blue)](https://astral.fan/) ## 预览 -![manage-step1](/assets/AstralET1.png) -![manage-step1](/assets/AstralET2.png) -![manage-step1](/assets/AstralET3.png) -![manage-step1](/assets/AstralET4.png) + +![manage-step1](/assets/AstralET1.png) ![manage-step1](/assets/AstralET2.png) +![manage-step1](/assets/AstralET3.png) ![manage-step1](/assets/AstralET4.png) ![manage-step1](/assets/AstralET5.png) ## 使用教程 + - https://astral.fan/quick-start/what-is-astral/ - ## 介绍 @@ -19,11 +19,11 @@ AstralGame 是一款基于 ​**Flutter** 和 ​**EasyTier** 开发的轻量级 ## 特性 -- ​**内置 EasyTier**：将 EasyTier 直接编译到 AstralGame 中，无需额外安装，也不会保留任何后台进程。 -- ​**即开即用**：联机时启动应用，结束后关闭即可，操作简单便捷。 +- ​**内置 EasyTier**：将 EasyTier 直接编译到 AstralGame 中，无需额外安装，也不会保留任何后台进程。 +- ​**即开即用**：联机时启动应用，结束后关闭即可，操作简单便捷。 - ​**活跃维护**：作者积极更新，随时修复问题并优化功能（上班摸鱼成果）。 ## 联系我们 & 功能建议 -- ​**QQ 群**： [点击加入 QQ 群](https://qm.qq.com/q/r4VsExDDt6) -- ​**GitHub Issues**： [提交问题或建议](https://github.com/ldoubil/astral/issues) +- ​**QQ 群**： [点击加入 QQ 群](https://qm.qq.com/q/r4VsExDDt6) +- ​**GitHub Issues**： [提交问题或建议](https://github.com/ldoubil/astral/issues) diff --git a/guide/gui/easytier-game.md b/guide/gui/easytier-game.md index aad2113c..066beebf 100644 --- a/guide/gui/easytier-game.md +++ b/guide/gui/easytier-game.md @@ -2,13 +2,12 @@ ## 简介 -EasyTierGame 游戏联机启动器，由`nuxt3` `typescript` `rust` `tauri` 开发 -具有简易的界面，附带最新版 easytier 内核，联机游玩的时候无论是心理上和使用上都能给予您最舒服的体验，同时支持自定义配置文件启动，满足各种需求 +EasyTierGame 游戏联机启动器，由`nuxt3` `typescript` `rust` `tauri` 开发 具有简易的界面，附带最新版 easytier +内核，联机游玩的时候无论是心理上和使用上都能给予您最舒服的体验，同时支持自定义配置文件启动，满足各种需求 ## 下载 -Github -Releases： [https://github.com/EasyTier/EasytierGame/releases](https://github.com/EasyTier/EasytierGame/releases) +Github Releases： https://github.com/EasyTier/EasytierGame/releases - 只有绿色zip包，个人不喜欢安装包各种写注册表，解压即用就行，目录清爽干净 @@ -16,13 +15,11 @@ Releases： [https://github.com/EasyTier/EasytierGame/releases](https://github.c ## 使用教程 -- 第一次使用，输入一个“主机名”点击启动联机即可，后续可以自建服务器或者使用爱心群友提供的服务器 - ![game-step2](/assets/game-step2.png) +- 第一次使用，输入一个“主机名”点击启动联机即可，后续可以自建服务器或者使用爱心群友提供的服务器 ![game-step2](/assets/game-step2.png) ![game-step3](/assets/game-step3.png) -- 高级选项里有一些特殊配置，可以自行选择 - ![game-step4](/assets/game-step4.png) +- 高级选项里有一些特殊配置，可以自行选择 ![game-step4](/assets/game-step4.png) - 如果还是无法满足您的需求，可以使用配置文件进行启动，具体如何配置，可以查看文档[配置文件](/guide/network/config-file.html) ![game-step5](/assets/game-step5.png) diff --git a/guide/gui/easytier-manager.md b/guide/gui/easytier-manager.md index 6935f1cf..750899e8 100644 --- a/guide/gui/easytier-manager.md +++ b/guide/gui/easytier-manager.md @@ -2,8 +2,7 @@ ## 下载 -Github -Releases： [https://github.com/xlc520/easytier-manager/releases](https://github.com/xlc520/easytier-manager/releases) +Github Releases： https://github.com/xlc520/easytier-manager/releases #### 各个包说明 @@ -72,4 +71,4 @@ EasyTier 管理器 整合Vue3 + Vite5 + Electron33 + Element-Plus， 是一个 ## 系统支持 -理论支持Windows 11 、Windows 10 、 Windows 7 +理论支持Windows 11 、Windows 10 、 Windows 7 diff --git a/guide/gui/qteasytier.md b/guide/gui/qteasytier.md index 550e069a..22925f3b 100644 --- a/guide/gui/qteasytier.md +++ b/guide/gui/qteasytier.md @@ -8,12 +8,13 @@ QtEasyTier 是一个基于 Qt 框架开发的异地组网工具，使用 EasyTie - 软件官网：[qtet.070219.xyz](https://qtet.070219.xyz) ### 项目地址： - - [Gitee: gitee.com/viagrahuang/qt-easy-tier](https://gitee.com/viagrahuang/qt-easy-tier) - - [GitHub: github.com/myqfeng/qt-easy-tier](https://github.com/myqfeng/qt-easy-tier) + +- [Gitee: gitee.com/viagrahuang/qt-easy-tier](https://gitee.com/viagrahuang/qt-easy-tier) +- [GitHub: github.com/myqfeng/qt-easy-tier](https://github.com/myqfeng/qt-easy-tier) ### 示例图片 -![QtEasyTier](/assets/qteasytier0.png) -![QtEasyTier](/assets/qteasytier1.png) + +![QtEasyTier](/assets/qteasytier0.png) ![QtEasyTier](/assets/qteasytier1.png) ![QtEasyTier](/assets/qteasytier2.png) ## 项目特点 @@ -30,37 +31,39 @@ QtEasyTier 是一个基于 Qt 框架开发的异地组网工具，使用 EasyTie - Mac 目前暂无支持计划（主要是作者没有Macbook），但欢迎大佬参与贡献 ## 快速上手 + 详情请前往[帮助文档](https://qtet.070219.xyz/docs-home) - 双击 QtEasyTier.exe 启动应用程序 - 点击右下角加号创建网络配置 - 输入网络名称、用户名、密码等基本信息或者点击下方导入配置 - 配置高级选项（可选） -- 点击 "运行网络" 按钮即可启动网络连接 +- 点击 “运行网络” 按钮即可启动网络连接 ## 本程序依赖或使用的相关项目 ### EasyTier 一个由 Rust 和 Tokio 驱动的简单、安全、去中心化的异地组网方案 -- 官网：[https://easytier.cn/](https://easytier.cn/) +- 官网：https://easytier.cn/ ### Qt Framework Qt 是一个跨平台的 C++ 应用程序开发框架，用于创建图形用户界面（GUI）和其他应用程序。 -- 官网：[https://www.qt.io/](https://www.qt.io/) +- 官网：https://www.qt.io/ ### Breeze Breeze 是 KDE Plasma 桌面环境的默认主题，本程序移植了其适用于 Qt 框架的样式库，为用户提供美观的界面。 -- 官网：[https://kde.org/](https://kde.org/) +- 官网：https://kde.org/ ## 联系作者 -- 项目地址：[https://gitee.com/viagrahuang/qt-easy-tier](https://gitee.com/viagrahuang/qt-easy-tier) + +- 项目地址：https://gitee.com/viagrahuang/qt-easy-tier - 问题反馈：欢迎提交 Issue 和 PR - 交流方式： - 交流Q群：1081241238 - - B站空间：[space.bilibili.com/558600071](https://space.bilibili.com/558600071) + - B站空间：[space.bilibili.com/558600071](https://space.bilibili.com/558600071) ## 许可证 @@ -68,8 +71,7 @@ Breeze 是 KDE Plasma 桌面环境的默认主题，本程序移植了其适用 ## 赞助与支持 -软件开发不易, 您的赞助与支持是对本项目持续开发和维护的重要动力，也是对作者持续努力的认可。 -如果您认为本项目对您有帮助，请考虑通过以下方式赞助本项目。 +软件开发不易, 您的赞助与支持是对本项目持续开发和维护的重要动力，也是对作者持续努力的认可。 如果您认为本项目对您有帮助，请考虑通过以下方式赞助本项目。 1. 贡献公共服务器：邮件联系viagrahuang@88.com 2. 帮助修复BUG、添加功能、多平台移植等：[项目地址](https://gitee.com/viagrahuang/qt-easy-tier) diff --git a/guide/gui/subnet_proxy.md b/guide/gui/subnet_proxy.md index fa0aa958..e619d933 100644 --- a/guide/gui/subnet_proxy.md +++ b/guide/gui/subnet_proxy.md @@ -2,7 +2,8 @@ 通过设置子网代理，连通本地局域网和虚拟局域网。 -假设家中的设备在子网 192.168.1.0/24 网段中，想在公司访问家中的任意设备，则可在家中启动一个 EasyTier 节点，新增子网代理 192.168.1.0/24。公司的设备中无需任何额外配置，只需与家中节点成功组网，即可访问家中任意设备。 +假设家中的设备在子网 192.168.1.0/24 网段中，想在公司访问家中的任意设备，则可在家中启动一个 EasyTier 节点，新增子网代理 +192.168.1.0/24。公司的设备中无需任何额外配置，只需与家中节点成功组网，即可访问家中任意设备。 ![子网代理配置](/assets/cn/subnet.png) diff --git a/guide/network/install-as-a-macos-service.md b/guide/network/install-as-a-macos-service.md index 22fb181f..bc2c055f 100644 --- a/guide/network/install-as-a-macos-service.md +++ b/guide/network/install-as-a-macos-service.md @@ -34,7 +34,6 @@ launchctl load -w /Library/LaunchDaemons/easytier.plist sudo launchctl stop easytier # 卸载任务, -w选项会在下次登录/重新启动时不再执行。 launchctl unload -w /Library/LaunchDaemons/easytier.plist - ``` 查看运行日志： diff --git a/guide/network/install-as-a-systemd-service.md b/guide/network/install-as-a-systemd-service.md index 35f0992e..bcfd4ca5 100644 --- a/guide/network/install-as-a-systemd-service.md +++ b/guide/network/install-as-a-systemd-service.md @@ -31,4 +31,4 @@ systemctl start easytier.service systemctl stop easytier.service ``` -请注意，使用 `systemctl` 命令替代 `service` 命令是更现代的做法，建议在支持 systemd 的系统中使用。 \ No newline at end of file +请注意，使用 `systemctl` 命令替代 `service` 命令是更现代的做法，建议在支持 systemd 的系统中使用。 diff --git a/guide/network/install-as-a-windows-service.md b/guide/network/install-as-a-windows-service.md index 52f0d788..deef549f 100644 --- a/guide/network/install-as-a-windows-service.md +++ b/guide/network/install-as-a-windows-service.md @@ -25,6 +25,7 @@ iwr "https://ghfast.top/https://raw.githubusercontent.com/EasyTier/EasyTier/main ## 安装流程 1. 在希望安装 EasyTier 的目录中打开 PowerShell。 + 2. 运行安装脚本： ```PowerShell @@ -32,6 +33,7 @@ iwr "https://ghfast.top/https://raw.githubusercontent.com/EasyTier/EasyTier/main ``` 3. 根据提示选择配置模式，并填写所需参数。 + 4. 安装完成后，脚本会自动创建并启动 Windows 服务。 ## 配置模式说明 diff --git a/guide/network/no-root.md b/guide/network/no-root.md index ab7c1ee6..3a10ffe7 100644 --- a/guide/network/no-root.md +++ b/guide/network/no-root.md @@ -1,6 +1,7 @@ # 无 TUN 模式 （免 Root 权限） -由于创建 TUN 设备需要 ROOT 权限，对于一些无法获取 Root 权限的环境，EasyTier 也提供了不依赖 TUN 的使用方法。只需在启动 EasyTier 时，增加 `--no-tun` 参数即可。 +由于创建 TUN 设备需要 ROOT 权限，对于一些无法获取 Root 权限的环境，EasyTier 也提供了不依赖 TUN 的使用方法。只需在启动 EasyTier 时，增加 +`--no-tun` 参数即可。 使用无 TUN 模式组网时，节点可以通过虚拟 IP 被访问（TCP、UDP 和 ICMP 都支持），也可以做子网代理（使用 -n 参数）。但是无法主动发起对其他节点的访问。 diff --git a/guide/network/socks5.md b/guide/network/socks5.md index d3de6abd..c0ae5319 100644 --- a/guide/network/socks5.md +++ b/guide/network/socks5.md @@ -2,4 +2,5 @@ EasyTier 支持创建 SOCKS5 服务器，节点上的其他程序可以通过将代理设置为 EasyTier 的 SOCKS5 服务，即可访问虚拟网和虚拟网中的其他代理子网。 -SOCKS5 服务的开启参数形为 `--socks5 12333`，将此参数加入 easytier-core 启动命令后，本机的 12333 端口即可服务于 SOCKS5 客户端。目前 SOCKS5 服务端无需用户名和密码验证，可直接使用。 +SOCKS5 服务的开启参数形为 `--socks5 12333`，将此参数加入 easytier-core 启动命令后，本机的 12333 端口即可服务于 SOCKS5 +客户端。目前 SOCKS5 服务端无需用户名和密码验证，可直接使用。 diff --git a/guide/perf.md b/guide/perf.md index 115e48d7..74f6b384 100644 --- a/guide/perf.md +++ b/guide/perf.md @@ -2,10 +2,10 @@ 参与测试的软件及其版本（为避嫌 + 公平待遇，用“某”代替）： -| 软件名 | 版本 | 链接 | -| -------- | ------ | ------------------------------------ | -| EasyTier | 1.2.1 | https://github.com/EasyTier/EasyTier | -| 某组网工具 A | 2024.7 月版本 | | +| 软件名 | 版本 | 链接 | +| --- | --- | --- | +| EasyTier | 1.2.1 | https://github.com/EasyTier/EasyTier | +| 某组网工具 A | 2024.7 月版本 | | 待测： @@ -13,29 +13,28 @@ - TailScale - ZeroTier - ## X86 -| | | -| -------- | -------------------------------------------- | -| 机器型号 | 阿里云 ecs.ic5.2xlarge | -| vCPU | 8 vCPU | -| RAM | 8G | +| | | +| --- | --- | +| 机器型号 | 阿里云 ecs.ic5.2xlarge | +| vCPU | 8 vCPU | +| RAM | 8G | | CPU 型号 | Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz | -| 操作系统 | Ubuntu 22.04 64位 | +| 操作系统 | Ubuntu 22.04 64位 | ## 测试结果 -| 软件 | 测试项目 | 性能 ( 无 -R / 带 -R ) Gbit/s | -| :-----------: | :-------------: | :---------------------------: | -| LoopBack 设备 | | 28.3 / 28.3 | -| EasyTier | UDP 无加密 | 1.43 / 1.46 | -| EasyTier | UDP AES-128-GCM | 1.36 / 1.37 | -| EasyTier | TCP 无加密 | 1.31 / 1.41 | -| EasyTier | TCP AES-128-GCM | 1.42 / 1.41 | -| | | | -| 某组网工具 A | UDP 无加密 | 1.10 / 1.11 | -| 某组网工具 A | UDP AES-128-GCM | 0.93 / 0.98 | +| 软件 | 测试项目 | 性能 ( 无 -R / 带 -R ) Gbit/s | +| :---: | :---: | :---: | +| LoopBack 设备 | | 28.3 / 28.3 | +| EasyTier | UDP 无加密 | 1.43 / 1.46 | +| EasyTier | UDP AES-128-GCM | 1.36 / 1.37 | +| EasyTier | TCP 无加密 | 1.31 / 1.41 | +| EasyTier | TCP AES-128-GCM | 1.42 / 1.41 | +| | | | +| 某组网工具 A | UDP 无加密 | 1.10 / 1.11 | +| 某组网工具 A | UDP AES-128-GCM | 0.93 / 0.98 | ## 复现方式 @@ -100,13 +99,15 @@ ip netns exec green iperf3 -c 192.168.0.2 ### EasyTier #### UDP 不带加密： + ```bash ip netns exec red easytier-core -i 10.126.126.2 --multi-thread -u ip netns exec green easytier-core -i 10.126.126.3 -p udp://192.168.0.2:11010 --multi-thread -u ip netns exec green iperf3 -c 10.126.126.2 ``` -#### UDP 加密： +#### UDP 加密： + ```bash ip netns exec red easytier-core -i 10.126.126.2 --multi-thread ip netns exec green easytier-core -i 10.126.126.3 -p udp://192.168.0.2:11010 --multi-thread @@ -131,7 +132,7 @@ ip netns exec green iperf3 -c 10.126.126.2 ### 某组网工具 A -#### UDP 无加密 +#### UDP 无加密 ```bash ip netns exec red xxx -k iperf -s 8.134.146.7:29872 --ip 10.26.0.2 @@ -139,7 +140,7 @@ ip netns exec green xxx -k iperf -s 8.134.146.7:29872 --ip 10.26.0.3 ip netns exec green iperf3 -c 10.26.0.2 ``` -#### UDP 带加密 +#### UDP 带加密 ```bash ip netns exec red xxx -k iperf -s 8.134.146.7:29872 -w 1234 --ip 10.26.0.2 diff --git a/guide/privacy.md b/guide/privacy.md index f0476b23..d050ef33 100644 --- a/guide/privacy.md +++ b/guide/privacy.md @@ -4,15 +4,17 @@ EasyTier 是一款简单、安全、去中心化的内网穿透和异地组网工具。本隐私政策说明了您在安装及使用 EasyTier 软件过程中，我们如何处理相关的隐私信息。 -_本协议仅适用于 EasyTier 发行的第一方软件及官方维护的服务器，不适用于任何第三方服务或软件。_ +*本协议仅适用于 EasyTier 发行的第一方软件及官方维护的服务器，不适用于任何第三方服务或软件。* -_本协议原文为中文版本，如有任何理解上的差异，以中文版本为准。_ +*本协议原文为中文版本，如有任何理解上的差异，以中文版本为准。* ## 1. 节点间通信相关信息 ### 1.1 节点发现信息 -在“独立”模式以外的组网场景下，为实现跨网络设备间的互联及 NAT 穿透，EasyTier 会访问由用户手动指定的组网服务器。在发起组网或寻找对端节点时，客户端程序会向服务器发送连接请求，该请求包含但不限于本地节点的网络配置参数、虚拟 IP 地址等信息。服务器将根据请求识别并返回客户端的公网出口 IP 地址及端口信息，并将这些必要元数据向经过授权且网络配置相符的合法对端节点进行公告。 +在“独立”模式以外的组网场景下，为实现跨网络设备间的互联及 NAT 穿透，EasyTier +会访问由用户手动指定的组网服务器。在发起组网或寻找对端节点时，客户端程序会向服务器发送连接请求，该请求包含但不限于本地节点的网络配置参数、虚拟 IP +地址等信息。服务器将根据请求识别并返回客户端的公网出口 IP 地址及端口信息，并将这些必要元数据向经过授权且网络配置相符的合法对端节点进行公告。 ### 1.2 网络连接信息 @@ -26,27 +28,32 @@ _本协议原文为中文版本，如有任何理解上的差异，以中文版 ### 2.1 数据加密说明 -EasyTier 默认采用工业级对称加密算法（如 AES-GCM 或 ChaCha20-Poly1305）对所有传输的流量进行保护。用户需要在组网节点间配置一致的预共享密钥（PSK）。所有通过本软件传输的数据在离开发送端前均会完成加密，确保只有持有正确密钥的合法节点能够解密并读取通信内容。我们不持有您的私有密钥，因此无法查阅您的任何通信数据。 +EasyTier 默认采用工业级对称加密算法（如 AES-GCM 或 +ChaCha20-Poly1305）对所有传输的流量进行保护。用户需要在组网节点间配置一致的预共享密钥（PSK）。所有通过本软件传输的数据在离开发送端前均会完成加密，确保只有持有正确密钥的合法节点能够解密并读取通信内容。我们不持有您的私有密钥，因此无法查阅您的任何通信数据。 ### 2.2 中继机制中的数据处理 -在无法建立直接 P2P 连接的复杂网络环境下，加密流量可能通过中继节点进行转发。即便在此场景下，流量依然保持对称加密状态。中继节点仅负责数据包的透传与路由，不具备解密能力，无法获取或分析被加密的原始数据内容。 +在无法建立直接 P2P +连接的复杂网络环境下，加密流量可能通过中继节点进行转发。即便在此场景下，流量依然保持对称加密状态。中继节点仅负责数据包的透传与路由，不具备解密能力，无法获取或分析被加密的原始数据内容。 ## 3. 服务器说明 ### 3.1 公共服务器 -为了辅助 NAT 探测与打洞，本软件提供用户使用公共的架设在第三方服务商的 EasyTier 服务器。当软件向这些服务器发起交互请求时，您的公网 IP 地址、端口信息及基本网络元数据可能会暴露给这些第三方服务提供商。此类数据的处理流程受各服务商自身隐私政策的约束，建议您查阅相关方的政策说明。 +为了辅助 NAT 探测与打洞，本软件提供用户使用公共的架设在第三方服务商的 EasyTier 服务器。当软件向这些服务器发起交互请求时，您的公网 IP +地址、端口信息及基本网络元数据可能会暴露给这些第三方服务提供商。此类数据的处理流程受各服务商自身隐私政策的约束，建议您查阅相关方的政策说明。 ### 3.2 第三方服务器 -本软件允许用户自行指定并连接到由第三方运行的组网服务器或中继节点。用户需知晓，连接此类服务器意味着您的连接元数据（如 IP 地址、网络信息等）将对该服务器运行方可见。开发者不对任何第三方服务器的安全性、数据处理行为或服务稳定性负责，亦不承担由此产生的任何直接或间接法律责任。 +本软件允许用户自行指定并连接到由第三方运行的组网服务器或中继节点。用户需知晓，连接此类服务器意味着您的连接元数据（如 IP +地址、网络信息等）将对该服务器运行方可见。开发者不对任何第三方服务器的安全性、数据处理行为或服务稳定性负责，亦不承担由此产生的任何直接或间接法律责任。 ## 4. 数据保留与存储 ### 4.1 本地配置存储 -本软件会将网络配置文件（包括虚拟 IP 地址、预共享对称密钥、节点公私钥以及对端地址等）存储在您的本地设备中。本软件不提供任何形式的云端备份或同步服务，这些敏感配置信息绝不会被自动同步或上传至任何中央服务器。用户需自行负责本地配置文件的安全管理。 +本软件会将网络配置文件（包括虚拟 IP +地址、预共享对称密钥、节点公私钥以及对端地址等）存储在您的本地设备中。本软件不提供任何形式的云端备份或同步服务，这些敏感配置信息绝不会被自动同步或上传至任何中央服务器。用户需自行负责本地配置文件的安全管理。 ### 4.2 日志与分析数据 @@ -58,7 +65,8 @@ EasyTier 默认采用工业级对称加密算法（如 AES-GCM 或 ChaCha20-Poly ## 5. 儿童隐私保护 -EasyTier 是一款网络工具类软件，不以吸引或面向儿童为设计目标。由于本软件在设计上不设立账户系统且不收集个人身份信息，我们不会有意收集、处理或存储 13 岁以下（或当地法律规定的相关年龄）儿童的任何个人数据。 +EasyTier 是一款网络工具类软件，不以吸引或面向儿童为设计目标。由于本软件在设计上不设立账户系统且不收集个人身份信息，我们不会有意收集、处理或存储 13 +岁以下（或当地法律规定的相关年龄）儿童的任何个人数据。 ## 6. 政策修订 From c7f9bf210300f9c96ed50e1dc6395d731d9e21dd Mon Sep 17 00:00:00 2001 From: fanyang Date: Sun, 14 Jun 2026 14:34:27 +0800 Subject: [PATCH 2/4] chore: ignore formatting commit in blame --- .git-blame-ignore-revs | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .git-blame-ignore-revs diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 00000000..e2802e34 --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1,2 @@ +# Format Markdown documentation with Flowmark. +f81d54e1027ba4e38465eea921488d78474a4ac0 From e77b4bb647dc329b97e6149f74452ca40fe37485 Mon Sep 17 00:00:00 2001 From: fanyang Date: Sun, 14 Jun 2026 14:43:35 +0800 Subject: [PATCH 3/4] chore: fix lint configuration --- eslint.config.js | 1 + 1 file changed, 1 insertion(+) diff --git a/eslint.config.js b/eslint.config.js index 8f259ca5..16eb49aa 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -8,5 +8,6 @@ export default antfu({ 'pnpm/yaml-enforce-settings': 'off', 'style/eol-last': ['error', 'always'], }, + // Markdown formatting is handled by Flowmark to avoid formatter conflicts. ignores: ['**/*.md'], }) From fc4d1f138a79da9dd499e8cb02f99b9e47c8104e Mon Sep 17 00:00:00 2001 From: fanyang Date: Sun, 14 Jun 2026 14:51:03 +0800 Subject: [PATCH 4/4] chore: update ignored blame revision --- .git-blame-ignore-revs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs index e2802e34..878e219a 100644 --- a/.git-blame-ignore-revs +++ b/.git-blame-ignore-revs @@ -1,2 +1,2 @@ # Format Markdown documentation with Flowmark. -f81d54e1027ba4e38465eea921488d78474a4ac0 +819fecec5b68a64a17389d0b4ce2c4de5b0553a5