# @maximegris/node-websockify

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

Latest version **1.0.7** (published 2019-12-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @maximegris/node-websockify
pnpm add @maximegris/node-websockify
yarn add @maximegris/node-websockify
bun add @maximegris/node-websockify
```

Provides the command `websockify`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-12-25 |
| First published | 2019-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8.9 |
| Dependencies | 2 |
| Unpacked size | 8.6 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 44 |
| Author | Maxime GRIS |
| Maintainers | maximegris |
| Keywords | webscoket, tcp, proxy |

## Links

- npm: https://www.npmjs.com/package/@maximegris/node-websockify
- Repository: https://github.com/maximegris/node-websockify
- Homepage: https://github.com/maximegris/node-websockify#readme
- Issues: https://github.com/maximegris/node-websockify/issues
- npm.io page: https://npm.io/package/@maximegris/node-websockify

## Dependencies (2)

- [ws](https://npm.io/package/ws.md) 7.2.1
- [mime](https://npm.io/package/mime.md) 2.4.4

## Recent versions

- 1.0.7 (latest) — 2019-12-25
- 1.0.6 — 2019-12-25
- 1.0.5 — 2019-12-25
- 1.0.4 — 2019-12-25
- 1.0.3 — 2019-12-25

## README

# WebSocket-to-TCP proxy/bridge in NodeJS (forked & inspired by https://github.com/novnc/websockify)
[![Build Status](https://travis-ci.org/maximegris/node-websockify.svg?branch=master)](https://travis-ci.org/maximegris/node-websockify) 
[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/maximegris/node-websockify/blob/master/LICENSE.md)


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

```bash
npm install --save node-websockify
```

Require the module and call the main function in your programm code

```javascript
var websockify = require('@maximegris/node-websockify');
websockify({
source: 'url:port',
target: 'url:port',
web : './directory',
cert: 'certSSL',
key: 'certSSL-key'
});
```

Example :

```javascript
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) |

---
_Source: https://npm.io/package/@maximegris/node-websockify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
