jcarr
/
noVNC
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Formatting cleanup of README

This commit is contained in:
Samuel Mannehed 2016-11-22 00:37:52 +01:00
parent 4cb91c4269
commit b55bfcf04b
1 changed files with 45 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
README.md
View File

@ -12,34 +12,34 @@ Many companies, projects and products have integrated noVNC including
[OpenStack](http://www.openstack.org), [OpenStack](http://www.openstack.org),
[OpenNebula](http://opennebula.org/), [OpenNebula](http://opennebula.org/),
[LibVNCServer](http://libvncserver.sourceforge.net), and [LibVNCServer](http://libvncserver.sourceforge.net), and
[ThinLinc](https://cendio.com/thinlinc). [ThinLinc](https://cendio.com/thinlinc). See
See [the Projects and Companies wiki page](https://github.com/kanaka/noVNC/wiki/Projects-and-companies-using-noVNC) [the Projects and Companies wiki page](https://github.com/kanaka/noVNC/wiki/Projects-and-companies-using-noVNC)
for a more complete list with additional info and links. for a more complete list with additional info and links.
### News/help/contact ### News/help/contact
Notable commits, announcements and news are posted to Notable commits, announcements and news are posted to
<a href="http://www.twitter.com/noVNC">@noVNC</a> <a href="http://www.twitter.com/noVNC">@noVNC</a>.
If you are a noVNC developer/integrator/user (or want to be) please If you are a noVNC developer/integrator/user (or want to be) please join the
join the <a <a href="https://groups.google.com/forum/?fromgroups#!forum/novnc">
href="https://groups.google.com/forum/?fromgroups#!forum/novnc">noVNC noVNC discussion group</a>.
discussion group</a>
Bugs and feature requests can be submitted via [github Bugs and feature requests can be submitted via
issues](https://github.com/kanaka/noVNC/issues). If you are looking [github issues](https://github.com/kanaka/noVNC/issues).
for a place to start contributing to noVNC, a good place to start If you are looking for a place to start contributing to noVNC, a good place to
would be the issues that are marked as start would be the issues that are marked as
["patchwelcome"](https://github.com/kanaka/noVNC/issues?labels=patchwelcome). ["patchwelcome"](https://github.com/kanaka/noVNC/issues?labels=patchwelcome).
If you want to show appreciation for noVNC you could donate to a great If you want to show appreciation for noVNC you could donate to a great non-
non-profits such as: [Compassion profits such as:
International](http://www.compassion.com/), [SIL](http://www.sil.org), [Compassion International](http://www.compassion.com/),
[Habitat for Humanity](http://www.habitat.org), [Electronic Frontier [SIL](http://www.sil.org),
Foundation](https://www.eff.org/), [Against Malaria [Habitat for Humanity](http://www.habitat.org),
Foundation](http://www.againstmalaria.com/), [Nothing But [Electronic Frontier Foundation](https://www.eff.org/),
Nets](http://www.nothingbutnets.net/), etc. Please tweet <a [Against Malaria Foundation](http://www.againstmalaria.com/),
href="http://www.twitter.com/noVNC">@noVNC</a> if you do. [Nothing But Nets](http://www.nothingbutnets.net/), etc.
Please tweet <a href="http://www.twitter.com/noVNC">@noVNC</a> if you do.
### Features ### Features
@ -59,9 +59,11 @@ href="http://www.twitter.com/noVNC">@noVNC</a> if you do.
Running in Chrome before and after connecting: Running in Chrome before and after connecting:
<img src="http://kanaka.github.com/noVNC/img/noVNC-5.png" width=400>&nbsp;<img src="http://kanaka.github.com/noVNC/img/noVNC-7.jpg" width=400> <img src="http://kanaka.github.com/noVNC/img/noVNC-5.png" width=400>&nbsp;
<img src="http://kanaka.github.com/noVNC/img/noVNC-7.jpg" width=400>
See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>. See more screenshots
<a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
### Browser Requirements ### Browser Requirements
@ -70,45 +72,49 @@ See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">h
* HTML5 Canvas, WebSockets and Typed Arrays * HTML5 Canvas, WebSockets and Typed Arrays
* Fast Javascript Engine: this is not strictly a requirement, but * Fast Javascript Engine: this is not strictly a requirement, but without a
without a fast Javascript engine, noVNC might be painfully slow. fast Javascript engine, noVNC might be painfully slow.
* See the more detailed [browser compatibility wiki page](https://github.com/kanaka/noVNC/wiki/Browser-support). * See the more detailed
[browser compatibility wiki page](https://github.com/kanaka/noVNC/wiki/Browser-support).
### Server Requirements ### Server Requirements
Unless you are using a VNC server with support for WebSockets Unless you are using a VNC server with support for WebSockets connections (such
connections (such as as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
[x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
[QEMU](http://www.qemu.org/), or [QEMU](http://www.qemu.org/), or
[PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), you need to [PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), you need to use a
use a WebSockets to TCP socket proxy. There is a python proxy included WebSockets to TCP socket proxy. There is a python proxy included
('websockify'). ('websockify').
### Quick Start ### Quick Start
* Use the launch script to start a mini-webserver and the WebSockets * Use the launch script to start a mini-webserver and the WebSockets proxy
proxy (websockify). The `--vnc` option is used to specify the location of (websockify). The `--vnc` option is used to specify the location of a running
a running VNC server: VNC server:
`./utils/launch.sh --vnc localhost:5901` `./utils/launch.sh --vnc localhost:5901`
* Point your browser to the cut-and-paste URL that is output by the * Point your browser to the cut-and-paste URL that is output by the launch
launch script. Enter a password if the VNC server has one script. Enter a password if the VNC server has one configured. Hit the
configured. Hit the Connect button and enjoy! Connect button and enjoy!
### Other Pages ### Other Pages
* [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections). How to setup websockify so that you can use encrypted connections from noVNC. * [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections)
- How to setup websockify so that you can use encrypted connections from noVNC.
* [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Starting a VNC server, advanced websockify usage, etc. * [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage)
- Starting a VNC server, advanced websockify usage, etc.
* [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects. * [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into
existing projects.
* [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems. * [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting)
problems.
### Authors/Contributors ### Authors/Contributors