## noVNC: HTML5 VNC Client
+[](https://travis-ci.org/novnc/noVNC)
### Description
-noVNC is a HTML5 VNC client that runs well in any modern browser
-including mobile browsers (iPhone/iPad and Android).
+noVNC is a HTML5 VNC client that runs well in any modern browser including
+mobile browsers (iOS and Android).
+
+Many companies, projects and products have integrated noVNC including
+[Ganeti Web Manager](http://code.osuosl.org/projects/ganeti-webmgr),
+[OpenStack](http://www.openstack.org),
+[OpenNebula](http://opennebula.org/),
+[LibVNCServer](http://libvncserver.sourceforge.net), and
+[ThinLinc](https://cendio.com/thinlinc). See
+[the Projects and Companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC)
+for a more complete list with additional info and links.
+
+### News/help/contact
Notable commits, announcements and news are posted to
-@<a href="http://www.twitter.com/noVNC">noVNC</a>
+<a href="http://www.twitter.com/noVNC">@noVNC</a>.
+
+If you are a noVNC developer/integrator/user (or want to be) please join the
+<a href="https://groups.google.com/forum/?fromgroups#!forum/novnc">
+noVNC discussion group</a>.
-There are many companies/projects that have integrated noVNC into
-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), [LibVNCServer](http://libvncserver.sourceforge.net) and [PocketVNC](http://www.pocketvnc.com/blog/?page_id=866). See [this wiki page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC) for more info and links.
+Bugs and feature requests can be submitted via
+[github issues](https://github.com/novnc/noVNC/issues).
+If you are looking for a place to start contributing to noVNC, a good place to
+start would be the issues that are marked as
+["patchwelcome"](https://github.com/novnc/noVNC/issues?labels=patchwelcome).
+
+If you want to show appreciation for noVNC you could donate to a great non-
+profits such as:
+[Compassion International](http://www.compassion.com/),
+[SIL](http://www.sil.org),
+[Habitat for Humanity](http://www.habitat.org),
+[Electronic Frontier Foundation](https://www.eff.org/),
+[Against Malaria Foundation](http://www.againstmalaria.com/),
+[Nothing But Nets](http://www.nothingbutnets.net/), etc.
+Please tweet <a href="http://www.twitter.com/noVNC">@noVNC</a> if you do.
### Features
* Clipboard copy/paste
* Clipping or scolling modes for large remote screens
* Easy site integration and theming (3 example themes included)
-* Licensed under the [LGPLv3](http://www.gnu.org/licenses/lgpl.html)
+* Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/)
### Screenshots
Running in Chrome before and after connecting:
-<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>
+<img src="http://novnc.com/img/noVNC-5.png" width=400>
+<img src="http://novnc.com/img/noVNC-7.jpg" width=400>
-See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
+See more screenshots
+<a href="http://novnc.com/screenshots.html">here</a>.
### Browser Requirements
-* HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS
- Safari, Opera 11+, Internet Explorer 9+, etc.
+* Chrome 8, Firefox 4, Safari 6, Opera 12, IE 11, Edge 12, etc.
-* HTML5 WebSockets: For browsers that do not have builtin
- WebSockets support, the project includes
- <a href="http://github.com/gimite/web-socket-js">web-socket-js</a>,
- a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in
- WebSocket support.
+* HTML5 Canvas, WebSockets and Typed Arrays
-* Fast Javascript Engine: this is not strictly a requirement, but
- without a fast Javascript engine, noVNC might be painfully slow.
+* Fast Javascript Engine: this is not strictly a requirement, but without a
+ fast Javascript engine, noVNC might be painfully slow.
-* I maintain a more detailed browser compatibility list <a
- href="https://github.com/kanaka/noVNC/wiki/Browser-support">here</a>.
+* See the more detailed
+[browser compatibility wiki page](https://github.com/novnc/noVNC/wiki/Browser-support).
### Server Requirements
-Unless you are using a VNC server with support for WebSockets
-connections (such as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/) or
-[PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)),
-you need to use a WebSockets to TCP socket proxy. There is
-a python proxy included ('websockify').
+Unless you are using a VNC server with support for WebSockets connections (such
+as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
+[QEMU](http://www.qemu.org/), or
+[MobileVNC](http://www.smartlab.at/mobilevnc/)), you need to use a
+WebSockets to TCP socket proxy. There is a python proxy included
+('websockify').
### Quick Start
-* Use the launch script to start a mini-webserver and the WebSockets
- proxy (websockify). The `--vnc` option is used to specify the location of
- a running VNC server:
+* Use the launch script to start a mini-webserver and the WebSockets proxy
+ (websockify). 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!
+* 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!
### Other Pages
-* [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections). How to setup websockify so that you can use encrypted connections from noVNC.
+* [Modules/API](https://github.com/novnc/noVNC/wiki/Modules-API) - The library
+ modules and their Javascript API.
+
+* [Integration](https://github.com/novnc/noVNC/wiki/Integration) - Get noVNC
+ to work in existing projects.
-* [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Starting a VNC server, advanced websockify usage, etc.
+* [Troubleshooting](https://github.com/novnc/noVNC/wiki/Troubleshooting) - How
+ to troubleshoot problems.
-* [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects.
+* [Encrypted Connections](https://github.com/novnc/websockify/wiki/Encrypted-Connections) -
+ Setup websockify so that you can use encrypted connections from noVNC.
-* [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems.
+* [Advanced Usage](https://github.com/novnc/noVNC/wiki/Advanced-usage) -
+ Generating an SSL certificate, starting a VNC server, advanced websockify
+ usage, etc.
+
+* [Testing](https://github.com/novnc/noVNC/wiki/Testing) - Run and write
+ tests.
+
+* [Translations](https://github.com/novnc/noVNC/wiki/Translations) - Add and
+ modify localization for JavaScript and HTML.
### Authors/Contributors
-* noVNC : Joel Martin (github.com/kanaka)
- * New UI and Icons : Chris Gordon
+* Core team:
+ * [Joel Martin](https://github.com/kanaka)
+ * [Samuel Mannehed](https://github.com/samhed) (Cendio)
+ * [Peter Åstrand](https://github.com/astrand) (Cendio)
+ * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack)
+ * [Pierre Ossman](https://github.com/CendioOssman) (Cendio)
+
+* Notable contributions:
+ * UI and Icons : Pierre Ossman, Chris Gordon
* Original Logo : Michael Sersen
* tight encoding : Michael Tinglof (Mercuri.ca)
* Included libraries:
- * web-socket-js : Hiroshi Ichikawa (github.com/gimite/web-socket-js)
* as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
* base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
- * jsunzip : Erik Moller (github.com/operasoftware/jsunzip),
- * tinflate : Joergen Ibsen (ibsensoftware.com)
* DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)
+ * Pako : Vitaly Puzrin (https://github.com/nodeca/pako)
-
+* [Contribution guide](https://github.com/novnc/noVNC/wiki/Contributing)
projects / mirror_novnc.git / blobdiff