-noVNC: HTML5 VNC Client
-======================
+## noVNC: HTML5 VNC Client
+[](https://travis-ci.org/novnc/noVNC)
-Description
------------
+### Description
-noVNC is a VNC client implemented using HTML5 technologies,
-specifically Canvas and WebSocket (supports 'wss://' encryption).
+noVNC is a HTML5 VNC client that runs well in any modern browser including
+mobile browsers (iOS and Android).
-For browsers that do not have builtin WebSocket support, the project
-includes web-socket-js, a WebSocket emulator using Adobe Flash
-(http://github.com/gimite/web-socket-js).
+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.
-In addition, as3crypto has been added to web-socket-js to implement
-WebSocket SSL/TLS encryption, i.e. the "wss://" URI scheme.
-(http://github.com/lyokato/as3crypto_patched).
+### News/help/contact
+Notable commits, announcements and news are posted to
+<a href="http://www.twitter.com/noVNC">@noVNC</a>.
-Requirements
-------------
+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>.
-Until there is VNC server support for WebSocket connections, you need
-to use a WebSocket to TCP socket proxy. There is a python proxy
-included ('wsproxy'). One advantage of using the proxy is that it has
-builtin support for SSL/TLS encryption (i.e. "wss://").
+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).
-There a few reasons why a proxy is required:
+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.
- 1. WebSocket is not a pure socket protocol. There is an initial HTTP
- like handshake to allow easy hand-off by web servers and allow
- some origin policy exchange. Also, each WebSocket frame begins
- with 0 ('\x00') and ends with 255 ('\xff').
- 2. Javascript itself does not have the ability to handle pure byte
- strings (Unicode encoding messes with it) even though you can
- read them with WebSocket. The python proxy encodes the data so
- that the Javascript client can base64 decode the data into an
- array.
+### Features
- 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.
+* Supports all modern browsers including mobile (iOS, Android)
+* Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
+* WebSocket SSL/TLS encryption (i.e. "wss://") support
+* 24-bit true color and 8 bit colour mapped
+* Supports desktop resize notification/pseudo-encoding
+* Local or remote cursor
+* Clipboard copy/paste
+* Clipping or scolling modes for large remote screens
+* Easy site integration and theming (3 example themes included)
+* Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/)
+### Screenshots
-Usage
------
+Running in Chrome before and after connecting:
-* To encrypt the traffic using the WebSocket 'wss://' URI scheme you
- need to generate a certificate for the proxy to load. You can generate
- a self-signed certificate using openssl. The common name should be the
- hostname of the server where the proxy will be running:
+<img src="http://novnc.com/img/noVNC-5.png" width=400>
+<img src="http://novnc.com/img/noVNC-7.jpg" width=400>
- `openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem`
+See more screenshots
+<a href="http://novnc.com/screenshots.html">here</a>.
-* run a VNC server.
-
- `vncserver :1`
-* run the python proxy:
+### Browser Requirements
- `./utils/wsproxy.py -f source_port target_addr:target_port
+* Chrome 8, Firefox 4, Safari 6, Opera 12, IE 11, Edge 12, etc.
- `./utils/wsproxy.py -f 8787 localhost:5901`
+* 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.
-* run the mini python web server to serve the directory:
+* See the more detailed
+[browser compatibility wiki page](https://github.com/novnc/noVNC/wiki/Browser-support).
- `./utils/web.py PORT`
- `./utils/web.py 8080`
+### Server Requirements
-* Point your web browser at http://localhost:8080/vnc.html
- (or whatever port you used above to run the web server).
+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').
-* Specify the host and port where the proxy is running and the
- password that the vnc server is using (if any). Hit the Connect
- button and enjoy!
+### Quick Start
-Browser Support
----------------
+* 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:
-I only currently test under Linux. Here are the current results:
+ `./utils/launch.sh --vnc localhost:5901`
-* Chrome 5.0.375.29 beta: Works great. Native WebSockets support. Very
- fast.
-* firefox 3.5, 3.7: Works well. Large full-color images are slow
- mostly due to flash WebSockets emulator overhead.
-* Opera 10.60: Works. Rendering performance between firefox 3.5 and
- Chrome. However, flash WebSockets emulator interaction causes
- inconsistence overall performance and occasional hangs.
-* Arora 0.50: Works. Broken putImageData so large full-color images
- are slow.
+* 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!
-* Konqueror 4.2.2: Broken: flash WebSockets emulator never connects.
+### Other Pages
-Integration
------------
+* [Modules/API](https://github.com/novnc/noVNC/wiki/Modules-API) - The library
+ modules and their Javascript API.
-The client is designed to be easily integrated with existing web
-structure and style.
+* [Integration](https://github.com/novnc/noVNC/wiki/Integration) - Get noVNC
+ to work in existing projects.
-At a minimum you must include the `vnc.js` and `default_controls.js`
-scripts and call their load() functions. For example:
+* [Troubleshooting](https://github.com/novnc/noVNC/wiki/Troubleshooting) - How
+ to troubleshoot problems.
- <head>
- <script src='include/vnc.js'></script>
- <script src="include/default_controls.js"></script>
- </head>
- <body>
- <div id='vnc'>Loading</div>
- </body>
- <script>
- window.onload = function () {
- DefaultControls.load('vnc');
- RFB.load(); };
- </script>
+* [Encrypted Connections](https://github.com/novnc/websockify/wiki/Encrypted-Connections) -
+ Setup websockify so that you can use encrypted connections from noVNC.
-See `vnc.html` and `vnc_auto.html` for examples. The file
-`include/plain.css` has a list of stylable elements.
+* [Advanced Usage](https://github.com/novnc/noVNC/wiki/Advanced-usage) -
+ Generating an SSL certificate, starting a VNC server, advanced websockify
+ usage, etc.
-The `vnc.js` also includes other scripts within the `include`
-sub-directory. The `VNC_uri_prefix` variable can be use override the
-URL path to the directory that contains the `include` sub-directory.
+* [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
+
+* 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:
+ * as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
+ * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
+ * 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