1.0.9 • Published 3 years ago

@vanhooferwin/node-websockify v1.0.9

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

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

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. Unfortunately this library can't be used directly in a nodeJS program. Thats the reason why I created this project.

Usage

Import this module in your project

npm install --save @vanhooferwin/node-websockify

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

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

Example :

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

Options

AliasValuesDefault
sourceURL of websocket Servernull
targetURL of the VNC Servernull
webDirectory of static sources exposed by the servernull (optional)
certPath of the SSL certificatenull (optional)
keyKey of the SSL certificatenull (optional)
1.0.9

3 years ago

1.0.8

3 years ago