]>
Commit | Line | Data |
---|---|---|
1 | ## noVNC: HTML5 VNC Client | |
2 | ||
3 | [![Build Status](https://travis-ci.org/kanaka/noVNC.svg?branch=master)](https://travis-ci.org/kanaka/noVNC) | |
4 | ||
5 | ### Description | |
6 | ||
7 | noVNC is a HTML5 VNC client that runs well in any modern browser including | |
8 | mobile browsers (iOS and Android). | |
9 | ||
10 | Many companies, projects and products have integrated noVNC including | |
11 | [Ganeti Web Manager](http://code.osuosl.org/projects/ganeti-webmgr), | |
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/kanaka/noVNC/wiki/Projects-and-companies-using-noVNC) | |
17 | for a more complete list with additional info and links. | |
18 | ||
19 | ### News/help/contact | |
20 | ||
21 | Notable commits, announcements and news are posted to | |
22 | <a href="http://www.twitter.com/noVNC">@noVNC</a>. | |
23 | ||
24 | If you are a noVNC developer/integrator/user (or want to be) please join the | |
25 | <a href="https://groups.google.com/forum/?fromgroups#!forum/novnc"> | |
26 | noVNC discussion group</a>. | |
27 | ||
28 | Bugs and feature requests can be submitted via | |
29 | [github issues](https://github.com/kanaka/noVNC/issues). | |
30 | If you are looking for a place to start contributing to noVNC, a good place to | |
31 | start would be the issues that are marked as | |
32 | ["patchwelcome"](https://github.com/kanaka/noVNC/issues?labels=patchwelcome). | |
33 | ||
34 | If you want to show appreciation for noVNC you could donate to a great non- | |
35 | profits such as: | |
36 | [Compassion International](http://www.compassion.com/), | |
37 | [SIL](http://www.sil.org), | |
38 | [Habitat for Humanity](http://www.habitat.org), | |
39 | [Electronic Frontier Foundation](https://www.eff.org/), | |
40 | [Against Malaria Foundation](http://www.againstmalaria.com/), | |
41 | [Nothing But Nets](http://www.nothingbutnets.net/), etc. | |
42 | Please tweet <a href="http://www.twitter.com/noVNC">@noVNC</a> if you do. | |
43 | ||
44 | ||
45 | ### Features | |
46 | ||
47 | * Supports all modern browsers including mobile (iOS, Android) | |
48 | * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG | |
49 | * WebSocket SSL/TLS encryption (i.e. "wss://") support | |
50 | * 24-bit true color and 8 bit colour mapped | |
51 | * Supports desktop resize notification/pseudo-encoding | |
52 | * Local or remote cursor | |
53 | * Clipboard copy/paste | |
54 | * Clipping or scolling modes for large remote screens | |
55 | * Easy site integration and theming (3 example themes included) | |
56 | * Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/) | |
57 | ||
58 | ### Screenshots | |
59 | ||
60 | Running in Chrome before and after connecting: | |
61 | ||
62 | <img src="http://kanaka.github.com/noVNC/img/noVNC-5.png" width=400> | |
63 | <img src="http://kanaka.github.com/noVNC/img/noVNC-7.jpg" width=400> | |
64 | ||
65 | See more screenshots | |
66 | <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>. | |
67 | ||
68 | ||
69 | ### Browser Requirements | |
70 | ||
71 | * Chrome 8, Firefox 4, Safari 6, Opera 12, IE 11, Edge 12, etc. | |
72 | ||
73 | * HTML5 Canvas, WebSockets and Typed Arrays | |
74 | ||
75 | * Fast Javascript Engine: this is not strictly a requirement, but without a | |
76 | fast Javascript engine, noVNC might be painfully slow. | |
77 | ||
78 | * See the more detailed | |
79 | [browser compatibility wiki page](https://github.com/kanaka/noVNC/wiki/Browser-support). | |
80 | ||
81 | ||
82 | ### Server Requirements | |
83 | ||
84 | Unless you are using a VNC server with support for WebSockets connections (such | |
85 | as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/), | |
86 | [QEMU](http://www.qemu.org/), or | |
87 | [PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), you need to use a | |
88 | WebSockets to TCP socket proxy. There is a python proxy included | |
89 | ('websockify'). | |
90 | ||
91 | ||
92 | ### Quick Start | |
93 | ||
94 | * Use the launch script to start a mini-webserver and the WebSockets proxy | |
95 | (websockify). The `--vnc` option is used to specify the location of a running | |
96 | VNC server: | |
97 | ||
98 | `./utils/launch.sh --vnc localhost:5901` | |
99 | ||
100 | * Point your browser to the cut-and-paste URL that is output by the launch | |
101 | script. Enter a password if the VNC server has one configured. Hit the | |
102 | Connect button and enjoy! | |
103 | ||
104 | ||
105 | ### Other Pages | |
106 | ||
107 | * [Modules/API](https://github.com/kanaka/noVNC/wiki/Modules-API) - The library | |
108 | modules and their Javascript API. | |
109 | ||
110 | * [Integration](https://github.com/kanaka/noVNC/wiki/Integration) - Get noVNC | |
111 | to work in existing projects. | |
112 | ||
113 | * [Troubleshooting](https://github.com/kanaka/noVNC/wiki/Troubleshooting) - How | |
114 | to troubleshoot problems. | |
115 | ||
116 | * [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections) - | |
117 | Setup websockify so that you can use encrypted connections from noVNC. | |
118 | ||
119 | * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage) - | |
120 | Generating an SSL certificate, starting a VNC server, advanced websockify | |
121 | usage, etc. | |
122 | ||
123 | * [Testing](https://github.com/kanaka/noVNC/wiki/Testing) - Run and write | |
124 | tests. | |
125 | ||
126 | * [Translations](https://github.com/kanaka/noVNC/wiki/Translations) - Add and | |
127 | modify localization for JavaScript and HTML. | |
128 | ||
129 | ||
130 | ### Authors/Contributors | |
131 | ||
132 | * Core team: | |
133 | * [Joel Martin](https://github.com/kanaka) | |
134 | * [Samuel Mannehed](https://github.com/samhed) (Cendio) | |
135 | * [Peter Åstrand](https://github.com/astrand) (Cendio) | |
136 | * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack) | |
137 | ||
138 | * Notable contributions: | |
139 | * UI and Icons : Pierre Ossman, Chris Gordon | |
140 | * Original Logo : Michael Sersen | |
141 | * tight encoding : Michael Tinglof (Mercuri.ca) | |
142 | ||
143 | * Included libraries: | |
144 | * as3crypto : Henri Torgemane (code.google.com/p/as3crypto) | |
145 | * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net) | |
146 | * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs) | |
147 | * Pako : Vitaly Puzrin (https://github.com/nodeca/pako) | |
148 | ||
149 | * [Contribution guide](https://github.com/kanaka/noVNC/wiki/Contributing) |