mirror of
https://github.com/tsl0922/ttyd.git
synced 2025-12-25 13:14:18 +01:00
205 lines
8.1 KiB
Markdown
205 lines
8.1 KiB
Markdown
# ttyd - Share your terminal over the web [](https://github.com/tsl0922/ttyd/actions?workflow=frontend) [](https://github.com/tsl0922/ttyd/actions?workflow=backend)
|
|
|
|
ttyd is a simple command-line tool for sharing terminal over the web, inspired by [GoTTY][1].
|
|
|
|
|
|
|
|
# Features
|
|
|
|
- Built on top of [Libwebsockets][2] with [libuv][20] for speed
|
|
- Fully-featured terminal based on [Xterm.js][3] with [CJK][18] and IME support
|
|
- Graphical [ZMODEM][16] integration with [lrzsz][17] support
|
|
- SSL support based on [OpenSSL][4]
|
|
- Run any custom command with options
|
|
- Basic authentication support and many other custom options
|
|
- Cross platform: macOS, Linux, FreeBSD/OpenBSD, [OpenWrt][5]/[LEDE][6], Windows
|
|
|
|
# Installation
|
|
|
|
## Install on macOS
|
|
|
|
Install with [homebrew][7]:
|
|
|
|
```bash
|
|
brew install ttyd
|
|
```
|
|
|
|
## Install on Linux
|
|
|
|
- Binary version: download from the [releases](https://github.com/tsl0922/ttyd/releases) page.
|
|
- Build from source (debian/ubuntu):
|
|
|
|
```bash
|
|
sudo apt-get install cmake g++ pkg-config git libjson-c-dev libwebsockets-dev
|
|
git clone https://github.com/tsl0922/ttyd.git
|
|
cd ttyd && mkdir build && cd build
|
|
cmake ..
|
|
make && make install
|
|
```
|
|
|
|
You may also need to compile/install [libwebsockets][2] from source if the `libwebsockets-dev` package is outdated.
|
|
|
|
- Install on Gentoo:
|
|
|
|
clone the repo at [https://bitbucket.org/mgpagano/ttyd/src/master/](https://bitbucket.org/mgpagano/ttyd/src/master/) and follow the directions [here](https://wiki.gentoo.org/wiki/Custom_repository#Creating_a_local_repository) for creating a local repository.
|
|
|
|
## Install on Windows
|
|
|
|
ttyd can be built with [MSYS2][10] on windows, The build instructions is [here][13].
|
|
|
|
> **NOTE:** Native windows console programs may not work correctly due to [pty incompatibility issues][11].
|
|
As a workaround, you can use [winpty][12] as a wrapper to invoke the windows program, eg: `ttyd winpty cmd`.
|
|
|
|
## Install on OpenWrt/LEDE
|
|
|
|
[LEDE][6] `17.01.0` and later:
|
|
|
|
```bash
|
|
opkg install ttyd
|
|
```
|
|
|
|
You may want to [compile it manually][14].
|
|
|
|
# Usage
|
|
|
|
## Command-line Options
|
|
|
|
```
|
|
ttyd is a tool for sharing terminal over the web
|
|
|
|
USAGE:
|
|
ttyd [options] <command> [<arguments...>]
|
|
|
|
VERSION:
|
|
1.5.2
|
|
|
|
OPTIONS:
|
|
-p, --port Port to listen (default: 7681, use `0` for random port)
|
|
-i, --interface Network interface to bind (eg: eth0), or UNIX domain socket path (eg: /var/run/ttyd.sock)
|
|
-c, --credential Credential for Basic Authentication (format: username:password)
|
|
-u, --uid User id to run with
|
|
-g, --gid Group id to run with
|
|
-s, --signal Signal to send to the command when exit it (default: 1, SIGHUP)
|
|
-a, --url-arg Allow client to send command line arguments in URL (eg: http://localhost:7681?arg=foo&arg=bar)
|
|
-R, --readonly Do not allow clients to write to the TTY
|
|
-t, --client-option Send option to client (format: key=value), repeat to add more options
|
|
-T, --terminal-type Terminal type to report, default: xterm-256color
|
|
-O, --check-origin Do not allow websocket connection from different origin
|
|
-m, --max-clients Maximum clients to support (default: 0, no limit)
|
|
-o, --once Accept only one client and exit on disconnection
|
|
-B, --browser Open terminal with the default system browser
|
|
-I, --index Custom index.html path
|
|
-6, --ipv6 Enable IPv6 support
|
|
-S, --ssl Enable SSL
|
|
-C, --ssl-cert SSL certificate file path
|
|
-K, --ssl-key SSL key file path
|
|
-A, --ssl-ca SSL CA file path for client certificate verification
|
|
-d, --debug Set log level (default: 7)
|
|
-v, --version Print the version and exit
|
|
-h, --help Print this text and exit
|
|
|
|
Visit https://github.com/tsl0922/ttyd to get more information and report bugs.
|
|
```
|
|
|
|
## Example Usage
|
|
|
|
ttyd starts web server at port `7681` by default, you can use the `-p` option to change it, the `command` will be started with `arguments` as options. For example, run:
|
|
|
|
```bash
|
|
ttyd -p 8080 bash -x
|
|
```
|
|
Then open <http://localhost:8080> with a browser, you will get a bash shell with debug mode enabled.
|
|
|
|
**More Examples:**
|
|
|
|
- If you want to login with your system accounts on the web browser, run `ttyd login`.
|
|
- You can even run a none shell command like vim, try: `ttyd vim`, the web browser will show you a vim editor.
|
|
- Sharing single process with multiple clients: `ttyd tmux new -A -s ttyd vim`, run `tmux new -A -s ttyd` to connect to the tmux session from terminal.
|
|
|
|
## Browser Support
|
|
|
|
Modern browsers, See [Browser Support][15].
|
|
|
|
## SSL how-to
|
|
|
|
Generate SSL CA and self signed server/client certificates:
|
|
|
|
```bash
|
|
# CA certificate (FQDN must be different from server/client)
|
|
openssl genrsa -out ca.key 2048
|
|
openssl req -new -x509 -days 365 -key ca.key -subj "/C=CN/ST=GD/L=SZ/O=Acme, Inc./CN=Acme Root CA" -out ca.crt
|
|
|
|
# server certificate (for multiple domains, change subjectAltName to: DNS:example.com,DNS:www.example.com)
|
|
openssl req -newkey rsa:2048 -nodes -keyout server.key -subj "/C=CN/ST=GD/L=SZ/O=Acme, Inc./CN=localhost" -out server.csr
|
|
openssl x509 -sha256 -req -extfile <(printf "subjectAltName=DNS:localhost") -days 365 -in server.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out server.crt
|
|
|
|
# client certificate (the p12/pem format may be useful for some clients)
|
|
openssl req -newkey rsa:2048 -nodes -keyout client.key -subj "/C=CN/ST=GD/L=SZ/O=Acme, Inc./CN=client" -out client.csr
|
|
openssl x509 -req -days 365 -in client.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out client.crt
|
|
openssl pkcs12 -export -clcerts -in client.crt -inkey client.key -out client.p12
|
|
openssl pkcs12 -in client.p12 -out client.pem -clcerts
|
|
```
|
|
|
|
Then start ttyd:
|
|
|
|
```bash
|
|
ttyd --ssl --ssl-cert server.crt --ssl-key server.key --ssl-ca ca.crt bash
|
|
```
|
|
You may want to test the client certificate verification with `curl`:
|
|
|
|
```bash
|
|
curl --insecure --cert client.p12[:password] -v https://localhost:7681
|
|
```
|
|
|
|
If you don't want to enable client certificate verification, remove the `--ssl-ca` option.
|
|
|
|
## Docker and ttyd
|
|
|
|
Docker containers are jailed environments which are more secure, this is useful for protecting the host system, you may use ttyd with docker like this:
|
|
|
|
- Sharing single docker container with multiple clients: `docker run -it --rm -p 7681:7681 tsl0922/ttyd`.
|
|
- Creating new docker container for each client: `ttyd docker run -it --rm ubuntu`.
|
|
|
|
## Nginx reverse proxy
|
|
|
|
Sample config to proxy ttyd under the `/ttyd` path:
|
|
|
|
```nginx
|
|
location ~ ^/ttyd(.*)$ {
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Host $host;
|
|
proxy_set_header X-Forwarded-Proto $scheme;
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
proxy_pass http://127.0.0.1:7681/$1;
|
|
}
|
|
```
|
|
|
|
# Credits
|
|
|
|
- [GoTTY][1]: ttyd is a port of GoTTY to `C` language with many improvements.
|
|
- [Libwebsockets][2]: is used to build the websocket server.
|
|
- [Xterm.js][3]: is used to run the terminal emulator on the web, [hterm][8] is used previously.
|
|
|
|
[1]: https://github.com/yudai/gotty
|
|
[2]: https://libwebsockets.org
|
|
[3]: https://github.com/xtermjs/xterm.js
|
|
[4]: https://www.openssl.org
|
|
[5]: https://openwrt.org
|
|
[6]: https://www.lede-project.org
|
|
[7]: http://brew.sh
|
|
[8]: https://chromium.googlesource.com/apps/libapps/+/HEAD/hterm
|
|
[9]: https://github.com/tsl0922/ttyd/issues/6
|
|
[10]: http://msys2.github.io
|
|
[11]: https://github.com/mintty/mintty/blob/master/wiki/Tips.md#inputoutput-interaction-with-alien-programs
|
|
[12]: https://github.com/rprichard/winpty
|
|
[13]: https://github.com/tsl0922/ttyd/tree/master/msys2
|
|
[14]: https://github.com/tsl0922/ttyd/tree/master/openwrt
|
|
[15]: https://github.com/xtermjs/xterm.js#browser-support
|
|
[16]: https://en.wikipedia.org/wiki/ZMODEM
|
|
[17]: https://ohse.de/uwe/software/lrzsz.html
|
|
[18]: https://en.wikipedia.org/wiki/CJK_characters
|
|
[19]: https://cmake.org/
|
|
[20]: https://libuv.org/
|