]>
Commit | Line | Data |
---|---|---|
5ba1dd78 | 1 | ## noVNC: HTML5 VNC Client |
5aeb9880 JM |
2 | |
3 | ||
5ba1dd78 | 4 | ### Description |
5aeb9880 | 5 | |
71d2426a | 6 | noVNC is a VNC client implemented using HTML5 technologies, |
b89c6db3 | 7 | specifically Canvas and WebSockets (supports 'wss://' encryption). |
5f409eee JM |
8 | noVNC is licensed under the |
9 | [LGPLv3](http://www.gnu.org/licenses/lgpl.html). | |
5aeb9880 | 10 | |
77c7a454 JM |
11 | Special thanks to [Sentry Data Systems](http://www.sentryds.com) for |
12 | sponsoring ongoing development of this project (and for employing me). | |
852ba642 | 13 | |
68edd7f4 | 14 | There are many companies/projects that have integrated noVNC into |
676fbbb6 | 15 | their products including: [Sentry Data Systems](http://www.sentryds.com), [Ganeti Web Manager](http://code.osuosl.org/projects/ganeti-webmgr), [Archipel](http://archipelproject.org), [openQRM](http://www.openqrm.com/), [OpenNode](http://www.opennodecloud.com/), [OpenStack](http://www.openstack.org), [Broadway (HTML5 GDK/GTK+ backend)](http://blogs.gnome.org/alexl/2011/03/15/gtk-html-backend-update/), [OpenNebula](http://opennebula.org/), [CloudSigma](http://www.cloudsigma.com/), [Zentyal (formerly eBox)](http://www.zentyal.org/), and [SlapOS](http://www.slapos.org). See [this wiki page](https://github.com/kanaka/noVNC/wiki/ProjectsCompanies-using-noVNC) for more info and links. |
68edd7f4 | 16 | |
b4748f04 JM |
17 | Notable commits, announcements and news are posted to |
18 | @<a href="http://www.twitter.com/noVNC">noVNC</a> | |
19 | ||
20 | ||
852ba642 JM |
21 | ### Screenshots |
22 | ||
e5517ecd | 23 | Running in Chrome before and after connecting: |
600887f0 | 24 | |
65db2d82 | 25 | <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 | 26 | |
852ba642 JM |
27 | See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>. |
28 | ||
29 | ||
6de07adb JM |
30 | ### Browser Requirements |
31 | ||
b29e06f3 JM |
32 | * HTML5 Canvas (with createImageData): Chrome, Firefox 3.6+, iOS |
33 | Safari, Opera 11+, Internet Explorer 9+, etc. | |
6de07adb JM |
34 | |
35 | * HTML5 WebSockets: For browsers that do not have builtin | |
36 | WebSockets support, the project includes | |
37 | <a href="http://github.com/gimite/web-socket-js">web-socket-js</a>, | |
b29e06f3 JM |
38 | a WebSockets emulator using Adobe Flash. iOS 4.2+ has built-in |
39 | WebSocket support. | |
6de07adb | 40 | |
a367e84a JM |
41 | * Fast Javascript Engine: this is not strictly a requirement, but |
42 | without a fast Javascript engine, noVNC might be painfully slow. | |
6de07adb | 43 | |
b29e06f3 | 44 | * I maintain a more detailed browser compatibility list <a |
667ef9ba | 45 | href="https://github.com/kanaka/noVNC/wiki/Browser-support">here</a>. |
d4139a9b JM |
46 | |
47 | ||
6de07adb | 48 | ### Server Requirements |
5aeb9880 | 49 | |
b89c6db3 | 50 | Unless you are using a VNC server with support for WebSockets |
a367e84a JM |
51 | connections (such as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/)), |
52 | you need to use a WebSockets to TCP socket proxy. There is | |
9df83a39 JM |
53 | a python proxy included ('websockify'). One advantage of using the |
54 | proxy is that it has builtin support for SSL/TLS encryption (i.e. | |
55 | "wss://"). | |
5aeb9880 | 56 | |
5aeb9880 | 57 | |
b89c6db3 | 58 | ### Quick Start |
5aeb9880 | 59 | |
b89c6db3 | 60 | * Use the launch script to start a mini-webserver and the WebSockets |
9df83a39 | 61 | proxy (websockify). The `--vnc` option is used to specify the location of |
b89c6db3 JM |
62 | a running VNC server: |
63 | ||
64 | `./utils/launch.sh --vnc localhost:5901` | |
65 | ||
66 | * Point your browser to the cut-and-paste URL that is output by the | |
67 | launch script. Enter a password if the VNC server has one | |
68 | configured. Hit the Connect button and enjoy! | |
69 | ||
70 | ||
9df83a39 | 71 | ### Other Pages |
5aeb9880 | 72 | |
667ef9ba | 73 | * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Generating an SSL |
9df83a39 | 74 | certificate, starting a VNC server, advanced websockify usage, etc. |
a4807656 | 75 | |
667ef9ba | 76 | * [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects. |
a4807656 | 77 | |
667ef9ba | 78 | * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems. |
b89c6db3 | 79 | |
0af07711 | 80 |