【导语】:将 CLI 工具变成 Web 利用在浏览器端拜访。

简介

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

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

我的项目地址是:https://github.com/sorenisane...

装置

安装包装置

能够从 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  
开源前哨 日常分享热门、乏味和实用的开源我的项目。参加保护 10万+ Star 的开源技术资源库,包含:Python、Java、C/C++、Go、JS、CSS、Node.js、PHP、.NET 等。