← Back to branch summary

~ubuntu-branches/ubuntu/vivid/emscripten/vivid

« back to all changes in this revision

Viewing changes to third_party/websockify/other/README.md

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2013-05-02 13:11:51 UTC
  • Revision ID: package-import@ubuntu.com-20130502131151-q8dvteqr1ef2x7xz
Tags: upstream-1.4.1~20130504~adb56cb
Import upstream version 1.4.1~20130504~adb56cb

Show diffs side-by-side

added added

removed removed

Lines of Context:
third_party/websockify/other/README.md
 
1
This directory contain alternate implementations of
 
2
WebSockets-to-TCP-Socket proxies (for noVNC).
 
3
 
 
4
## websockify.c (C)
 
5
 
 
6
### Description
 
7
 
 
8
This is a C version of the original websockify. It is more limited in
 
9
functionality than the original.
 
10
 
 
11
 
 
12
## websockify.js
 
13
 
 
14
### Description
 
15
 
 
16
This is a Node.JS (server-side event driven Javascript) implementation
 
17
of websockify.
 
18
 
 
19
 
 
20
## kumina.c (C)
 
21
 
 
22
### Description
 
23
 
 
24
The upstream source of the kumina proxy is [here](https://github.com/kumina/wsproxy).
 
25
 
 
26
[This article](http://blog.kumina.nl/2011/06/proxying-and-multiplexing-novnc-using-wsproxy/)
 
27
describes the kumina proxy.
 
28
 
 
29
kumina is an application that is run from inetd, which allows noVNC
 
30
to connect to an unmodified VNC server. Furthermore, it makes use of
 
31
the recently added support in noVNC for file names. The file name is
 
32
used to denote the port number. Say, you connect to:
 
33
 
 
34
  ws://host:41337/25900
 
35
 
 
36
The kumina proxy opens a connection to:
 
37
 
 
38
  vnc://host:25900/
 
39
 
 
40
The address to which kumina connects, is the same as the address to
 
41
which the client connected (using getsockname()).
 
42
 
 
43
### Configuration
 
44
 
 
45
kumina can be enabled by adding the following line to inetd.conf:
 
46
 
 
47
  41337 stream tcp nowait nobody /usr/sbin/kumina kumina 25900 25909
 
48
 
 
49
The two parameters of kumina denote the minimum and the maximum allowed
 
50
port numbers. This allows a single kumina instance to multiplex
 
51
connections to multiple VNC servers.