From a1586c7ea2e8d28a4166758c3565534811afff35 Mon Sep 17 00:00:00 2001 From: billchurch Date: Wed, 1 Feb 2017 16:22:21 -0500 Subject: [PATCH] Updated to reflect new URL scheme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b986708..1a13dc7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # WebSSH2 -Web SSH Client using ssh2, socket.io, term.js, and express +Web SSH Client using ssh2, socket.io, xterm.js, and express Bare bones example of using SSH2 as a client on a host to proxy a Websocket / Socket.io connection to a SSH2 server. @@ -8,16 +8,16 @@ Bare bones example of using SSH2 as a client on a host to proxy a Websocket / So # Instructions To install, copy to a location somewhere and 'npm install' -Edit index.js to change the listener to something (maybe I'll make this CLI arguments at some point?) +Edit config.json to change the listener to your liking. There are also some default options which may be definied for a few of the variables. -Fire up a browser, navigate to IP/port of your choice and specify a host: +Fire up a browser, navigate to IP/port of your choice and specify a host (https isn't used here because it's assumed it will be off-loaded to +some sort of proxy): -http://localhost:2222/?host=192.168.1.1 +http://localhost:2222/ssh/host/127.0.0.1 You will be prompted for credentials to use on the SSH server via HTTP Basic authentcaiton. This is to permit usage with some SSO systems that can replay credentials over HTTP basic. # Options (GET request vars) -host= - ip or host name of SSH server to connect to (reqired) port= - port of SSH server (defaults to 22) @@ -27,5 +27,5 @@ headerBackground= - optional background color of header to display on page # Example: -http://localhost:2222/?host=192.168.1.1&port=2244&header=My%20Header&color=red +http://localhost:2222/ssh/host/192.168.1.1?port=2244&header=My%20Header&color=red