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