jobscale/wetty

WeTTY Docker镜像文档

镜像概述

WeTTY（Web + TTY）是一款通过HTTP/HTTPS在浏览器中提供终端访问的工具。它使用xterm.js实现完整的终端模拟功能，采用websockets技术替代传统Ajax，提供更优的响应速度，是ajaxterm和anyterm等工具的增强替代方案。

核心功能与特性

• 完整终端模拟：基于xterm.js实现全功能终端仿真，支持标准终端操作
• 高效通信：使用websockets技术，相比Ajax具有更低延迟和更好响应性
• SSH连接支持：可直接连接本地或远程SSH服务器，支持密码和公钥认证
• 灵活配置：提供丰富的命令行参数，支持SSL、自定义端口、基础路径等配置
• 浏览器兼容性：支持所有xterm.js兼容的浏览器

使用场景

• 远程服务器的浏览器端管理与操作
• 开发环境的快速终端访问
• 无需安装终端客户端的临时系统访问
• 嵌入式系统或服务器的Web管理界面集成

使用方法与配置说明

基本运行方式

通过Docker Hub获取镜像并运行：

sh
docker run --rm -p 3000:3000 wettyoss/wetty --ssh-host=<目标IP地址>

运行后，通过浏览器访问 http://localhost:3000/wetty 即可打开终端登录界面。

核心配置参数

高级使用示例

1. 连接远程SSH服务器

sh
docker run --rm -p 8080:3000 wettyoss/wetty \
  --ssh-host=192.168.1.100 \
  --ssh-port=2222 \
  --ssh-user=admin \
  --title="Remote Server Terminal" \
  --port=3000

访问 http://localhost:8080/wetty 即可连接到192.168.1.100:2222的SSH服务。

2. 带SSL加密的安全访问

sh
docker run --rm -p 443:3000 \
  -v /path/to/ssl/key.pem:/ssl/key.pem \
  -v /path/to/ssl/cert.pem:/ssl/cert.pem \
  wettyoss/wetty \
  --ssl-key=/ssl/key.pem \
  --ssl-cert=/ssl/cert.pem \
  --ssh-host=localhost

3. 指定基础路径

sh
docker run --rm -p 3000:3000 wettyoss/wetty --base=/terminal

通过 http://localhost:3000/terminal 访问服务。

反向代理配置建议

为增强安全性，建议将WeTTY部署在反向代理后以支持HTTPS和Let's Encrypt证书：

• Nginx：参考https://github.com/butlerx/wetty/blob/master/docs/nginx.md
• Traefik：项目提供了docker-compose示例配置
• Apache：参考https://github.com/butlerx/wetty/blob/master/docs/apache.md

浏览器支持

支持所有xterm.js兼容的浏览器，包括：

• Chrome/Chromium 54+
• Firefox 52+
• Edge 16+
• Safari 10+

常见问题

• 如何设置自动登录：参考https://github.com/butlerx/wetty/blob/master/docs/auto-login.md
• 如何作为服务运行：参考https://github.com/butlerx/wetty/blob/master/docs/service.md
• 文件下载功能：参考https://github.com/butlerx/wetty/blob/master/docs/downloading-files.md

更多详细文档请访问https://github.com/butlerx/wetty/tree/master/docs%E3%80%82