GitHub/witty
3
0
Fork 0
mirror of https://github.com/syssecfsu/witty.git synced 2024-11-01 09:39:26 +01:00
Code Issues Projects Releases Wiki Activity
Web-based interactive terminal emulator that allows users to easily record, share, and replay console sessions.
15 Commits 1 Branch 3 Tags 20 MiB
Go 54.9%
HTML 31.1%
JavaScript 11.3%
CSS 2.3%
Shell 0.4%
4b8a7b064a
Go to file
Zhi Wang 4b8a7b064a Merge branch 'master' of https://github.com/syssecfsu/web_terminal
2022-01-06 20:54:45 -05:00
assets rewrite the ws handling according to command example in websocket lib. Basically adding timeout for receive and send 2022-01-06 15:29:02 -05:00
extra add screenshot 2022-01-05 17:48:58 -05:00
go.mod rewrite the ws handling according to command example in websocket lib. Basically adding timeout for receive and send 2022-01-06 15:29:02 -05:00
go.sum has a websocket shell now! 2022-01-05 12:38:52 -05:00
main.go correct argument passing 2022-01-06 20:53:36 -05:00
README.md Update README.md 2022-01-06 20:37:57 -05:00

README.md

Web Terminal

A (unsafe) technical demo to export a shell to web browser.

This program is written in the go programming language, using the Gin web framework, gorilla/websocket, pty, and xterm.js! The workflow is simple, the client will initiate a terminal window (xterm.js) and create a websocket with the server. On the server side, it serves the basic HTML/JS/CSS files and websockets (by shovling the data between pty and xterm).

It is amazing what you can do with 260 lines of go code.

It is just a simple demo in case some people are interested in how to setup xterm.js with websocket.

To use the program, download/clone the code, and in the web_terminal directory, run go build ., this will create the binary called web_terminal. To run it, use ./web_terminal cmd options_to_cmd. If no cmd and options are given, web_terminal will run bash by default. You can run shells but also single programs, such as htop. The program has been tested on Linux, WSL2, Raspberry Pi 3B (Debian), and MacOSX.

known bug

On MacOS X, running zsh with web_terminal will produce an extra % each time. Consider it a feautre, will not fix unless there is a pull request.

NOTE

Do NOT run this in an untrusted network. You will expose your shell to anyone that can access your network and Do NOT leave the server running.

Here is a screenshot: