butlerx
5 years ago
No known key found for this signature in database
GPG Key ID: B37CA765BAA89170
1 changed files with
2 additions and
0 deletions
-
docs/API.md
|
|
|
@ -24,6 +24,8 @@ Starts WeTTy Server |
|
|
|
| [ssh.host] | `string` | `"localhost"` | machine to ssh too | |
|
|
|
| [ssh.auth] | `string` | `"password"` | authtype to use | |
|
|
|
| [ssh.port] | `number` | `22` | port to connect to over ssh | |
|
|
|
| [ssh.pass] | `string` | | Optional param of a password to use for ssh | |
|
|
|
| [ssh.key] | `string` | | path to an optional client private key (connection will be password-less and insecure!) | |
|
|
|
| [serverConf] | `Object` | | Server settings | |
|
|
|
| [serverConf.base] | `Object` | `'/wetty/'` | Server settings | |
|
|
|
| [serverConf.port] | `number` | `3000` | Port to run server on | |
|
|
|
|
