@maximegris/node-websockify

1.0.7 • Public • Published

WebSocket-to-TCP proxy/bridge in NodeJS (forked & inspired by https://github.com/novnc/websockify)

Build Status License

Node-websockify is a WebSocket-to-TCP proxy/bridge you can use in a NodeJS program.

As said it is inspired of the javascript library of https://github.com/novnc/websockify. Sadly this librairy can't be used directly in a nodeJS program taht's why I created this project.

Usage

Import this module in your project

npm install --save node-websockify

Require the module and call the main function in your programm code

var websockify = require('@maximegris/node-websockify');
websockify({
source: 'url:port',
target: 'url:port',
web : './directory',
cert: 'certSSL',
key: 'certSSL-key'
});

Example :

var websockify = require('@maximegris/node-websockify');
websockify({  source: '127.0.0.1:8080', target: '192.168.0.100:5900'});

Options

Alias Values Default
source URL of websocket Server null
target URL of the VNC Server null
web Directory of static sources exposed by the server null (optional)
cert Path of the SSL certificate null (optional)
key Key of the SSL certificate null (optional)

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.0.7
    37
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 1.0.7
    37
  • 1.0.6
    0
  • 1.0.5
    0
  • 1.0.4
    2
  • 1.0.3
    0

Package Sidebar

Install

npm i @maximegris/node-websockify

Weekly Downloads

39

Version

1.0.7

License

MIT

Unpacked Size

8.81 kB

Total Files

4

Last publish

Collaborators

  • maximegris