Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Complete Spice Web Client written in HTML5 and Javascript
# Complete Spice Web Client written in HTML5 and Javascript
Full and complete implementation of the SPICE protocol (by Red Hat) written in HTML5 and JavaScript. It allows any standard HTML5-ready Web Browser to connect to remote
virtual sessions just by accessing a single URL.

Expand All @@ -24,29 +24,29 @@ NOTE: This project is NOT based on the spice-html5 prototype.
- Spice authentication tokens support
- Supports graphic live debugging the spice protocol and to replay packets to fix bugs

##Missing features
## Missing features

There are some SPICE features still to be implemented, the most important ones are:

- Celt or other audio codec
- USB redirection (not possible at browser level, maybe with a plugin?)

##Client System requirements
## Client System requirements

To get the best result we recommend at least 1GB of ram and at least two cores at 1,5ghz.

It should work decently on 512mb of ram and 1ghz.

We have made tests in raspberry pi 2 with very good results.

##Network requirements
## Network requirements

Only Binary websockets are used to send and receive server data, so you should expect similar network requirements than SPICE itself.
for a normal 1080p session the performance is very good up to 150-200ms of latency and 100kb/s bandwidth.

The network consumption of a spice session depends a lot on the usage patterns.

##Performance
## Performance

Writing a web client for a protocol like spice is challenge because of the limited access to system resources like GPU and the way the javascript VM works.

Expand All @@ -58,7 +58,7 @@ for the javascript GC and refined all our canvas operations and all the entire s

You should expect a near perfect experience if you meet the client requirements and the network requirements.

##Browser support
## Browser support

We strongly recommend use the spice web client with Chromium/Chrome or Firefox, however it should work at least on:

Expand All @@ -68,7 +68,7 @@ We strongly recommend use the spice web client with Chromium/Chrome or Firefox,
- Edge


##How to use it
## How to use it

In order to work you only need to provide the IP address of the websockets proxy and the port
of the websockets proxy.
Expand All @@ -79,21 +79,21 @@ http://example.com/spice-web-client/index.html?host=IP_ADDRESS_OF_WEBSOCKIFY&por

By doing this you will connect to the remote spice session and the resolution will be adapted to your browser viewport area.

##Notes For linux sessions
## Notes For linux sessions
If you are planning to use this to connect to remote linux sessions you should consider disabling compositing on your desktop. The best performance is achieved with
kde with compositing and visual effects disabled.

Always install the spice-vdagent and xorg-qxl to get the best results and to have custom resolutions etc.

##Notes For Windows sessions
## Notes For Windows sessions

Spice web client has a very good performance connecting to remote windows sessions. Always install the spice-agent package including the qxl video driver to get the best results and to have custom resolutions etc.

##More information
## More information

For more information about the implementation or questions about roadmap etc contact Jose Carlos Norte (jcarlosn) at jose@eyeos.com

##License
## License

Spice Web Client is distributed under the terms of the [MIT license](https://opensource.org/licenses/MIT).