From 952ed7459ad6155a86d128fda6fbf6a60368b455 Mon Sep 17 00:00:00 2001 From: syssecfsu Date: Wed, 5 Jan 2022 18:04:37 -0500 Subject: [PATCH] Add some basic info --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a2029b3 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# 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 less than 200 lines of go code. + +It is just a simple demo in case some people are interested in +how to setup xterm.js with websocket. + + +**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: + +