ttyd is an easy command-line instrument for sharing terminal over the net, impressed by GoTTY.
Options
- Constructed on high of Libwebsockets with C for pace
- Absolutely-featured terminal primarily based on Xterm.js with CJK and IME assist
- Graphical ZMODEM integration with lrzsz assist
- SSL assist primarily based on OpenSSL
- Run any customized command with choices
- Fundamental authentication assist and plenty of different customized choices
- Cross platform: macOS, Linux, FreeBSD/OpenBSD, OpenWrt/LEDE, Home windows
Set up
Set up on macOS
Set up with homebrew:
brew set up ttyd
Set up on Linux
- Binary model obtain from the releases web page.
- Construct from supply (debian/ubuntu):
sudo apt-get set up 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 construct && cd construct
cmake ..
make && make set up
You may additionally must compile/set up libwebsockets from supply if the libwebsockets-dev package deal is outdated.
Set up on Gentoo:
clone the repo at https://bitbucket.org/mgpagano/ttyd/src/master/ and comply with the instructions right here for creating an area repository.
Set up on Home windows
ttyd could be constructed with MSYS2 on home windows, The construct directions is right here.
NOTE: Native home windows console packages could not work accurately attributable to pty incompatibility points. As a workaround, you need to use winpty as a wrapper to invoke the home windows program, eg: ttyd winpty cmd.
Set up on OpenWrt/LEDE
LEDE 17.01.Zero and later:
opkg set up ttyd
It’s possible you’ll need to compile it manually.
Utilization
Command-line Choices
ttyd is a instrument for sharing terminal over the net
USAGE:
ttyd [options]
VERSION:
1.4.4
OPTIONS:
-p, –port Port to hear (default: 7681, use `0` for random port)
-i, –interface Community interface to bind (eg: eth0), or UNIX area socket path (eg: /var/run/ttyd.sock)
-c, –credential Credential for Fundamental Authentication (format: username:password)
-u, –uid Person id to run with
-g, –gid Group id to run with
-s, –signal Sign to ship to the command when exit it (default: 1, SIGHUP)
-r, –reconnect Time to reconnect for the shopper in seconds (default: 10)
-a, –url-arg Permit shopper to ship command line arguments in URL (eg: http://localhost:7681?arg=foo&arg=bar)
-R, –readonly Don’t enable shoppers to write down to the TTY
-t, –client-option Ship choice to shopper (format: key=worth), repeat so as to add extra choices
-T, –terminal-type Terminal kind to report, default: xterm-256colour
-O, –check-origin Don’t enable websocket connection from completely different origin
-m, –max-clients Most shoppers to assist (default: 0, no restrict)
-o, –once Settle for just one shopper and exit on disconnection
-B, –browser Open terminal with the default system browser
-I, –index Customized index.html path
-6, –ipv6 Allow IPv6 assist
-S, –ssl Allow SSL
-C, –ssl-cert SSL certificates file path
-Ok, –ssl-key SSL key file path
-A, –ssl-ca SSL CA file path for shopper certificates verification
-d, –debug Set log stage (default: 7)
-v, –version Print the model and exit
-h, –help Print this textual content and exit
Go to https://github.com/tsl0922/ttyd to get extra info and report bugs.
Instance Utilization
ttyd begins internet server at port 7681 by default, you need to use the -p choice to alter it, the command shall be began with arguments as choices. For instance, run:
ttyd -p 8080 bash -x
Then open http://localhost:8080 with a browser, you’re going to get a bash shell with debug mode enabled.
Extra Examples:
- If you wish to login together with your system accounts on the internet browser, run ttyd login.
- You’ll be able to even run a none shell command like vim, strive: ttyd vim, the net browser will present you a vim editor.
- Sharing single course of with a number of shoppers: ttyd tmux new -A -s ttyd vim, run tmux new -A -s ttyd to hook up with the tmux session from terminal.
Browser Assist
Trendy browsers, See Browser Support.
SSL how-to
Generate SSL CA and self signed server/shopper certificates:
# CA certificates (FQDN should be completely different from server/shopper)
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 certificates (for a number of domains, change subjectAltName to: DNS:instance.com,DNS:www.instance.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 -req -extfile
# shopper certificates (the p12/pem format could also be helpful for some shoppers)
openssl req -newkey rsa:2048 -nodes -keyout shopper.key -subj “/C=CN/ST=GD/L=SZ/O=Acme, Inc./CN=shopper” -out shopper.csr
openssl x509 -req -days 365 -in shopper.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out shopper.crt
openssl pkcs12 -export -clcerts -in shopper.crt -inkey shopper.key -out shopper.p12
openssl pkcs12 -in shopper.p12 -out shopper.pem -clcerts
Then begin ttyd:
ttyd –ssl –ssl-cert server.crt –ssl-key server.key –ssl-ca ca.crt bash
It’s possible you’ll need to check the shopper certificates verification with curl:
curl –insecure –cert shopper.p12[:password] -v https://localhost:7681
In case you do not need to allow shopper certificates verification, take away the –ssl-ca choice.
Docker and ttyd
Docker containers are jailed environments that are safer, that is helpful for shielding the host system, you could use ttyd with docker like this:
- Sharing single docker container with a number of shoppers: docker run -it –rm -p 7681:7681 tsl0922/ttyd.
- Creating new docker container for every shopper: ttyd docker run -it –rm ubuntu.
