1 ## noVNC: HTML5 VNC Client
6 noVNC is a HTML5 VNC client that runs well in any modern browser
7 including mobile browsers (iPhone/iPad and Android).
9 Notable commits, announcements and news are posted to
10 @<a href="http://www.twitter.com/noVNC">noVNC</a>
12 There are many companies/projects that have integrated noVNC into
13 their products including: [Ganeti Web Manager](http://code.osuosl.org/projects/ganeti-webmgr), [Archipel](http://archipelproject.org), [openQRM](http://www.openqrm.com/), [OpenNode](http://www.opennodecloud.com/), [OpenStack](http://www.openstack.org), [Broadway (HTML5 GDK/GTK+ backend)](http://blogs.gnome.org/alexl/2011/03/15/gtk-html-backend-update/), [OpenNebula](http://opennebula.org/), [CloudSigma](http://www.cloudsigma.com/), [Zentyal (formerly eBox)](http://www.zentyal.org/), [SlapOS](http://www.slapos.org), [Intel MeshCentral](https://meshcentral.com), [Amahi](http://amahi.org), [Brightbox](http://brightbox.com/), [Foreman](http://theforeman.org) and [LibVNCServer](http://libvncserver.sourceforge.net). See [this wiki page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC) for more info and links.
18 * Supports all modern browsers including mobile (iOS, Android)
19 * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
20 * WebSocket SSL/TLS encryption (i.e. "wss://") support
21 * 24-bit true color and 8 bit colour mapped
22 * Supports desktop resize notification/pseudo-encoding
23 * Local or remote cursor
24 * Clipboard copy/paste
25 * Clipping or scolling modes for large remote screens
26 * Easy site integration and theming (3 example themes included)
27 * Licensed under the [LGPLv3](http://www.gnu.org/licenses/lgpl.html)
31 Running in Chrome before and after connecting:
33 <img src="http://kanaka.github.com/noVNC/img/noVNC-5.png" width=400> <img src="http://kanaka.github.com/noVNC/img/noVNC-7.jpg" width=400>
35 See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
38 ### Browser Requirements
40 * HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS
41 Safari, Opera 11+, Internet Explorer 9+, etc.
43 * HTML5 WebSockets: For browsers that do not have builtin
44 WebSockets support, the project includes
45 <a href="http://github.com/gimite/web-socket-js">web-socket-js</a>,
46 a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in
49 * Fast Javascript Engine: this is not strictly a requirement, but
50 without a fast Javascript engine, noVNC might be painfully slow.
52 * I maintain a more detailed browser compatibility list <a
53 href="https://github.com/kanaka/noVNC/wiki/Browser-support">here</a>.
56 ### Server Requirements
58 Unless you are using a VNC server with support for WebSockets
59 connections (such as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/)),
60 you need to use a WebSockets to TCP socket proxy. There is
61 a python proxy included ('websockify').
66 * Use the launch script to start a mini-webserver and the WebSockets
67 proxy (websockify). The `--vnc` option is used to specify the location of
70 `./utils/launch.sh --vnc localhost:5901`
72 * Point your browser to the cut-and-paste URL that is output by the
73 launch script. Enter a password if the VNC server has one
74 configured. Hit the Connect button and enjoy!
79 * [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections). How to setup websockify so that you can use encrypted connections from noVNC.
81 * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Starting a VNC server, advanced websockify usage, etc.
83 * [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects.
85 * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems.
88 ### Authors/Contributors
90 * noVNC : Joel Martin (github.com/kanaka)
91 * New UI and Icons : Chris Gordon
92 * Original Logo : Michael Sersen
93 * tight encoding : Michael Tinglof (Mercuri.ca)
96 * web-socket-js : Hiroshi Ichikawa (github.com/gimite/web-socket-js)
97 * as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
98 * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
99 * jsunzip : Erik Moller (github.com/operasoftware/jsunzip),
100 * tinflate : Joergen Ibsen (ibsensoftware.com)
101 * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)