README.md

   1 ## noVNC: HTML5 VNC Client
   2
   3 [![Build Status](https://travis-ci.org/kanaka/noVNC.svg?branch=master)](https://travis-ci.org/kanaka/noVNC)
   4
   5 ### Description
   6
   7 noVNC is a HTML5 VNC client that runs well in any modern browser
   8 including mobile browsers (iPhone/iPad and Android).
   9
  10 Many companies/projects have integrated noVNC including [Ganeti Web
  11 Manager](http://code.osuosl.org/projects/ganeti-webmgr),
  12 [OpenStack](http://www.openstack.org),
  13 [OpenNebula](http://opennebula.org/), and
  14 [LibVNCServer](http://libvncserver.sourceforge.net). See [the Projects
  15 and Companies wiki
  16 page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC)
  17 for a more complete list with additional info and links.
  18
  19 ### News/help/contact
  20
  21 Notable commits, announcements and news are posted to
  22 <a href="http://www.twitter.com/noVNC">@noVNC</a>
  23
  24 If you are a noVNC developer/integrator/user (or want to be) please
  25 join the <a
  26 href="https://groups.google.com/forum/?fromgroups#!forum/novnc">noVNC
  27 discussion group</a>
  28
  29 Bugs and feature requests can be submitted via [github
  30 issues](https://github.com/kanaka/noVNC/issues). If you are looking
  31 for a place to start contributing to noVNC, a good place to start
  32 would be the issues that are marked as
  33 ["patchwelcome"](https://github.com/kanaka/noVNC/issues?labels=patchwelcome).
  34
  35 If you want to show appreciation for noVNC you could donate to a great
  36 non-profits such as: [Compassion
  37 International](http://www.compassion.com/), [SIL](http://www.sil.org),
  38 [Habitat for Humanity](http://www.habitat.org), [Electronic Frontier
  39 Foundation](https://www.eff.org/), [Against Malaria
  40 Foundation](http://www.againstmalaria.com/), [Nothing But
  41 Nets](http://www.nothingbutnets.net/), etc. Please tweet <a
  42 href="http://www.twitter.com/noVNC">@noVNC</a> if you do.
  43
  44
  45 ### Features
  46
  47 * Supports all modern browsers including mobile (iOS, Android)
  48 * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
  49 * WebSocket SSL/TLS encryption (i.e. "wss://") support
  50 * 24-bit true color and 8 bit colour mapped
  51 * Supports desktop resize notification/pseudo-encoding
  52 * Local or remote cursor
  53 * Clipboard copy/paste
  54 * Clipping or scolling modes for large remote screens
  55 * Easy site integration and theming (3 example themes included)
  56 * Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/)
  57
  58 ### Screenshots
  59
  60 Running in Chrome before and after connecting:
  61
  62 <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>
  63
  64 See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
  65
  66
  67 ### Browser Requirements
  68
  69 * HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS
  70   Safari, Opera 11+, Internet Explorer 9+, etc.
  71
  72 * HTML5 WebSockets: For browsers that do not have builtin
  73   WebSockets support, the project includes
  74   <a href="http://github.com/gimite/web-socket-js">web-socket-js</a>,
  75   a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in
  76   WebSocket support.
  77
  78 * Fast Javascript Engine: this is not strictly a requirement, but
  79   without a fast Javascript engine, noVNC might be painfully slow.
  80
  81 * See the more detailed [browser compatibility wiki page](https://github.com/kanaka/noVNC/wiki/Browser-support).
  82
  83
  84 ### Server Requirements
  85
  86 Unless you are using a VNC server with support for WebSockets
  87 connections (such as
  88 [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
  89 [QEMU](http://www.qemu.org/), or
  90 [PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), you need to
  91 use a WebSockets to TCP socket proxy. There is a python proxy included
  92 ('websockify').
  93
  94
  95 ### Quick Start
  96
  97 * Use the launch script to start a mini-webserver and the WebSockets
  98   proxy (websockify). The `--vnc` option is used to specify the location of
  99   a running VNC server:
 100
 101     `./utils/launch.sh --vnc localhost:5901`
 102
 103 * Point your browser to the cut-and-paste URL that is output by the
 104   launch script. Enter a password if the VNC server has one
 105   configured. Hit the Connect button and enjoy!
 106
 107
 108 ### Other Pages
 109
 110 * [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections). How to setup websockify so that you can use encrypted connections from noVNC.
 111
 112 * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Starting a VNC server, advanced websockify usage, etc.
 113
 114 * [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects.
 115
 116 * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems.
 117
 118
 119 ### Authors/Contributors
 120
 121 * Core team:
 122     * [Joel Martin](https://github.com/kanaka)
 123     * [Samuel Mannehed](https://github.com/samhed) (Cendio)
 124     * [Peter Åstrand](https://github.com/astrand) (Cendio)
 125     * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack)
 126
 127 * Notable contributions:
 128     * UI and Icons : Chris Gordon
 129     * Original Logo : Michael Sersen
 130     * tight encoding : Michael Tinglof (Mercuri.ca)
 131
 132 * Included libraries:
 133     * web-socket-js : Hiroshi Ichikawa (github.com/gimite/web-socket-js)
 134     * as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
 135     * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
 136     * jsunzip : Erik Moller (github.com/operasoftware/jsunzip),
 137     * tinflate : Joergen Ibsen (ibsensoftware.com)
 138     * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)