rndviktor/wetty

Wetty Docker镜像文档

镜像概述

Wetty（Web + tty）是一个通过HTTP和HTTPS提供终端访问的工具，作为ajaxterm/anyterm的替代方案，它使用ChromeOS的hterm终端模拟器（纯JavaScript实现的完整终端仿真）和websockets通信，相比传统Ajax终端具有更好的响应时间和功能完整性。

核心功能与特性

• hterm终端模拟器：采用ChromeOS的hterm，提供完整的终端仿真功能，支持各种终端命令和控制序列
• Websockets通信：使用websockets替代Ajax，实现更低延迟和更实时的交互体验
• 多协议支持：同时支持HTTP和HTTPS协议，可根据需求配置
• 灵活的连接方式：支持连接本地或远程SSH服务器，可通过命令行参数或URL指定用户名、主机和端口
• Nginx代理支持：可部署在Nginx反向代理后，适应生产环境需求
• Docker化部署：提供Docker镜像，简化部署流程

使用场景

• 远程服务器的Web-based终端管理
• 无需安装本地终端工具的临时终端访问
• 团队共享的Web终端环境
• 嵌入式设备或无本地终端环境的系统管理

详细使用方法

Docker部署

基本运行命令

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

访问方式

在浏览器中访问以下URL：

• 本地运行：http://localhost:3000
• 远程服务器：http://<服务器IP>:3000
• 使用boot2docker：http://$(boot2docker ip):3000

默认登录凭据：

• 用户名：term
• 密码：term

高级配置

自定义端口映射

如需使用不同端口（如8080）：

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

配置HTTPS

建议在生产环境中使用HTTPS协议。可通过下列步骤配置：

1. 生成自签名SSL证书：

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

2. 通过Docker挂载证书并运行：

bash
docker run --name term -p 3000:3000 -v $(pwd)/key.pem:/key.pem -v $(pwd)/cert.pem:/cert.pem -dt nathanleclaire/wetty node app.js --sslkey /key.pem --sslcert /cert.pem -p 3000

连接远程SSH服务器

通过命令行参数指定远程SSH主机、端口和用户：

bash
docker run --name term -p 3000:3000 -dt nathanleclaire/wetty node app.js --sshhost <远程主机IP> --sshport <端口> --sshuser <用户名> -p 3000

也可通过URL指定用户名： http://yourserver:3000/wetty/ssh/<用户名>

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

注意：如果Nginx已配置HTTPS，则Wetty应使用HTTP模式运行，无需启用SSL。

作为服务守护进程运行

如需将Wetty作为系统服务长期运行，可参考以下步骤：

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端口运行，可修改wetty.conf文件调整端口和日志输出：

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