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