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
17e972f5df5a028d3e2ea026c4a65f0d30ca8a17
ttyd/README.md
Shuanglei Tao 17e972f5df [ci skip] Update README.md
2016-09-25 09:37:11 +08:00

2.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

  • Build on libwebsockets with C for speed
  • Full terminal emulation based on hterm
  • SSL support based on OpenSSL
  • Run any custom command with options
  • Basic authentication support
  • Cross platform: macOS, Linux, OpenWrt

Installation

For Mac OS X users

Install with homebrew:

brew tap tsl0922/ttyd
brew install ttyd

For Linux users

Ubuntu 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

Usage

ttyd is a tool for sharing terminal over the web

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

VERSION:
    1.0.0

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)
    --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.
  • hterm: ttyd uses hterm to run a terminal emulator on the web.