From d5c944a2e1c03e83d63380bf46b094e6a459c559 Mon Sep 17 00:00:00 2001 From: Shuanglei Tao Date: Mon, 13 Mar 2017 23:36:13 +0800 Subject: [PATCH] Add man page --- CMakeLists.txt | 5 +- README.md | 2 +- _config.yml | 2 - man/ttyd.1 | 203 ++++++++++++++++++++++++++++++++++++++++++++++++ man/ttyd.man.md | 135 ++++++++++++++++++++++++++++++++ 5 files changed, 343 insertions(+), 4 deletions(-) delete mode 100644 _config.yml create mode 100644 man/ttyd.1 create mode 100644 man/ttyd.man.md diff --git a/CMakeLists.txt b/CMakeLists.txt index 3eee8ba..2395093 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -63,4 +63,7 @@ add_executable(${PROJECT_NAME} ${SOURCE_FILES}) target_include_directories(${PROJECT_NAME} PUBLIC ${INCLUDE_DIRS}) target_link_libraries(${PROJECT_NAME} ${LINK_LIBS}) -install(TARGETS ${PROJECT_NAME} RUNTIME DESTINATION bin) +include(GNUInstallDirs) + +install(TARGETS ${PROJECT_NAME} DESTINATION "${CMAKE_INSTALL_BINDIR}" COMPONENT prog) +install(FILES man/ttyd.1 DESTINATION "${CMAKE_INSTALL_MANDIR}/man1" COMPONENT doc) diff --git a/README.md b/README.md index ce7280d..adadbc2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ ttyd is a simple command-line tool for sharing terminal over the web, inspired b - SSL support based on [OpenSSL][4] - Run any custom command with options - Basic authentication support and many other custom options -- Cross platform: macOS, Linux, FreeBSD, [OpenWrt][5]/[LEDE][6] +- Cross platform: macOS, Linux, FreeBSD, [OpenWrt][5]/[LEDE][6], Windows # Installation diff --git a/_config.yml b/_config.yml deleted file mode 100644 index b8db5b4..0000000 --- a/_config.yml +++ /dev/null @@ -1,2 +0,0 @@ -theme: jekyll-theme-cayman -show_downloads: true diff --git a/man/ttyd.1 b/man/ttyd.1 new file mode 100644 index 0000000..b481ed0 --- /dev/null +++ b/man/ttyd.1 @@ -0,0 +1,203 @@ +.TH ttyd 1 "September 2016" ttyd "User Manual" + +.SH NAME +.PP +ttyd \- Share your terminal over the web + + +.SH SYNOPSIS +.PP +\fBttyd\fP [options] [] + + +.SH Description +.PP +ttyd is a command\-line tool for sharing terminal over the web that runs in *nix and windows systems, with the following features: +.IP \(bu 2 +Built on top of Libwebsockets with C for speed +.IP \(bu 2 +Fully\-featured terminal based on Xterm.js with CJK (Chinese, Japanese, Korean) and IME support +.IP \(bu 2 +SSL support based on OpenSSL +.IP \(bu 2 +Run any custom command with options +.IP \(bu 2 +Basic authentication support and many other custom options +.IP \(bu 2 +Cross platform: macOS, Linux, FreeBSD, OpenWrt/LEDE, Windows + + +.SH OPTIONS +.PP +\-p, \-\-port + Port to listen (default: 7681, use \fB\fC0\fR for random port) + +.PP +\-i, \-\-interface + Network interface to bind (eg: eth0), or UNIX domain socket path (eg: /var/run/ttyd.sock) + +.PP +\-c, \-\-credential USER[:PASSWORD] + Credential for Basic Authentication (format: username:password) + +.PP +\-u, \-\-uid + User id to run with + +.PP +\-g, \-\-gid + Group id to run with + +.PP +\-s, \-\-signal + Signal to send to the command when exit it (default: SIGHUP) + +.PP +\-\-signal\-list + Print a list of supported signals + +.PP +\-r, \-\-reconnect + Time to reconnect for the client in seconds (default: 10) + +.PP +\-R, \-\-readonly + Do not allow clients to write to the TTY + +.PP +\-t, \-\-client\-option + Send option to client (format: key=value), repeat to add more options + +.PP +\-O, \-\-check\-origin + Do not allow websocket connection from different origin + +.PP +\-o, \-\-once + Accept only one client and exit on disconnection + +.PP +\-B, \-\-browser + Open terminal with the default system browser + +.PP +\-I, \-\-index + Custom index.html path + +.PP +\-S, \-\-ssl + Enable SSL + +.PP +\-C, \-\-ssl\-cert + SSL certificate file path + +.PP +\-K, \-\-ssl\-key + SSL key file path + +.PP +\-A, \-\-ssl\-ca + SSL CA file path for client certificate verification + +.PP +\-d, \-\-debug + Set log level (default: 7) + +.PP +\-v, \-\-version + Print the version and exit + +.PP +\-h, \-\-help + Print this text and exit + + +.SH Examples +.PP +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: + +.PP +.RS + +.nf +ttyd \-p 8080 bash \-x + +.fi +.RE + +.PP +Then open +\[la]http://localhost:8080\[ra] with a browser, you will get a bash shell with debug mode enabled. More examples: +.IP \(bu 2 +If you want to login with your system accounts on the web browser, run \fB\fCttyd login\fR\&. +.IP \(bu 2 +You can even run a none shell command like vim, try: \fB\fCttyd vim\fR, the web browser will show you a vim editor. +.IP \(bu 2 +Sharing single process with multiple clients: \fB\fCttyd tmux new \-A \-s ttyd vim\fR, run \fB\fCtmux new \-A \-s ttyd\fR to connect to the tmux session from terminal. + + +.SH SSL how\-to +.PP +Generate SSL CA and self signed server/client certificates: + +.PP +.RS + +.nf +# CA certificate (FQDN must be different from server/client) +openssl genrsa \-out ca.key 4096 +openssl req \-new \-x509 \-days 365 \-key ca.key \-out ca.crt +# server certificate +openssl req \-newkey rsa:2048 \-nodes \-keyout server.key \-out server.csr +openssl x509 \-req \-days 365 \-in server.csr \-CA ca.crt \-CAkey ca.key \-set\_serial 01 \-out server.crt +# client certificate (the p12/pem format may be useful for some clients) +openssl req \-newkey rsa:2048 \-nodes \-keyout client.key \-out client.csr +openssl x509 \-req \-days 365 \-in client.csr \-CA ca.crt \-CAkey ca.key \-set\_serial 02 \-out client.crt +openssl pkcs12 \-export \-clcerts \-in client.crt \-inkey client.key \-out client.p12 +openssl pkcs12 \-in client.p12 \-out client.pem \-clcerts + +.fi +.RE + +.PP +Then start ttyd: + +.PP +.RS + +.nf +ttyd \-\-ssl \-\-ssl\-cert server.crt \-\-ssl\-key server.key \-\-ssl\-ca ca.crt bash + +.fi +.RE + +.PP +You may want to test the client certificate verification with \fIcurl\fP(1): + +.PP +.RS + +.nf +curl \-\-insecure \-\-cert client.p12[:password] \-v https://localhost:7681 + +.fi +.RE + +.PP +If you don't want to enable client certificate verification, remove the \fB\fC\-\-ssl\-ca\fR option. + + +.SH Docker and ttyd +.PP +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: +.IP \(bu 2 +Sharing single docker container with multiple clients: docker run \-it \-\-rm \-p 7681:7681 tsl0922/ttyd. +.IP \(bu 2 +Creating new docker container for each client: ttyd docker run \-it \-\-rm ubuntu. + + +.SH AUTHOR +.PP +Shuanglei Tao Visit +\[la]https://github.com/tsl0922/ttyd\[ra] to get more information and report bugs. diff --git a/man/ttyd.man.md b/man/ttyd.man.md new file mode 100644 index 0000000..1a7f3ba --- /dev/null +++ b/man/ttyd.man.md @@ -0,0 +1,135 @@ +ttyd 1 "September 2016" ttyd "User Manual" +================================================== + +# NAME + ttyd - Share your terminal over the web + +# SYNOPSIS + **ttyd** [options] \ [\] + +# Description + ttyd is a command-line tool for sharing terminal over the web that runs in *nix and windows systems, with the following features: + + - Built on top of Libwebsockets with C for speed + - Fully-featured terminal based on Xterm.js with CJK (Chinese, Japanese, Korean) and IME support + - SSL support based on OpenSSL + - Run any custom command with options + - Basic authentication support and many other custom options + - Cross platform: macOS, Linux, FreeBSD, OpenWrt/LEDE, Windows + +# 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 USER[:PASSWORD] + 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: SIGHUP) + + --signal-list + Print a list of supported signals + + -r, --reconnect + Time to reconnect for the client in seconds (default: 10) + + -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 + + -O, --check-origin + Do not allow websocket connection from different origin + + -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 + + -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 + +# Examples + 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 browser, you will get a bash shell with debug mode enabled. More examples: + + - If you want to login with your system accounts on the web browser, run `ttyd login`. + - You can even run a none shell command like vim, try: `ttyd vim`, the web browser will show you a vim editor. + - Sharing single process with multiple clients: `ttyd tmux new -A -s ttyd vim`, run `tmux new -A -s ttyd` to connect to the tmux session from terminal. + +# SSL how-to + Generate SSL CA and self signed server/client certificates: + +``` +# CA certificate (FQDN must be different from server/client) +openssl genrsa -out ca.key 4096 +openssl req -new -x509 -days 365 -key ca.key -out ca.crt +# server certificate +openssl req -newkey rsa:2048 -nodes -keyout server.key -out server.csr +openssl x509 -req -days 365 -in server.csr -CA ca.crt -CAkey ca.key -set_serial 01 -out server.crt +# client certificate (the p12/pem format may be useful for some clients) +openssl req -newkey rsa:2048 -nodes -keyout client.key -out client.csr +openssl x509 -req -days 365 -in client.csr -CA ca.crt -CAkey ca.key -set_serial 02 -out client.crt +openssl pkcs12 -export -clcerts -in client.crt -inkey client.key -out client.p12 +openssl pkcs12 -in client.p12 -out client.pem -clcerts +``` + + Then start ttyd: + +``` +ttyd --ssl --ssl-cert server.crt --ssl-key server.key --ssl-ca ca.crt bash +``` + + You may want to test the client certificate verification with *curl*(1): + +``` +curl --insecure --cert client.p12[:password] -v https://localhost:7681 +``` + + If you don't want to enable client certificate verification, remove the `--ssl-ca` option. + +# 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: + + - Sharing single docker container with multiple clients: docker run -it --rm -p 7681:7681 tsl0922/ttyd. + - Creating new docker container for each client: ttyd docker run -it --rm ubuntu. + +# AUTHOR + Shuanglei Tao \ Visit https://github.com/tsl0922/ttyd to get more information and report bugs. \ No newline at end of file -- 2.43.4