From 1c8b87df9079c322480675cd09f7030e294f843f Mon Sep 17 00:00:00 2001 From: Iwasaki Yudai Date: Sun, 16 Aug 2015 21:21:26 -0700 Subject: [PATCH] Add section for how to use with terminal multiplexer --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 24ab55a..dc28b86 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,24 @@ By default, gotty starts a web server at port 8080. Open the URL on your web bro By default, gotty doesn't allow clients to send any keystrokes or commands except terminal window resizing. When you want to permmit 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 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. +## Sharing with Multiple Clients + +Gotty starts a new process when a new client connects to the server. This means users cannot share a single terminal with others by default. However, you can use terminal multiplexers for sharing a single process with multiple clients. + +For example, you can start a new tmux session named `gotty` with `top` command by the command below. + +```sh +gotty tmux new -A -s gotty top +``` + +This command doesn't allow clients to send keystrokes, however, you can attach the session from your local terminal and run operatitons like switching the mode of the `top` command. To connect to the tmux session from your terminal, you can use following command. + +``` +tmux new -A -s gotty +``` + +By using terminal multiplexers, you can have the control of your terminal and allow clients to just see your screen. + # License The MIT License