ttyd - terminal emulator for the web

ttyd is a simple command line tool for sharing terminal over the web, inspired by GoTTY.

WARNING: ttyd is still under heavily development, so features may be incomplete or expected to have bugs.

Requirements

Installation

For Mac OS X users

brew install cmake openssl json-c libwebsockets
git clone https://github.com/tsl0922/ttyd.git
cd ttyd && mkdir build && cd build
cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl ..
make

For Linux users

Ubuntu as example:

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

The ttyd executable file will be in the build directory.

Usage

ttyd is a tool for sharing terminal over the web

USAGE: ttyd [options] <command> [<arguments...>]

OPTIONS:
    --port, -p              Port to listen (default: 7681)
    --interface, -i         Network interface to bind
    --credential, -c        Credential for Basic Authentication (format: username:password)
    --uid, -u               User id to run with
    --gid, -g               Group id to run with
    --signal, -s            Signal to send to the command when exit it (default: SIGHUP)
    --reconnect, -r         Time to reconnect for the client in seconds (default: 10)
    --ssl, -S               Enable ssl
    --ssl-cert, -C          Ssl certificate file path
    --ssl-key, -K           Ssl key file path
    --ssl-ca, -A            Ssl ca file path
    --debug, -d             Set log level (0-9, default: 7)
    --help, -h              Print this text and exit

ttyd starts web server at port 7681 by default. When you open http://localhost:7681, the command will be started with options as arguments and now you can see the running command on the web! 🎉

Credits

GoTTY: ttyd is a port of GoTTY to C language.
hterm: ttyd uses hterm to run a terminal emulator on the web.

2.4 KiB Raw Blame History