jcarr
/
noVNC
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Launch script and reworked usage in README.md.

This commit is contained in:
Joel Martin 2010-07-15 20:18:39 -05:00
parent 7c81747b52
commit b89c6db3a1
2 changed files with 162 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
README.md
View File

@ -4,14 +4,14 @@
### Description ### Description
noVNC is a VNC client implemented using HTML5 technologies, noVNC is a VNC client implemented using HTML5 technologies,
specifically Canvas and WebSocket (supports 'wss://' encryption). specifically Canvas and WebSockets (supports 'wss://' encryption).
For browsers that do not have builtin WebSocket support, the project For browsers that do not have builtin WebSockets support, the project
includes [web-socket-js](http://github.com/gimite/web-socket-js), includes [web-socket-js](http://github.com/gimite/web-socket-js),
a WebSocket emulator using Adobe Flash . a WebSockets emulator using Adobe Flash .
In addition, [as3crypto](http://github.com/lyokato/as3crypto_patched) In addition, [as3crypto](http://github.com/lyokato/as3crypto_patched)
has been added to web-socket-js to implement WebSocket SSL/TLS has been added to web-socket-js to implement WebSockets SSL/TLS
encryption, i.e. the "wss://" URI scheme. encryption, i.e. the "wss://" URI scheme.
Special thanks to [Sentry Data Systems](http://www.sentryds.com) for Special thanks to [Sentry Data Systems](http://www.sentryds.com) for
@ -28,51 +28,79 @@ See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">h
### Requirements ### Requirements
Until there is VNC server support for WebSocket connections, you need Unless you are using a VNC server with support for WebSockets
to use a WebSocket to TCP socket proxy. There is a python proxy connections (only my [fork of libvncserver](http://github.com/kanaka/libvncserver)
included ('wsproxy'). One advantage of using the proxy is that it has currently), you need to use a WebSockets to TCP socket proxy. There is
builtin support for SSL/TLS encryption (i.e. "wss://"). a python proxy included ('wsproxy'). One advantage of using the proxy
is that it has builtin support for SSL/TLS encryption (i.e. "wss://").
There a few reasons why a proxy is required: There a few reasons why a proxy is required:
1. WebSocket is not a pure socket protocol. There is an initial HTTP 1. WebSockets is not a pure socket protocol. There is an initial HTTP
like handshake to allow easy hand-off by web servers and allow like handshake to allow easy hand-off by web servers and allow
some origin policy exchange. Also, each WebSocket frame begins some origin policy exchange. Also, each WebSockets frame begins
with 0 ('\x00') and ends with 255 ('\xff'). with 0 ('\x00') and ends with 255 ('\xff').
2. Javascript itself does not have the ability to handle pure byte 2. Javascript itself does not have the ability to handle pure byte
strings (Unicode encoding messes with it) even though you can arrays. The python proxy base64 encodes the data so that
read them with WebSocket. The python proxy encodes the data so the Javascript client can decode the data as an integer array.
that the Javascript client can base64 decode the data into an
array.
3. When using the web-socket-js as a fallback, WebSocket 'onmessage'
events may arrive out of order. In order to compensate for this
the client asks the proxy (using the initial query string) to add
sequence numbers to each packet.
### Usage ### Quick Start
* Use the launch script to start a mini-webserver and the WebSockets
proxy. The `--vnc` option is used to specify the location of
a running VNC server:
`./utils/launch.sh --vnc localhost:5901`
* Point your browser to the cut-and-paste URL that is output by the
launch script. Enter a password if the VNC server has one
configured. Hit the Connect button and enjoy!
### Advanced usage
* To encrypt the traffic using the WebSocket 'wss://' URI scheme you * To encrypt the traffic using the WebSocket 'wss://' URI scheme you
need to generate a certificate for the proxy to load. You can generate need to generate a certificate for the proxy to load. By default the
a self-signed certificate using openssl. The common name should be the proxy loads a certificate file name `self.pem` but the --cert=CERT
hostname of the server where the proxy will be running: option can override it. You can generate a self-signed certificate
using openssl. When asked for the common name, use the hostname of
the server where the proxy will be running:
`openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem` `openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem`
* run a VNC server. * `tightvnc` provide a nice startup script that can be used to run
a separate X desktop that is served by VNC. To install and run the
server under Ubuntu you would do something like this:
`sudo apt-get install tightvncserver`
`vncserver :1` `vncserver :1`
* run the python proxy: The VNC server will run in the background. The port that it runs
on is the display number + 5900 (i.e. 5901 in the case above).
* `x11vnc` can be used to share your current X desktop. Note that if
you run noVNC on the X desktop you are connecting to via VNC you
will get a neat hall of mirrors effect, but the the client and
server will fight over the mouse.
`sudo apt-get install x11vnc`
`x11vnc -forever -display :0`
Without the `-forever` option, x11vnc will exit after the first
disconnect. The `-display` option indicates the exiting X display to
share. The port that it runs on is the display number + 5900 (i.e.
5900 in the case above).
* To run the python proxy directly without using launch script (to
pass additional options for example):
`./utils/wsproxy.py -f source_port target_addr:target_port `./utils/wsproxy.py -f source_port target_addr:target_port
`./utils/wsproxy.py -f 8787 localhost:5901` `./utils/wsproxy.py -f 8787 localhost:5901`
* To run the mini python web server without the launch script:
* run the mini python web server to serve the directory:
`./utils/web.py PORT` `./utils/web.py PORT`
@ -82,8 +110,7 @@ There a few reasons why a proxy is required:
(or whatever port you used above to run the web server). (or whatever port you used above to run the web server).
* Specify the host and port where the proxy is running and the * Specify the host and port where the proxy is running and the
password that the vnc server is using (if any). Hit the Connect password that the vnc server is using (if any).
button and enjoy!
### Browser Support ### Browser Support

105
utils/launch.sh Executable file
View File

@ -0,0 +1,105 @@
#!/bin/bash
usage() {
if [ "$*" ]; then
echo "$*"
echo
fi
echo "Usage: ${NAME} [--web WEB_PORT] [--proxy PROXY_PORT] [--vnc VNC_HOST:PORT]"
echo
echo "Starts a mini-webserver and the WebSockets proxy and"
echo "provides a cut and paste URL to go to."
echo
echo " --web WEB_PORT Port to serve web pages at"
echo " Default: 8080"
echo " --proxy PROXY_PORT Port for proxy to listen on"
echo " Default: 8081"
echo " --vnc VNC_HOST:PORT VNC server host:port proxy target"
echo " Default: localhost:5900"
exit 2
}
NAME="$(basename $0)"
HERE=$(readlink -f $(dirname $0))
WEB_PORT="6080"
PROXY_PORT="6081"
VNC_DEST="localhost:5900"
web_pid=""
proxy_pid=""
die() {
echo "$*"
exit 1
}
cleanup() {
trap - TERM QUIT INT EXIT
trap "true" CHLD # Ignore cleanup messages
echo
if [ -n "${web_pid}" ]; then
echo "Terminating webserver (${web_pid})"
kill ${web_pid}
fi
if [ -n "${proxy_pid}" ]; then
echo "Terminating WebSockets proxy (${proxy_pid})"
kill ${proxy_pid}
fi
}
# Process Arguments
# Arguments that only apply to chrooter itself
while [ "$*" ]; do
param=$1; shift; OPTARG=$1
case $param in
--web) WEB_PORT="${OPTARG}"; shift ;;
--proxy) PROXY_PORT="${OPTARG}"; shift ;;
--vnc) VNC_DEST="${OPTARG}"; shift ;;
-h|--help) usage ;;
-*) usage "Unknown chrooter option: ${param}" ;;
*) break ;;
esac
done
# Sanity checks
which netstat >/dev/null 2>&1 \
|| die "Must have netstat installed"
netstat -ltn | grep -qs "${WEB_PORT}.*LISTEN" \
&& die "Port ${WEB_PORT} in use. Try --web WEB_PORT"
netstat -ltn | grep -qs "${PROXY_PORT}.*LISTEN" \
&& die "Port ${PROXY_PORT} in use. Try --proxy PROXY_PORT"
trap "cleanup" TERM QUIT INT EXIT
echo "Starting webserver on port ${WEB_PORT}"
${HERE}/web.py ${WEB_PORT} >/dev/null &
web_pid="$!"
sleep 1
if ps -p ${web_pid} >/dev/null; then
echo "Started webserver (pid: ${web_pid})"
else
web_pid=
echo "Failed to start webserver"
exit 1
fi
echo "Starting WebSockets proxy on port ${PROXY_PORT}"
${HERE}/wsproxy.py -f ${PROXY_PORT} ${VNC_DEST} &
proxy_pid="$!"
sleep 1
if ps -p ${proxy_pid} >/dev/null; then
echo "Started WebSockets proxy (pid: ${proxy_pid})"
else
proxy_pid=
echo "Failed to start WebSockets proxy"
exit 1
fi
echo -e "\n\nNavigate to to this URL:\n"
echo -e " http://$(hostname):${WEB_PORT}/vnc.html?host=$(hostname)&port=${PROXY_PORT}\n"
echo -e "Press Ctrl-C to exit\n\n"
wait ${web_pid}