From 371e905fb39b99e9cbe85b7d2fbdb83627ee3852 Mon Sep 17 00:00:00 2001 From: Shuanglei Tao Date: Tue, 15 Nov 2016 20:03:28 +0800 Subject: [PATCH] Update with 1.2.0 --- index.html | 101 +++++++++++++++++++++++++++++------------------------ 1 file changed, 55 insertions(+), 46 deletions(-) diff --git a/index.html b/index.html index 259e46e..dc6dd39 100644 --- a/index.html +++ b/index.html @@ -12,52 +12,49 @@
-

ttyd - Share your terminal over the web

-

ttyd is a simple command-line tool for sharing terminal over the web, inspired by GoTTY.

-

screenshot

+

ttyd - Share your terminal over the web

+

ttyd is a simple command-line tool for sharing terminal over the web, inspired by GoTTY.

+

screenshot

Features

- -

Installation

-

Install on macOS

-

Install with homebrew:

-
- 
brew install ttyd
-
-

Install on Linux

-

Ubuntu 16.04 as example:

+ +

Installation

+

Install on macOS

+

Install with homebrew:

+ 
brew install ttyd
+

Install on Linux

+

Ubuntu 16.04 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
-
+
NOTE: You may need to compile libwebsockets from source for ubuntu versions old than 16.04, since they have outdated libwebsockets-dev package (Issue #6). -
-

Install on OpenWrt/LEDE

-
- 
opkg install ttyd
-
-
- NOTE: This may only works for LEDE snapshots currently, if the install command fails, compile it yourself. -
-

Usage

+
+

Install on OpenWrt/LEDE

+ 
opkg install ttyd
+
+ NOTE: This may only works for LEDE snapshots currently, if the install command fails, compile it yourself. +
+

Usage

+

Command-line Options

ttyd is a tool for sharing terminal over the web
 
 USAGE:
-    ttyd [options]  []
+    ttyd [options] <command> [<arguments...>]
 
 VERSION:
-    1.1.0
+    1.2.0
 
 OPTIONS:
-    --port, -p              Port to listen (default: 7681)
+    --port, -p              Port to listen (default: 7681, use `0` for random port)
     --interface, -i         Network interface to bind
     --credential, -c        Credential for Basic Authentication (format: username:password)
     --uid, -u               User id to run with
@@ -74,19 +71,31 @@ OPTIONS:
     --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

- -
- + --help, -h Print this text and exit + +

Example Usage

+

ttyd starts web server at port 7681 by default, you can use the -p option to change it, the command will be started with arguments as options. For example, run:

+ 
ttyd -p 8080 bash -x
+

Then open http://localhost:8080 with a broswer, you will get a bash shell with debug mode enabled.

+

More Examples:

+ +

Docker and ttyd

+

Docker containers are jailed environments which are more secure, this is useful for protecting the host system, you may use ttyd with docker like this:

+ +

Credits

+ + + \ No newline at end of file