Github url


by novnc

novnc /noVNC

VNC client web application

6.6K Stars 1.4K Forks Last release: about 1 year ago (v1.1.0) Other 2.0K Commits 13 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

noVNC: HTML VNC Client Library and Application

Test StatusLint Status


noVNC is both a HTML VNC client JavaScript library and an application built on top of that library. noVNC runs well in any modern browser including mobile browsers (iOS and Android).

Many companies, projects and products have integrated noVNC includingOpenStack,OpenNebula,LibVNCServer, andThinLinc. Seethe Projects and Companies wiki pagefor a more complete list with additional info and links.

Table of Contents


The project website is found at Notable commits, announcements and news are posted to@noVNC.

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

Bugs and feature requests can be submitted viagithub issues. If you have questions about using noVNC then please first use thediscussion group. We also have a wiki with lots of helpful information.

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". Please check ourcontribution guide though.

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.


  • Supports all modern browsers including mobile (iOS, Android)
  • Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
  • Supports scaling, clipping and resizing the desktop
  • Local cursor rendering
  • Clipboard copy/paste
  • Translations
  • Touch gestures for emulating common mouse actions
  • Licensed mainly under the MPL 2.0, seethe license document for details


Running in Firefox before and after connecting:


See more screenshotshere.

Browser Requirements

noVNC uses many modern web technologies so a formal requirement list is not available. However these are the minimum versions we are currently aware of:

  • Chrome 49, Firefox 44, Safari 11, Opera 36, IE 11, Edge 12

Server Requirements

noVNC follows the standard VNC protocol, but unlike other VNC clients it does require WebSockets support. Many servers include support (e.g.x11vnc/libvncserver,QEMU, andMobileVNC), but for the others you need to use a WebSockets to TCP socket proxy. noVNC has a sister projectwebsockify that provides a simple such proxy.

Quick Start

  • Use the launch script to automatically download and start websockify, which includes a mini-webserver and the WebSockets proxy. The


option is used to specify the location of a running VNC server:

./utils/ --vnc localhost:5901
  • Point your browser to the cut-and-paste URL that is output by the launch script. Hit the Connect button, enter a password if the VNC server has one configured, and enjoy!

Installation from Snap Package

Running the command below will install the latest release of noVNC from Snap:

sudo snap install novnc

Running noVNC

You can run the Snap-package installed novnc directly with, for example:

novnc --listen 6081 --vnc localhost:5901 # /snap/bin/novnc if /snap/bin is not in your PATH

Running as a Service (Daemon)

The Snap package also has the capability to run a 'novnc' service which can be configured to listen on multiple ports connecting to multiple VNC servers (effectively a service runing multiple instances of novnc). Instructions (with example values):

List current services (out-of-box this will be blank):

sudo snap get novnc services Key Value services.n6080 {...} services.n6081 {...}

Create a new service that listens on port 6082 and connects to the VNC server running on port 5902 on localhost:

sudo snap set novnc services.n6082.listen=6082 services.n6082.vnc=localhost:5902

(Any services you define with 'snap set' will be automatically started) Note that the name of the service, 'n6082' in this example, can be anything as long as it doesn't start with a number or contain spaces/special characters.

View the configuration of the service just created:

sudo snap get novnc services.n6082 Key Value services.n6082.listen 6082 services.n6082.vnc localhost:5902

Disable a service (note that because of a limitation in Snap it's currently not possible to unset config variables, setting them to blank values is the way to disable a service):

sudo snap set novnc services.n6082.listen='' services.n6082.vnc=''

(Any services you set to blank with 'snap set' like this will be automatically stopped)

Verify that the service is disabled (blank values):

sudo snap get novnc services.n6082 Key Value services.n6082.listen services.n6082.vnc

Integration and Deployment

Please see our other documents for how to integrate noVNC in your own software, or deploying the noVNC application in production environments:

  • Embedding - For the noVNC application
  • Library - For the noVNC JavaScript library


See AUTHORS for a (full-ish) list of authors. If you're not on that list and you think you should be, feel free to send a PR to fix that.

Notable contributions:

  • UI and Icons : Pierre Ossman, Chris Gordon
  • Original Logo : Michael Sersen
  • tight encoding : Michael Tinglof (

Included libraries:

  • base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (
  • DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)
  • Pako : Vitaly Puzrin (

Do you want to be on this list? Check out ourcontribution guide and start hacking!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.