aljaz/ttyd
1
1
Fork 0
mirror of https://github.com/tsl0922/ttyd.git synced 2025-12-26 05:24:21 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
16bec0a5cb207effd9f12295901145f2f7589fa7
ttyd/README.md
Shuanglei Tao 16bec0a5cb Bump to 1.2.0
2016-11-13 17:58:16 +08:00

3.5 KiB
Raw Blame History

ttyd - Share your terminal over the web Build Status

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

screenshot

Features

  • Built on top of Libwebsockets with C for speed
  • Full terminal emulation based on Xterm.js with CJK and IME support
  • SSL support based on OpenSSL
  • Run any custom command with options
  • Basic authentication support and many other custom options
  • Cross platform: macOS, Linux, OpenWrt/LEDE

Installation

Install on macOS

Install with homebrew:

brew install ttyd

Install on Linux

Ubuntu 16.04 as example:

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

NOTE: You may need to compile libwebsockets from source for ubuntu versions old than 16.04, since they have outdated libwebsockets-dev package (Issue #6).

Install on OpenWrt/LEDE

opkg install ttyd

NOTE: This may only works for LEDE snapshots currently, if the install command fails, compile it yourself.

Usage

ttyd is a tool for sharing terminal over the web

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

VERSION:
    1.2.0

OPTIONS:
    --port, -p              Port to listen (default: 7681, use `0` for random port)
    --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)
    --readonly, -R          Do not allow clients to write to the TTY
    --client-option, -t     Send option to client (format: key=value), repeat to add more options
    --check-origin, -O      Do not allow websocket connection from different origin
    --once, -o              Accept only one client and exit on disconnection
    --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)
    --version, -v           Print the version and exit
    --help, -h              Print this text and exit

ttyd starts web server at port 7681 by default, the command will be started with arguments as options. For example, run:

ttyd bash

Then open http://localhost:7681, now you can see and control the bash console on your web broswer! 🎉

TIP: You may replace bash with login to get a login prompt first.

Credits

  • GoTTY: ttyd is a port of GoTTY to C language.

  • Libwebsockets: used to build the websocket server.

  • Xterm.js: used to run the terminal emulator on the web, former: hterm.