七叶笔记 » golang编程 » Web即终端——基于GoTTY,ttyd通过Web共享终端

Web即终端——基于GoTTY,ttyd通过Web共享终端

我们热爱终端,终端简易而便捷,但是终端需要先连接到主机上,连接到主机需要 SSH ,需要认证,需要配证书,设置还要登陆堡垒机才行。对于一般用户有一定的壁垒,那么有没有快捷的方法呢?本文虫虫就给大家介绍通过Web共享终端的两种解决方案——GoTTY和ttyd,GoTTY是 Golang 编写,ttyd是C语言编写两者各有千秋,同学们可以根据喜好选择。

GoTTY

GoTTY 是一个简单的命令行工具,可将可以一键将命令行工具转换为 Web应用程序。

安装

GoTTY的安装非常简单,可以直接 Github 官方仓库下载编译好的二进制文件安装,当前版本为V1.2.0。

文件命名为 darwin _amd64可以用于 Mac OS X 用户。

可以用brew管理器安装:

 brew install sorenisanerd/gotty/gotty  

熟悉golang的用户可以使用go get安装:

 go get github.com/sorenisanerd/gotty  

该命令会将拉取一个最新的master分支构建二进制包,其中可能包含不稳定或破坏性的更改。

用法

GoTTY的使用很简单,基本用法为:

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

如果不带参数gotty使用默认参数(例如 gotty top)。 默认情况下,GoTTY 在监听8080端口启动Web服务。

在浏览器上打开 URL,就可以看到正在运行的命令和终端上运行一样:

基本选项

-a,-address,监听的 IP 地址(默认:”0.0.0.0″,即全网开放),对应配置变量为[$GOTTY_ADDRESS]。

-p,–port,监听的端口号(默认:8080),对应配置变量为[$GOTTY_PORT]。

-m,–path,基本路径(默认”/”),对应配置变量为[$GOTTY_PATH]。

-w,–permit-write,允许客户端TTY写入(默认值:false,注意安全),对应配置变量为[ $GOTTY_PERMIT_WRITE ]。

-c,–credential,基本身份验证的凭据(例如:用户名:密码,默认禁用),对应配置变量[$GOTTY_CREDENTIAL]。

-r,–random-url,向 URL 添加一个随机字符串(默认值:false,建议启用), 对应配置变量[$GOTTY_RANDOM_URL]。

–random-url-length 值随机 URL 长度(默认值:8), 对应配置变量[$GOTTY_RANDOM_URL],[$GOTTY_RANDOM_URL_LENGTH]

-t,–tls,启用TLS/SSL(默认: false) , 对应配置变量[$GOTTY_TLS]

–tls-crt ,TLS/SSL 证书文件路径(默认:~/.gotty.crt), 对应配置变量[ $GOTTY_TLS_CRT ]

–tls-key TLS/SSL 密钥文件路径(默认:~/.gotty.key), 对应配置变量[ $GOTTY_TLS_KEY ]

–tls-ca-crt v,TLS/SSL 用于客户端认证CA根证书文件(默认: ~/.gotty.ca.crt), 对应配置变量[ $GOTTY_TLS_CA_CRT ]

–index 值自定义 index.html 文件, 对应配置变量[ $GOTTY_INDEX ]

–title-format,浏览器窗口的标题格式(默认:{{ .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值超时秒 为 等待客户端(0到禁用), 对应配置变量(默认值:0)[ $ GOTTY_TIMEOUT ]

–permit-arguments 允许客户端 发送 命令 行参数 在 URL 中 (例如 example:8080/?arg=AAA & arg=BBB)(默认值:false), 对应配置变量[ $GOTTY_PERMIT_ARGUMENTS ]

–width value 屏幕的静态宽度,0(default) 表示动态调整大小 (default: 0) , 对应配置变量[ $GOTTY_WIDTH ]

–height value 屏幕的静态高度,0(default) 表示动态调整大小 (default: 0) , 对应配置变量[ $GOTTY_HEIGHT ]

–ws-origin value 与 WebSocket 接受的原始 URL 匹配的正则表达式。 默认情况下不接受跨源请求 , 对应配置变量[ $GOTTY_WS_ORIGIN ]

–term value 要在浏览器上使用的终端名称,xterm 或 hterm 之一。 (默认: “ xterm ” ), 对应配置变量[ $GOTTY_TERM ]

–enable-webgl 启用 WebGL 渲染器(默认值:false), 对应配置变量[ $GOTTY_ENABLE_WEBGL ]

–close-signal value ,gotty 关闭时发送到进程的信号(默认:SIGHUP)(默认:1), 对应配置变量[ $GOTTY_CLOSE_SIGNAL ]

–close-timeout,客户端断开连接后强制关闭进程的秒数(默认值:-1)(默认值:-1), 对应配置变量[$GOTTY_CLOSE_TIMEOUT ]

–config ,配置文件路径(默认: ~/.gotty), 对应配置变量[ $GOTTY_CONFIG ]

-h,–help,显示帮助(默认:false)

-v,–version,打印版本(默认:false)。

配置文件

上一部分基本命令选选项都对应一个配置变量,可以在设置自定义化的默认配置项目,配置文件默认为~/.gotty,也可以通过—config指定。一个示例配置文件如下:

 //监听端口为9000
port = "9000"
//启用 TSL /SSL
enable_tls = true
// 指定主题的字体和背景色
preferences {
font_size = 5
background_color = "rgb(16, 16, 32)"
}  

多用户共享

当新客户端连接到服务器时,GoTTY 会用执行的命令启动一个新进程。默认情况下用户不能与其他人共享单个终端。但是,可以使用多终端复用器与多个客户端共享单个进程。GoTTy支持通过Screen和Tmux共享终端

Screen

安装 GNU screen 后,通过creen -S name-for-sessions开始一个新的会话并通过另一个终端窗口/选项卡中gotty 连接到它

 ./gotty screen -x name-for-session  

在第一个终端选项卡/窗口中执行的所有命令和活动将会由gotty共享到web。

tmux

在tmux下可以由gotty启动新tmux 会话:

 gotty tmux new -A -s gotty top  

此命令不允许客户端发送击键,但是,可以从本地终端附加会话并运行诸如切换模式的操作top命令。

但是你可以使用tmux再从终端连接到该tmux会话:

 tmux new -A -s gotty  

可以通过快捷键与伙伴们分享当前的会话,可以配置tmux配置文件(.tmux.conf)。

 # Start GoTTY in a new window with C-t
bind-key C-t new-window "gotty tmux attach -t `tmux display -p '#S'`"  

Docker

为了安全地给用户提供一个被监禁的环境时,可以使用 Docker容器 ,如下所示:

 gotty -w docker run -it --rm busybox  

ttyd

ttyd 是一个C语言开发的终端web共享方案,用于通过网络共享终端。ttyd基于在 的 Libwebsockets 和libuv 建立,性能很好,响应速度快。前端方案基于Xterm.js,具有全功能终端以及中日韩 和IME支持。具有lrzsz支持的图像ZMODEM。基于 OpenSSL 提供 TSL/SSL支持。

ttdy支持跨平台:macOS、Linux、FreeBSD/OpenBSD、 OpenWrt 、Windows等。

安装

macOS 安装,可以通过homebrew:

 brew install ttyd  

Linux:

可以直接下载对应的 二进制 版本下载:

或者基于源码自己编译:

 sudo apt-get install build-essential cmake git libjson-c-dev libwebsockets-dev
git clone github/tsl0922/ttyd.git
cd ttyd && mkdir build && cd build
 cmake  ..
make && sudo make install  

可能还需要编译/安装 libwebsockets 从源代码。

用法

命令行选项:

基本用法

 ttyd -p 8080 bash  

和Gotty默认只读不同,ttyd默认是全功能的一个终端,可以执行任意操作,所以要注意自己设置安全。

甚至可以在web下,嵌套启动一个ttyd(套娃)。

要在通过系统认证,在web登陆有再使用,可以用ttyd login启动(注意login启动需要root权限);

Docker

同样ttyd也支持docker方式启动。多个客户端共享单个 docker 容器 ,可以使用:

 docker run -it --rm -p 7681:7681 tsl0922/ttyd  

为每个客户端创建新的 docker 容器:

 ttyd docker run -it --rm Ubuntu  

总结

本文给大家介绍利用Web共享终端的两种方案,GoTTY和ttyd,两种方案都各有特长,GoTTY精练,更加安全(默认只读,随机token字串等,单应用),而ttyd则支持更加全面的终端功能,更加快速流畅。大家可以根据爱好选择一种使用,也可以两种都先尝试一下,然后再选择。

相关文章