OrgGo
/
gotty
mirror of https://github.com/sorenisanerd/gotty.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Mention `-c` option in README

This commit is contained in:
Iwasaki Yudai 2015-08-20 17:34:49 +09:00
parent 496c791a68
commit fd4a9d3bf8
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -43,6 +43,7 @@ By default, gotty starts a web server at port 8080. Open the URL on your web bro
--addr, -a IP address to listen [$GOTTY_ADDR]
--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]
```
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.