andi91/ttyd_extended

andi91/ttyd_extended Docker镜像文档

镜像概述和主要用途

andi91/ttyd_extended是ttyd的扩展Docker镜像。ttyd是一个通过Web分享终端的简单命令行工具，该扩展镜像在基础功能上增加了非root用户运行、登录shell支持，以及openssh-client、nano编辑器和screen终端复用工具，且支持x86_64、arm及arm64多架构（无alpine版本）。

核心功能和特性

基础功能（继承自ttyd）

• 基于Libwebsockets和libuv构建，确保高性能运行
• 集成Xterm.js终端，支持CJK字符和IME输入
• 图形化ZMODEM集成，支持lrzsz文件传输
• 基于OpenSSL的SSL加密支持
• 可运行任意自定义命令并支持选项配置
• 提供基础认证及多种自定义选项
• 跨平台支持：macOS、Linux、FreeBSD/OpenBSD、OpenWrt、Windows

扩展镜像特有功能

• 非root用户运行：提升容器安全性
• 登录shell支持：提供标准登录环境
• 工具集成：包含openssh-client（远程连接）、nano（文本编辑）和screen（终端复用）

使用场景和适用范围

• 远程终端访问：通过Web浏览器安全访问服务器终端
• 操作演示与协作：实时分享终端操作过程
• 多架构环境部署：在x86_64、arm或arm64设备上统一部署
• 轻量级管理工具：无需安装客户端，通过浏览器即可完成基础管理
• 开发/测试环境：快速搭建包含基础工具链的Web终端环境

使用方法和配置说明

Docker CLI 快速启动

使用以下命令启动容器，需将<username>和<secretpassword>替换为实际的用户名和密码：

bash
sudo docker run -d -p 7681:7681 -e user=<username> -e password=<secretpassword> andi91/ttyd_extended

Docker Compose 配置

创建docker-compose.yml文件，配置如下（替换<username>和<secretpassword>）：

yaml
version: '3'
services:
  webshell:
    image: 'andi91/ttyd_extended'
    environment:
     - user=<username>
     - password=<secretpassword>
    # 可选：使用环境变量文件（替代直接配置）
    # env_file:
    #  - ./userpass.env
    ports:
     - "7681:7681"

启动服务：

bash
docker-compose up -d

环境变量说明

访问方式

容器启动后，通过浏览器访问 http://<服务器IP或域名>:7681，输入配置的用户名和密码即可登录Web终端。

终端界面预览

!https://github.com/tsl0922/ttyd/raw/master/screenshot.gif

ttyd命令行选项

容器内ttyd工具支持以下主要选项（执行ttyd --help查看完整列表）：

ttyd [options] <command> [<arguments...>]

主要选项：
  -p, --port        监听端口（默认：7681，0为随机端口）
  -c, --credential  基础认证凭据（格式：username:password）
  -s, --ssl         启用SSL加密
  -C, --ssl-cert    SSL证书文件路径
  -K, --ssl-key     SSL密钥文件路径
  -u, --uid         运行用户ID
  -g, --gid         运行组ID
  -R, --readonly    只读模式（禁止客户端写入）
  -m, --max-clients 最大客户端连接数（默认：0，无限制）

浏览器支持

支持现代浏览器，具体兼容范围参考https://github.com/xtermjs/xterm.js#browser-support%E3%80%82

同类工具对比