sijie.sun
133 lines
4.5 KiB
Markdown
133 lines
4.5 KiB
Markdown
# 使用 Web 控制台
|
||
|
||
EasyTier 支持使用 [Web 控制台](https://easytier.cn/web#/) 来管理 EasyTier 节点，包括查看节点状态、配置节点参数、查看节点日志等。
|
||
|
||
## 注册账号
|
||
|
||
首次使用 Web 控制台需要注册账号，[注册地址](https://easytier.cn/web#/auth/register)。
|
||
|
||
## 运行 EasyTier 节点
|
||
|
||
如果希望 EasyTier 节点可以被 Web 控制台管理，需要在启动时指定 `--config-server` 或 `-w` 参数，例如：
|
||
|
||
```sh
|
||
sudo ./easytier-core -w <你的用户名>
|
||
```
|
||
|
||
> 请将 `<你的用户名>` 替换为你在 Web 控制台注册的用户名。
|
||
|
||
如果终端出现类似 “连接成功” 或 “已连接服务器” 的提示，则表示 Easytier Core 已成功连接到 Web 控制台的服务器。
|
||
|
||
::: tip 提示
|
||
Web 后端通过机器唯一码来识别设备和持久化配置，默认情况下 EasyTier 会自动从系统中获取机器唯一码。若机器码获取失败会导致重启后配置丢失，建议使用 `--machine-id` 参数指定机器码，例如：
|
||
|
||
```sh
|
||
sudo ./easytier-core -w <你的用户名> --machine-id abc123
|
||
```
|
||
|
||
请确保机器码在所有设备中唯一且不变。 **强烈建议 Docker 环境下手动指定机器码。**
|
||
:::
|
||
|
||
::: danger 注意
|
||
一台机器只能有一个 EasyTier 进程被 Web 控制台管理，如果有多个进程可能会导致奇怪的问题。
|
||
:::
|
||
|
||
::: tip 提示
|
||
|
||
可以通过 `--hostname <自定义主机名>` 参数指定控制台上显示的主机名。
|
||
|
||
:::
|
||
|
||
## 使用 Web 控制台
|
||
|
||
使用刚才注册的用户名和密码登录 [Web 控制台](https://easytier.cn/web#/)，登录成功后会看到节点列表。
|
||
|
||
在网页上选择你需要配置的设备。
|
||
|
||
|
||
|
||
点开设备后，点击绿色的连接按钮。
|
||
|
||
|
||
|
||
|
||
进行配置
|
||
|
||
|
||
|
||
接下来的配置步骤与之前配置带 GUI 的程序相同。
|
||
|
||
# 自建 Web 控制台
|
||
|
||
EasyTier 支持自建 Web 控制台来管理 EasyTier 节点，EasyTier Web 控制台采用前后端分离的架构，在设计上共有3个服务
|
||
|
||
1. Web 前端（默认11211端口）
|
||
2. Web API 后端（默认11211端口）
|
||
3. 配置下发端（默认22020端口，UDP协议）
|
||
|
||
其中，web前端与web api后端默认绑定在同一端口，配置下发端则是web api后端的一部分。
|
||
|
||
EasyTier的web控制台有2个版本
|
||
|
||
- `easytier-web`（仅web api后端）
|
||
- `easytier-web-embed`（web前端 + web api后端）
|
||
|
||
下面举一个用`easytier-web-embed`前后端同时部署的例子
|
||
|
||
```sh
|
||
./easytier-web-embed \
|
||
--api-server-port 11211 \
|
||
--api-host "http://127.0.0.1:11211" \
|
||
--config-server-port 22020 \
|
||
--config-server-protocol udp
|
||
```
|
||
|
||
运行后若无任何内容显示则成功。
|
||
|
||
下面是`easytier-web-embed`常用参数的说明：
|
||
|
||
- `--api-server-port`: web前后端的端口
|
||
- `--api-host`: 在web前端指定web api后端的访问地址（不设你就只能在web前端手动指定api后端地址）
|
||
- `--config-server-port`: 用于easytier-core连接的配置下发端的端口
|
||
- `--config-server-protocol`: 用于easytier-core连接的配置下发端的协议（支持 tcp, udp, ws）
|
||
- `--web-server-port`: 额外监听web前端的端口（注：此设置不受 --no-web 影响）
|
||
- `--no-web`: 不运行web前端（关闭 --api-server-port 端口的前端功能）
|
||
|
||
之后打开 Web 控制台 `http://127.0.0.1:11211`就可以看到这个页面。
|
||
|
||
|
||
|
||
点击`Register`注册一个账户，若刷新不出验证码则说明你`--api-host`设置有误。
|
||
|
||
|
||
|
||
::: tip 提示
|
||
|
||
你可以用EasyTier官方前端`https://easytier.cn/web`访问你的Web API后端，无需自建前端。
|
||
|
||
:::
|
||
|
||
## 接入自建 Web 控制台
|
||
|
||
前面我们本地搭建好了web控制台，并且配置下发端口为22020，协议UDP，那么easytier接入自建控制台的指令就是
|
||
|
||
```sh
|
||
# ./easytier-core -w <protocol>://<host>:<port>/<你在自建web控制台上的用户名>
|
||
# protocol: udp, tcp, ws, wss
|
||
./easytier-core -w udp://127.0.0.1:22020/<你在自建web控制台上的用户名>
|
||
```
|
||
|
||
接下来的用法就和官方控制台一样了。
|
||
|
||
::: tip 注意
|
||
|
||
Web 控制台有了两个默认账户，用户名与密码分别为`admin`和`user`。虽然这属于普通账户，但仍需留意其存在。
|
||
|
||
:::
|
||
|
||
::: tip 注意
|
||
|
||
当设置监听的协议为ws时，若被反向代理为wss，则连接时可填写protocol为`wss`。
|
||
|
||
:::
|