README.md

   1 ## noVNC: HTML5 VNC Client
   2
   3
   4 ### Description
   5
   6 noVNC is a HTML5 VNC client that runs well in any modern browser
   7 including mobile browsers (iPhone/iPad and Android).
   8
   9 Notable commits, announcements and news are posted to
  10 @<a href="http://www.twitter.com/noVNC">noVNC</a>
  11
  12 There are many companies/projects that have integrated noVNC into
  13 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/), and [LibVNCServer](http://libvncserver.sourceforge.net). See [this wiki page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC) for more info and links.
  14
  15
  16 ### Features
  17
  18 * Supports all modern browsers including mobile (iOS, Android)
  19 * Supported VNC encodings: raw, copyrect, rre, hextile, tightPNG
  20 * WebSocket SSL/TLS encryption (i.e. "wss://") support
  21 * 24-bit true color and 8 bit colour mapped
  22 * Supports desktop resize notification/pseudo-encoding
  23 * Local or remote cursor
  24 * Clipboard copy/paste
  25 * Clipping or scolling modes for large remote screens
  26 * Easy site integration and theming (3 example themes included)
  27 * Licensed under the [LGPLv3](http://www.gnu.org/licenses/lgpl.html)
  28
  29 * Support for tight encoding (contributed by Mercuri.ca)
  30
  31 ### Screenshots
  32
  33 Running in Chrome before and after connecting:
  34
  35 <img src="http://kanaka.github.com/noVNC/img/noVNC-5.png" width=400>&nbsp;<img src="http://kanaka.github.com/noVNC/img/noVNC-7.jpg" width=400>
  36
  37 See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
  38
  39
  40 ### Browser Requirements
  41
  42 * HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS
  43   Safari, Opera 11+, Internet Explorer 9+, etc.
  44
  45 * HTML5 WebSockets: For browsers that do not have builtin
  46   WebSockets support, the project includes
  47   <a href="http://github.com/gimite/web-socket-js">web-socket-js</a>,
  48   a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in
  49   WebSocket support.
  50
  51 * Fast Javascript Engine: this is not strictly a requirement, but
  52   without a fast Javascript engine, noVNC might be painfully slow.
  53
  54 * I maintain a more detailed browser compatibility list <a
  55   href="https://github.com/kanaka/noVNC/wiki/Browser-support">here</a>.
  56
  57
  58 ### Server Requirements
  59
  60 Unless you are using a VNC server with support for WebSockets
  61 connections (such as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/)),
  62 you need to use a WebSockets to TCP socket proxy. There is
  63 a python proxy included ('websockify').
  64
  65
  66 ### Quick Start
  67
  68 * Use the launch script to start a mini-webserver and the WebSockets
  69   proxy (websockify). The `--vnc` option is used to specify the location of
  70   a running VNC server:
  71
  72     `./utils/launch.sh --vnc localhost:5901`
  73
  74 * Point your browser to the cut-and-paste URL that is output by the
  75   launch script. Enter a password if the VNC server has one
  76   configured. Hit the Connect button and enjoy!
  77
  78
  79 ### Other Pages
  80
  81 * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Generating an SSL
  82   certificate, starting a VNC server, advanced websockify usage, etc.
  83
  84 * [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects.
  85
  86 * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems.
  87
  88