wstty-agent

Device agent for remote diagnosis over WebSocket. The agent shares its TTY session with end-users via wstty-server (as cloud relay).

Quick Start

Server and Agent at Localhost

Open one terminal window to run wstty-server docker image:

$ docker run -p 6030:6030 --rm --name wstty-server tictactoe/wstty-server:latest

And, open another terminal window to run agent by checking out repository and installing required node modules:

$ cd wstty-agent
$ npm install
$ node ./index.js

Then open browser to visit http://localhost:6030/tty to enjoy Web TTY with default user account test1 (password is same as username).

Server and Agent at different machines

On the machine to run wstty-server docker image (assuming the ip address of this machine is 192.168.1.10):

$ docker run -p 6030:6030 --rm --name wstty-server tictactoe/wstty-server:latest

On the machine to run agent, please instruct:

$ cd wstty-agent
$ npm install
$ node ./index.js -s 'wstty-client.url=http://192.168.1.10:6030'

Then open browser to visit http://192.168.1.10:6030/tty to enjoy Web TTY with default user account test1.

Todo

• format CHANGELOG.md as https://keepachangelog.com/en/1.0.0/