Skip to content

A simple WebSocket-to-TCP proxy/bridge you can use in NodeJS

License

Notifications You must be signed in to change notification settings

maximegris/node-websockify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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. 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 @maximegris/node-websockify

Require the module and call the main function in your program 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)

About

A simple WebSocket-to-TCP proxy/bridge you can use in NodeJS

Resources

License

Stars

Watchers

Forks

Packages

No packages published