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 noVNC is licensed under the
  10 [LGPLv3](http://www.gnu.org/licenses/lgpl.html).
  11
  12 There are many companies/projects that have integrated noVNC into
  13 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/), [SlapOS](http://www.slapos.org), [Intel MeshCentral](https://meshcentral.com), and [Amahi](http://amahi.org). See [this wiki page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC) for more info and links.
  14
  15 Notable commits, announcements and news are posted to
  16 @<a href="http://www.twitter.com/noVNC">noVNC</a>
  17
  18
  19 ### Screenshots
  20
  21 Running in Chrome before and after connecting:
  22
  23 <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>
  24
  25 See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
  26
  27
  28 ### Browser Requirements
  29
  30 * HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS
  31   Safari, Opera 11+, Internet Explorer 9+, etc.
  32
  33 * HTML5 WebSockets: For browsers that do not have builtin
  34   WebSockets support, the project includes
  35   <a href="http://github.com/gimite/web-socket-js">web-socket-js</a>,
  36   a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in
  37   WebSocket support.
  38
  39 * Fast Javascript Engine: this is not strictly a requirement, but
  40   without a fast Javascript engine, noVNC might be painfully slow.
  41
  42 * I maintain a more detailed browser compatibility list <a
  43   href="https://github.com/kanaka/noVNC/wiki/Browser-support">here</a>.
  44
  45
  46 ### Server Requirements
  47
  48 Unless you are using a VNC server with support for WebSockets
  49 connections (such as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/)),
  50 you need to use a WebSockets to TCP socket proxy. There is
  51 a python proxy included ('websockify'). One advantage of using the
  52 proxy is that it has builtin support for SSL/TLS encryption (i.e.
  53 "wss://").
  54
  55
  56 ### Quick Start
  57
  58 * Use the launch script to start a mini-webserver and the WebSockets
  59   proxy (websockify). The `--vnc` option is used to specify the location of
  60   a running VNC server:
  61
  62     `./utils/launch.sh --vnc localhost:5901`
  63
  64 * Point your browser to the cut-and-paste URL that is output by the
  65   launch script. Enter a password if the VNC server has one
  66   configured. Hit the Connect button and enjoy!
  67
  68
  69 ### Other Pages
  70
  71 * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Generating an SSL
  72   certificate, starting a VNC server, advanced websockify usage, etc.
  73
  74 * [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects.
  75
  76 * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems.
  77
  78