jcarr
/
noVNC
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
VNC client web application
1,811 Commits 4 Branches 22 Tags 18 MiB
JavaScript 92.7%
CSS 3.8%
HTML 2.2%
Shell 1.1%
Makefile 0.2%
Go to file
Lee Yarwood 188c9a591b launch.sh: Check for a local websockify directory 
Previously launch.sh would check both for the existence of a local
websockify file and /websockify/run file.

This initial check should really be for a local websockify directory
as in packaged environments a file could very well be the actual
executable leading to launch.sh incorrectly attempting to use a local
version of websockify.
 		2019-07-09 12:27:26 +01:00
.github/ISSUE_TEMPLATE Add issue templates 2018-05-21 09:37:37 +02:00
app Add Japanese translation 2019-06-12 04:30:56 +09:00
core Remove server pixel format warnings 2019-05-24 13:06:26 +02:00
docs Make the screen background cutomizable 2019-01-18 19:36:23 +01:00
po Add Japanese translation 2019-06-12 04:30:56 +09:00
tests Fix up errors and warnings in vnc_playback.html 2019-03-26 15:21:31 +01:00
utils launch.sh: Check for a local websockify directory 2019-07-09 12:27:26 +01:00
vendor Explicitly list what we want in our NPM package 2019-01-11 13:39:02 +01:00
.eslintignore Don't lint xtscancodes.js 2018-09-06 16:37:11 +02:00
.eslintrc Enforce switch colon spacing 2018-09-06 17:36:48 +02:00
.gitignore [infra] updated packaging config 2017-10-04 14:29:54 -04:00
.gitmodules Use Typed Arrays for the Websock receive queue 2015-08-06 14:47:03 -04:00
.travis.yml Don't do cleanup on deploy 2019-04-15 16:11:01 +02:00
AUTHORS Change copyright header (#1138) 2018-10-09 12:15:35 +02:00
LICENSE.txt Change copyright header (#1138) 2018-10-09 12:15:35 +02:00
README.md Add translations as a feature 2019-03-21 13:57:16 +01:00
VERSION noVNC 1.1.0 2019-04-09 16:29:53 +02:00
karma.conf.js Stop transpiling karma tests 2018-07-16 13:32:35 +02:00
package.json noVNC 1.1.0 2019-04-09 16:29:53 +02:00
vnc.html Get rid of self-closing tags 2019-04-02 14:22:34 +02:00
vnc_lite.html Get rid of self-closing tags 2019-04-02 14:22:34 +02:00

README.md

noVNC: HTML VNC Client Library and Application

Build Status

Description

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 including OpenStack, OpenNebula, LibVNCServer, and ThinLinc. See the Projects and Companies wiki page for a more complete list with additional info and links.

Table of Contents

News/help/contact

The project website is found at novnc.com. 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 have questions about using noVNC then please first use the discussion 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 our contribution 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.

Features

  • 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
  • Licensed mainly under the MPL 2.0, see the license document for details

Screenshots

Running in Firefox before and after connecting:

 

See more screenshots here.

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 10, 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, and MobileVNC), but for the others you need to use a WebSockets to TCP socket proxy. noVNC has a sister project websockify 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 --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. Hit the Connect button, enter a password if the VNC server has one configured, and enjoy!

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

Authors/Contributors

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.

  • Core team:

  • Notable contributions:

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

  • 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 our contribution guide and start hacking!