mirror of https://github.com/huashengdun/webssh
Updated README
parent
a7a3f46609
commit
41740690ac
|
@ -38,8 +38,8 @@ A simple web application to be used as an ssh client to connect to your ssh serv
|
||||||
|
|
||||||
### Quickstart
|
### Quickstart
|
||||||
|
|
||||||
1. Install this app `pip install webssh`
|
1. Install this app, run command `pip install webssh`
|
||||||
2. Start a webserver `wssh`
|
2. Start a webserver, run command `wssh`
|
||||||
3. Open your browser, navigate to `127.0.0.1:8888`
|
3. Open your browser, navigate to `127.0.0.1:8888`
|
||||||
4. Input your data, submit the form.
|
4. Input your data, submit the form.
|
||||||
|
|
||||||
|
@ -77,7 +77,6 @@ wssh --help
|
||||||
|
|
||||||
### Use console
|
### Use console
|
||||||
|
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
// set a new encoding for client to use
|
// set a new encoding for client to use
|
||||||
wssh.set_encoding(encoding);
|
wssh.set_encoding(encoding);
|
||||||
|
@ -88,7 +87,7 @@ wssh.reset_encoding();
|
||||||
// connect to your ssh server
|
// connect to your ssh server
|
||||||
wssh.connect(hostname, port, username, password, privatekey);
|
wssh.connect(hostname, port, username, password, privatekey);
|
||||||
|
|
||||||
// without argument, wssh will use the form data to connect
|
// without an argument, wssh will use the form data to connect
|
||||||
wssh.connect();
|
wssh.connect();
|
||||||
|
|
||||||
// define a mapping object
|
// define a mapping object
|
||||||
|
|
|
@ -40,8 +40,8 @@ Requirements
|
||||||
Quickstart
|
Quickstart
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
||||||
1. Install this app ``pip install webssh``
|
1. Install this app, run command ``pip install webssh``
|
||||||
2. Start a webserver ``wssh``
|
2. Start a webserver, run command ``wssh``
|
||||||
3. Open your browser, navigate to ``127.0.0.1:8888``
|
3. Open your browser, navigate to ``127.0.0.1:8888``
|
||||||
4. Input your data, submit the form.
|
4. Input your data, submit the form.
|
||||||
|
|
||||||
|
@ -94,7 +94,7 @@ Use console
|
||||||
// connect to your ssh server
|
// connect to your ssh server
|
||||||
wssh.connect(hostname, port, username, password, privatekey);
|
wssh.connect(hostname, port, username, password, privatekey);
|
||||||
|
|
||||||
// without argument, wssh will use the form data to connect
|
// without an argument, wssh will use the form data to connect
|
||||||
wssh.connect();
|
wssh.connect();
|
||||||
|
|
||||||
// define a mapping object
|
// define a mapping object
|
||||||
|
|
Loading…
Reference in New Issue