diff options
Diffstat (limited to 'webclients/novnc/README.md')
| -rw-r--r-- | webclients/novnc/README.md | 67 |
1 files changed, 38 insertions, 29 deletions
diff --git a/webclients/novnc/README.md b/webclients/novnc/README.md index 4672969..887c96c 100644 --- a/webclients/novnc/README.md +++ b/webclients/novnc/README.md @@ -3,20 +3,28 @@ ### Description -noVNC is a VNC client implemented using HTML5 technologies, -specifically Canvas and WebSockets (supports 'wss://' encryption). -noVNC is licensed under the -[LGPLv3](http://www.gnu.org/licenses/lgpl.html). +noVNC is a HTML5 VNC client that runs well in any modern browser +including mobile browsers (iPhone/iPad and Android). -Special thanks to [Sentry Data Systems](http://www.sentryds.com) for -sponsoring ongoing development of this project (and for employing me). +Notable commits, announcements and news are posted to +@<a href="http://www.twitter.com/noVNC">noVNC</a> There are many companies/projects that have integrated noVNC into -their products including: [Sentry Data Systems](http://www.sentryds.com), [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/), and [SlapOS](http://www.slapos.org). See [this wiki page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC) for more info and links. +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. -Notable commits, announcements and news are posted to -@<a href="http://www.twitter.com/noVNC">noVNC</a> +### Features + +* 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 [LGPLv3](http://www.gnu.org/licenses/lgpl.html) ### Screenshots @@ -38,10 +46,8 @@ See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">h a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in WebSocket support. -* Fast Javascript Engine: noVNC avoids using new Javascript - functionality so it will run on older browsers, but decode and - rendering happen in Javascript, so a slow Javascript engine will - mean noVNC is 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>. @@ -50,22 +56,9 @@ See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">h ### Server Requirements Unless you are using a VNC server with support for WebSockets -connections (only my [fork of libvncserver](http://github.com/kanaka/libvncserver) -currently), you need to use a WebSockets to TCP socket proxy. There is -a python proxy included ('websockify'). One advantage of using the -proxy is that it has builtin support for SSL/TLS encryption (i.e. -"wss://"). - -There a few reasons why a proxy is required: - - 1. WebSockets 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 WebSockets frame begins - with 0 ('\x00') and ends with 255 ('\xff'). - - 2. Javascript itself does not have the ability to handle pure byte - arrays. The python proxy encodes the data as base64 so that the - Javascript client can decode the data as an integer array. +connections (such as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/)), +you need to use a WebSockets to TCP socket proxy. There is +a python proxy included ('websockify'). ### Quick Start @@ -91,3 +84,19 @@ There a few reasons why a proxy is required: * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems. +### Authors/Contributors + +* noVNC : Joel Martin (github.com/kanaka) + * New UI and Icons : 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) + + |