Updated README and version
This commit is contained in:
@@ -9,11 +9,6 @@
|
||||
## 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.
|
||||
```
|
||||
+---------+ http +--------+ ssh +-----------+
|
||||
| browser | <==========> | webssh | <=======> | ssh server|
|
||||
+---------+ websocket +--------+ ssh +-----------+
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
@@ -31,6 +26,13 @@ A simple web application to be used as an ssh client to connect to your ssh serv
|
||||

|
||||
|
||||
|
||||
### How it works
|
||||
```
|
||||
+---------+ http +--------+ ssh +-----------+
|
||||
| browser | <==========> | webssh | <=======> | ssh server|
|
||||
+---------+ websocket +--------+ ssh +-----------+
|
||||
```
|
||||
|
||||
### Requirements
|
||||
|
||||
* Python 2.7/3.4+
|
||||
@@ -44,18 +46,6 @@ A simple web application to be used as an ssh client to connect to your ssh serv
|
||||
4. Input your data, submit the form.
|
||||
|
||||
|
||||
### Installation options
|
||||
|
||||
Install from the pypi repository, may not the latest version
|
||||
```
|
||||
pip install webssh
|
||||
```
|
||||
|
||||
Install from the github repository, always the latest version
|
||||
```
|
||||
pip install https://github.com/huashengdun/webssh/archive/master.zip
|
||||
```
|
||||
|
||||
### Server options
|
||||
|
||||
```bash
|
||||
@@ -78,19 +68,10 @@ wssh --help
|
||||
### Use console
|
||||
|
||||
```javascript
|
||||
// set a new encoding for client to use
|
||||
wssh.set_encoding(encoding);
|
||||
|
||||
// reset encoding to use the default one
|
||||
wssh.reset_encoding();
|
||||
|
||||
// connect to your ssh server
|
||||
wssh.connect(hostname, port, username, password, privatekey);
|
||||
|
||||
// without an argument, wssh will use the form data to connect
|
||||
wssh.connect();
|
||||
|
||||
// define a mapping object
|
||||
// define a object for wssh
|
||||
var opts = {
|
||||
hostname: 'hostname',
|
||||
port: 'port',
|
||||
@@ -100,6 +81,15 @@ var opts = {
|
||||
};
|
||||
wssh.connect(opts);
|
||||
|
||||
// without an argument, wssh will use the form data to connect
|
||||
wssh.connect();
|
||||
|
||||
// set a new encoding for client to use
|
||||
wssh.set_encoding(encoding);
|
||||
|
||||
// reset encoding to use the default one
|
||||
wssh.reset_encoding();
|
||||
|
||||
// send a command to the server
|
||||
wssh.send('ls -l');
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user