stxnextgotham/wetty

Wetty：Web 终端模拟器

镜像概述和主要用途

Wetty（Web + tty）是一款通过HTTP和HTTPS协议提供终端访问的工具，允许用户在浏览器中使用终端功能。它采用ChromeOS的hterm终端模拟器（纯JavaScript实现的完整终端仿真），并使用WebSockets技术替代传统Ajax，提供更快的响应速度，是ajaxterm/anyterm等工具的增强替代方案。

核心功能和特性

• 完整终端仿真：基于ChromeOS的hterm实现，支持完整的终端功能
• 高效通信：采用WebSockets技术，相比Ajax具有更低延迟和更快响应速度
• 多协议支持：同时支持HTTP和HTTPS两种访问方式
• 灵活连接配置：可连接本地或远程SSH服务器，支持自定义SSH主机、端口和用户
• 反向代理兼容：可部署在Nginx等反向代理之后，支持HTTPS环境集成

使用场景和适用范围

• 远程服务器管理：通过浏览器安全访问服务器终端，无需额外终端工具
• Web集成终端：为Web应用提供嵌入式终端功能
• 开发/运维工具：简化远程操作流程，适合团队协作和远程支持
• 教学演示：在浏览器中展示终端操作过程，便于教学和演示

详细使用方法和配置说明

基本安装（非Docker方式）

1. 克隆仓库：

   bash
   git clone https://github.com/krishnasrinivas/wetty
   

2. 进入目录并安装依赖：

   bash
   cd wetty
   npm install
   

运行在HTTP模式

bash
node app.js -p 3000

• 运行权限差异：

  • 以root用户运行：启动/bin/login，可手动指定用户名
  • 以普通用户运行：默认通过SSH连接localhost

• 远程连接配置：

  • --sshhost：指定远程SSH主机
  • --sshport：指定SSH端口
  • --sshuser：指定SSH用户名

• 通过URL指定用户：

  http://yourserver:3000/wetty/ssh/<username>
  

运行在HTTPS模式

建议优先使用HTTPS。若无CA证书，可生成自签名证书：

bash
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 30000 -nodes

启动HTTPS服务：

bash
node app.js --sslkey key.pem --sslcert cert.pem -p 3000

在Nginx反向代理后运行

在Nginx配置文件中添加以下配置：

nginx
location /wetty {
    proxy_pass http://127.0.0.1:3000/wetty;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_read_timeout 43200000;

    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_set_header X-NginX-Proxy true;
}

• 访问地址规则：

  • root用户运行app.js：http://yourserver.com/wetty
  • 普通用户运行：http://yourserver.com/wetty/ssh/<username>

• 注意：若Nginx已配置HTTPS，Wetty无需启用SSL。

Docker化部署

基本运行命令

bash
docker run --name term -p 3000:3000 -dt docker.xuanyuan.run/nathanleclaire/wetty

• 访问地址：[localhost|服务器IP]:3000
• 默认凭据：用户名term，密码term

作为服务守护进程运行

1. 全局安装Wetty：

   bash
   sudo npm install wetty -g
   

2. 复制配置文件：

   bash
   sudo cp /usr/local/lib/node_modules/wetty/bin/wetty.conf /etc/init
   

3. 启动服务：

   bash
   sudo start wetty
   

• 默认在3000端口运行。如需修改端口或日志配置，编辑/etc/init/wetty.conf文件，例如：

  bash
  exec sudo -u root wetty -p 80 >> /var/log/wetty.log 2>&1
  

配置参数说明