Add html5 client

Moved from wiki http://www.spice-space.org/page/Html5

3 files changed, 47 insertions, 0 deletions

diff --git a/content/pages/download.rst b/content/pages/download.rst
index b57aefc..6027995 100644
--- a/content/pages/download.rst
+++ b/content/pages/download.rst
@@ -15,6 +15,7 @@ Download
 .. _UsbDk_1.0.12_x86.msi: http://www.spice-space.org/download/windows/usbdk/UsbDk_1.0.12_x86.msi
 .. _aSPICE:
 .. _aSPICE from play.google.com: https://play.google.com/store/apps/details?id=com.iiordanov.freeaSPICE
+.. _Web client: spice-html5.html
 .. _spicec_n900-0.tar.gz: http://www.spice-space.org/download/arm/spicec_n900-0.tar.gz
 .. _launcher-mobile: https://github.com/flexvdi/launcher-mobile
 .. _flexVDI: https://flexvdi.com
@@ -58,6 +59,9 @@ Windows binaries
 Other clients
 ^^^^^^^^^^^^^
 - Android client - aSPICE_ is a secure, SSH capable, open source SPICE protocol client that makes use of the LGPL licensed native libspice library. You can find and install `aSPICE from play.google.com`_.
+- `Web client`_ - a simple javascript client
+
+  - http://cgit.freedesktop.org/spice/spice-html5
 - Experimental N900 SPICE client - `spicec_n900-0.tar.gz`_
 - launcher-mobile_ - A GPLv2 licensed cross-platform mobile client for both iOS and Android. Though mainly intended to be used as a client for flexVDI_, it can also connect to conventional SPICE sessions.
 
diff --git a/content/pages/features.rst b/content/pages/features.rst
index f07611a..88e579a 100644
--- a/content/pages/features.rst
+++ b/content/pages/features.rst
@@ -21,6 +21,7 @@ Features
 .. _Seamless applications: https://bugs.freedesktop.org/show_bug.cgi?id=39238
 .. _CD sharing: https://bugs.freedesktop.org/show_bug.cgi?id=85956
 .. _OSX client: osx-client.html
+.. _Web client: spice-html5.html
 .. _Simultaneous clients connection: multiple-clients.html
 
 Current Features
@@ -44,6 +45,7 @@ Current Features
 - `Encrypted communication`_
 - `SASL authentication`_
 - Xspice_ - a standalone server that is both an X server and a Spice server
+- `Web client`_ - a simple javacript client
 - Smartcard_ - CAC smartcard redirection
 - `Folder sharing`_ - for sharing a client's folder with the remote guest
 
diff --git a/content/pages/spice-html5.rst b/content/pages/spice-html5.rst
new file mode 100644
index 0000000..461fe52
--- /dev/null
+++ b/content/pages/spice-html5.rst
@@ -0,0 +1,41 @@
+HTML5 Client
+###############################################################################
+
+:slug: spice-html5
+:modified: 2016-06-30 10:28
+
+.. role:: bash(code)
+   :language: bash
+
+.. _TODO: http://cgit.freedesktop.org/spice/spice-html5/tree/TODO
+.. _websockify: https://github.com/kanaka/websockify
+.. _the git page: http://cgit.freedesktop.org/spice/spice-html5
+
+
+Spice has a prototype Web client which runs entirely within a modern browser.  It is limited in function, a bit slow, and lacks support for many features of Spice (audio, video, agents just to name a few).
+
+A complete TODO_ list is kept in the source code.
+
+However, it is surprisingly functional, and certainly a useful proof of concept.
+
+Requirements
+++++++++++++
+
+The browser must support binary WebSockets as well as the binaryType of arraybuffer. As of June, 2012, Firefox 12 and Chrome >= 18 both provided the required features.
+
+Currently, you must also use a WebSocket proxy, as Spice has no built in support for the WebSocket protocol.  websockify_ works great.
+
+You must, of course, also have a Spice server of some kind.  It has been tested primarily against Xspice, but it also works with qemu. However, it works better with linux guests than with Windows guests.
+
+To Try It
++++++++++
+
+The following steps should enable you to use the HTML5 Client:
+
+#. (optional) Obtain the spice-html5 client.  See `the git page`_ for more details.
+#. Start your spice server.  This is left as an exercise for the reader. For the purposes of this set of instructions, we imagine it is running on your localhost at port 5900.
+#. Obtain websockify_
+#. Start websockify :bash:`websockify/websockify.py 5959 localhost:5900`
+#. Point your browser to spice.html and try it!
+
+Be sure to give the hostname where websockify is running and the port number you provided when starting websockify.