lucacalcaterra/wetty

WeTTy = Web + TTy

基于HTTP和HTTPS的终端工具。WeTTy是ajaxterm和anyterm的替代方案，但功能更强大，因为它使用xterm.js（完全用JavaScript编写的终端仿真实现），并通过websockets而非Ajax通信，响应速度更快。

镜像概述和主要用途

WeTTy允许用户通过Web浏览器访问终端，支持本地和远程服务器的SSH连接，适用于需要通过Web界面管理服务器、进行远程终端操作的场景。

核心功能和特性

• 完整终端仿真：基于xterm.js实现，支持标准终端功能
• 高效通信：使用websockets替代Ajax，响应速度更快
• 灵活连接：支持本地登录（root用户）或SSH连接（非root用户）
• 自定义配置：可指定端口、SSH主机、用户、端口及URL前缀
• HTTPS支持：可直接配置SSL或通过代理（如Nginx、Apache）实现HTTPS
• 自动登录：支持通过URL参数传递密码实现自动登录（需注意安全风险）
• Docker部署：提供Docker化版本，支持快速部署

安装方法

从源码安装

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

从npm安装（全局）

使用yarn或npm：

• yarn: yarn global add wetty.js
• npm: npm i -g wetty.js

自动登录功能依赖（可选）

如需自动登录功能，需安装sshpass（程序其他功能无需此依赖）：

• Debian/Ubuntu: apt-get install sshpass
• Red Hat/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

核心配置参数

通过 --help 标志可查看所有参数。

服务端口

默认端口为3000，可通过 --port 或 -p 修改：

bash
node index.js --port 8080  # 或 -p 8080

SSH主机

• 如以root用户运行且主机为本地，将使用 login 程序而非SSH
• 未指定时默认连接 localhost
• 可通过 --sshhost 指定远程主机：

bash
node index.js --sshhost remote.example.com

默认用户

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

bash
node index.js --sshuser defaultuser

未指定时，用户连接时需手动输入用户名。

SSH端口

默认SSH端口为22，可通过 --sshport 修改：

bash
node index.js --sshport 2222

URL前缀

默认URL前缀为 /wetty，可通过 --base 修改（不可设为 /ssh/${something}，以免破坏用户名匹配）：

bash
node index.js --base /terminal

HTTPS配置

建议使用HTTPS，可通过两种方式实现：

1. 直接配置SSL：需同时指定 --sslkey 和 --sslcert：

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

生成自签名证书（无CA证书时）：

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

2. 通过代理（Nginx/Apache）：此时WeTTy无需启用SSL，由代理处理HTTPS。

自动登录

非root用户运行时，可通过URL参数传递密码实现自动登录（注意安全风险）：

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

代理配置

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

Apache

在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>

Docker部署

WeTTy提供Docker化版本，支持快速部署。修改 docker-compose.yml 配置目标主机后运行：

bash
$ docker-compose up -d

访问 [localhost|$(boot2docker ip)]:PORT 即可。默认用户名为 term，密码为 term（未修改 SSHHOST 时）。

Docker版本中，所有标志可通过环境变量设置（如 SSHHOST、SSHPORT 等）。如需使用官方镜像，移除 build: . 配置。

作为服务运行

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

默认端口为3000，如需修改端口或重定向日志，修改配置文件最后一行，例如：

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