Skip to content

使用 Web 控制台

EasyTier 支持使用 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前后端同时部署的例子

cli
sh
./easytier-web-embed \
    --api-server-port 11211 \
    --api-host "http://127.0.0.1:11211" \
    --config-server-port 22020 \
    --config-server-protocol udp
docker
sh
   # docker.io 镜像
   docker pull easytier/easytier:latest
   docker run -d --entrypoint easytier-web-embed -v /yourpath/data:/app -p 11211:11211 -p 22020:22020/udp easytier/easytier:latest

   # 国内用户可以使用 DaoCloud 镜像
   docker pull m.daocloud.io/docker.io/easytier/easytier:latest
   docker run -d --entrypoint easytier-web-embed -v /yourpath/data:/app -p 11211:11211 -p 22020:22020/udp easytier/easytier:latest

-v 路径映射根据自己的情况修改,/app 不要改,这个可以在 docker hub 上看到他默认的 workdir

docker-compose.yml
yaml
services:
  easytier:
    # 如果之前安装了easytier-core的镜像,则改为之前的镜像名
    image: easytier/easytier:latest 
    container_name: easytier-web-embed
    restart: unless-stopped
    ports:
      - "11211:11211"
      - "22020:22020"
    environment:
       - TZ=Asia/Shanghai
    entrypoint: ["/sbin/tini", "--", "easytier-web-embed"]
    command: --api-server-port 11211 --api-host http://127.0.0.1:11211 --config-server-port 22020 --config-server-protocol udp --db /data/et.db
    network_mode: host
    volumes:
      - ./data:/data

运行后若无任何内容显示则成功。

下面是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就可以看到这个页面。

alt text

点击Register注册一个账户,若刷新不出验证码则说明你--api-host设置有误。

alt text

接入自建 Web 控制台

前面我们本地搭建好了web控制台,并且配置下发端口为22020,协议UDP,那么easytier接入自建控制台的指令就是

cli
sh
# ./easytier-core -w <protocol>://<host>:<port>/<你在自建web控制台上的用户名>
# protocol: udp, tcp, ws, wss
./easytier-core -w udp://127.0.0.1:22020/<你在自建web控制台上的用户>
docker-compose.yml
yaml
 services:
   easytier:
     # 国内用户可以使用 daocloud.io 镜像
     # image: m.daocloud.io/docker.io/easytier/easytier:latest
     image: easytier/easytier:latest
     hostname: easytier
     container_name: easytier
     restart: unless-stopped
     network_mode: host
     cap_add:
       - NET_ADMIN
       - NET_RAW
     environment:
       - TZ=Asia/Shanghai
     devices:
       - /dev/net/tun:/dev/net/tun
     volumes:
       - /etc/machine-id:/etc/machine-id:ro
       - ./conf:/config
     command: --config-server udp://127.0.0.1:22020/<你在自建web控制台上的用户名>

接下来的用法就和官方控制台一样了。

注意

Web 控制台有两个默认账户,用户名与密码分别为adminuser。虽然这属于普通账户,但仍需留意其存在。

注意

当设置监听的协议为ws时,若被反向代理为wss,则连接时可填写protocol为wss