jinql
/
webssh
mirror of https://github.com/huashengdun/webssh
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated README

static
Sheng 2019-05-19 20:19:51 +08:00
parent 34af59a1c9
commit e1cd3efdf0
2 changed files with 21 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -6,11 +6,11 @@
![PyPI](https://img.shields.io/pypi/v/webssh.svg) ![PyPI](https://img.shields.io/pypi/v/webssh.svg)
## Introduction ### Introduction
A simple web application to be used as an ssh client to connect to your ssh servers. It is written in Python, base on tornado, paramiko and xterm.js. A simple web application to be used as an ssh client to connect to your ssh servers. It is written in Python, base on tornado, paramiko and xterm.js.
## Features ### Features
* SSH password authentication supported, including empty password. * SSH password authentication supported, including empty password.
* SSH public-key authentication supported, including DSA RSA ECDSA Ed25519 keys. * SSH public-key authentication supported, including DSA RSA ECDSA Ed25519 keys.
@ -21,7 +21,7 @@ A simple web application to be used as an ssh client to connect to your ssh serv
* Modern browsers including Chrome, Firefox, Safari, Edge, Opera supported. * Modern browsers including Chrome, Firefox, Safari, Edge, Opera supported.
## Preview ### Preview
![Login](https://github.com/huashengdun/webssh/raw/master/preview/login.png) ![Login](https://github.com/huashengdun/webssh/raw/master/preview/login.png)
![Terminal](https://github.com/huashengdun/webssh/raw/master/preview/terminal.png) ![Terminal](https://github.com/huashengdun/webssh/raw/master/preview/terminal.png)
@ -114,7 +114,12 @@ http://localhost:8888/#bgcolor=green
Passing a user defined title Passing a user defined title
```bash ```bash
http://localhost:8888/?title=my-webssh-server http://localhost:8888/?title=my-ssh-server
```
Passing an encoding
```bash
http://localhost:8888/#encoding=gbk
``` ```
### Use Docker ### Use Docker
@ -168,7 +173,7 @@ wssh --port=8080 --sslport=4433 --certfile='cert.crt' --keyfile='cert.key' --xhe
``` ```
## Tips ### Tips
* For whatever deployment choice you choose, don't forget to enable SSL. * For whatever deployment choice you choose, don't forget to enable SSL.
* By default plain http requests from a public network will be either redirected or blocked and being redirected takes precedence over being blocked. * By default plain http requests from a public network will be either redirected or blocked and being redirected takes precedence over being blocked.

16
README.rst
View File

@ -4,14 +4,14 @@ WebSSH
|Build Status| |codecov| |PyPI - Python Version| |PyPI| |Build Status| |codecov| |PyPI - Python Version| |PyPI|
Introduction Introduction
------------ ~~~~~~~~~~~~
A simple web application to be used as an ssh client to connect to your A simple web application to be used as an ssh client to connect to your
ssh servers. It is written in Python, base on tornado, paramiko and ssh servers. It is written in Python, base on tornado, paramiko and
xterm.js. xterm.js.
Features Features
-------- ~~~~~~~~
- SSH password authentication supported, including empty password. - SSH password authentication supported, including empty password.
- SSH public-key authentication supported, including DSA RSA ECDSA - SSH public-key authentication supported, including DSA RSA ECDSA
@ -24,7 +24,7 @@ Features
supported. supported.
Preview Preview
------- ~~~~~~~
|Login| |Terminal| |Login| |Terminal|
@ -125,7 +125,13 @@ Passing a user defined title
.. code:: bash .. code:: bash
http://localhost:8888/?title=my-webssh-server http://localhost:8888/?title=my-ssh-server
Passing an encoding
.. code:: bash
http://localhost:8888/#encoding=gbk
Use Docker Use Docker
~~~~~~~~~~ ~~~~~~~~~~
@ -187,7 +193,7 @@ Running as a standalone server
wssh --port=8080 --sslport=4433 --certfile='cert.crt' --keyfile='cert.key' --xheaders=False --policy=reject wssh --port=8080 --sslport=4433 --certfile='cert.crt' --keyfile='cert.key' --xheaders=False --policy=reject
Tips Tips
---- ~~~~
- For whatever deployment choice you choose, don't forget to enable - For whatever deployment choice you choose, don't forget to enable
SSL. SSL.