Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .vitepress/config/cn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ export const cn = defineConfig({
items: [
{ text: '功能简介', link: '/guide/introduction' },
{ text: '下载', link: '/guide/download' },
{ text: '安装', link: '/guide/installation' },
{ text: '安装 CLI', link: '/guide/installation' },
{ text: '安装 GUI', link: '/guide/installation_gui' },
{ text: '常见问题', link: '/guide/faq' },
],
},
{
text: '命令行工具组网',
link: '/guide/networking',
items: [
{ text: '快速组网', link: '/guide/network/fast-networking' },
{ text: '快速组网', link: '/guide/network/quick-networking' },
{ text: '去中心组网', link: '/guide/network/decentralized-networking' },
{ text: '使用 Web 控制台组网', link: '/guide/network/web-console' },
{ text: '使用 WireGuard 客户端接入', link: '/guide/network/use-easytier-with-wireguard-client' },
Expand All @@ -32,8 +34,10 @@ export const cn = defineConfig({
{ text: 'SOCKS5', link: '/guide/network/socks5' },
{ text: '搭建共享节点', link: '/guide/network/host-public-server' },
{ text: '改善 P2P', link: '/guide/network/p2p-optimize' },
{ text: '魔法 DNS', link: '/guide/network/magic-dns' },
] },
{ text: '开机自启(注册服务)', collapsed: true, items: [
{ text: '一键安装服务', link: '/guide/network/oneclick-install-as-service' },
{ text: '安装为 Windows 服务', link: '/guide/network/install-as-a-windows-service' },
{ text: '安装为 Linux systemd 服务', link: '/guide/network/install-as-a-systemd-service' },
{ text: '安装为 macOS 服务', link: '/guide/network/install-as-a-macos-service' },
Expand Down
9 changes: 7 additions & 2 deletions .vitepress/config/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,31 @@ export const en = defineConfig({
items: [
{ text: 'Introduction', link: '/en/guide/introduction' },
{ text: 'Download', link: '/en/guide/download' },
{ text: 'Installation', link: '/en/guide/installation' },
{ text: 'Installation CLI', link: '/en/guide/installation' },
{ text: 'Installation GUI', link: '/en/guide/installation_gui' },
{ text: 'FAQ', link: '/en/guide/faq' },
],
},
{
text: 'Command Line Networking',
link: '/en/guide/networking',
items: [
{ text: 'Quick Networking', link: '/en/guide/network/fast-networking' },
{ text: 'Quick Networking', link: '/en/guide/network/quick-networking' },
{ text: 'Decentralized Networking', link: '/en/guide/network/decentralized-networking' },
{ text: 'Networking with Web Console', link: '/en/guide/network/web-console' },
{ text: 'Using WireGuard Client', link: '/en/guide/network/use-easytier-with-wireguard-client' },
{ text: 'Subnet Proxy (Point-to-Network)', link: '/en/guide/network/point-to-networking' },
{ text: 'Bandwidth and Latency Optimization (KCP Proxy)', link: '/en/guide/network/kcp-proxy' },
{ text: 'Advanced Features', collapsed: true, items: [
{ text: 'Network-to-Network', link: '/en/guide/network/network-to-network' },
{ text: 'No TUN Mode (No Root Required)', link: '/en/guide/network/no-root' },
{ text: 'SOCKS5', link: '/en/guide/network/socks5' },
{ text: 'Hosting Public Server', link: '/en/guide/network/host-public-server' },
{ text: 'P2P Optimization', link: '/en/guide/network/p2p-optimize' },
{ text: 'Magic DNS', link: '/en/guide/network/magic-dns' },
] },
{ text: 'Autostart (Register Service)', collapsed: true, items: [
{ text: 'One-Click Install Service', link: '/en/guide/network/oneclick-install-as-service' },
{ text: 'Install as Windows Service', link: '/en/guide/network/install-as-a-windows-service' },
{ text: 'Install as Linux systemd Service', link: '/en/guide/network/install-as-a-systemd-service' },
{ text: 'Install as macOS Service', link: '/en/guide/network/install-as-a-macos-service' },
Expand Down
Binary file modified assets/AstralET1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/AstralET2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/AstralET3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/AstralET4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/AstralET5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/alipay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/cn/config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/cn/manual.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/cn/portal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/cn/portal_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/cn/running.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/cn/subnet-mapping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/cn/subnet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/easytier.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/game-step1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/game-step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/game-step3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/game-step4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/game-step5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/game-step6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gui-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/image-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/image-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/image-6.png
Binary file not shown.
Binary file removed assets/image-7.png
Binary file not shown.
Binary file modified assets/manage-step1.png
Binary file modified assets/manage-step2.png
Binary file modified assets/manage-step3.png
Binary file modified assets/manage-step4.png
Binary file modified assets/manage-step5.png
Binary file modified assets/manage-step6.png
Binary file modified assets/manage-step7.png
Binary file modified assets/manage-step8.png
Binary file modified assets/manage-step9.png
Binary file modified assets/web-device-config.png
Binary file modified assets/web-device-list.png
Binary file modified assets/web-device-run-network.png
Binary file modified assets/web-homepage.png
Binary file added assets/wechat.png
Binary file removed assets/weixin.png
Diff not rendered.
Binary file modified assets/win-service.png
Binary file removed assets/zhifubao.png
Diff not rendered.
24 changes: 11 additions & 13 deletions en/guide/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const packages = ref<Package[]>([
cli_pkg_tmpl: {
"zip": 'https://github.com/EasyTier/EasyTier/releases/download/v{}/easytier-windows-x86_64-v{}.zip'
},
comment: "Support Windows 8 and above, Windows 7 only supports EasyTier v2.1.2 and below."
comment: "Windows 7 needs to be SP1 and above, and you need to install the two patches KB3063858 and KB4474419, and disable QUIC input."
},
{
os: "Windows",
Expand All @@ -49,17 +49,6 @@ const packages = ref<Package[]>([
"zip": 'https://github.com/EasyTier/EasyTier/releases/download/v{}/easytier-windows-arm64-v{}.zip'
},
},
{
os: 'Windows 7',
arch: 'x86_64',
gui_pkg_tmpl: {
"exe": 'https://github.com/EasyTier/EasyTier/releases/download/v2.1.2/easytier-gui_2.1.2_x64-setup.exe'
},
cli_pkg_tmpl: {
"zip": 'https://github.com/EasyTier/EasyTier/releases/download/v2.1.2/easytier-windows-x86_64-v2.1.2.zip'
},
comment: "Windows 7 needs to be SP1 and above, and you need to install the two patches KB3063858 and KB4474419. This version is EasyTier v2.1.2."
},
{
os: "Linux",
arch: "x86_64",
Expand Down Expand Up @@ -113,6 +102,14 @@ const packages = ref<Package[]>([
cli_pkg_tmpl: {},
comment: "If you encounter abnormal display issues, please try upgrading WebView"
},
{
os: "Android Magisk Module",
arch: "aarch64",
gui_pkg_tmpl: {},
cli_pkg_tmpl: {
"zip": 'https://github.com/EasyTier/EasyTier/releases/download/v{}/Easytier-Magisk-v{}.zip'
},
},
{
os: "FreeBSD 13.2",
arch: "x86_64",
Expand Down Expand Up @@ -144,11 +141,12 @@ function renderUrlTmpl(url_tmpl: string): string {

You can directly go to the [GitHub Release page](https://github.com/EasyTier/EasyTier/releases) to view the download links for all versions, or use the table below to find the version that suits you.

The command line program package includes three executables:
The command line program package includes four executables:

- `easytier-core`: The core program of EasyTier
- `easytier-cli`: EasyTier management program, after starting easytier-core, you can use easytier-cli to view virtual network information
- `easytier-web`: Used for self-hosting the EasyTier Web console backend, generally no need to self-host, you can use the official Web console
- `easytier-web-embed`: Same functionality as `easytier-web`, but includes the Web frontend.

## <a :href="url + version">EasyTier v{{ version }}</a> { #latest }

Expand Down
39 changes: 39 additions & 0 deletions en/guide/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Frequently Asked Questions {#faq}

---

**Q: Windows 7 cannot create a network, the program crashes or reports an error saying it cannot create a virtual network?**

**A:** Windows 7 requires SP1 or later versions, and the following patches must be installed:
- [KB3063858](https://www.microsoft.com/en-us/download/details.aspx?id=47409)
- [KB4474419](https://www.catalog.update.microsoft.com/search.aspx?q=KB4474419)

---

**Q: The Linux command-line help is in English, how can I switch to Chinese?**

**A:** Set the environment variable `LANG=zh_CN`. Use the following command:

```bash
export LANG=zh_CN
```

---

**Q: What should I do if TunError is displayed after startup?**

**A:** Please ensure that the TUN driver is correctly loaded and the `/dev/net/tun` file exists. If running in Docker, ensure privileged mode is enabled. The command to load the TUN driver on Linux is as follows:

```bash
modprobe tun
mkdir -p /dev/net
sudo mknod /dev/net/tun c 10 200
```

---

**Q: What should I do if the error `Address already in use` is reported after startup?**

**A:** This may be due to port conflicts. Please check whether port 11010 or the port specified by the startup parameter (e.g., `-l tcp:12345`) is occupied by other programs.

---
2 changes: 1 addition & 1 deletion en/guide/gui/basic.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Public Server Networking

Currently, a small bandwidth public server is provided to facilitate networking for friends without a public server. In most cases, P2P tunneling can be successful. If P2P tunneling fails, the bandwidth between nodes may be relatively low.
The GUI defaults to using official shared nodes for networking, which is convenient for friends without public IPs. In most cases, P2P tunneling can be successful. If P2P tunneling fails, the bandwidth between nodes may be relatively low.

The configuration method is shown in the figure.

Expand Down
24 changes: 11 additions & 13 deletions en/guide/gui/easytier-game.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,40 @@

## Introduction

EasyTierGame is a game launcher developed with `nuxt3`, `typescript`, `rust`, and `tauri`.
It features a simple interface and includes the latest EasyTier core, providing a comfortable experience both psychologically and practically when playing online. It also supports custom configuration file launches 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](https://github.com/EasyTier/EasytierGame/releases)

- Only a green zip package is available. I personally dislike 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 game. You can later create your own server or use servers provided by community members.
- 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)

- If your needs are still not met, you can use a configuration file to start the game. 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)

## Features

- Developed based on the EasyTier networking tool, with a clear and simple interface.
- Comes with an "update" button. When a new version of the EasyTier networking tool is released, click update to get it (requires a VPN).
- For the first use, enter a "hostname" and click to start the game. You can later create your own server or use servers provided by community members.
- Simple configuration with advanced features, also supports custom configuration file launches.
- **WinIPBroadcast** is enabled by default, so you no longer have to worry about not finding rooms when playing online (e.g., Borderlands 3).
- Tested and stable for online play with **Elden Ring**, **Borderlands 3**, **Deep Rock Galactic**, **Monster Hunter: World**, and more.
- 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.

## System Support

Expand Down
51 changes: 25 additions & 26 deletions en/guide/gui/easytier-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,27 @@

## 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](https://github.com/xlc520/easytier-manager/releases)

#### Package Descriptions

- `exe`: Installer, needs to be installed before use
- `zip`: No installation required, just unzip to use
- `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-x64_2.0.0.exe`: Installer for 64-bit Windows systems
- `easytier-manager-win-ia32_2.0.0.exe`: Installer for 32-bit Windows systems
- `easytier-manager-win7-x64_2.0.0.exe`: Installer for 64-bit Windows 7 systems
- `tar.gz` `deb` `rpm` `AppImage`: For use on Linux systems (untested)
- `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
- `tar.gz` `deb` `rpm` `AppImage`: For Linux systems (not yet tested)

## Tutorial

- **1. [Important] On the settings page, check if the kernel exists. If not, download and install the kernel, then check again** (only needed for the first use, subsequent uses can run directly if the kernel exists)
- **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. On the configuration page, create a new network configuration, either by editing the code directly or by filling out a form
- 2. Configuration page: Create new network configurations, providing both direct code editing and form filling methods

![manage-step3](/assets/manage-step3.png)

Expand All @@ -33,42 +32,42 @@ Releases: [https://github.com/xlc520/easytier-manager/releases](https://github.c

![manage-step6](/assets/manage-step6.png)

- 3. On the workspace (home page), run the specified configuration
- 3. Workspace (home page): Run specified configurations

![manage-step7](/assets/manage-step7.png)

- 4. [Optional] After the network is successfully configured, you can exit the manager if there are no connection issues. The core program will run in the background (right-click the tray icon and select `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 the specified configuration as a system service
- 5. [Optional] On the configuration page, install specified configurations as system services

![manage-step8](/assets/manage-step8.png)

![manage-step9](/assets/manage-step9.png)

## Introduction

EasyTier Manager integrates Vue3 + Vite5 + Electron33 + Element-Plus. It is a free and open-source network management tool based on `element-plus`. It is developed using the latest technologies such as `vue3`, `vite5`, and `TypeScript`.
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 the network is successfully configured, you can exit the manager without affecting the network, so it won't occupy memory or cause memory leaks
- **Multiple Configurations**: Supports running and managing multiple network configurations
- **System Service Installation**: One-click installation as a system service with automatic startup on boot
- **Visual Configuration**: Provides a form for visual network configuration, making it simple and convenient
- **Visual Log Viewing**: View logs of the current network configuration on the home page
- **One-Click Download and Install**: One-click download and install of the kernel with built-in accelerated sources, no manual download required
- **Latest Tech Stack**: Developed using cutting-edge technologies like Electron33/Vue3/vite5
- **TypeScript**: A language for application-scale JavaScript
- **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
- **TypeScript**: Application-level JavaScript language
- **Internationalization**: Built-in comprehensive internationalization solution

## Bug Reports & Suggestions

> The project is stable and may not have new features developed, only bug fixes
> Tending towards stability, may not develop new features, only fix vulnerabilities and such

Check [TODO](https://github.com/xlc520/easytier-manager/blob/master/TODO.md) to see if there are existing records 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

[BUG Report | Feature Suggestion](https://github.com/xlc520/easytier-manager/issues/new/choose)
[Submit Bug | Feature Request](https://github.com/xlc520/easytier-manager/issues/new/choose)

## System Support

Theoretically supports Windows 11, Windows 10, Windows 7
Theoretically supports Windows 11, Windows 10, and Windows 7.
7 changes: 4 additions & 3 deletions en/guide/gui/manual.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# 手动组网
# Manual Networking

EasyTier 不区分客户端服务端,且完全去中心化,新增节点只需与虚拟网络中的任意节点建链即可加入组网。配置方法如下图所示。
EasyTier does not distinguish between client and server, and is completely decentralized. New nodes only need to establish a connection with any node in the virtual network to join the network. The configuration method is shown in the figure below.

![手动组网](/assets/cn/manual.png)
![Manual Networking](/assets/cn/manual.png)

Note: After entering the node IP, you need to click on the list item to confirm. After confirmation, the node address will be displayed in card format.
Loading