X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=README.md;h=b695d05c465827d2955d82f984cba955f70e254d;hb=b8d1a8bb57c0e1bff08ea5df2c62b9479ce49d02;hp=25b3dafd5ff20a69058f26a6db797f0b2f0f1344;hpb=b55bfcf04b37d6343212ae7d5e69d0500ddf0a64;p=mirror_novnc.git diff --git a/README.md b/README.md index 25b3daf..b695d05 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,54 @@ -## noVNC: HTML5 VNC Client +## noVNC: HTML VNC Client Library and Application -[![Build Status](https://travis-ci.org/kanaka/noVNC.svg?branch=master)](https://travis-ci.org/kanaka/noVNC) +[![Build Status](https://travis-ci.org/novnc/noVNC.svg?branch=master)](https://travis-ci.org/novnc/noVNC) ### Description -noVNC is a HTML5 VNC client that runs well in any modern browser including -mobile browsers (iOS and Android). +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 -[Ganeti Web Manager](http://code.osuosl.org/projects/ganeti-webmgr), [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/kanaka/noVNC/wiki/Projects-and-companies-using-noVNC) +[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. +### Table of Contents + +- [News/help/contact](#newshelpcontact) +- [Features](#features) +- [Screenshots](#screenshots) +- [Browser Requirements](#browser-requirements) +- [Server Requirements](#server-requirements) +- [Quick Start](#quick-start) +- [Installation from Snap Package](#installation-from-snap-package) +- [Integration and Deployment](#integration-and-deployment) +- [Authors/Contributors](#authorscontributors) + ### News/help/contact +The project website is found at [novnc.com](http://novnc.com). Notable commits, announcements and news are posted to -@noVNC. +[@noVNC](http://www.twitter.com/noVNC). If you are a noVNC developer/integrator/user (or want to be) please join the - -noVNC discussion group. +[noVNC discussion group](https://groups.google.com/forum/?fromgroups#!forum/novnc). Bugs and feature requests can be submitted via -[github issues](https://github.com/kanaka/noVNC/issues). +[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/kanaka/noVNC/issues?labels=patchwelcome). +["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: @@ -39,91 +58,144 @@ profits such as: [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 if you do. +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 -* 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 +* Supports scaling, clipping and resizing the desktop +* Local cursor rendering * 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/) +* Translations +* Licensed mainly under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/), see + [the license document](LICENSE.txt) for details ### Screenshots -Running in Chrome before and after connecting: +Running in Firefox before and after connecting: -  - +  + See more screenshots -here. +[here](http://novnc.com/screenshots.html). ### Browser Requirements -* Chrome 8, Firefox 4, Safari 6, Opera 12, IE 11, Edge 12, etc. +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: -* HTML5 Canvas, WebSockets and Typed Arrays - -* 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). +* Chrome 49, Firefox 44, Safari 11, Opera 36, IE 11, Edge 12 ### 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'). +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. ### 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: +* 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. Enter a password if the VNC server has one configured. Hit the - Connect button and enjoy! + 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): -### Other Pages +``` +sudo snap get novnc services +Key Value +services.n6080 {...} +services.n6081 {...} +``` -* [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections) - - How to setup websockify so that you can use encrypted connections from noVNC. +Create a new service that listens on port 6082 and connects to the VNC server +running on port 5902 on localhost: -* [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage) - - Starting a VNC server, advanced websockify usage, etc. +`sudo snap set novnc services.n6082.listen=6082 services.n6082.vnc=localhost:5902` -* [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into - existing projects. +(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. -* [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) - problems. +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](docs/EMBEDDING.md) - For the noVNC application +* [Library](docs/LIBRARY.md) - For the noVNC JavaScript library ### Authors/Contributors +See [AUTHORS](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: * [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) * Notable contributions: * UI and Icons : Pierre Ossman, Chris Gordon @@ -131,7 +203,10 @@ WebSockets to TCP socket proxy. There is a python proxy included * 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!