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 Please check our
  39 [contribution guide](https://github.com/novnc/noVNC/wiki/Contributing) though.
  40
  41 If you want to show appreciation for noVNC you could donate to a great non-
  42 profits such as:
  43 [Compassion International](http://www.compassion.com/),
  44 [SIL](http://www.sil.org),
  45 [Habitat for Humanity](http://www.habitat.org),
  46 [Electronic Frontier Foundation](https://www.eff.org/),
  47 [Against Malaria Foundation](http://www.againstmalaria.com/),
  48 [Nothing But Nets](http://www.nothingbutnets.net/), etc.
  49 Please tweet [@noVNC](http://www.twitter.com/noVNC) if you do.
  50
  51
  52 ### Features
  53
  54 * Supports all modern browsers including mobile (iOS, Android)
  55 * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
  56 * Supports scaling, clipping and resizing the desktop
  57 * Local cursor rendering
  58 * Clipboard copy/paste
  59 * Licensed mainly under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/), see
  60   [the license document](LICENSE.txt) for details
  61
  62 ### Screenshots
  63
  64 Running in Firefox before and after connecting:
  65
  66 <img src="http://novnc.com/img/noVNC-1-login.png" width=400>&nbsp;
  67 <img src="http://novnc.com/img/noVNC-3-connected.png" width=400>
  68
  69 See more screenshots
  70 [here](http://novnc.com/screenshots.html).
  71
  72
  73 ### Browser Requirements
  74
  75 noVNC uses many modern web technologies so a formal requirement list is
  76 not available. However these are the minimum versions we are currently
  77 aware of:
  78
  79 * Chrome 49, Firefox 44, Safari 10, Opera 36, IE 11, Edge 12
  80
  81
  82 ### Server Requirements
  83
  84 noVNC follows the standard VNC protocol, but unlike other VNC clients it does
  85 require WebSockets support. Many servers include support (e.g.
  86 [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
  87 [QEMU](http://www.qemu.org/), and
  88 [MobileVNC](http://www.smartlab.at/mobilevnc/)), but for the others you need to
  89 use a WebSockets to TCP socket proxy. noVNC has a sister project
  90 [websockify](https://github.com/novnc/websockify) that provides a simple such
  91 proxy.
  92
  93
  94 ### Quick Start
  95
  96 * Use the launch script to automatically download and start websockify, which
  97   includes a mini-webserver and the WebSockets proxy. The `--vnc` option is
  98   used to specify the location of a running 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. Hit the Connect button, enter a password if the VNC server has one
 104   configured, and enjoy!
 105
 106
 107 ### Integration and Deployment
 108
 109 Please see our other documents for how to integrate noVNC in your own software,
 110 or deploying the noVNC application in production environments:
 111
 112 * [Embedding](docs/EMBEDDING.md) - For the noVNC application
 113 * [Library](docs/LIBRARY.md) - For the noVNC JavaScript library
 114
 115
 116 ### Authors/Contributors
 117
 118 * Core team:
 119     * [Joel Martin](https://github.com/kanaka)
 120     * [Samuel Mannehed](https://github.com/samhed) (Cendio)
 121     * [Peter Åstrand](https://github.com/astrand) (Cendio)
 122     * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack)
 123     * [Pierre Ossman](https://github.com/CendioOssman) (Cendio)
 124
 125 * Notable contributions:
 126     * UI and Icons : Pierre Ossman, Chris Gordon
 127     * Original Logo : Michael Sersen
 128     * tight encoding : Michael Tinglof (Mercuri.ca)
 129
 130 * Included libraries:
 131     * as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
 132     * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
 133     * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)
 134     * Pako : Vitaly Puzrin (https://github.com/nodeca/pako)
 135
 136 Do you want to be on this list? Check out our
 137 [contribution guide](https://github.com/novnc/noVNC/wiki/Contributing) and
 138 start hacking!