RETIRED, further work has moved to Debian project infrastructure
Go to file
Samuel Mannehed 772dc0d017 Update copyright 2016-09-03 19:26:29 +02:00
docs Release 0.6.1 2016-07-04 15:29:00 -04:00
images Renamed showExtraKeys to toggleExtraKeys 2016-05-12 16:56:50 +02:00
include Update copyright 2016-09-03 19:26:29 +02:00
tests QEMU RFB extension - rfb.js and input.js changes 2016-08-26 17:34:39 -03:00
utils Removing unused import (#642) 2016-08-26 11:09:22 +02:00
.gitignore Make sure websockify is cloned to the correct dir 2015-02-17 17:54:21 -05:00
.gitmodules Use Typed Arrays for the Websock receive queue 2015-08-06 14:47:03 -04:00
.travis.yml CI: Switch to Container-Based Travis 2015-08-06 14:43:02 -04:00
CONTRIBUTING.md Added in guidelines for contributing to noVNC 2014-11-02 13:27:06 -05:00
LICENSE.txt QEMU RFB extension - new file xtscancodes.js 2016-08-26 17:06:42 -03:00
README.md Use Typed Arrays for the Websock receive queue 2015-08-06 14:47:03 -04:00
favicon.ico Add logo, favicon. 2011-02-03 11:04:32 -06:00
karma.conf.js QEMU RFB extension - new file xtscancodes.js 2016-08-26 17:06:42 -03:00
package.json Release 0.6.1 2016-07-04 15:29:00 -04:00
vnc.html Consistent closing tags for void elements 2016-05-27 16:14:25 +02:00
vnc_auto.html QEMU RFB extension - new file xtscancodes.js 2016-08-26 17:06:42 -03:00

README.md

noVNC: HTML5 VNC Client

Build Status

Description

noVNC is a HTML5 VNC client that runs well in any modern browser including mobile browsers (iPhone/iPad and Android).

Many companies/projects have integrated noVNC including Ganeti Web Manager, OpenStack, OpenNebula, and LibVNCServer. See the Projects and Companies wiki page for a more complete list with additional info and links.

News/help/contact

Notable commits, announcements and news are posted to @noVNC

If you are a noVNC developer/integrator/user (or want to be) please join the noVNC discussion group

Bugs and feature requests can be submitted via github issues. If you are looking for a place to start contributing to noVNC, a good place to start would be the issues that are marked as "patchwelcome".

If you want to show appreciation for noVNC you could donate to a great non-profits such as: Compassion International, SIL, Habitat for Humanity, Electronic Frontier Foundation, Against Malaria Foundation, Nothing But Nets, etc. Please tweet @noVNC if you do.

Features

  • Supports all modern browsers including mobile (iOS, Android)
  • Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
  • WebSocket SSL/TLS encryption (i.e. "wss://") support
  • 24-bit true color and 8 bit colour mapped
  • Supports desktop resize notification/pseudo-encoding
  • Local or remote cursor
  • Clipboard copy/paste
  • Clipping or scolling modes for large remote screens
  • Easy site integration and theming (3 example themes included)
  • Licensed under the MPL 2.0

Screenshots

Running in Chrome before and after connecting:

 

See more screenshots here.

Browser Requirements

  • HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS Safari, Opera 11+, Internet Explorer 9+, etc.

  • HTML5 WebSockets and Typed Arrays

  • Fast Javascript Engine: this is not strictly a requirement, but without a fast Javascript engine, noVNC might be painfully slow.

  • See the more detailed browser compatibility wiki page.

Server Requirements

Unless you are using a VNC server with support for WebSockets connections (such as x11vnc/libvncserver, QEMU, or PocketVNC), you need to use a WebSockets to TCP socket proxy. There is a python proxy included ('websockify').

Quick Start

  • Use the launch script to start a mini-webserver and the WebSockets proxy (websockify). The --vnc option is used to specify the location of a running VNC server:

    ./utils/launch.sh --vnc localhost:5901

  • Point your browser to the cut-and-paste URL that is output by the launch script. Enter a password if the VNC server has one configured. Hit the Connect button and enjoy!

Other Pages

Authors/Contributors

  • Core team:

  • Notable contributions:

    • UI and Icons : Chris Gordon
    • Original Logo : Michael Sersen
    • tight encoding : Michael Tinglof (Mercuri.ca)
  • Included libraries:

    • as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
    • base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
    • DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)
    • Pako : Vitaly Puzrin (https://github.com/nodeca/pako)