summaryrefslogtreecommitdiff
path: root/third_party/websockify/other/README.md
blob: 1851e2aa1f95bac5a142834b11d4c179f8d5256b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
This directory contain alternate implementations of
WebSockets-to-TCP-Socket proxies (for noVNC).

## websockify.c (C)

### Description

This is a C version of the original websockify. It is more limited in
functionality than the original.


## websockify.js

### Description

This is a Node.JS (server-side event driven Javascript) implementation
of websockify.


## kumina.c (C)

### Description

The upstream source of the kumina proxy is [here](https://github.com/kumina/wsproxy).

[This article](http://blog.kumina.nl/2011/06/proxying-and-multiplexing-novnc-using-wsproxy/)
describes the kumina proxy.

kumina is an application that is run from inetd, which allows noVNC
to connect to an unmodified VNC server. Furthermore, it makes use of
the recently added support in noVNC for file names. The file name is
used to denote the port number. Say, you connect to:

  ws://host:41337/25900

The kumina proxy opens a connection to:

  vnc://host:25900/

The address to which kumina connects, is the same as the address to
which the client connected (using getsockname()).

### Configuration

kumina can be enabled by adding the following line to inetd.conf:

  41337 stream tcp nowait nobody /usr/sbin/kumina kumina 25900 25909

The two parameters of kumina denote the minimum and the maximum allowed
port numbers. This allows a single kumina instance to multiplex
connections to multiple VNC servers.