神奇！可在浏览器中运行终端命令行的开源工具

来源丨经授权转自 开源前哨（ID：osfront）

作者丨小秋

【导语】：将 CLI 工具变成 Web 应用在浏览器端访问。

简介

GoTTY 是一个简单的命令行工具，可以将 CLI 工具转换为 Web 应用程序。GoTTY 是使用 xterm.js 和 hterm 在 Web 浏览器上运行基于 JavaScript 的终端。

GoTTY 本身提供了一个 websocket 服务器，它简单地将来自 TTY 的输出中转到客户端，并接收来自客户端的输入并将其转发到 TTY。这个 hterm + websocket 的想法受到 Wetty 的启发。

 项目地址 获取方式↓↓↓ 1. 关注下方公众号（非本号）：程序员架构2. 在 消息对话框 回复：210628 即可以获取

安装

安装包安装

可以从 Releases 页面下载最新的稳定二进制文件进行安装，文件名中包含 darwin_amd64 的适用于 Mac 系统。

https://github.com/sorenisanerd/gotty/releases

使用 Homebrew 安装

$ brew install sorenisanerd/gotty/gotty

使用 Go 安装

如果有 Go 语言环境，可以使用 go get 命令安装 GoTTY 。但是，此命令会从最新的 master 分支构建一个二进制文件，其中可能包含不稳定的代码。GoTTY 需要 go 1.9 或以上版本。

$ go get github.com/sorenisanerd/gotty

用法

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

使用终端命令作为 gotty 的参数，如 gotty top。默认情况下，GoTTY 在端口 8080 启动 Web 服务器。在 Web 浏览器上打开 URL，可以看到正在运行的命令，就像在终端上运行一样。

命令参数

   --address value, -a value     要监听的 IP 地址(默认: "0.0.0.0") [$GOTTY_ADDRESS]
   --port value, -p value        要监听的端口号(默认: "8080") [$GOTTY_PORT]
   --path value, -m value        访问路径url(默认: "/") [$GOTTY_PATH]
   --permit-write, -w            允许客户端执行写操作(默认: false) [$GOTTY_PERMIT_WRITE]
   --credential value, -c value  身份验证的凭证(如: 用户名:密码, 默认禁用) [$GOTTY_CREDENTIAL]
   --random-url, -r              向 URL 添加一个随机字符串(默认: false) [$GOTTY_RANDOM_URL]
   --random-url-length value     随机 URL 字符串的长度(默认: 8) [$GOTTY_RANDOM_URL_LENGTH]
   --tls, -t                     启用 TLS/SSL (默认: false) [$GOTTY_TLS]
   --tls-crt value               TLS/SSL 证书文件路径(默认: "~/.gotty.crt") [$GOTTY_TLS_CRT]
   --tls-key value               TLS/SSL 密钥文件路径(默认: "~/.gotty.key") [$GOTTY_TLS_KEY]
   --tls-ca-crt value            TLS/SSL 用于客户端认证的证书(默认: "~/.gotty.ca.crt") [$GOTTY_TLS_CA_CRT]
   --index value                 自定义 index.html 文件[$GOTTY_INDEX]
   --title-format value          浏览器窗口的标题格式(默认: "{{ .command }}@{{ .hostname }}") [$GOTTY_TITLE_FORMAT]
   --reconnect                   启用重新连接(默认: false) [$GOTTY_RECONNECT]
   --reconnect-time value        重新连接的时间(默认: 10) [$GOTTY_RECONNECT_TIME]
   --max-connection value        gotty 的最大连接数(默认: 0) [$GOTTY_MAX_CONNECTION]
   --once                        只接受一个客户端并在断开连接后退出(默认: false) [$GOTTY_ONCE]
   --timeout value               等待客户端连接超时时间(0 表示禁用) (默认: 0) [$GOTTY_TIMEOUT]
   --permit-arguments            允许客户端在 URL 中发送命令行参数(e.g. http://example.com:8080/?arg=AAA&arg=BBB) (默认: false) [$GOTTY_PERMIT_ARGUMENTS]
   --width value                 屏幕的静态宽度，0(默认)表示动态调整大小 [$GOTTY_WIDTH]
   --height value                屏幕的静态高度，0(默认)表示动态调整大小 [$GOTTY_HEIGHT]
   --ws-origin value             与 WebSocket 源 URL 匹配的正则表达式。默认情况下不接受跨源请求 [$GOTTY_WS_ORIGIN]
   --term value                  要在浏览器上使用的终端名称，xterm 或 hterm 之一. (默认: "xterm") [$GOTTY_TERM]
   --enable-webgl                启用 WebGL 渲染器(默认: true) [$GOTTY_ENABLE_WEBGL]
   --close-signal value          当 gotty 停止命令时，发送到命令进程的信号(默认: SIGHUP) [$GOTTY_CLOSE_SIGNAL]
   --close-timeout value         客户端断开后关闭进程的时间(默认: -1) [$GOTTY_CLOSE_TIMEOUT]
   --config value                配置文件路径(默认: "~/.gotty") [$GOTTY_CONFIG]
   --help, -h                    查看帮助文档 (默认: false)
   --version, -v                 打印当前版本 (默认: false)

配置文件

可以通过配置文件来修改 gotty 的一些默认行为，默认会从 ~/.gotty 路径加载配置文件。

// 使用 9000 端口进行监听
port = "9000"

// 启用 TSL/SSL
enable_tls = true

// 修改终端显示字体、颜色
preferences {
    font_size = 5
    background_color = "rgb(16, 16, 32)"
}

安全配置

默认情况下，GoTTY 只允许调整终端窗口大小，不允许客户端发送可能导致写入的命令。如果要允许客户端将输入写入 TTY 时，请添加 -w 选项。不过，接受来自远程客户端的输入对于大多数命令来说是危险的操作。

要限制客户端访问，可以使用 -c 选项启用基本身份验证。使用此选项，客户端需要输入指定的用户名和密码才能连接到 GoTTY 服务器。这种情况下，用户名和密码会以纯文本形式在服务器和客户端之间传输。如果对安全要求更高，请使用 SSL/TLS 证书身份验证。

-r 选项是一种更随意的限制访问方式。GoTTY 会生成一个随机 URL，以便只有知道该 URL 的人才能访问服务器。

默认情况下，服务器和客户端之间的所有流量都未加密。如果通过 GoTTY 发送机密信息，官方强烈建议使用 -t 在会话中启用 TLS/SSL。默认情况下，GoTTY 加载的 CRT和密钥文件放在 ~/.gotty.crt 和 ~/.gotty.key。可以使用 --tls-crt 和 --tls-key 选项指定证书文件路径。如果需要生成自签名认证文件时，可以使用openssl命令：

openssl req -x509 -nodes -days 9999 -newkey rsa:2048 -keyout ~/.gotty.key -out ~/.gotty.crt

点分享

点点赞

点在看