andi91/ttyd

TTYD Webshell 镜像文档

镜像概述

本镜像为基于Ubuntu系统的TTYD Webshell多架构镜像，集成TTYD工具功能，可将本地终端（TTY）转换为Web应用，支持通过浏览器访问和操作终端。该镜像适配多种硬件架构，提供稳定的运行环境。

更多信息请参考：

• https://github.com/tsl0922/ttyd
• https://github.com/andig91/ttyd

核心功能与特性

• TTYD Webshell功能：将终端（TTY）转换为Web应用，支持通过浏览器实时访问和操作终端
• 多架构支持：适配多种硬件架构（如x86_64、ARM等），可在不同设备上运行
• 基于Ubuntu系统：依托Ubuntu稳定的基础环境，兼容常见Linux命令和工具
• 轻量便捷：无需复杂配置，快速启动Web终端服务

使用场景

• 远程终端访问：通过浏览器远程管理设备，无需安装额外终端客户端
• 嵌入式设备管理：适用于无图形界面的嵌入式设备，通过Web界面进行配置和操作
• 服务器维护：便捷的远程服务器终端操作，支持多用户协作（需额外配置）
• 开发测试环境：快速搭建临时Web终端环境，用于代码调试或演示

使用方法与配置说明

基本运行

通过以下命令启动容器，默认映射TTYD默认端口7681，并启动bash终端：

bash
docker run -p 7681:7681 --rm -it andig91/ttyd

启动后，在浏览器中访问 http://<容器所在IP>:7681 即可打开Web终端界面。

自定义配置

TTYD支持多种命令行参数，可通过在容器启动命令中添加参数实现自定义配置。常用参数示例：

• 修改端口：指定非默认端口（如8080）

  bash
  docker run -p 8080:8080 --rm -it andig91/ttyd -p 8080 bash
  

• 指定终端命令：启动其他终端程序（如zsh）

  bash
  docker run -p 7681:7681 --rm -it andig91/ttyd zsh
  

• 启用认证：添加基本HTTP认证（需替换<username>和<password>）

  bash
  docker run -p 7681:7681 --rm -it andig91/ttyd -c <username>:<password> bash
  

持久化配置

若需保存终端配置或数据，可通过挂载本地目录实现持久化：

bash
docker run -p 7681:7681 --rm -it -v /本地目录:/root andig91/ttyd

上述命令将容器内/root目录挂载到本地目录，保存用户配置文件及数据。

完整参数说明

更多配置参数（如SSL加密、终端大小设置等）请参考TTYD官方文档：
https://github.com/tsl0922/ttyd#usage