1 ## noVNC: HTML5 VNC Client
3 [![Build Status](https://travis-ci.org/novnc/noVNC.svg?branch=master)](https://travis-ci.org/novnc/noVNC)
7 noVNC is a HTML5 VNC client that runs well in any modern browser including
8 mobile browsers (iOS and Android).
10 Many companies, projects and products have integrated noVNC including
11 [Ganeti Web Manager](http://code.osuosl.org/projects/ganeti-webmgr),
12 [OpenStack](http://www.openstack.org),
13 [OpenNebula](http://opennebula.org/),
14 [LibVNCServer](http://libvncserver.sourceforge.net), and
15 [ThinLinc](https://cendio.com/thinlinc). See
16 [the Projects and Companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC)
17 for a more complete list with additional info and links.
21 Notable commits, announcements and news are posted to
22 <a href="http://www.twitter.com/noVNC">@noVNC</a>.
24 If you are a noVNC developer/integrator/user (or want to be) please join the
25 <a href="https://groups.google.com/forum/?fromgroups#!forum/novnc">
26 noVNC discussion group</a>.
28 Bugs and feature requests can be submitted via
29 [github issues](https://github.com/novnc/noVNC/issues).
30 If you are looking for a place to start contributing to noVNC, a good place to
31 start would be the issues that are marked as
32 ["patchwelcome"](https://github.com/novnc/noVNC/issues?labels=patchwelcome).
34 If you want to show appreciation for noVNC you could donate to a great non-
36 [Compassion International](http://www.compassion.com/),
37 [SIL](http://www.sil.org),
38 [Habitat for Humanity](http://www.habitat.org),
39 [Electronic Frontier Foundation](https://www.eff.org/),
40 [Against Malaria Foundation](http://www.againstmalaria.com/),
41 [Nothing But Nets](http://www.nothingbutnets.net/), etc.
42 Please tweet <a href="http://www.twitter.com/noVNC">@noVNC</a> if you do.
47 * Supports all modern browsers including mobile (iOS, Android)
48 * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
49 * WebSocket SSL/TLS encryption (i.e. "wss://") support
50 * 24-bit true color and 8 bit colour mapped
51 * Supports desktop resize notification/pseudo-encoding
52 * Local or remote cursor
53 * Clipboard copy/paste
54 * Clipping or scolling modes for large remote screens
55 * Easy site integration and theming (3 example themes included)
56 * Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/)
60 Running in Chrome before and after connecting:
63 .github.com/noVNC/img/noVNC-5.png" width=400>
64 <img src="http://novnc.github.com/noVNC/img/noVNC-7.jpg" width=400>
67 <a href="http://novnc.github.com/noVNC/screenshots.html">here</a>.
70 ### Browser Requirements
72 * Chrome 8, Firefox 4, Safari 6, Opera 12, IE 11, Edge 12, etc.
74 * HTML5 Canvas, WebSockets and Typed Arrays
76 * Fast Javascript Engine: this is not strictly a requirement, but without a
77 fast Javascript engine, noVNC might be painfully slow.
79 * See the more detailed
80 [browser compatibility wiki page](https://github.com/novnc/noVNC/wiki/Browser-support).
83 ### Server Requirements
85 Unless you are using a VNC server with support for WebSockets connections (such
86 as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
87 [QEMU](http://www.qemu.org/), or
88 [PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), you need to use a
89 WebSockets to TCP socket proxy. There is a python proxy included
95 * Use the launch script to start a mini-webserver and the WebSockets proxy
96 (websockify). The `--vnc` option is used to specify the location of a running
99 `./utils/launch.sh --vnc localhost:5901`
101 * Point your browser to the cut-and-paste URL that is output by the launch
102 script. Enter a password if the VNC server has one configured. Hit the
103 Connect button and enjoy!
108 * [Modules/API](https://github.com/novnc/noVNC/wiki/Modules-API) - The library
109 modules and their Javascript API.
111 * [Integration](https://github.com/novnc/noVNC/wiki/Integration) - Get noVNC
112 to work in existing projects.
114 * [Troubleshooting](https://github.com/novnc/noVNC/wiki/Troubleshooting) - How
115 to troubleshoot problems.
117 * [Encrypted Connections](https://github.com/novnc/websockify/wiki/Encrypted-Connections) -
118 Setup websockify so that you can use encrypted connections from noVNC.
120 * [Advanced Usage](https://github.com/novnc/noVNC/wiki/Advanced-usage) -
121 Generating an SSL certificate, starting a VNC server, advanced websockify
124 * [Testing](https://github.com/novnc/noVNC/wiki/Testing) - Run and write
127 * [Translations](https://github.com/novnc/noVNC/wiki/Translations) - Add and
128 modify localization for JavaScript and HTML.
131 ### Authors/Contributors
134 * [Joel Martin](https://github.com/kanaka)
135 * [Samuel Mannehed](https://github.com/samhed) (Cendio)
136 * [Peter Åstrand](https://github.com/astrand) (Cendio)
137 * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack)
138 * [Pierre Ossman](https://github.com/CendioOssman) (Cendio)
140 * Notable contributions:
141 * UI and Icons : Pierre Ossman, Chris Gordon
142 * Original Logo : Michael Sersen
143 * tight encoding : Michael Tinglof (Mercuri.ca)
145 * Included libraries:
146 * as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
147 * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
148 * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)
149 * Pako : Vitaly Puzrin (https://github.com/nodeca/pako)
151 * [Contribution guide](https://github.com/novnc/noVNC/wiki/Contributing)