Updated README

pull/75/head
Sheng 2019-07-07 15:19:39 +08:00
parent d197133c95
commit 3ea76dcbe6
3 changed files with 10 additions and 4 deletions

View File

@ -15,6 +15,7 @@ A simple web application to be used as an ssh client to connect to your ssh serv
* 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.
* Encrypted keys supported. * Encrypted keys supported.
* Two-Factor Authentication(time-based one-time password) supported.
* Fullscreen terminal supported. * Fullscreen terminal supported.
* Terminal window resizable. * Terminal window resizable.
* Auto detect the ssh server's default encoding. * Auto detect the ssh server's default encoding.
@ -73,7 +74,7 @@ wssh --help
```javascript ```javascript
// connect to your ssh server // connect to your ssh server
wssh.connect(hostname, port, username, password, privatekey); wssh.connect(hostname, port, username, password, privatekey, passphrase, totp);
// pass an object to wssh.connect // pass an object to wssh.connect
var opts = { var opts = {
@ -81,7 +82,9 @@ var opts = {
port: 'port', port: 'port',
username: 'username', username: 'username',
password: 'password', password: 'password',
privatekey: 'the private key text' privatekey: 'the private key text',
passphrase: 'passphrase',
totp: 'totp'
}; };
wssh.connect(opts); wssh.connect(opts);

View File

@ -17,6 +17,7 @@ Features
- SSH public-key authentication supported, including DSA RSA ECDSA - SSH public-key authentication supported, including DSA RSA ECDSA
Ed25519 keys. Ed25519 keys.
- Encrypted keys supported. - Encrypted keys supported.
- Two-Factor Authentication(time-based one-time password) supported.
- Fullscreen terminal supported. - Fullscreen terminal supported.
- Terminal window resizable. - Terminal window resizable.
- Auto detect the ssh server's default encoding. - Auto detect the ssh server's default encoding.
@ -79,7 +80,7 @@ Browser console
.. code:: javascript .. code:: javascript
// connect to your ssh server // connect to your ssh server
wssh.connect(hostname, port, username, password, privatekey); wssh.connect(hostname, port, username, password, privatekey, passphrase, totp);
// pass an object to wssh.connect // pass an object to wssh.connect
var opts = { var opts = {
@ -87,7 +88,9 @@ Browser console
port: 'port', port: 'port',
username: 'username', username: 'username',
password: 'password', password: 'password',
privatekey: 'the private key text' privatekey: 'the private key text',
passphrase: 'passphrase',
totp: 'totp'
}; };
wssh.connect(opts); wssh.connect(opts);

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 60 KiB