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
14 changes: 11 additions & 3 deletions en/guide/network/host-public-server.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# Self-Hosted Public Server

Users can use their own public IP nodes to host a public server for mesh networking without a public IP, making it convenient for other users without public IPs to form networks.

To start EasyTier as a public server, simply launch `easytier-core` without any parameters (no root permissions required):
Users can use their own public IP nodes to host a public server, making it convenient for other users without public IPs to form networks. To start EasyTier as a public server, simply launch `easytier-core` without any parameters (no root permissions required):

```
easytier-core
```

EasyTier supports public server clusters. Each virtual network (created using the same network name and key) can function as a public server cluster. Nodes from other networks can connect to any node in the public server cluster and discover each other without the need for a public IP. Running a self-hosted public server cluster is identical to running a virtual network, except you can skip configuring an IPv4 address.

You can also use the following command to join the official public server cluster. In the future, load balancing between nodes in the public server cluster will be implemented:

```
sudo easytier-core --network-name easytier --network-secret easytier -p tcp://public.easytier.top:11010
```

## Disable Forwarding

By default, every node of EasyTier is capable of providing forwarding services for other virtual networks, even if the node has specified a `--network-name` and `--network-secret` and has joined a virtual network.

If you wish to change this behavior, you can use the `--relay-network-whitelist` parameter to define a whitelist of network names (a space-separated list of wildcard patterns, e.g., `"ab* abc"`). When the list for this parameter is empty, the node will not provide forwarding services for all other networks.
Expand Down
2 changes: 1 addition & 1 deletion en/guide/network/install-as-a-windows-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. Go to the NSSM official website [https://nssm.cc/download] to download NSSM and extract it to a local directory.
2. Download the command-line version of `easytier-core.exe`, remember the installation directory, such as `D:\Software\Easytier\cli\easytier-core.exe`.
3. Register it as a Windows service, naming it `easytier_service`:
- `nssm.exe install easytier_service D:\Software\Easytier\cli\easytier-core.exe --ipv4 10.144.144.2 --network-name abc --network-secret abc -e tcp://easytier.public.kkrainbow.top:11010`
- `nssm.exe install easytier_service D:\Software\Easytier\cli\easytier-core.exe --ipv4 10.144.144.2 --network-name abc --network-secret abc -e tcp://public.easytier.top:11010`
4. Run `services.msc`, locate the `easytier_service` service, enable it, and set it to start with a delay.
5. To remove the service: `nssm.exe remove easytier_service`.
6. Note that after registering as a service, the program (referring to easytier-core.exe) cannot be modified, deleted, or moved. Otherwise, it needs to be removed for re-registration or modifying the Windows registry.
Expand Down
4 changes: 2 additions & 2 deletions en/guide/network/network-to-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To achieve network-to-network, Node A needs to be the gateway of the 192.168.1.0
Node A
```bash
# Start EasyTier and proxy the 192.168.1.0/24 subnet, and use a public server to help network
easytier-core -i 10.144.144.1 -n 192.168.1.0/24 -p tcp://easytier.public.kkrainbow.top:11010 --network-name n2n_test
easytier-core -i 10.144.144.1 -n 192.168.1.0/24 -p tcp://public.easytier.top:11010 --network-name n2n_test

# Allow the gateway to forward traffic and configure the firewall to allow forwarding traffic
sysctl -w net.ipv4.ip_forward=1
Expand All @@ -41,5 +41,5 @@ iptables -A FORWARD -d 192.168.1.0/24 -j ACCEPT
Node B
```bash
# Start EasyTier and proxy the 10.1.1.0/24 subnet, and use a public server to help network
easytier-core -i 10.144.144.2 -n 10.1.1.0/24 -p tcp://easytier.public.kkrainbow.top:11010 --network-name n2n_test $
easytier-core -i 10.144.144.2 -n 10.1.1.0/24 -p tcp://public.easytier.top:11010 --network-name n2n_test $
```
6 changes: 3 additions & 3 deletions en/guide/network/networking-without-public-ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

EasyTier supports networking using shared public nodes. The currently deployed shared public node is

`tcp://easytier.public.kkrainbow.top:11010`
`tcp://public.easytier.top:11010`

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

Taking two nodes as an example, Node A executes:

```sh
sudo easytier-core -i 10.144.144.1 --network-name abc --network-secret abc -p tcp://easytier.public.kkrainbow.top:11010
sudo easytier-core -i 10.144.144.1 --network-name abc --network-secret abc -p tcp://public.easytier.top:11010
```

Node B executes

```sh
sudo easytier-core --ipv4 10.144.144.2 --network-name abc --network-secret abc -p tcp://easytier.public.kkrainbow.top:11010
sudo easytier-core --ipv4 10.144.144.2 --network-name abc --network-secret abc -p tcp://public.easytier.top:11010
```

After the command is successfully executed, Node A can access Node B through the virtual IP 10.144.144.2.
Expand Down
14 changes: 11 additions & 3 deletions guide/network/host-public-server.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# 自建公共服务器

用户可以使用自己的公网节点自建用于无公网 IP 组网的公共服务器,方便其他无公网 IP 的用户组网。

只需要不带任何参数启动 EasyTier,该节点就可作为公共服务器使用(不需要 root 权限):
用户可以使用自己的公网节点自建用于无公网 IP 组网的公共服务器,方便其他无公网 IP 的用户组网。 需要不带任何参数启动 EasyTier,该节点就可作为公共服务器使用(不需要 root 权限):

```
easytier-core
```

另外 EasyTier 支持服务器集群。每个虚拟网络(通过相同的网络名称和密钥建链)都可以充当公共服务器集群,其他网络的节点可以连接到公共服务器集群中的任意节点,无需公共 IP 即可发现彼此。运行自建的公共服务器集群与运行虚拟网络完全相同,不过可以跳过配置 ipv4 地址。

也可以使用以下命令加入官方公共服务器集群,后续将实现公共服务器集群的节点间负载均衡:

```
sudo easytier-core --network-name easytier --network-secret easytier -p tcp://public.easytier.top:11010
```

## 关闭转发

另外,默认情况下, EasyTier 的每个节点都允许为其他虚拟网提供转发服务,即使该节点已经指定了 网络名 (`--network-name`) 和 网络密钥 (`--network-secret`)、并已加入一个虚拟网。

若需改变此行为,可通过 `--relay-network-whitelist` 参数限定可被转发的网络名白名单(空格分割的通配符列表,如 ` "ab* abc" `)。当该参数的列表为空时,就不会为所有其他网络提供转发服务。
Expand Down
2 changes: 1 addition & 1 deletion guide/network/install-as-a-windows-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1. 前往NSSM官网[https://nssm.cc/download]下载NSSM并解压到本地目录
2. 下载好命令行版easytier-core.exe,记住存放目录,如`D:\Software\Easytier\cli\easytier-core.exe`
3. 将其注册为windows服务,如命名为`easytier_service`:
- `nssm.exe install easytier_service D:\Software\Easytier\cli\easytier-core.exe --ipv4 10.144.144.2 --network-name abc --network-secret abc -e tcp://easytier.public.kkrainbow.top:11010`
- `nssm.exe install easytier_service D:\Software\Easytier\cli\easytier-core.exe --ipv4 10.144.144.2 --network-name abc --network-secret abc -e tcp://public.easytier.top:11010`
4. 运行 `services.msc`,找到easytier_service服务,启用并将其设置为延时启动
5. 如要删除服务:`nssm.exe remove easytier_service`
6. 注意注册成服务后程序(指easytier-core.exe)不能修改、删除或移动,否则需要删除以重新注册或修改win注册表
Expand Down
4 changes: 2 additions & 2 deletions guide/network/network-to-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ id2 -.无需 EasyTier 访问对方子网.-> id1
节点 A
```bash
# 启动 EasyTier 并代理 192.168.1.0/24 网段,并使用公共服务器帮助组网
easytier-core -i 10.144.144.1 -n 192.168.1.0/24 -p tcp://easytier.public.kkrainbow.top:11010 --network-name n2n_test
easytier-core -i 10.144.144.1 -n 192.168.1.0/24 -p tcp://public.easytier.top:11010 --network-name n2n_test

# 允许网关转发流量,并配置防火墙允许转发流量
sysctl -w net.ipv4.ip_forward=1
Expand All @@ -41,5 +41,5 @@ iptables -A FORWARD -d 192.168.1.0/24 -j ACCEPT
节点 B
```bash
# 启动 EasyTier 并代理 10.1.1.0/24 网段,并使用公共服务器帮助组网
easytier-core -i 10.144.144.2 -n 10.1.1.0/24 -p tcp://easytier.public.kkrainbow.top:11010 --network-name n2n_test
easytier-core -i 10.144.144.2 -n 10.1.1.0/24 -p tcp://public.easytier.top:11010 --network-name n2n_test
```
6 changes: 3 additions & 3 deletions guide/network/networking-without-public-ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

EasyTier 支持共享公网节点进行组网。目前已部署共享的公网节点

`tcp://easytier.public.kkrainbow.top:11010`
`tcp://public.easytier.top:11010`

使用共享节点时,需要每个入网节点提供相同的 `--network-name` 和 `--network-secret` 参数,作为网络的唯一标识。

以双节点为例,节点 A 执行:

```sh
sudo easytier-core -i 10.144.144.1 --network-name abc --network-secret abc -p tcp://easytier.public.kkrainbow.top:11010
sudo easytier-core -i 10.144.144.1 --network-name abc --network-secret abc -p tcp://public.easytier.top:11010
```

节点 B 执行

```sh
sudo easytier-core --ipv4 10.144.144.2 --network-name abc --network-secret abc -p tcp://easytier.public.kkrainbow.top:11010
sudo easytier-core --ipv4 10.144.144.2 --network-name abc --network-secret abc -p tcp://public.easytier.top:11010
```

命令执行成功后,节点 A 即可通过虚拟 IP 10.144.144.2 访问节点 B。
Expand Down