putty182/wetty

WeTTy = Web + TTy

镜像概述和主要用途

WeTTy是一个通过HTTP和HTTPS提供终端访问的工具，是ajaxterm和anyterm的替代方案。它使用xterm.js实现完整的终端模拟（纯JavaScript编写），并采用websockets而非Ajax通信，因此具有更优的响应速度。用户可通过浏览器访问终端，支持本地及远程SSH连接。

!WeTTy

核心功能和特性

• 完整终端模拟：基于xterm.js实现，支持标准终端功能
• 高效通信：使用websockets替代Ajax，响应速度更快
• 灵活连接：支持本地登录（root用户）或SSH连接（非root用户）
• HTTPS支持：可直接配置SSL或通过反向代理实现HTTPS
• 自定义配置：支持端口、SSH主机/端口/用户、URL前缀等参数配置
• 自动登录：支持通过URL参数传递密码实现自动登录（需谨慎使用）
• 容器化部署：提供Docker版本，支持快速部署

使用场景和适用范围

• 远程服务器管理：通过浏览器安全访问服务器终端
• 开发环境调试：无需本地终端工具，直接通过浏览器操作
• 多用户共享终端：配置适当权限后支持多用户访问
• 嵌入式设备管理：通过Web界面管理无本地终端的设备

详细使用方法和配置说明

安装方式

从源码安装

bash
$ git clone https://github.com/krishnasrinivas/wetty.git
$ cd wetty
$ yarn
$ yarn build

从npm安装（全局）

使用yarn：

bash
yarn global add wetty.js

使用npm：

bash
npm i -g wetty.js

依赖安装（自动登录功能）

自动登录功能需要安装sshpass（非核心功能必需）：

• Debian/Ubuntu：apt-get install sshpass
• RedHat/CentOS：yum install sshpass

运行WeTTy

基本运行

可作为独立服务运行或集成到 node脚本（API文档见API Doc）：

bash
$ node index.js

浏览器访问：

• http://yourserver:3000/wetty - 提示登录
• http://yourserver:3000/wetty/ssh/<username> - 预先指定用户名

运行行为说明

• 以root用户运行：启动/bin/login（可指定用户名）
• 以非root用户运行：默认SSH连接到localhost

配置参数（Flags）

使用--help查看所有参数：

bash
node index.js --help

服务器端口

默认端口：3000
修改端口：--port或-p

bash
node index.js -p 8080

SSH主机

默认主机：localhost
指定远程主机：--sshhost

bash
node index.js --sshhost 192.168.1.100

注意：root用户运行且主机为本地时，使用login二进制而非SSH

默认用户

指定默认SSH用户：--sshuser
可通过URL覆盖：http://yourserver:3000/ssh/<username>

bash
node index.js --sshuser admin

SSH端口

默认端口：22
指定端口：--sshport

bash
node index.js --sshport 2222

URL前缀

默认前缀：/wetty
自定义前缀：--base（不要设置为/ssh/${something}，会破坏用户名匹配）

bash
node index.js --base /terminal

HTTPS配置

直接运行HTTPS需同时指定证书和密钥：

bash
node index.js --sslkey key.pem --sslcert cert.pem

生成自签名证书：

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

自动登录

非root用户运行时，可通过URL参数传递密码自动登录：

http://yourserver:3000/wetty/ssh/<username>?sshpass=<password>

注意：URL中传递密码存在安全风险，需自行评估

反向代理配置

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;
}

Apache配置

apache
RewriteCond %{REQUEST_URI}  ^/wetty/socket.io [NC]
RewriteCond %{QUERY_STRING} transport=websocket [NC]
RewriteRule /wetty/socket.io/(.*) ws://localhost:3000/wetty/socket.io/$1 [P,L]

<LocationMatch ^/wetty/(.*)>
  DirectorySlash On
  Require all granted
  ProxyPassMatch http://127.0.0.1:3000
  ProxyPassReverse /wetty/
</LocationMatch>

注意：代理使用HTTPS时，WeTTy应关闭SSL

Docker部署

docker-compose配置

修改docker-compose.yml后启动：

bash
$ docker-compose up -d

访问地址：[localhost|$(boot2docker ip)]:PORT

环境变量配置

Docker版本中所有参数可通过环境变量设置：

• SSHHOST：SSH主机
• SSHPORT：SSH端口
• SSHUSER：默认SSH用户
• PORT：服务端口
• BASE：URL前缀
• SSLKEY：SSL密钥路径
• SSLCERT：SSL证书路径

默认凭据（未修改SSHHOST时）：

• 用户名：term
• 密码：term

作为服务运行

init.d服务

bash
$ sudo yarn global add wetty.js
$ sudo cp ~/.config/yarn/global/node_modules/wetty.js/bin/wetty.conf /etc/init
$ sudo start wetty

systemd服务

bash
$ yarn global add wetty.js
$ cp ~/.config/yarn/global/node_modules/wetty.js/bin/wetty.service  ~/.config/systemd/user/
$ systemctl --user enable wetty
$ systemctl --user start wetty

修改配置（如端口或日志）： 编辑wetty.conf，修改执行行：

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

FAQ

支持的浏览器

WeTTy支持所有https://github.com/xtermjs/xterm.js#browser-support%E3%80%82