]>
Commit | Line | Data |
---|---|---|
5ba1dd78 | 1 | ## noVNC: HTML5 VNC Client |
5aeb9880 | 2 | |
5911cfd5 | 3 | [![Build Status](https://travis-ci.org/novnc/noVNC.svg?branch=master)](https://travis-ci.org/novnc/noVNC) |
5aeb9880 | 4 | |
5ba1dd78 | 5 | ### Description |
5aeb9880 | 6 | |
0f725a30 SM |
7 | noVNC is a HTML5 VNC client that runs well in any modern browser including |
8 | mobile browsers (iOS and Android). | |
a538be43 | 9 | |
0f725a30 SM |
10 | Many companies, projects and products have integrated noVNC including |
11 | [Ganeti Web Manager](http://code.osuosl.org/projects/ganeti-webmgr), | |
f901d9c9 | 12 | [OpenStack](http://www.openstack.org), |
0f725a30 SM |
13 | [OpenNebula](http://opennebula.org/), |
14 | [LibVNCServer](http://libvncserver.sourceforge.net), and | |
b55bfcf0 | 15 | [ThinLinc](https://cendio.com/thinlinc). See |
5911cfd5 | 16 | [the Projects and Companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC) |
f901d9c9 | 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 |
b55bfcf0 | 22 | <a href="http://www.twitter.com/noVNC">@noVNC</a>. |
5aeb9880 | 23 | |
b55bfcf0 SM |
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>. | |
cbb55df0 | 27 | |
b55bfcf0 | 28 | Bugs and feature requests can be submitted via |
5911cfd5 | 29 | [github issues](https://github.com/novnc/noVNC/issues). |
b55bfcf0 SM |
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 | |
5911cfd5 | 32 | ["patchwelcome"](https://github.com/novnc/noVNC/issues?labels=patchwelcome). |
cbb55df0 | 33 | |
b55bfcf0 SM |
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. | |
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 | |
5911cfd5 SM |
62 | <img src="http:// |
63 | .github.com/noVNC/img/noVNC-5.png" width=400> | |
64 | <img src="http://novnc.github.com/noVNC/img/noVNC-7.jpg" width=400> | |
5aeb9880 | 65 | |
b55bfcf0 | 66 | See more screenshots |
5911cfd5 | 67 | <a href="http://novnc.github.com/noVNC/screenshots.html">here</a>. |
852ba642 JM |
68 | |
69 | ||
6de07adb JM |
70 | ### Browser Requirements |
71 | ||
4cb91c42 | 72 | * Chrome 8, Firefox 4, Safari 6, Opera 12, IE 11, Edge 12, etc. |
6de07adb | 73 | |
4cb91c42 | 74 | * HTML5 Canvas, WebSockets and Typed Arrays |
6de07adb | 75 | |
b55bfcf0 SM |
76 | * Fast Javascript Engine: this is not strictly a requirement, but without a |
77 | fast Javascript engine, noVNC might be painfully slow. | |
6de07adb | 78 | |
b55bfcf0 | 79 | * See the more detailed |
5911cfd5 | 80 | [browser compatibility wiki page](https://github.com/novnc/noVNC/wiki/Browser-support). |
d4139a9b JM |
81 | |
82 | ||
6de07adb | 83 | ### Server Requirements |
5aeb9880 | 84 | |
b55bfcf0 SM |
85 | Unless you are using a VNC server with support for WebSockets connections (such |
86 | as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/), | |
f901d9c9 | 87 | [QEMU](http://www.qemu.org/), or |
adc19ca1 | 88 | [TigerVNC](http://tigervnc.org/)), you need to use a |
b55bfcf0 | 89 | WebSockets to TCP socket proxy. There is a python proxy included |
f901d9c9 | 90 | ('websockify'). |
5aeb9880 | 91 | |
5aeb9880 | 92 | |
b89c6db3 | 93 | ### Quick Start |
5aeb9880 | 94 | |
b55bfcf0 SM |
95 | * Use the launch script to start a mini-webserver and the WebSockets proxy |
96 | (websockify). The `--vnc` option is used to specify the location of a running | |
97 | VNC server: | |
b89c6db3 JM |
98 | |
99 | `./utils/launch.sh --vnc localhost:5901` | |
100 | ||
b55bfcf0 SM |
101 | * Point your browser to the cut-and-paste URL that is output by the launch |
102 | script. Enter a password if the VNC server has one configured. Hit the | |
103 | Connect button and enjoy! | |
b89c6db3 JM |
104 | |
105 | ||
9df83a39 | 106 | ### Other Pages |
5aeb9880 | 107 | |
5911cfd5 | 108 | * [Modules/API](https://github.com/novnc/noVNC/wiki/Modules-API) - The library |
7629b03e | 109 | modules and their Javascript API. |
57044a3c | 110 | |
5911cfd5 | 111 | * [Integration](https://github.com/novnc/noVNC/wiki/Integration) - Get noVNC |
7629b03e | 112 | to work in existing projects. |
a4807656 | 113 | |
5911cfd5 | 114 | * [Troubleshooting](https://github.com/novnc/noVNC/wiki/Troubleshooting) - How |
7629b03e | 115 | to troubleshoot problems. |
a4807656 | 116 | |
5911cfd5 | 117 | * [Encrypted Connections](https://github.com/novnc/websockify/wiki/Encrypted-Connections) - |
7629b03e SM |
118 | Setup websockify so that you can use encrypted connections from noVNC. |
119 | ||
5911cfd5 | 120 | * [Advanced Usage](https://github.com/novnc/noVNC/wiki/Advanced-usage) - |
7629b03e SM |
121 | Generating an SSL certificate, starting a VNC server, advanced websockify |
122 | usage, etc. | |
123 | ||
5911cfd5 | 124 | * [Testing](https://github.com/novnc/noVNC/wiki/Testing) - Run and write |
7629b03e SM |
125 | tests. |
126 | ||
5911cfd5 | 127 | * [Translations](https://github.com/novnc/noVNC/wiki/Translations) - Add and |
7629b03e | 128 | modify localization for JavaScript and HTML. |
b89c6db3 | 129 | |
0af07711 | 130 | |
b8dd87c7 JM |
131 | ### Authors/Contributors |
132 | ||
f901d9c9 JM |
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) | |
41f476a8 | 138 | * [Pierre Ossman](https://github.com/CendioOssman) (Cendio) |
f901d9c9 JM |
139 | |
140 | * Notable contributions: | |
32ec8f32 | 141 | * UI and Icons : Pierre Ossman, Chris Gordon |
b8dd87c7 JM |
142 | * Original Logo : Michael Sersen |
143 | * tight encoding : Michael Tinglof (Mercuri.ca) | |
144 | ||
145 | * Included libraries: | |
b8dd87c7 JM |
146 | * as3crypto : Henri Torgemane (code.google.com/p/as3crypto) |
147 | * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net) | |
b8dd87c7 | 148 | * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs) |
6940936f | 149 | * Pako : Vitaly Puzrin (https://github.com/nodeca/pako) |
7629b03e | 150 | |
5911cfd5 | 151 | * [Contribution guide](https://github.com/novnc/noVNC/wiki/Contributing) |