]> git.proxmox.com Git - mirror_novnc.git/blob - README.md
Update generated JS files for translations
[mirror_novnc.git] / README.md
1 ## noVNC: HTML VNC Client Library and Application
2
3 [![Build Status](https://travis-ci.org/novnc/noVNC.svg?branch=master)](https://travis-ci.org/novnc/noVNC)
4
5 ### Description
6
7 noVNC is both a HTML VNC client JavaScript library and an application built on
8 top of that library. noVNC runs well in any modern browser including mobile
9 browsers (iOS and Android).
10
11 Many companies, projects and products have integrated noVNC including
12 [OpenStack](http://www.openstack.org),
13 [OpenNebula](http://opennebula.org/),
14 [LibVNCServer](http://libvncserver.sourceforge.net), and
15 [ThinLinc](https://cendio.com/thinlinc). See
16 [the Projects and Companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC)
17 for a more complete list with additional info and links.
18
19 ### Table of Contents
20
21 - [News/help/contact](#newshelpcontact)
22 - [Features](#features)
23 - [Screenshots](#screenshots)
24 - [Browser Requirements](#browser-requirements)
25 - [Server Requirements](#server-requirements)
26 - [Quick Start](#quick-start)
27 - [Integration and Deployment](#integration-and-deployment)
28 - [Authors/Contributors](#authorscontributors)
29
30 ### News/help/contact
31
32 The project website is found at [novnc.com](http://novnc.com).
33 Notable commits, announcements and news are posted to
34 [@noVNC](http://www.twitter.com/noVNC).
35
36 If you are a noVNC developer/integrator/user (or want to be) please join the
37 [noVNC discussion group](https://groups.google.com/forum/?fromgroups#!forum/novnc).
38
39 Bugs and feature requests can be submitted via
40 [github issues](https://github.com/novnc/noVNC/issues). If you have questions
41 about using noVNC then please first use the
42 [discussion group](https://groups.google.com/forum/?fromgroups#!forum/novnc).
43 We also have a [wiki](https://github.com/novnc/noVNC/wiki/) with lots of
44 helpful information.
45
46 If you are looking for a place to start contributing to noVNC, a good place to
47 start would be the issues that are marked as
48 ["patchwelcome"](https://github.com/novnc/noVNC/issues?labels=patchwelcome).
49 Please check our
50 [contribution guide](https://github.com/novnc/noVNC/wiki/Contributing) though.
51
52 If you want to show appreciation for noVNC you could donate to a great non-
53 profits such as:
54 [Compassion International](http://www.compassion.com/),
55 [SIL](http://www.sil.org),
56 [Habitat for Humanity](http://www.habitat.org),
57 [Electronic Frontier Foundation](https://www.eff.org/),
58 [Against Malaria Foundation](http://www.againstmalaria.com/),
59 [Nothing But Nets](http://www.nothingbutnets.net/), etc.
60 Please tweet [@noVNC](http://www.twitter.com/noVNC) if you do.
61
62
63 ### Features
64
65 * Supports all modern browsers including mobile (iOS, Android)
66 * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
67 * Supports scaling, clipping and resizing the desktop
68 * Local cursor rendering
69 * Clipboard copy/paste
70 * Translations
71 * Licensed mainly under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/), see
72 [the license document](LICENSE.txt) for details
73
74 ### Screenshots
75
76 Running in Firefox before and after connecting:
77
78 <img src="http://novnc.com/img/noVNC-1-login.png" width=400>&nbsp;
79 <img src="http://novnc.com/img/noVNC-3-connected.png" width=400>
80
81 See more screenshots
82 [here](http://novnc.com/screenshots.html).
83
84
85 ### Browser Requirements
86
87 noVNC uses many modern web technologies so a formal requirement list is
88 not available. However these are the minimum versions we are currently
89 aware of:
90
91 * Chrome 49, Firefox 44, Safari 10, Opera 36, IE 11, Edge 12
92
93
94 ### Server Requirements
95
96 noVNC follows the standard VNC protocol, but unlike other VNC clients it does
97 require WebSockets support. Many servers include support (e.g.
98 [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
99 [QEMU](http://www.qemu.org/), and
100 [MobileVNC](http://www.smartlab.at/mobilevnc/)), but for the others you need to
101 use a WebSockets to TCP socket proxy. noVNC has a sister project
102 [websockify](https://github.com/novnc/websockify) that provides a simple such
103 proxy.
104
105
106 ### Quick Start
107
108 * Use the launch script to automatically download and start websockify, which
109 includes a mini-webserver and the WebSockets proxy. The `--vnc` option is
110 used to specify the location of a running VNC server:
111
112 `./utils/launch.sh --vnc localhost:5901`
113
114 * Point your browser to the cut-and-paste URL that is output by the launch
115 script. Hit the Connect button, enter a password if the VNC server has one
116 configured, and enjoy!
117
118
119 ### Integration and Deployment
120
121 Please see our other documents for how to integrate noVNC in your own software,
122 or deploying the noVNC application in production environments:
123
124 * [Embedding](docs/EMBEDDING.md) - For the noVNC application
125 * [Library](docs/LIBRARY.md) - For the noVNC JavaScript library
126
127
128 ### Authors/Contributors
129
130 See [AUTHORS](AUTHORS) for a (full-ish) list of authors. If you're not on
131 that list and you think you should be, feel free to send a PR to fix that.
132
133 * Core team:
134 * [Joel Martin](https://github.com/kanaka)
135 * [Samuel Mannehed](https://github.com/samhed) (Cendio)
136 * [Peter Åstrand](https://github.com/astrand) (Cendio)
137 * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack)
138 * [Pierre Ossman](https://github.com/CendioOssman) (Cendio)
139
140 * Notable contributions:
141 * UI and Icons : Pierre Ossman, Chris Gordon
142 * Original Logo : Michael Sersen
143 * tight encoding : Michael Tinglof (Mercuri.ca)
144
145 * Included libraries:
146 * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net)
147 * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs)
148 * Pako : Vitaly Puzrin (https://github.com/nodeca/pako)
149
150 Do you want to be on this list? Check out our
151 [contribution guide](https://github.com/novnc/noVNC/wiki/Contributing) and
152 start hacking!