]>
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 | 10 | Many companies, projects and products have integrated noVNC including |
f901d9c9 | 11 | [OpenStack](http://www.openstack.org), |
0f725a30 SM |
12 | [OpenNebula](http://opennebula.org/), |
13 | [LibVNCServer](http://libvncserver.sourceforge.net), and | |
b55bfcf0 | 14 | [ThinLinc](https://cendio.com/thinlinc). See |
5911cfd5 | 15 | [the Projects and Companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC) |
f901d9c9 | 16 | for a more complete list with additional info and links. |
cbb55df0 JM |
17 | |
18 | ### News/help/contact | |
19 | ||
395c6f60 | 20 | The project website is found at [novnc.com](http://novnc.com). |
bc715065 | 21 | Notable commits, announcements and news are posted to |
544106c5 | 22 | [@noVNC](http://www.twitter.com/noVNC). |
5aeb9880 | 23 | |
b55bfcf0 | 24 | If you are a noVNC developer/integrator/user (or want to be) please join the |
544106c5 | 25 | [noVNC discussion group](https://groups.google.com/forum/?fromgroups#!forum/novnc). |
cbb55df0 | 26 | |
b55bfcf0 | 27 | Bugs and feature requests can be submitted via |
5911cfd5 | 28 | [github issues](https://github.com/novnc/noVNC/issues). |
b55bfcf0 SM |
29 | If you are looking for a place to start contributing to noVNC, a good place to |
30 | start would be the issues that are marked as | |
5911cfd5 | 31 | ["patchwelcome"](https://github.com/novnc/noVNC/issues?labels=patchwelcome). |
cbb55df0 | 32 | |
b55bfcf0 SM |
33 | If you want to show appreciation for noVNC you could donate to a great non- |
34 | profits such as: | |
35 | [Compassion International](http://www.compassion.com/), | |
36 | [SIL](http://www.sil.org), | |
37 | [Habitat for Humanity](http://www.habitat.org), | |
38 | [Electronic Frontier Foundation](https://www.eff.org/), | |
39 | [Against Malaria Foundation](http://www.againstmalaria.com/), | |
40 | [Nothing But Nets](http://www.nothingbutnets.net/), etc. | |
544106c5 | 41 | Please tweet [@noVNC](http://www.twitter.com/noVNC) 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 | ||
69300d3c | 59 | Running in Firefox before and after connecting: |
600887f0 | 60 | |
69300d3c SM |
61 | <img src="http://novnc.com/img/noVNC-1-login.png" width=400> |
62 | <img src="http://novnc.com/img/noVNC-3-connected.png" width=400> | |
5aeb9880 | 63 | |
b55bfcf0 | 64 | See more screenshots |
544106c5 | 65 | [here](http://novnc.com/screenshots.html). |
852ba642 JM |
66 | |
67 | ||
6de07adb JM |
68 | ### Browser Requirements |
69 | ||
4cb91c42 | 70 | * Chrome 8, Firefox 4, Safari 6, Opera 12, IE 11, Edge 12, etc. |
6de07adb | 71 | |
4cb91c42 | 72 | * HTML5 Canvas, WebSockets and Typed Arrays |
6de07adb | 73 | |
b55bfcf0 SM |
74 | * Fast Javascript Engine: this is not strictly a requirement, but without a |
75 | fast Javascript engine, noVNC might be painfully slow. | |
6de07adb | 76 | |
b55bfcf0 | 77 | * See the more detailed |
5911cfd5 | 78 | [browser compatibility wiki page](https://github.com/novnc/noVNC/wiki/Browser-support). |
d4139a9b JM |
79 | |
80 | ||
6de07adb | 81 | ### Server Requirements |
5aeb9880 | 82 | |
b55bfcf0 SM |
83 | Unless you are using a VNC server with support for WebSockets connections (such |
84 | as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/), | |
f901d9c9 | 85 | [QEMU](http://www.qemu.org/), or |
7d73fdf9 | 86 | [MobileVNC](http://www.smartlab.at/mobilevnc/)), you need to use a |
b55bfcf0 | 87 | WebSockets to TCP socket proxy. There is a python proxy included |
f901d9c9 | 88 | ('websockify'). |
5aeb9880 | 89 | |
5aeb9880 | 90 | |
b89c6db3 | 91 | ### Quick Start |
5aeb9880 | 92 | |
b55bfcf0 SM |
93 | * Use the launch script to start a mini-webserver and the WebSockets proxy |
94 | (websockify). The `--vnc` option is used to specify the location of a running | |
95 | VNC server: | |
b89c6db3 JM |
96 | |
97 | `./utils/launch.sh --vnc localhost:5901` | |
98 | ||
b55bfcf0 SM |
99 | * Point your browser to the cut-and-paste URL that is output by the launch |
100 | script. Enter a password if the VNC server has one configured. Hit the | |
101 | Connect button and enjoy! | |
b89c6db3 JM |
102 | |
103 | ||
9df83a39 | 104 | ### Other Pages |
5aeb9880 | 105 | |
fc64213c | 106 | * [Modules/API](https://github.com/novnc/noVNC/blob/master/docs/API.md) - The library |
7629b03e | 107 | modules and their Javascript API. |
57044a3c | 108 | |
5911cfd5 | 109 | * [Integration](https://github.com/novnc/noVNC/wiki/Integration) - Get noVNC |
7629b03e | 110 | to work in existing projects. |
a4807656 | 111 | |
5911cfd5 | 112 | * [Troubleshooting](https://github.com/novnc/noVNC/wiki/Troubleshooting) - How |
7629b03e | 113 | to troubleshoot problems. |
a4807656 | 114 | |
5911cfd5 | 115 | * [Encrypted Connections](https://github.com/novnc/websockify/wiki/Encrypted-Connections) - |
7629b03e SM |
116 | Setup websockify so that you can use encrypted connections from noVNC. |
117 | ||
5911cfd5 | 118 | * [Advanced Usage](https://github.com/novnc/noVNC/wiki/Advanced-usage) - |
7629b03e SM |
119 | Generating an SSL certificate, starting a VNC server, advanced websockify |
120 | usage, etc. | |
121 | ||
5911cfd5 | 122 | * [Testing](https://github.com/novnc/noVNC/wiki/Testing) - Run and write |
7629b03e SM |
123 | tests. |
124 | ||
5911cfd5 | 125 | * [Translations](https://github.com/novnc/noVNC/wiki/Translations) - Add and |
7629b03e | 126 | modify localization for JavaScript and HTML. |
b89c6db3 | 127 | |
0af07711 | 128 | |
b8dd87c7 JM |
129 | ### Authors/Contributors |
130 | ||
f901d9c9 JM |
131 | * Core team: |
132 | * [Joel Martin](https://github.com/kanaka) | |
133 | * [Samuel Mannehed](https://github.com/samhed) (Cendio) | |
134 | * [Peter Åstrand](https://github.com/astrand) (Cendio) | |
135 | * [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack) | |
41f476a8 | 136 | * [Pierre Ossman](https://github.com/CendioOssman) (Cendio) |
f901d9c9 JM |
137 | |
138 | * Notable contributions: | |
32ec8f32 | 139 | * UI and Icons : Pierre Ossman, Chris Gordon |
b8dd87c7 JM |
140 | * Original Logo : Michael Sersen |
141 | * tight encoding : Michael Tinglof (Mercuri.ca) | |
142 | ||
143 | * Included libraries: | |
b8dd87c7 JM |
144 | * as3crypto : Henri Torgemane (code.google.com/p/as3crypto) |
145 | * base64 : Martijn Pieters (Digital Creations 2), Samuel Sieb (sieb.net) | |
b8dd87c7 | 146 | * DES : Dave Zimmerman (Widget Workshop), Jef Poskanzer (ACME Labs) |
6940936f | 147 | * Pako : Vitaly Puzrin (https://github.com/nodeca/pako) |
7629b03e | 148 | |
5911cfd5 | 149 | * [Contribution guide](https://github.com/novnc/noVNC/wiki/Contributing) |