diff --git a/README.md b/README.md index aa080cc..e0bfbd5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,24 @@ # WiTTY: Web-based interactive TTY -This program allows you to use terminal in the browser. Simply run the program and give it the command to execute when users connect via the browser. ___Interestingly___, it allows others to view your interactive sessions as well. This could be useful to provide remote support and/or help. You can use the program to run any command line programs, such as ```bash```, ```htop```, ```vi```, ```ssh```. This following screenshot shows that six interactive session running ```zsh``` on macOS Monterey. +This program allows you to use terminal in the browser. Simply run the program and give it the command to execute when users connect via the browser. ___Interestingly___, it allows others to view your interactive sessions as well. This could be useful to provide remote support and/or help. You can use the program to run any command line programs, such as ```bash```, ```htop```, ```vi```, ```ssh```. This following screenshot shows that three interactive session running ```zsh``` on macOS Monterey. + +With WiTTY, you can also __record and replay your interactive sessions__. The following screenshot shows three recorded sessions. You can replay/download/delete them. + + + +Here is a session, where we sshed into a Raspberry Pi running +[pi-hole](https://pi-hole.net/) +(```./witty ssh 192.168.1.2 -l pi```, +WiTTY runs in a WSL2 VM on Windows) being replayed. You can play/pause the session. + + + + + To use the program, you need to provide a TLS cert. You can request a free [Let's Encrypt](https://letsencrypt.org/) cert or use a self-signed cert. The program currently does not support user authentication. Therefore, do not run it in untrusted networks or leave it running. A probably safe use of the program is to run ```ssh```. Please ensure that you do not automatically login to the ssh server (e.g., via key authentication). @@ -44,17 +63,4 @@ window (xterm.js) and create a websocket with the server, which relays the data ```https://your_ip_address:8080``` -The program has been tested on Linux, WSL2, Raspberry Pi 3B (Debian), and MacOSX using Google Chrome, Firefox, and Safari. - - - -## An Screencast featuring an older version of WiTTY - -Here is a screencast for sshing into Raspberry Pi running -[pi-hole](https://pi-hole.net/) -(```./witty ssh 192.168.1.2 -l pi```, -WiTTY runs in a WSL2 VM on Windows): - - +The program has been tested on Linux, WSL2, Raspberry Pi 3B (Debian), and MacOSX using Google Chrome, Firefox, and Safari. \ No newline at end of file diff --git a/extra/main.png b/extra/main.png index 78382a6..998f3ac 100644 Binary files a/extra/main.png and b/extra/main.png differ diff --git a/extra/screencast.gif b/extra/screencast.gif index 1001de8..525fcc1 100644 Binary files a/extra/screencast.gif and b/extra/screencast.gif differ diff --git a/extra/screenshot.png b/extra/screenshot.png deleted file mode 100644 index bbae0ed..0000000 Binary files a/extra/screenshot.png and /dev/null differ diff --git a/extra/view.png b/extra/view.png new file mode 100644 index 0000000..6cee817 Binary files /dev/null and b/extra/view.png differ