X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=README.md;h=23dc5c303eb5a32ec91a404f9188c7aef03aed94;hb=be8580558cceb990c641bbc021b6818b971781c8;hp=2a0d89b2e4be7ae6a48dd6db5aabe250873fc8a5;hpb=4529ec0176880c658f3d44f12dc8b4daff77f75b;p=mirror_novnc.git diff --git a/README.md b/README.md index 2a0d89b..23dc5c3 100644 --- a/README.md +++ b/README.md @@ -1,114 +1,149 @@ -## noVNC: HTML5 VNC Client +## noVNC: HTML VNC Client Library and Application +[![Build Status](https://travis-ci.org/novnc/noVNC.svg?branch=master)](https://travis-ci.org/novnc/noVNC) ### Description -noVNC is a VNC client implemented using HTML5 technologies, -specifically Canvas and WebSockets (supports 'wss://' encryption). -noVNC is licensed under the -[LGPLv3](http://www.gnu.org/licenses/lgpl.html). +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). -Special thanks to [Sentry Data Systems](http://www.sentryds.com) for -sponsoring ongoing development of this project (and for employing me). +Many companies, projects and products have integrated noVNC including +[OpenStack](http://www.openstack.org), +[OpenNebula](http://opennebula.org/), +[LibVNCServer](http://libvncserver.sourceforge.net), and +[ThinLinc](https://cendio.com/thinlinc). See +[the Projects and Companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC) +for a more complete list with additional info and links. -Notable commits, announcements and news are posted to -@noVNC - - -### Screenshots +### Table of Contents -Running in Chrome before and after connecting: +- [News/help/contact](#newshelpcontact) +- [Features](#features) +- [Screenshots](#screenshots) +- [Browser Requirements](#browser-requirements) +- [Server Requirements](#server-requirements) +- [Quick Start](#quick-start) +- [Integration and Deployment](#integration-and-deployment) +- [Authors/Contributors](#authorscontributors) -  +### News/help/contact -See more screenshots here. - - -### Projects/Companies using noVNC - -* [Sentry Data Systems](http://www.sentryds.com): uses noVNC in the - [Datanex Cloud Computing Platform](http://www.sentryds.com/products/datanex/). +The project website is found at [novnc.com](http://novnc.com). +Notable commits, announcements and news are posted to +[@noVNC](http://www.twitter.com/noVNC). + +If you are a noVNC developer/integrator/user (or want to be) please join the +[noVNC discussion group](https://groups.google.com/forum/?fromgroups#!forum/novnc). + +Bugs and feature requests can be submitted via +[github issues](https://github.com/novnc/noVNC/issues). If you have questions +about using noVNC then please first use the +[discussion group](https://groups.google.com/forum/?fromgroups#!forum/novnc). +We also have a [wiki](https://github.com/novnc/noVNC/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"](https://github.com/novnc/noVNC/issues?labels=patchwelcome). +Please check our +[contribution guide](https://github.com/novnc/noVNC/wiki/Contributing) though. + +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 [@noVNC](http://www.twitter.com/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 +* Licensed mainly under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/), see + [the license document](LICENSE.txt) for details -* [Ganeti Web Manager](http://code.osuosl.org/projects/ganeti-webmgr): - Feature [#1935](http://code.osuosl.org/issues/1935). +### Screenshots -* [Archipel](http://archipelproject.org): - [Video demo](http://antoinemercadal.fr/archipelblog/wp-content/themes/ArchipelWPTemplate/video_youtube.php?title=VNC%20Demonstration&id=te_bzW574Zo) +Running in Firefox before and after connecting: -* [openQRM](http://www.openqrm.com/): VNC plugin available - by request. Probably included in [version - 4.8](http://www.openqrm.com/?q=node/15). [Video - demo](http://www.openqrm-enterprise.com/news/details/article/remote-vm-console-plugin-available.html). +  + -* [OpenNode](http://www.opennodecloud.com/): uses noVNC in - [OpenNode Management Console](http://opennode.activesys.org/about/software-included-in-opennode/). - [OMC Screencast](http://opennode.activesys.org/about/opennode-management-console-screencast/). +See more screenshots +[here](http://novnc.com/screenshots.html). -* [OpenStack](http://www.openstack.org): uses noVNC in Cactus release - of [OpenStack Compute (Nova)](http://nova.openstack.org/runnova/vncconsole.html). - [OpenStack Screencast](http://player.vimeo.com/video/20787736?autoplay=1) with noVNC shown at about 2:17. ### Browser Requirements -* HTML5 Canvas: Except for Internet Explorer, most - browsers have had Canvas support for quite some time. Internet - Explorer 9 will have Canvas support (finally). - -* HTML5 WebSockets: For browsers that do not have builtin - WebSockets support, the project includes - web-socket-js, - a WebSockets emulator using Adobe Flash. +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: -* Fast Javascript Engine: noVNC avoids using new Javascript - functionality so it will run on older browsers, but decode and - rendering happen in Javascript, so a slow Javascript engine will - mean noVNC is painfully slow. - -* I maintain a more detailed list of browser compatibility here. +* Chrome 49, Firefox 44, Safari 10, Opera 36, IE 11, Edge 12 ### Server Requirements -Unless you are using a VNC server with support for WebSockets -connections (only my [fork of libvncserver](http://github.com/kanaka/libvncserver) -currently), you need to use a WebSockets to TCP socket proxy. There is -a python proxy included ('websockify'). One advantage of using the -proxy is that it has builtin support for SSL/TLS encryption (i.e. -"wss://"). +noVNC follows the standard VNC protocol, but unlike other VNC clients it does +require WebSockets support. Many servers include support (e.g. +[x11vnc/libvncserver](http://libvncserver.sourceforge.net/), +[QEMU](http://www.qemu.org/), and +[MobileVNC](http://www.smartlab.at/mobilevnc/)), but for the others you need to +use a WebSockets to TCP socket proxy. noVNC has a sister project +[websockify](https://github.com/novnc/websockify) that provides a simple such +proxy. -There a few reasons why a proxy is required: - 1. WebSockets is not a pure socket protocol. There is an initial HTTP - like handshake to allow easy hand-off by web servers and allow - some origin policy exchange. Also, each WebSockets frame begins - with 0 ('\x00') and ends with 255 ('\xff'). +### Quick Start - 2. Javascript itself does not have the ability to handle pure byte - arrays. The python proxy encodes the data as base64 so that the - Javascript client can decode the data as an integer array. +* 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` -### Quick Start +* 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! -* 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` +### Integration and Deployment -* 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! +Please see our other documents for how to integrate noVNC in your own software, +or deploying the noVNC application in production environments: +* [Embedding](docs/EMBEDDING.md) - For the noVNC application +* [Library](docs/LIBRARY.md) - For the noVNC JavaScript library -### Other Pages -* [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Generating an SSL - certificate, starting a VNC server, advanced websockify usage, etc. +### Authors/Contributors -* [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects. +* 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) + * [Pierre Ossman](https://github.com/CendioOssman) (Cendio) -* [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems. +* Notable contributions: + * UI and Icons : Pierre Ossman, 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) +Do you want to be on this list? Check out our +[contribution guide](https://github.com/novnc/noVNC/wiki/Contributing) and +start hacking!