diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 18 insertions, 6 deletions
@@ -1,4 +1,9 @@ -  [](https://repology.org/project/ttyd/versions) + + +[](https://github.com/tsl0922/ttyd/releases) +[](https://hub.docker.com/r/tsl0922/ttyd) +[](https://repology.org/project/ttyd/versions) + # ttyd - Share your terminal over the web @@ -23,16 +28,18 @@ ttyd is a simple command-line tool for sharing terminal over the web. ## Install on macOS -- Install with [homebrew](http://brew.sh): `brew install ttyd` +- Install with [Homebrew](http://brew.sh): `brew install ttyd` - Install with [MacPorts](https://www.macports.org): `sudo port install ttyd` ## Install on Linux - Binary version (recommended): download from the [releases](https://github.com/tsl0922/ttyd/releases) page +- Install with [Homebrew](https://docs.brew.sh/Homebrew-on-Linux) : `brew install ttyd` - Install the snap: `sudo snap install ttyd --classic` - Build from source (debian/ubuntu): ```bash - sudo apt-get install build-essential cmake git libjson-c-dev libwebsockets-dev + sudo apt-get update + sudo apt-get install -y build-essential cmake git libjson-c-dev libwebsockets-dev git clone https://github.com/tsl0922/ttyd.git cd ttyd && mkdir build && cd build cmake .. @@ -45,6 +52,7 @@ ttyd is a simple command-line tool for sharing terminal over the web. ## Install on Windows - Binary version (recommended): download from the [releases](https://github.com/tsl0922/ttyd/releases) page +- Install with [WinGet](https://github.com/microsoft/winget-cli): `winget install tsl0922.ttyd` - Install with [Scoop](https://scoop.sh/#/apps?q=ttyd&s=2&d=1&o=true): `scoop install ttyd` - [Compile on Windows](https://github.com/tsl0922/ttyd/wiki/Compile-on-Windows) @@ -59,21 +67,25 @@ USAGE: 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, --socket-owner User owner of the UNIX domain socket file, when enabled (eg: user:group) + -c, --credential Credential for basic authentication (format: username:password) + -H, --auth-header HTTP Header name for auth proxy, this will configure ttyd to let a HTTP reverse proxy handle authentication -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) + -w, --cwd Working directory to be set for the child program -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 + -W, --writable Allow clients to write to the TTY (readonly by default) -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 + -q, --exit-no-conn Exit on all clients 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, max length: 128) - -P, --ping-interval Websocket ping interval(sec) (default: 300) + -P, --ping-interval Websocket ping interval(sec) (default: 5) -6, --ipv6 Enable IPv6 support -S, --ssl Enable SSL -C, --ssl-cert SSL certificate file path |