## WeTTy Create WeTTY server * [WeTTy](#module_WeTTy) * [~start](#module_WeTTy..start) ⇒ Promise * ["connection"](#event_connection) * ["spawn"](#event_spawn) * ["exit"](#event_exit) * ["disconnect"](#event_disconnect) * ["server"](#event_server) ### WeTTy~start ⇒ Promise Starts WeTTy Server **Kind**: inner property of [WeTTy](#module_WeTTy) **Returns**: Promise - Promise resolves once server is running | Param | Type | Default | Description | | ------------ | ------------------- | ------------------------------------- | --------------------------- | | [ssh] | Object | | SSH settings | | [ssh.user] | string | "''" | default user for ssh | | [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 | | [serverPort] | number | 3000 | Port to run server on | | [ssl] | Object | | SSL settings | | [ssl.key] | string | | Path to ssl key | | [ssl.cert] | string | | Path to ssl cert | ### "connection" **Kind**: event emitted by [WeTTy](#module_WeTTy) **Properties** | Name | Type | Description | | ---- | ------------------- | --------------------------- | | msg | string | Message for logs | | date | Date | date and time of connection | ### "spawn" Terminal process spawned **Kind**: event emitted by [WeTTy](#module_WeTTy) **Properties** | Name | Type | Description | | ------- | ------------------- | -------------------------------------- | | msg | string | Message containing pid info and status | | pid | number | Pid of the terminal | | address | string | address of connecting user | ### "exit" Terminal process exits **Kind**: event emitted by [WeTTy](#module_WeTTy) **Properties** | Name | Type | Description | | ---- | ------------------- | -------------------------------------- | | code | number | the exit code | | msg | string | Message containing pid info and status | ### "disconnect" **Kind**: event emitted by [WeTTy](#module_WeTTy) ### "server" **Kind**: event emitted by [WeTTy](#module_WeTTy) **Properties** | Name | Type | Description | | ---------- | ------------------- | ------------------------------- | | msg | string | Message for logging | | port | number | port sever is on | | connection | string | connection type for web traffic |