README.md

   1 ## noVNC: HTML VNC Client Library and Application
   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 both a HTML VNC client JavaScript library and an application built on
   8 top of that library. noVNC runs well in any modern browser including mobile
   9 browsers (iOS and Android).
  10
  11 Many companies, projects and products have integrated noVNC including
  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 [@noVNC](http://www.twitter.com/noVNC).
  24
  25 If you are a noVNC developer/integrator/user (or want to be) please join the
  26 [noVNC discussion group](https://groups.google.com/forum/?fromgroups#!forum/novnc).
  27
  28 Bugs and feature requests can be submitted via
  29 [github issues](https://github.com/novnc/noVNC/issues). If you have questions
  30 about using noVNC then please first use the
  31 [discussion group](https://groups.google.com/forum/?fromgroups#!forum/novnc).
  32 We also have a [wiki](https://github.com/novnc/noVNC/wiki/) with lots of
  33 helpful information.
  34
  35 If you are looking for a place to start contributing to noVNC, a good place to
  36 start would be the issues that are marked as
  37 ["patchwelcome"](https://github.com/novnc/noVNC/issues?labels=patchwelcome).
  38
  39 If you want to show appreciation for noVNC you could donate to a great non-
  40 profits such as:
  41 [Compassion International](http://www.compassion.com/),
  42 [SIL](http://www.sil.org),
  43 [Habitat for Humanity](http://www.habitat.org),
  44 [Electronic Frontier Foundation](https://www.eff.org/),
  45 [Against Malaria Foundation](http://www.againstmalaria.com/),
  46 [Nothing But Nets](http://www.nothingbutnets.net/), etc.
  47 Please tweet [@noVNC](http://www.twitter.com/noVNC) if you do.
  48
  49
  50 ### Features
  51
  52 * Supports all modern browsers including mobile (iOS, Android)
  53 * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
  54 * WebSocket SSL/TLS encryption (i.e. "wss://") support
  55 * 24-bit true color and 8 bit colour mapped
  56 * Supports desktop resize notification/pseudo-encoding
  57 * Local or remote cursor
  58 * Clipboard copy/paste
  59 * Clipping or scolling modes for large remote screens
  60 * Easy site integration and theming (3 example themes included)
  61 * Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/)
  62
  63 ### Screenshots
  64
  65 Running in Firefox before and after connecting:
  66
  67 <img src="http://novnc.com/img/noVNC-1-login.png" width=400>&nbsp;
  68 <img src="http://novnc.com/img/noVNC-3-connected.png" width=400>
  69
  70 See more screenshots
  71 [here](http://novnc.com/screenshots.html).
  72
  73
  74 ### Browser Requirements
  75
  76 * Chrome 49, Firefox 44, Safari 10, Opera 36, IE 11, Edge 12, etc.
  77
  78 * HTML5 Canvas, WebSockets and Typed Arrays, etc.
  79
  80 * Fast Javascript Engine: this is not strictly a requirement, but without a
  81   fast Javascript engine, noVNC might be painfully slow.
  82
  83 * See the more detailed
  84 [browser compatibility wiki page](https://github.com/novnc/noVNC/wiki/Browser-support).
  85
  86
  87 ### Server Requirements
  88
  89 Unless you are using a VNC server with support for WebSockets connections (such
  90 as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
  91 [QEMU](http://www.qemu.org/), or
  92 [MobileVNC](http://www.smartlab.at/mobilevnc/)), you need to use a
  93 WebSockets to TCP socket proxy. There is a python proxy included
  94 ('websockify').
  95
  96
  97 ### Quick Start
  98
  99 * Use the launch script to start a mini-webserver and the WebSockets proxy
 100   (websockify). The `--vnc` option is used to specify the location of a running
 101   VNC server:
 102
 103     `./utils/launch.sh --vnc localhost:5901`
 104
 105 * Point your browser to the cut-and-paste URL that is output by the launch
 106   script. Enter a password if the VNC server has one configured. Hit the
 107   Connect button and enjoy!
 108
 109
 110 ### Authors/Contributors
 111
 112 * Core team:
 113     * [Joel Martin](https://github.com/kanaka)
 114     * [Samuel Mannehed](https://github.com/samhed) (Cendio)
 115     * [Peter Åstrand](https://github.com/astrand) (Cendio)
 116     * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack)
 117     * [Pierre Ossman](https://github.com/CendioOssman) (Cendio)
 118
 119 * Notable contributions:
 120     * UI and Icons : Pierre Ossman, Chris Gordon
 121     * Original Logo : Michael Sersen
 122     * tight encoding : Michael Tinglof (Mercuri.ca)
 123
 124 * Included libraries:
 125     * as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
 126     * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
 127     * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)
 128     * Pako : Vitaly Puzrin (https://github.com/nodeca/pako)
 129
 130 * [Contribution guide](https://github.com/novnc/noVNC/wiki/Contributing)