Fabio/webssh2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Web SSH Client using ssh2, socket.io, xterm.js, and express. webssh webssh2
45 commits 14 branches 50 tags 55 MiB
JavaScript 55%
CSS 22%
TypeScript 15.1%
HTML 6.9%
Shell 0.5%
Other 0.4%
Find a file
billchurch bcf732c2c9 updated .travis.yml"
2017-05-18 16:07:53 -04:00
public codelint and cross platform improvements 2017-05-08 12:03:18 -07:00
.gitignore adding some more files to ignore… 2017-02-01 15:56:41 -05:00
.travis.yml updated .travis.yml" 2017-05-18 16:07:53 -04:00
config.json moved terminal selection to config.json 2017-03-23 11:24:03 -04:00
index.js codelint and cross platform improvements 2017-05-08 12:07:47 -07:00
LICENSE Create LICENSE 2016-05-18 13:08:45 -04:00
package.json formatting changes 2017-03-29 11:55:38 -04:00
README.md Update README.md 2017-03-23 18:17:30 -04:00

README.md

WebSSH2

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.

Screenshot 2017-03-23 18.13.59

Instructions

To install:

  1. Clone to a location somewhere and npm install

  2. If desired, 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.

  3. Run npm start

  4. 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/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)

port= - port of SSH server (defaults to 22)

header= - optional header to display on page

headerBackground= - optional background color of header to display on page

Config File Options

config.json contains several options which may be specified to customize to your needs, vs editing the javascript direclty. This is JSON format so mind your spacing, brackets, etc...

listen.ip default 127.0.0.1

  • IP address node should listen on for client connections

listen.port default 2222

  • Port node should listen on for client connections

user.name default null

  • Specify user name to authenticate with

user.password default null

  • Specify password to authenticate with

ssh.host default null

  • Specify host to connect to

ssh.port default 22

  • Specify SSH port to connect to

ssh.term default xterm-color

  • Specify terminal emulation to use

header.text

  • Specify header text, defaults to My Header but may also be set to null

header.background

  • Header background, defaults to green

options.challengeButton

  • Challenge button. This option, which is still under development, allows the user to resend the password to the server (in cases of step-up authentication for things like sudo or a router enable command.

Experimental client-side logging

Clicking Start logging on the status bar will log all data to the client. A Download log option will appear after starting the logging. You may download at any time to the client. You may stop logging at any time my pressing the Logging - STOP LOG. Note that clicking the Start logging option again will cause the current log to be overwritten, so be sure to download first.

Example:

http://localhost:2222/ssh/host/192.168.1.1?port=2244&header=My%20Header&color=red