README.md
1#  GoTTY - Share your terminal as a web application
2
3[][release]
4[][wercker]
5[][license]
6[][gitter]
7
8[release]: https://github.com/yudai/gotty/releases
9[wercker]: https://app.wercker.com/project/bykey/03b91f441bebeda34f80e09a9f14126f
10[license]: https://github.com/yudai/gotty/blob/master/LICENSE
11[gitter]: https://gitter.im/yudai/gotty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
12
13GoTTY is a simple command line tool that turns your CLI tools into web applications.
14
15
16
17# Installation
18
19Download the latest stable binary file from the [Releases](https://github.com/yudai/gotty/releases) page. Note that the release marked `Pre-release` is built automatically when new code is pushed to the repository, which can include unstable or breaking changes. Download a release marked `Latest release` for a stabale build.
20
21(`darwin_amd64.tar.gz` is for Mac OS X users)
22
23## Homebrew Installation
24
25You can install GoTTY with [Homebrew](http://brew.sh/) as well.
26
27```sh
28$ brew install yudai/gotty/gotty
29```
30
31## `go get` Installation (Development)
32
33If 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.
34
35```sh
36$ go get github.com/yudai/gotty
37```
38
39# Usage
40
41```
42Usage: gotty [options] <command> [<arguments...>]
43```
44
45Run `gotty` with your preferred command as its arguments (e.g. `gotty top`).
46
47By 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.
48
49## Options
50
51```
52--address, -a IP address to listen [$GOTTY_ADDRESS]
53--port, -p "8080" Port number to listen [$GOTTY_PORT]
54--permit-write, -w Permit clients to write to the TTY (BE CAREFUL) [$GOTTY_PERMIT_WRITE]
55--credential, -c Credential for Basic Authentication (ex: user:pass, default disabled) [$GOTTY_CREDENTIAL]
56--random-url, -r Add a random string to the URL [$GOTTY_RANDOM_URL]
57--random-url-length "8" Random URL length [$GOTTY_RANDOM_URL_LENGTH]
58--tls, -t Enable TLS/SSL [$GOTTY_TLS]
59--tls-crt "~/.gotty.crt" TLS/SSL certificate file path [$GOTTY_TLS_CRT]
60--tls-key "~/.gotty.key" TLS/SSL key file path [$GOTTY_TLS_KEY]
61--tls-ca-crt "~/.gotty.ca.crt" TLS/SSL CA certificate file for client certifications [$GOTTY_TLS_CA_CRT]
62--index Custom index.html file [$GOTTY_INDEX]
63--title-format "GoTTY - {{ .Command }} ({{ .Hostname }})" Title format of browser window [$GOTTY_TITLE_FORMAT]
64--reconnect Enable reconnection [$GOTTY_RECONNECT]
65--reconnect-time "10" Time to reconnect [$GOTTY_RECONNECT_TIME]
66--timeout "0" Timeout seconds for waiting a client (0 to disable) [$GOTTY_TIMEOUT]
67--max-connection "0" Set the maximum number of simultaneous connections (0 to disable)
68--once Accept only one client and exit on disconnection [$GOTTY_ONCE]
69--permit-arguments Permit clients to send command line arguments in URL (e.g. http://example.com:8080/?arg=AAA&arg=BBB) [$GOTTY_PERMIT_ARGUMENTS]
70--close-signal "1" Signal sent to the command process when gotty close it (default: SIGHUP) [$GOTTY_CLOSE_SIGNAL]
71--config "~/.gotty" Config file path [$GOTTY_CONFIG]
72--version, -v print the version
73```
74
75### Config File
76
77You 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.
78
79```
80// Listen at port 9000 by default
81port = "9000"
82
83// Enable TSL/SSL by default
84enable_tls = true
85
86// hterm preferences
87// Smaller font and a little bit bluer background color
88preferences {
89 font_size = 5
90 background_color = "rgb(16, 16, 32)"
91}
92```
93
94See the [`.gotty`](https://github.com/yudai/gotty/blob/master/.gotty) file in this repository for the list of configuration options.
95
96### Security Options
97
98By 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).
99
100To 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 credentical will be transmitted between the server and clients in plain text. For more strict authentication, consider the SSL/TLS client certificate authentication described below.
101
102The `-r` option is a little bit casualer 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.
103
104All 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.
105
106```sh
107openssl req -x509 -nodes -days 9999 -newkey rsa:2048 -keyout ~/.gotty.key -out ~/.gotty.crt
108```
109
110(NOTE: For Safari uses, see [how to enable self-signed certificates for WebSockets](http://blog.marcon.me/post/24874118286/secure-websockets-safari) when use self-signed certificates)
111
112For 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.
113
114## Sharing with Multiple Clients
115
116GoTTY 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.
117
118For example, you can start a new tmux session named `gotty` with `top` command by the command below.
119
120```sh
121$ gotty tmux new -A -s gotty top
122```
123
124This 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.
125
126```sh
127$ tmux new -A -s gotty
128```
129
130By using terminal multiplexers, you can have the control of your terminal and allow clients to just see your screen.
131
132### Quick Sharing on tmux
133
134To share your current session with others by a shortcut key, you can add a line like below to your `.tmux.conf`.
135
136```
137# Start GoTTY in a new window with C-t
138bind-key C-t new-window "gotty tmux attach -t `tmux display -p '#S'`"
139```
140
141## Playing with Docker
142
143When you want to create a jailed environment for each client, you can use Docker containers like following:
144
145```sh
146$ gotty -w docker run -it --rm busybox
147```
148
149## Development
150
151You can build a binary using the following commands. Windows is not supported now.
152
153```sh
154# Install tools
155go get github.com/jteeuwen/go-bindata/...
156go get github.com/tools/godep
157
158# Checkout hterm
159git submodule sync && git submodule update --init --recursive
160
161# Restore libraries in Godeps
162godep restore
163
164# Build
165make
166```
167
168## Architecture
169
170GoTTY uses [hterm](https://groups.google.com/a/chromium.org/forum/#!forum/chromium-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](https://github.com/krishnasrinivas/wetty).
171
172## Alternatives
173
174### Command line client
175
176* [gotty-client](https://github.com/moul/gotty-client): If you want to connect to GoTTY server from your terminal
177
178### Terminal/SSH on Web Browsers
179
180* [Secure Shell (Chrome App)](https://chrome.google.com/webstore/detail/secure-shell/pnhechapfaindjhompbnflcldabbghjo): 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
181* [Wetty](https://github.com/krishnasrinivas/wetty): Node based web terminal (SSH/login)
182* [ttyd](https://tsl0922.github.io/ttyd): C port of GoTTY with CJK and IME support
183
184### Terminal Sharing
185
186* [tmate](http://tmate.io/): Forked-Tmux based Terminal-Terminal sharing
187* [termshare](https://termsha.re): Terminal-Terminal sharing through a HTTP server
188* [tmux](https://tmux.github.io/): Tmux itself also supports TTY sharing through SSH)
189
190# License
191
192The MIT License
193
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}