GoTTY - Share your terminal as a web application

GoTTY - Share your terminal as a web application

GitHub release MIT License

GoTTY is a simple command line tool that turns your CLI tools into web applications.

Screenshot

Installation

From release page

You can download the latest stable binary file from the Releases page. Note that the release marked Pre-release is built for testing purpose, which can include unstable or breaking changes. Download a release marked Latest release for a stable build.

(Files named with darwin_amd64 are for Mac OS X users)

Homebrew Installation

You can install GoTTY with Homebrew as well.

$ brew install sorenisanerd/gotty/gotty

go get Installation (Development)

If you have a Go language environment, you can install GoTTY with the go get command. However, this command builds a binary file from the latest master branch, which can include unstable or breaking changes. GoTTY requires go1.9 or later.

$ go get github.com/sorenisanerd/gotty

Usage

Usage: gotty [options]  []

Run gotty with your preferred command as its arguments (e.g. gotty top).

By default, GoTTY starts a web server at port 8080. Open the URL on your web browser and you can see the running command as if it were running on your terminal.

Options

   --address value, -a value     IP address to listen (default: "0.0.0.0") [$GOTTY_ADDRESS]
   --port value, -p value        Port number to liten (default: "8080") [$GOTTY_PORT]
   --path value, -m value        Base path (default: "/") [$GOTTY_PATH]
   --permit-write, -w            Permit clients to write to the TTY (BE CAREFUL) (default: false) [$GOTTY_PERMIT_WRITE]
   --credential value, -c value  Credential for Basic Authentication (ex: user:pass, default disabled) [$GOTTY_CREDENTIAL]
   --random-url, -r              Add a random string to the URL (default: false) [$GOTTY_RANDOM_URL]
   --random-url-length value     Random URL length (default: 8) [$GOTTY_RANDOM_URL_LENGTH]
   --tls, -t                     Enable TLS/SSL (default: false) [$GOTTY_TLS]
   --tls-crt value               TLS/SSL certificate file path (default: "~/.gotty.crt") [$GOTTY_TLS_CRT]
   --tls-key value               TLS/SSL key file path (default: "~/.gotty.key") [$GOTTY_TLS_KEY]
   --tls-ca-crt value            TLS/SSL CA certificate file for client certifications (default: "~/.gotty.ca.crt") [$GOTTY_TLS_CA_CRT]
   --index value                 Custom index.html file [$GOTTY_INDEX]
   --title-format value          Title format of browser window (default: "{{ .command }}@{{ .hostname }}") [$GOTTY_TITLE_FORMAT]
   --reconnect                   Enable reconnection (default: false) [$GOTTY_RECONNECT]
   --reconnect-time value        Time to reconnect (default: 10) [$GOTTY_RECONNECT_TIME]
   --max-connection value        Maximum connection to gotty (default: 0) [$GOTTY_MAX_CONNECTION]
   --once                        Accept only one client and exit on disconnection (default: false) [$GOTTY_ONCE]
   --timeout value               Timeout seconds for waiting a client(0 to disable) (default: 0) [$GOTTY_TIMEOUT]
   --permit-arguments            Permit clients to send command line arguments in URL (e.g. http://example.com:8080/?arg=AAA&arg=BBB) (default: false) [$GOTTY_PERMIT_ARGUMENTS]
   --width value                 Static width of the screen, 0(default) means dynamically resize (default: 0) [$GOTTY_WIDTH]
   --height value                Static height of the screen, 0(default) means dynamically resize (default: 0) [$GOTTY_HEIGHT]
   --ws-origin value             A regular expression that matches origin URLs to be accepted by WebSocket. No cross origin requests are acceptable by default [$GOTTY_WS_ORIGIN]
   --term value                  Terminal name to use on the browser, one of xterm or hterm. (default: "hterm") [$GOTTY_TERM]
   --close-signal value          Signal sent to the command process when gotty close it (default: SIGHUP) (default: 1) [$GOTTY_CLOSE_SIGNAL]
   --close-timeout value         Time in seconds to force kill process after client is disconnected (default: -1) (default: -1) [$GOTTY_CLOSE_TIMEOUT]
   --config value                Config file path (default: "~/.gotty") [$GOTTY_CONFIG]
   --help, -h                    show help (default: false)
   --version, -v                 print the version (default: false)

Config File

You can customize default options and your terminal (hterm) by providing a config file to the gotty command. GoTTY loads a profile file at ~/.gotty by default when it exists.

// Listen at port 9000 by default
port = "9000"

// Enable TSL/SSL by default
enable_tls = true

// hterm preferences
// Smaller font and a little bit bluer background color
preferences {
    font_size = 5
    background_color = "rgb(16, 16, 32)"
}

See the .gotty file in this repository for the list of configuration options.

Security Options

By default, GoTTY doesn't allow clients to send any keystrokes or commands except terminal window resizing. When you want to permit clients to write input to the TTY, add the -w option. However, accepting input from remote clients is dangerous for most commands. When you need interaction with the TTY for some reasons, consider starting GoTTY with tmux or GNU Screen and run your command on it (see "Sharing with Multiple Clients" section for detail).

To restrict client access, you can use the -c option to enable the basic authentication. With this option, clients need to input the specified username and password to connect to the GoTTY server. Note that the credentials will be transmitted between the server and clients in plain text. For more strict authentication, consider the SSL/TLS client certificate authentication described below.

The -r option is a little bit more casual way to restrict access. With this option, GoTTY generates a random URL so that only people who know the URL can get access to the server.

All traffic between the server and clients are NOT encrypted by default. When you send secret information through GoTTY, we strongly recommend you use the -t option which enables TLS/SSL on the session. By default, GoTTY loads the crt and key files placed at ~/.gotty.crt and ~/.gotty.key. You can overwrite these file paths with the --tls-crt and --tls-key options. When you need to generate a self-signed certification file, you can use the openssl command.

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

(NOTE: For Safari uses, see how to enable self-signed certificates for WebSockets when use self-signed certificates)

For additional security, you can use the SSL/TLS client certificate authentication by providing a CA certificate file to the --tls-ca-crt option (this option requires the -t or --tls to be set). This option requires all clients to send valid client certificates that are signed by the specified certification authority.

Sharing with Multiple Clients

GoTTY starts a new process with the given command when a new client connects to the server. This means users cannot share a single terminal with others by default. However, you can use terminal multiplexers for sharing a single process with multiple clients.

Screen

After installing GNU screen, start a new session with screen -S name-for-session and connect to it with gotty in another terminal window/tab through screen -x name-for-session. All commands and activities being done in the first terminal tab/window will now be broadcasted by gotty.

Tmux

For example, you can start a new tmux session named gotty with top command by the command below.

$ gotty tmux new -A -s gotty top

This command doesn't allow clients to send keystrokes, however, you can attach the session from your local terminal and run operations like switching the mode of the top command. To connect to the tmux session from your terminal, you can use following command.

$ tmux new -A -s gotty

By using terminal multiplexers, you can have the control of your terminal and allow clients to just see your screen.

Quick Sharing on tmux

To share your current session with others by a shortcut key, you can add a line like below to your .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'`"

Playing with Docker

When you want to create a jailed environment for each client, you can use Docker containers like following:

$ gotty -w docker run -it --rm busybox

Development

You can build a binary using the following commands. Windows is not supported now. go1.9 is required.

# Install tools
go get github.com/jteeuwen/go-bindata/...
go get github.com/tools/godep

# Build
make

To build the frontend part (JS files and other static files), you need npm.

Architecture

GoTTY uses xterm.js and hterm to run a JavaScript based terminal on web browsers. GoTTY itself provides a websocket server that simply relays output from the TTY to clients and receives input from clients and forwards it to the TTY. This hterm + websocket idea is inspired by Wetty.

Alternatives

Command line client

  • gotty-client: If you want to connect to GoTTY server from your terminal

Terminal/SSH on Web Browsers

  • Secure Shell (Chrome App): If you are a chrome user and need a "real" SSH client on your web browser, perhaps the Secure Shell app is what you want
  • Wetty: Node based web terminal (SSH/login)
  • ttyd: C port of GoTTY with CJK and IME support

Terminal Sharing

  • tmate: Forked-Tmux based Terminal-Terminal sharing
  • termshare: Terminal-Terminal sharing through a HTTP server
  • tmux: Tmux itself also supports TTY sharing through SSH)

License

The MIT License

Contributors

Original author

  • Iwasaki Yudai

Maintainer

  • Søren L. Hansen

Contributors

  • 0xflotus
  • Anand Patil
  • Andrea Lusuardi - uovobw
  • Andy Skelton
  • Artem Medvedev
  • Blake Jennings
  • Christian Jensen
  • Christopher Wilkinson
  • Cyrus
  • David Horsley
  • Fazal Majid
  • freakhill
  • fredster33
  • Jan-Willem Korver
  • Jason Cooke
  • Johan Gall
  • Korenevskiy Denis
  • Lin
  • Manfred Touron
  • Massimiliano Stucchi
  • mattn
  • Mikhail f. Shiryaev
  • Quentin Perez
  • Richard Metzler
  • Robert Bittle
  • Sebastian Haas
  • shingt
  • Shoji Ihara
  • Shuanglei Tao
  • Stephan van Ellewee
  • The Gitter Badger
  • Xinyun Zhou
  • Yifa Zhang
  • yogesh singh
  • zlji
Comments
  • Pass HTTP headers with the --pass-headers option

    Pass HTTP headers with the --pass-headers option

    I have merged the original idea and code from @George-NG (https://github.com/sorenisanerd/gotty/issues/23) and the request to add an option (https://github.com/sorenisanerd/gotty/issues/23#issuecomment-1012739480) to create this merge request.

    This adds --pass-headers option, which for example when running gotty --pass-headers env produces the following output in a web terminal:

    Zrzut ekranu 2022-09-15 o 18 13 07

    It has some nice use-cases:

    • accessing client IP from X-Forwarded-For or CF-Connecting-IP
    • getting client country code from CF-IPCountry
    • reading values from Cookie
    • acting upon the Origin header value
    • setting custom headers on a reverse proxy (like Varnish, Haproxy) working between a client and gotty
  • Zmodem transfers/cancellations hang terminal

    Zmodem transfers/cancellations hang terminal

    What version of GoTTY are you using (gotty --version)?

    1.4.0

    What operating system and browser are you using?

    Ubuntu 22.04, Chrome

    What did you do?

    If possible, please provide the command you ran.

    ./gotty -p 7681 -w bash

    What did you expect to see?

    | Action | Expected Behavior | | --- | --- | | rz, cancel upload (close modal) | rz exits and terminal prompt advances | | sz <filename>, click Accept | File is transferred to browser, terminal prompt advances | | sz <filename>, click Decline | sz exits and terminal prompt advances | | sz <filename>, close modal | sz exits and terminal prompt advances |

    What did you see instead?

    If possible, please provide the output of the command and your browser's console output.

    | Action | Observed Behavior | | --- | --- | | rz, cancel upload (close modal) | Prompt is stuck on rz waiting to receive.**B0100000023be50 | | sz <filename>, click Accept | File is transferred to browser, terminal prompt is stuck on **B00000000000000, JavaScript console reports errors: Uncaught PROTOCOL: Only thing after ZFIN should be “OO” (79,79), not: ... at zsession.js:563 | | sz <filename>, click Decline | Modal displays "Skipping..." until manually closed, JavaScript console reports errors: Uncaught PROTOCOL: Only thing after ZFIN should be “OO” (79,79), not: ..., sz: skipped: <filename> is written to terminal but prompt is stuck | | sz <filename>, close modal | Prompt is stuck on **B00000000000000 until it eventually times out |

  • Can't send meta to emacs in the browser

    Can't send meta to emacs in the browser

    When file a bug report (see below for feature requests)

    What version of GoTTY are you using (gotty --version)?

    gotty version v1.4.0

    What operating system and browser are you using?

    macOS Monterey 12.5 Google Chrome (Desktop) Version 103.0.5060.134 (Official Build) (x86_64) Safari (Desktop) Version 15.6 (17613.3.9.1.5) Safari (iPadOS 15.5)

    What did you do?

    I run spacemacs via gotty with gotty --port 11111 --permit-write --reconnect emacsclient --tty -a "" when I go to localhost:11111 I can successfully use emacs. Since when I press the "option" key I want instead to send a "meta" key, I have tried using this config (and restarting gotty)

    preferences {                                                                   
        alt_is_meta = true
    }
    

    or this config

    preferences {                                                                   
        alt_is_meta = true
        alt_is_what = "browser-key"
    }
    

    but nothing changes.

    What did you expect to see?

    I would expect the meta key to be sent. For example, if I press for instance Option-x, I expect emacs in the browser to recognize M-x.

    What did you see instead?

    I get the option key instead. In the example above, if I press Option-x I get the character . So I can't use most of the emacs keybinding. As a workaround I can use spacemacs and switch to evil-mode, but I would like to use the default emacs keybindings.

  • Add API to get current number of WebSocket connections

    Add API to get current number of WebSocket connections

    • Background:

    I want to kill gotty main process to release resources if not one use it, so required a method to get current WebSocket connections number

    About use it definition:

    • open in browser even without any input command. Or without any operation
    • have any operations

    Signed-off-by: Chenyang Yan [email protected]

  • Colors no longer obeyed in 1.4.0

    Colors no longer obeyed in 1.4.0

    It seems that the color preferences are no longer respected in 1.4.0. I was looking through the release notes, and did not see anything to explain it.

    What version of GoTTY are you using (gotty --version)?

    Gotty 1.4.0 - bug exists Gotty 1.3.0 - bug does not exist

    What operating system and browser are you using?

    Ubuntu 20.04

    What did you do?

    Have this file in ~/.gotty

    port = 3000
    
    term = "hterm" 
    
    preferences {
      background_color = "white"
      foreground_color = "black"
      cursor_color = "blue"
    }
    

    and run gotty --once ls

    Note: This exact same config worked in all previous Gotty versions, including 1.3.0

    What did you expect to see?

    The terminal background color should be white.

    What did you see instead?

    The terminal background color was black.

  • How to debug the front-end code locally ?

    How to debug the front-end code locally ?

    Hello.

    I am currently using your repository for local development. It really works very well and I appreciate it. But at the moment I have a question, how do you debug the front-end code locally (especially js part as well as html etc) By building a separate http server, which is possible. But I don't know if it is already supported inside your code?

    I would be grateful if I could get an answer from you.

Web terminal - A (unsafe) technical demo to export a shell to web browser
Web terminal - A (unsafe) technical demo to export a shell to web browser

Web Terminal A (unsafe) technical demo to export a shell to web browser. This pr

Aug 25, 2022
📔 Journal helps you manage multiple journals with ease from the comfort of your terminal, web browser or API client.
📔 Journal helps you manage multiple journals with ease from the comfort of your terminal, web browser or API client.

Journal helps you manage multiple journals with ease from the comfort of your terminal, web browser or API client. You can import/export journals as horcruxes and set simple customizations for layout, theme, and keybindings.

Sep 14, 2022
A quick and easy password protected web server for your files. httpfolder makes downloading/uploading files from your current working directory easy, even for fairly large files.

httpfolder A quick and easy password protected web server for your files. httpfolder makes downloading/uploading files from your current working direc

Sep 12, 2022
This application is used as an example HTTP/SQLite application for Litestream tutorials.

This application is used as an example HTTP/SQLite application for Litestream tutorials. It simply maintains a count of HTTP requests and persists it to a SQLite database.

Apr 2, 2022
A simple database application that I was asked to implement as part of a job application process

This is a simple database application that I was asked to implement as part of a job application process. They told me I could choose any languages an

Nov 24, 2021
sigurlx a web application attack surface mapping tool.

sigurlx a web application attack surface mapping tool, it does ...:

Jul 24, 2021
Retro-Floppy UI is a web based application for managing & using a GoTek floppy emulator running the Flash Floppy firmware.
Retro-Floppy UI is a web based application for managing & using a GoTek floppy emulator running the Flash Floppy firmware.

A web user interface for a GoTek running flashfloppy utilising a Raspberry PI 0W as the storage. This allows for remote uploading of files & selecting which disk image is loaded on a retro computer like the BBC Micro or Amiga A1200

Aug 26, 2021
A web application attack surface mapping tool. It takes in a list of urls then performs numerous probes

sigurlscann3r A web application attack surface mapping tool. It takes in a list of urls then performs numerous probes Resources Features Installation

Sep 9, 2022
A simple web application written in Golang which listens on port 8080

GoWebApp It's a simple web application written in Golang which listens on port 8080 Building It can be build using the command go build -o metricsweba

Oct 21, 2021
A web application example to work with a customer object

Wallester Task This repository contains a web application example to work with a customer object. Build in GO version 1.17.1 Live running app example

Oct 25, 2021
🖖🏻 A self-hosted Quora like web application written in Go
🖖🏻 A self-hosted Quora like web application written in Go

Guora ???? A self-hosted Quora like web application written in Go 基于 Golang 类似知乎的私有部署问答应用 包含问答、评论、点赞、管理后台等功能 Quick Start (Docker Deploy) $ docker-comp

Sep 20, 2022
Using golang framework (Gin) to create a web-application

News feeder Using golang framework (Gin) to create a web-application. This simpl

Aug 22, 2022
Go-service-gin - Simple Web api application developed in Golang and Gin

Simple Web api application developed in Golang and Gin Initial Tutorial URL http

Jan 4, 2022
Go kickstart is a simple repository that I'm managing to a have a fast setup for Go web application

Go kickstart is a simple repository that I'm managing to a have a fast setup for Go web application with my most common use cases using practices that I found useful and easy to maintain.

Jan 30, 2022
Ecommerce-api - Rest api of e-commerce web application
Ecommerce-api - Rest api of e-commerce web application

E-commerce Rest API Swagger documentation to test api Domain diagram

Sep 5, 2022
GoVWA - A web application developed to help the pentester and programmers to learn the vulnerabilities

GoVWA - A web application developed to help the pentester and programmers to learn the vulnerabilities

Feb 12, 2022
Jeen is a package wrapper that is used as a web application base for the go language.

Jeen Jeen is a package wrapper that is used as a web application base for the go language. Package Wrappers? Yes, because jeen works by using other av

Feb 21, 2022
Go-watchdog - a web application observability tool built for Go
Go-watchdog - a web application observability tool built for Go

Go-watchdog is a web application observability tool built for Go, it exposes a status endpoint for application services like databases, caches, message-brokers, mails and storages.

Jul 11, 2022
Extract structured data from web sites. Web sites scraping.
Extract structured data from web sites. Web sites scraping.

Dataflow kit Dataflow kit ("DFK") is a Web Scraping framework for Gophers. It extracts data from web pages, following the specified CSS Selectors. You

Sep 17, 2022