README.md

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