]>
Commit | Line | Data |
---|---|---|
5ba1dd78 | 1 | ## noVNC: HTML5 VNC Client |
5aeb9880 JM |
2 | |
3 | ||
5ba1dd78 | 4 | ### Description |
5aeb9880 | 5 | |
a538be43 JM |
6 | noVNC is a HTML5 VNC client that runs well in any modern browser |
7 | including mobile browsers (iPhone/iPad and Android). | |
8 | ||
f901d9c9 | 9 | Many companies/projects have integrated noVNC including [Ganeti Web |
cbb55df0 | 10 | Manager](http://code.osuosl.org/projects/ganeti-webmgr), |
f901d9c9 JM |
11 | [OpenStack](http://www.openstack.org), |
12 | [OpenNebula](http://opennebula.org/), and | |
13 | [LibVNCServer](http://libvncserver.sourceforge.net). See [the Projects | |
14 | and Companies wiki | |
15 | page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC) | |
16 | for a more complete list with additional info and links. | |
cbb55df0 JM |
17 | |
18 | ### News/help/contact | |
19 | ||
bc715065 | 20 | Notable commits, announcements and news are posted to |
f901d9c9 | 21 | <a href="http://www.twitter.com/noVNC">@noVNC</a> |
5aeb9880 | 22 | |
cbb55df0 JM |
23 | If you are a noVNC developer/integrator/user (or want to be) please |
24 | join the <a | |
25 | href="https://groups.google.com/forum/?fromgroups#!forum/novnc">noVNC | |
26 | discussion group</a> | |
27 | ||
28 | Bugs and feature requests can be submitted via [github | |
29 | issues](https://github.com/kanaka/noVNC/issues). If you are looking | |
30 | for a place to start contributing to noVNC, a good place to start | |
f901d9c9 | 31 | would be the issues that are have marked as |
cbb55df0 JM |
32 | ["patchwelcome"](https://github.com/kanaka/noVNC/issues?labels=patchwelcome). |
33 | ||
f901d9c9 JM |
34 | If you want to show appreciation for noVNC you could donate to a great |
35 | non-profits such as: [Compassion | |
cbb55df0 JM |
36 | International](http://www.compassion.com/), [SIL](http://www.sil.org), |
37 | [Habitat for Humanity](http://www.habitat.org), [Electronic Frontier | |
38 | Foundation](https://www.eff.org/), [Against Malaria | |
39 | Foundation](http://www.againstmalaria.com/), [Nothing But | |
f901d9c9 JM |
40 | Nets](http://www.nothingbutnets.net/), etc. Please tweet <a |
41 | href="http://www.twitter.com/noVNC">@noVNC</a> if you do. | |
68edd7f4 | 42 | |
bc715065 JM |
43 | |
44 | ### Features | |
45 | ||
46 | * Supports all modern browsers including mobile (iOS, Android) | |
b8dd87c7 | 47 | * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG |
bc715065 JM |
48 | * WebSocket SSL/TLS encryption (i.e. "wss://") support |
49 | * 24-bit true color and 8 bit colour mapped | |
50 | * Supports desktop resize notification/pseudo-encoding | |
51 | * Local or remote cursor | |
52 | * Clipboard copy/paste | |
53 | * Clipping or scolling modes for large remote screens | |
54 | * Easy site integration and theming (3 example themes included) | |
1d728ace | 55 | * Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/) |
bc715065 | 56 | |
852ba642 JM |
57 | ### Screenshots |
58 | ||
e5517ecd | 59 | Running in Chrome before and after connecting: |
600887f0 | 60 | |
65db2d82 | 61 | <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> |
5aeb9880 | 62 | |
852ba642 JM |
63 | See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>. |
64 | ||
65 | ||
6de07adb JM |
66 | ### Browser Requirements |
67 | ||
b29e06f3 JM |
68 | * HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS |
69 | Safari, Opera 11+, Internet Explorer 9+, etc. | |
6de07adb JM |
70 | |
71 | * HTML5 WebSockets: For browsers that do not have builtin | |
72 | WebSockets support, the project includes | |
73 | <a href="http://github.com/gimite/web-socket-js">web-socket-js</a>, | |
b29e06f3 JM |
74 | a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in |
75 | WebSocket support. | |
6de07adb | 76 | |
a367e84a JM |
77 | * Fast Javascript Engine: this is not strictly a requirement, but |
78 | without a fast Javascript engine, noVNC might be painfully slow. | |
6de07adb | 79 | |
f901d9c9 | 80 | * See the more detailed [browser compatibility wiki page](https://github.com/kanaka/noVNC/wiki/Browser-support). |
d4139a9b JM |
81 | |
82 | ||
6de07adb | 83 | ### Server Requirements |
5aeb9880 | 84 | |
b89c6db3 | 85 | Unless you are using a VNC server with support for WebSockets |
f901d9c9 JM |
86 | connections (such as |
87 | [x11vnc/libvncserver](http://libvncserver.sourceforge.net/), | |
88 | [QEMU](http://www.qemu.org/), or | |
89 | [PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), you need to | |
90 | use a WebSockets to TCP socket proxy. There is a python proxy included | |
91 | ('websockify'). | |
5aeb9880 | 92 | |
5aeb9880 | 93 | |
b89c6db3 | 94 | ### Quick Start |
5aeb9880 | 95 | |
b89c6db3 | 96 | * Use the launch script to start a mini-webserver and the WebSockets |
9df83a39 | 97 | proxy (websockify). The `--vnc` option is used to specify the location of |
b89c6db3 JM |
98 | a running VNC server: |
99 | ||
100 | `./utils/launch.sh --vnc localhost:5901` | |
101 | ||
102 | * Point your browser to the cut-and-paste URL that is output by the | |
103 | launch script. Enter a password if the VNC server has one | |
104 | configured. Hit the Connect button and enjoy! | |
105 | ||
106 | ||
9df83a39 | 107 | ### Other Pages |
5aeb9880 | 108 | |
57044a3c JM |
109 | * [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections). How to setup websockify so that you can use encrypted connections from noVNC. |
110 | ||
111 | * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Starting a VNC server, advanced websockify usage, etc. | |
a4807656 | 112 | |
667ef9ba | 113 | * [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects. |
a4807656 | 114 | |
667ef9ba | 115 | * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems. |
b89c6db3 | 116 | |
0af07711 | 117 | |
b8dd87c7 JM |
118 | ### Authors/Contributors |
119 | ||
f901d9c9 JM |
120 | * Core team: |
121 | * [Joel Martin](https://github.com/kanaka) | |
122 | * [Samuel Mannehed](https://github.com/samhed) (Cendio) | |
123 | * [Peter Åstrand](https://github.com/astrand) (Cendio) | |
124 | * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack) | |
125 | ||
126 | * Notable contributions: | |
cbb55df0 | 127 | * UI and Icons : Chris Gordon |
b8dd87c7 JM |
128 | * Original Logo : Michael Sersen |
129 | * tight encoding : Michael Tinglof (Mercuri.ca) | |
130 | ||
131 | * Included libraries: | |
132 | * web-socket-js : Hiroshi Ichikawa (github.com/gimite/web-socket-js) | |
133 | * as3crypto : Henri Torgemane (code.google.com/p/as3crypto) | |
134 | * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net) | |
135 | * jsunzip : Erik Moller (github.com/operasoftware/jsunzip), | |
136 | * tinflate : Joergen Ibsen (ibsensoftware.com) | |
137 | * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs) |