ttyd

https://tsl0922.github.io/ttyd/
Admin
A simple command-line tool for sharing terminal over the web with web-based terminal access,...
Tokens:870
Snippets:14
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install ttyd on OpenWrt

Source: https://tsl0922.github.io/ttyd

Install ttyd on OpenWrt using opkg.

```bash
opkg install ttyd
```

--------------------------------

### Install ttyd on macOS

Source: https://tsl0922.github.io/ttyd

Install ttyd on macOS using homebrew.

```bash
brew install ttyd
```

--------------------------------

### Install ttyd on Linux from source

Source: https://tsl0922.github.io/ttyd

Install ttyd on Debian/Ubuntu based Linux distributions from source.

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

--------------------------------

### ttyd Command-line Options

Source: https://tsl0922.github.io/ttyd

ttyd command-line options and usage.

```bash
ttyd is a tool for sharing terminal over the web

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

VERSION:
    1.6.0

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
    -b, --base-path         Expected base path for requests coming from a reverse proxy (eg: /mounted/here)
    -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.
```
Tokens:
Raw