mirror of
https://github.com/novnc/noVNC.git
synced 2026-06-05 11:59:39 +00:00
e6af0f60b0
This adds support for Travis CI and SauceLabs testing. Testing on SauceLabs in done via the Karma test runner. Note that encrypted Sauce username and access key values need to be inserted into .travis.yml as global environment variables. Additionally, the local test runner (which is still useful for debugging tests and code) was updated to reflect that the 'node_modules' folder now gets placed in the root directory.
139 lines
5.3 KiB
Markdown
139 lines
5.3 KiB
Markdown
## noVNC: HTML5 VNC Client
|
|
|
|
[](https://travis-ci.org/kanaka/noVNC)
|
|
|
|
### 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](http://code.osuosl.org/projects/ganeti-webmgr),
|
|
[OpenStack](http://www.openstack.org),
|
|
[OpenNebula](http://opennebula.org/), and
|
|
[LibVNCServer](http://libvncserver.sourceforge.net). See [the Projects
|
|
and Companies wiki
|
|
page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC)
|
|
for a more complete list with additional info and links.
|
|
|
|
### News/help/contact
|
|
|
|
Notable commits, announcements and news are posted to
|
|
<a href="http://www.twitter.com/noVNC">@noVNC</a>
|
|
|
|
If you are a noVNC developer/integrator/user (or want to be) please
|
|
join the <a
|
|
href="https://groups.google.com/forum/?fromgroups#!forum/novnc">noVNC
|
|
discussion group</a>
|
|
|
|
Bugs and feature requests can be submitted via [github
|
|
issues](https://github.com/kanaka/noVNC/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"](https://github.com/kanaka/noVNC/issues?labels=patchwelcome).
|
|
|
|
If you want to show appreciation for noVNC you could donate to a great
|
|
non-profits such as: [Compassion
|
|
International](http://www.compassion.com/), [SIL](http://www.sil.org),
|
|
[Habitat for Humanity](http://www.habitat.org), [Electronic Frontier
|
|
Foundation](https://www.eff.org/), [Against Malaria
|
|
Foundation](http://www.againstmalaria.com/), [Nothing But
|
|
Nets](http://www.nothingbutnets.net/), etc. Please tweet <a
|
|
href="http://www.twitter.com/noVNC">@noVNC</a> 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](http://www.mozilla.org/MPL/2.0/)
|
|
|
|
### Screenshots
|
|
|
|
Running in Chrome before and after connecting:
|
|
|
|
<img src="http://kanaka.github.com/noVNC/img/noVNC-5.png" width=400> <img src="http://kanaka.github.com/noVNC/img/noVNC-7.jpg" width=400>
|
|
|
|
See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
|
|
|
|
|
|
### Browser Requirements
|
|
|
|
* HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS
|
|
Safari, Opera 11+, Internet Explorer 9+, etc.
|
|
|
|
* HTML5 WebSockets: For browsers that do not have builtin
|
|
WebSockets support, the project includes
|
|
<a href="http://github.com/gimite/web-socket-js">web-socket-js</a>,
|
|
a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in
|
|
WebSocket support.
|
|
|
|
* 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](https://github.com/kanaka/noVNC/wiki/Browser-support).
|
|
|
|
|
|
### Server Requirements
|
|
|
|
Unless you are using a VNC server with support for WebSockets
|
|
connections (such as
|
|
[x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
|
|
[QEMU](http://www.qemu.org/), or
|
|
[PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), 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
|
|
|
|
* [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections). How to setup websockify so that you can use encrypted connections from noVNC.
|
|
|
|
* [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Starting a VNC server, advanced websockify usage, etc.
|
|
|
|
* [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects.
|
|
|
|
* [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems.
|
|
|
|
|
|
### Authors/Contributors
|
|
|
|
* Core team:
|
|
* [Joel Martin](https://github.com/kanaka)
|
|
* [Samuel Mannehed](https://github.com/samhed) (Cendio)
|
|
* [Peter Åstrand](https://github.com/astrand) (Cendio)
|
|
* [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack)
|
|
|
|
* Notable contributions:
|
|
* UI and Icons : Chris Gordon
|
|
* Original Logo : Michael Sersen
|
|
* tight encoding : Michael Tinglof (Mercuri.ca)
|
|
|
|
* Included libraries:
|
|
* web-socket-js : Hiroshi Ichikawa (github.com/gimite/web-socket-js)
|
|
* as3crypto : Henri Torgemane (code.google.com/p/as3crypto)
|
|
* base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
|
|
* jsunzip : Erik Moller (github.com/operasoftware/jsunzip),
|
|
* tinflate : Joergen Ibsen (ibsensoftware.com)
|
|
* DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)
|