Add some basic info

This commit is contained in:
syssecfsu 2022-01-05 18:04:37 -05:00 committed by GitHub
parent 8a68bf0c69
commit 952ed7459a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

25
README.md Normal file
View File

@ -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:
<img src="https://github.com/syssecfsu/web_terminal/blob/master/extra/screenshot.png?raw=true" width="800px">