From eec9862fece795cd4e247c3a4af37d5ce180fba5 Mon Sep 17 00:00:00 2001 From: butlerx Date: Mon, 21 Oct 2019 20:51:53 +0100 Subject: [PATCH] Fix #203, update docs with uptodate args --- docs/API.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/API.md b/docs/API.md index c789771..89bc3b1 100644 --- a/docs/API.md +++ b/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 |