From 23ca3c8d1320fc4c9b8948a15c23b3199d914a46 Mon Sep 17 00:00:00 2001 From: Iwasaki Yudai Date: Fri, 21 Aug 2015 19:06:19 +0900 Subject: [PATCH] Add `-r` (random URL) option to README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2c322d9..54a62fe 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ By default, gotty starts a web server at port 8080. Open the URL on your web bro --port, -p "8080" Port number to listen [$GOTTY_PORT] --permit-write, -w Permit clients to write to the TTY (BE CAREFUL) [$GOTTY_PERMIT_WRITE] --credential, -c Credential for Basic Authentication (ex: user:pass) [$GOTTY_CREDENTIAL] +--random-url, -r Add a random string to the URL [$GOTTY_RANDOM_URL] ``` By default, gotty doesn't allow clients to send any keystrokes or commands except terminal window resizing. When you want to permit clients to write input to the PTY, add the `-w` option. However, accepting input from remote clients is dangerous for most commands. Make sure that only trusted clients can connect to your gotty server when you activate this option. If you need interaction with the PTY, consider starting gotty with tmux or GNU Screen and run your main command on it.