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