tsl0922/ttyd

ttyd - 通过Web共享终端

镜像概述和主要用途

ttyd 是一款简单的命令行工具，用于通过Web浏览器共享终端会话。它允许用户在Web界面中访问和操作远程终端，支持标准终端功能及扩展特性，适用于远程协助、终端共享、Web化终端访问等场景。

核心功能和特性

• 高性能基础：基于 Libwebsockets 和 libuv 构建，确保高效的网络传输和事件处理
• 全功能终端：集成 Xterm.js 终端模拟器，支持 CJK 字符、IME 输入法及丰富的终端特性
• 文件传输支持：通过 ZMODEM 协议与 lrzsz 工具集成，实现图形化文件传输
• 安全特性：支持 SSL 加密传输及基本认证（用户名/密码验证）
• 高度自定义：可运行任意自定义命令，支持丰富的命令行选项配置
• 跨平台兼容：支持 macOS、Linux、FreeBSD/OpenBSD、OpenWrt 及 Windows 系统

使用场景和适用范围

适用场景

• 远程终端访问：通过Web浏览器访问服务器终端，无需安装SSH客户端
• 终端共享协作：多人实时查看或操作同一终端会话，适用于技术支持、教学演示
• 嵌入式设备管理：为 OpenWrt 等嵌入式系统提供Web化终端管理界面
• 受限网络环境：在仅开放Web端口的网络中，通过HTTP/HTTPS提供终端服务
• 临时终端服务：快速搭建临时终端环境，支持一次性会话（断开连接后自动退出）

适用人群

• 系统管理员、开发人员
• 需要远程管理服务器/设备的用户
• 技术支持及教育培训人员

Docker部署方案

基础运行示例

1. 直接运行容器（默认配置）

bash
# 运行ttyd并共享bash终端，映射端口7681
docker run -d -p 7681:7681 --name ttyd ttyd ttyd bash

访问 http://<主机IP>:7681 即可打开Web终端。

2. 带基本认证的配置

bash
# 设置用户名密码认证（格式：username:password）
docker run -d -p 7681:7681 --name ttyd ttyd ttyd -c admin:password123 bash

3. 启用SSL加密

bash
# 挂载本地SSL证书，启用HTTPS
docker run -d -p 7681:7681 \
  -v /path/to/ssl:/ssl \
  --name ttyd ttyd ttyd \
  -S -C /ssl/cert.pem -K /ssl/key.pem \
  bash

4. 只读模式（禁止客户端输入）

bash
# 仅允许查看终端，禁止写入操作
docker run -d -p 7681:7681 --name ttyd ttyd ttyd -R bash

Docker Compose配置示例

yaml
version: '3'
services:
  ttyd:
    image: ttyd
    container_name: ttyd
    ports:
      - "7681:7681"  # 映射Web访问端口
    command: ttyd -c admin:SecurePass123 -m 5 bash  # 启用认证，限制最大5个客户端
    restart: always
    # 可选：挂载SSL证书（启用HTTPS时）
    # volumes:
    #   - ./ssl:/ssl
    # command: ttyd -S -C /ssl/cert.pem -K /ssl/key.pem -c admin:SecurePass123 bash

配置参数说明

命令行选项

浏览器支持

支持现代浏览器，具体兼容性取决于Xterm.js引擎，包括：

• Chrome/Chromium 80+
• Firefox 75+
• Edge 80+
• Safari 13+

相关信息

替代方案

• Wetty：基于Node.js的Web终端工具，支持SSH登录
• GoTTY：基于Go语言的Web终端工具，轻量且易于部署

致谢

特别感谢JetBrains为该项目提供开源许可支持。

更多信息请访问 https://github.com/tsl0922/ttyd%E3%80%82