Repository files navigation

noVNC is both a HTML VNC client JavaScript library and an application built ontop of that library. noVNC runs well in any modern browser including mobilebrowsers (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.

• News/help/contact
• Features
• Screenshots
• Browser requirements
• Server requirements
• Quick start
• Installation from snap package
• Integration and deployment
• Authors/Contributors

The project website is found atnovnc.com.

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 questionsabout using noVNC then please first use thediscussion group.We also have awiki with lots ofhelpful information.

If you are looking for a place to start contributing to noVNC, a good place tostart 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.

• Supports all modern browsers including mobile (iOS, Android)
• Supported authentication methods: none, classical VNC, RealVNC'sRSA-AES, Tight, VeNCrypt Plain, XVP, Apple's Diffie-Hellman,UltraVNC's MSLogonII
• Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG,ZRLE, JPEG, Zlib, H.264
• Supports scaling, clipping and resizing the desktop
• Supports back & forward mouse buttons
• Local cursor rendering
• Clipboard copy/paste with full Unicode support
• Translations
• Touch gestures for emulating common mouse actions
• Licensed mainly under theMPL 2.0, seethe license document for details

Running in Firefox before and after connecting:

See more screenshotshere.

noVNC uses many modern web technologies so a formal requirement list isnot available. However these are the minimum versions we are currentlyaware of:

• Chrome 89, Firefox 89, Safari 15, Opera 75, Edge 89

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

• Use thenovnc_proxy script to automatically download and start websockify, whichincludes a mini-webserver and the WebSockets proxy. The--vnc option isused to specify the location of a running VNC server:

  ./utils/novnc_proxy --vnc localhost:5901

• If you don't need to expose the web server to public internet, you canbind to localhost:

  ./utils/novnc_proxy --vnc localhost:5901 --listen localhost:6081

• Point your browser to the cut-and-paste URL that is output by thenovnc_proxyscript. Hit the Connect button, enter a password if the VNC server has oneconfigured, and enjoy!

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

sudo snap install 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

If you want to use certificate files, due to standard snap confinement restrictions you need to have them in the /home/<user>/snap/novnc/current/ directory. If your username is jsmith an example command would be:

novnc --listen 8443 --cert ~jsmith/snap/novnc/current/self.crt --key ~jsmith/snap/novnc/current/self.key --vnc ubuntu.example.com:5901

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

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

sudo snap get novnc servicesKey             Valueservices.n6080  {...}services.n6081  {...}

Create a new service that listens on port 6082 and connects to the VNC serverrunning 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 anythingas 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.n6082Key                    Valueservices.n6082.listen  6082services.n6082.vnc     localhost:5902

Disable a service (note that because of a limitation in snap it's currently notpossible to unset config variables, setting them to blank values is the wayto 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.n6082Key                    Valueservices.n6082.listen  services.n6082.vnc

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

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

• Core team:

  • Samuel Mannehed (Cendio)
  • Pierre Ossman (Cendio)

• Previous core contributors:

  • Joel Martin (Project founder)
  • Solly Ross (Red Hat / OpenStack)

• Notable contributions:

  • UI and icons : Pierre Ossman, Chris Gordon
  • Original logo : Michael Sersen
  • tight encoding : Michael Tinglof (Mercuri.ca)
  • RealVNC RSA AES authentication : USTC Vlab Team

• Included libraries:

  • 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)

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