# webshell

**Repository Path**: nanbowang/webshell

## Basic Information

- **Project Name**: webshell
- **Description**: Secure Shell / File Transfer over Websocket
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-01-17
- **Last Updated**: 2022-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Web Shell (License: MIT)

A kind of Secure Shell Server completely replacing OpenSSH Server, sharing connection message over websocket protocol.

![image](webshell.png "Web Shell")

--------------------------------------------------------

*Features of webssh-proxy*:

- UTF-8 Support, Color Terminal, Visual Bell/Beep Sound, ..
- Local File Uploading to Remote: supporting huge file upload
- Remote File Downloading to Local: support huge file download
- No dependency with OpenSSH Server
- Fully AsyncIO based

*Supported All mainstream browsers*:

-	Firefox/Iceweasel latest (all supported)
-	Chrome/Chromium latest (all supported)
-	IE 11 (only beep sound is not supported)

--------------------------------------------------------

### Run Embeded Web Shell in Docker from Repository

```sh
docker run -it --rm --net=host -e LISTEN="8080" ghostplant/webshell
docker run -it --rm --net=host -e LISTEN="8443 ssl" ghostplant/webshell
docker run -it --rm --net=host -e LISTEN="8443 ssl" -e ACCOUNT="admin:badmin" ghostplant/webshell
```
--------------------------------------------------------

### Compile Source Codes on Ubuntu 16.04 LTS

```sh
apt install nginx-core
apt build-dep nginx-core

git clone https://github.com/ghostplant/webshell
cd webshell/
./wsh-compile
LISTEN=8080 ./wsh-run
```
--------------------------------------------------------

### Next, open your browser to get access to the terminal

```sh
firefox "http://localhost:8080/"
```

--------------------------------------------------------

If you want to enable http over SSL, change listen ports, or add WWW authorization,
you can add your custom settings in nginx config file - www.cfg.in.