ttyd README

The project's README from github.com/tsl0922/ttyd. As one markdown file: README.md.

backend frontend GitHub Releases Docker Pulls Packaging status GitHub

ttyd - Share your terminal over the web

ttyd is a simple command-line tool for sharing terminal over the web.

screenshot

Features

Installation

Install on macOS

Install on Linux

Install on Windows

Usage

Command-line Options

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

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)
    -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)
    -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: 5)
    -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

Read the example usage on the wiki.

Browser Support

Modern browsers, See Browser Support.

Alternatives

ttyd (tsl0922/ttyd)

Searching Database…

12.5K ·GitHub
Ttyd
Что это такое?ttyd — это инструмент командной строки, который открывает доступ к вашему терминалу через веб: вы можете подключаться к сеансу терминала и работать в нём через браузер.
Это приложение с графическим интерфейсом или инструмент командной строки?Это инструмент командной строки: вы запускаете команду `ttyd` с нужной оболочкой или программой, и он поднимает веб-сервер, который передаёт этот сеанс терминала подключённым браузерам.
Как мне установить и запустить его?Установите через менеджер пакетов вашей ОС (Homebrew или MacPorts на macOS, apt или snap в Linux, WinGet или Scoop в Windows, opkg в OpenWrt) или скачайте готовый статически собранный бинарный файл со страницы релизов, а затем запустите ttyd с командой, к которой хотите открыть доступ.
Что нужно внутри, чтобы он работал?Он построен на libuv и WebGL2 для отрисовки терминала, а поддержка SSL обеспечивается через OpenSSL или Mbed TLS.
Работает ли он в любом браузере?Нужен современный браузер; на отдельной странице поддержки браузеров указано, какие из них совместимы.
Работает ли он только в Linux и macOS?Нет, он кроссплатформенный: поддерживаются macOS, Linux, FreeBSD/OpenBSD, OpenWrt и Windows.
Поддерживает ли он передачу файлов через терминал?Да, ttyd поддерживает передачу файлов по протоколам ZMODEM (lrzsz) и trzsz прямо в сеансе терминала.
Можно ли показывать изображения в терминале?Да, поддерживается вывод изображений в формате Sixel, поэтому такие инструменты, как img2sixel или lsix, могут показывать картинки в веб-терминале.
Поддерживается ли ввод не-ASCII символов, например китайских или японских?Да, это полнофункциональный терминал со встроенной поддержкой CJK и IME.
Есть ли альтернативы ttyd?В README упоминаются Wetty (веб-терминал на Node с SSH и входом в систему) и GoTTY (веб-терминал на Go) как альтернативы.
What are similar projects?websocketd, xterm.js, WindTerm, upterm, gotty, tailcat, xpra, smartdns
Which topics is it in?xterm, tty, openwrt, ssl, terminal-emulators, websockets, remote-access, websocket, c, command-line, networking, command-line-tool
Creator
tsl0922
Size
20.1 MB
Stars
12.5K
Updated
CommitAug 12Release1.7.7Mar 30
Age
10y
Commits · 90 Days