redbrick/wetty

WeTTy Docker镜像文档

镜像概述

WeTTy（Web + TTY）是一款通过HTTP/HTTPS在浏览器中提供终端访问的工具，作为ajaxterm和anyterm的替代方案，它采用xterm.js实现完整的终端模拟功能，并使用WebSocket替代Ajax通信，提供更优的响应速度。本Docker镜像封装了WeTTy服务，便于快速部署和使用。

核心功能与特性

• 完整终端模拟：基于xterm.js实现全功能终端仿真，支持标准终端操作
• 高效通信：采用WebSocket协议，相比传统Ajax方式响应速度更快
• 灵活连接：支持连接本地或远程SSH服务器，可通过环境变量配置
• 安全选项：支持SSL加密配置，保障数据传输安全
• 轻量部署：通过Docker容器化，简化安装和环境配置流程

使用场景

• 远程服务器管理：无需安装本地终端客户端，通过浏览器即可访问服务器终端
• 共享终端环境：团队成员可通过浏览器共享同一终端会话
• 教学演示：实时展示终端操作过程
• 受限环境访问：在无法安装终端软件的环境中提供终端功能

安装与使用

基本使用

通过Docker运行WeTTy容器：

bash
docker run -d -p 3000:3000 --name wetty wetty

访问浏览器：http://<服务器IP>:3000/wetty，将显示登录界面。

环境变量配置

WeTTy容器支持以下环境变量配置：

高级使用示例

1. 连接远程SSH主机

bash
docker run -d -p 3000:3000 \
  -e SSHHOST=remote.example.com \
  -e SSHPORT=2222 \
  -e SSHUSER=admin \
  --name wetty-remote wetty

2. 启用SSL加密

bash
docker run -d -p 443:3000 \
  -e SSL_KEY_PATH=/ssl/private.key \
  -e SSL_CERT_PATH=/ssl/certificate.crt \
  -v /path/to/ssl:/ssl \
  --name wetty-ssl wetty

3. 自定义基础路径和端口

bash
docker run -d -p 8080:8080 \
  -e PORT=8080 \
  -e BASE=/terminal \
  --name wetty-custom wetty

访问地址：http://<服务器IP>:8080/terminal

Docker Compose配置示例

yaml
version: '3'
services:
  wetty:
    image: wetty
    ports:
      - "3000:3000"
    environment:
      - SSHHOST=192.168.1.100
      - SSHUSER=devops
      - TITLE=My Remote Terminal
    restart: unless-stopped

常见问题

支持的浏览器

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

• Chrome/Chromium 49+
• Firefox 45+
• Edge 14+
• Safari 10+

如何实现自动登录

可通过配置SSH密钥认证实现自动登录，具体步骤：

1. 将SSH私钥挂载到容器中
2. 配置COMMAND环境变量为包含密钥认证的ssh命令：

bash
docker run -d -p 3000:3000 \
  -e COMMAND="ssh -i /ssh/id_rsa user@host" \
  -v /path/to/ssh/key:/ssh \
  --name wetty-auto-login wetty

如何通过反向代理访问

以Nginx为例，配置反向代理：

nginx
server {
    listen 80;
    server_name wetty.example.com;

    location /wetty/ {
        proxy_pass http://localhost:3000/wetty/;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
    }
}

注意事项

• 生产环境中建议启用SSL加密，避免敏感数据明文传输
• 容器运行用户权限应遵循最小权限原则
• 长时间不活动的会话可能会被服务器断开连接
• 确保目标SSH服务器允许指定用户的连接权限