besutkode/gotty

GoTTY - 将终端共享为Web应用

GoTTY是一款轻量级命令行工具，能将本地CLI工具转化为Web应用，用户可通过浏览器访问并操作终端，适用于远程协作、演示或便捷访问场景。

核心功能

• 终端Web化：将任意CLI命令（如top、bash）转为网页端可访问的终端界面
• 安全控制：支持基础认证（用户名密码）、TLS加密、随机URL访问限制
• 多客户端共享：结合tmux/screen实现多用户共享同一终端会话
• 灵活配置：可自定义端口、终端尺寸、重连策略等参数

使用场景

1. 远程访问服务器终端，无需SSH客户端
2. 团队协作中共享终端操作过程（如调试、演示）
3. Docker环境下为每个客户端提供隔离的终端会话
4. 快速分享本地命令执行结果给他人

配置说明

常用选项

• -p <端口>：指定监听端口（默认8080）
• -c <用户:密码>：启用基础认证
• -t：启用TLS加密（需提供证书文件）
• -r：生成随机URL以限制访问
• -w：允许客户端写入终端（需谨慎使用）

配置文件示例

在~/.gotty中自定义默认配置：

port = "9000"
enable_tls = true
preferences {
    font_size = 12
    background_color = "rgb(24,24,24)"
}

Docker部署示例

基本运行（展示top命令）

bash
docker run -d -p 8080:8080 docker.xuanyuan.run/besutkode/gotty top

访问http://localhost:8080即可查看top命令输出。

带基础认证的运行

bash
docker run -d -p 8080:8080 docker.xuanyuan.run/besutkode/gotty -c admin:123456 bash

客户端访问时需输入用户名admin和密码***。

共享tmux会话

bash
docker run -d -p 8080:8080 docker.xuanyuan.run/besutkode/gotty tmux new -A -s shared_session bash

多个客户端可同时访问该会话，本地也可通过tmux attach -t shared_session连接。

注意事项

• 启用客户端写入（-w）时需确保命令安全，避免未授权操作
• 传输敏感信息时务必启用TLS加密（-t）
• 结合终端复用工具（如tmux）可实现更灵活的多用户协作