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 More than 16 companies/projects have integrated noVNC into their
10 products including [Ganeti Web
11 Manager](http://code.osuosl.org/projects/ganeti-webmgr),
12 [OpenStack](http://www.openstack.org), and
13 [OpenNebula](http://opennebula.org/). See [the Projects and Companies
14 wiki page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC)
15 for more complete list.
19 Notable commits, announcements and news are posted to
20 @<a href="http://www.twitter.com/noVNC">noVNC</a>
22 If you are a noVNC developer/integrator/user (or want to be) please
24 href="https://groups.google.com/forum/?fromgroups#!forum/novnc">noVNC
27 Bugs and feature requests can be submitted via [github
28 issues](https://github.com/kanaka/noVNC/issues). If you are looking
29 for a place to start contributing to noVNC, a good place to start
30 would be the issues that I have marked as
31 ["patchwelcome"](https://github.com/kanaka/noVNC/issues?labels=patchwelcome).
33 If you want to show appreciation for noVNC you could buy something off
34 my [Amazon wishlist](http://www.amazon.com/registry/wishlist/XTXFXK39IA8C/?reveal=unpurchased&sort=priority&layout=compact) or you could donate to a great non-profits such as: [Compassion
35 International](http://www.compassion.com/), [SIL](http://www.sil.org),
36 [Habitat for Humanity](http://www.habitat.org), [Electronic Frontier
37 Foundation](https://www.eff.org/), [Against Malaria
38 Foundation](http://www.againstmalaria.com/), [Nothing But
39 Nets](http://www.nothingbutnets.net/), etc.
44 * Supports all modern browsers including mobile (iOS, Android)
45 * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
46 * WebSocket SSL/TLS encryption (i.e. "wss://") support
47 * 24-bit true color and 8 bit colour mapped
48 * Supports desktop resize notification/pseudo-encoding
49 * Local or remote cursor
50 * Clipboard copy/paste
51 * Clipping or scolling modes for large remote screens
52 * Easy site integration and theming (3 example themes included)
53 * Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/)
57 Running in Chrome before and after connecting:
59 <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>
61 See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
64 ### Browser Requirements
66 * HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS
67 Safari, Opera 11+, Internet Explorer 9+, etc.
69 * HTML5 WebSockets: For browsers that do not have builtin
70 WebSockets support, the project includes
71 <a href="http://github.com/gimite/web-socket-js">web-socket-js</a>,
72 a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in
75 * Fast Javascript Engine: this is not strictly a requirement, but
76 without a fast Javascript engine, noVNC might be painfully slow.
78 * I maintain a more detailed browser compatibility list <a
79 href="https://github.com/kanaka/noVNC/wiki/Browser-support">here</a>.
82 ### Server Requirements
84 Unless you are using a VNC server with support for WebSockets
85 connections (such as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/) or
86 [PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)),
87 you need to use a WebSockets to TCP socket proxy. There is
88 a python proxy included ('websockify').
93 * Use the launch script to start a mini-webserver and the WebSockets
94 proxy (websockify). The `--vnc` option is used to specify the location of
97 `./utils/launch.sh --vnc localhost:5901`
99 * Point your browser to the cut-and-paste URL that is output by the
100 launch script. Enter a password if the VNC server has one
101 configured. Hit the Connect button and enjoy!
106 * [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections). How to setup websockify so that you can use encrypted connections from noVNC.
108 * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Starting a VNC server, advanced websockify usage, etc.
110 * [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects.
112 * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems.
115 ### Authors/Contributors
117 * noVNC : Joel Martin (github.com/kanaka)
118 * UI and Icons : Chris Gordon
119 * Original Logo : Michael Sersen
120 * tight encoding : Michael Tinglof (Mercuri.ca)
122 * Included libraries:
123 * web-socket-js : Hiroshi Ichikawa (github.com/gimite/web-socket-js)
124 * as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
125 * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
126 * jsunzip : Erik Moller (github.com/operasoftware/jsunzip),
127 * tinflate : Joergen Ibsen (ibsensoftware.com)
128 * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)