[Users] HowTo: Spice ActiveX Plugin/Virt Viewer Console on oVirt 3.1

29 Aug 2012

      I have seen this question asked many times on this list and the spice-devel
list. Now having figured out how to make it work I will provide the answer
to the rest of the community.

*NOTE* this only applies to Windows/Internet Explorer users. There exists
no other option other than the html5 spice console (still beta/in
development) for windows users ATM. This will also only work with Internet
Explorer.

Basic Steps:
- Install an oVirt server.
- Add at least one node
- Setup storage/iso/export domains

Advanced steps
- Start by downloading: http://elmarco.fedorapeople.org/spice.cab
- Create a directory for it oVirt looks by default in /usr/share/spice
- Rename spice.cab to SpiceX.cab and copy it into /usr/share/spice
- Now edit /usr/share/ovirt-engine/engine.ear/root.war/WEB-INF and add the
following:

 <!-- SpiceX.cab -->
  <servlet>
    <servlet-name>SpiceX.cab</servlet-name>
    <servlet-class>org.ovirt.engine.core.FileServlet</servlet-class>
    <init-param>
      <param-name>type</param-name>
      <param-value>application/octet-stream</param-value>
    </init-param>
    <init-param>
      <param-name>file</param-name>
      <param-value>/usr/share/spice/SpiceX.cab</param-value>
    </init-param>
  </servlet>
  <servlet-mapping>
    <servlet-name>SpiceX.cab</servlet-name>
    <url-pattern>/spice/SpiceX.cab</url-pattern>
  </servlet-mapping>

- Next create an html file within
/usr/share/ovirt-engine/engine.ear/root.war
- In the example below an html file called "spice.html"
- Copy/Paste the below into spice.html:

<!DOCTYPE html>
<html>
<head>
<title>SPICE Plugin Installer</title>

<script type="text/javascript">
function installSpice()
{
try {
    document.getElementById('SpiceX').innerHTML = '<OBJECT id="SpiceX"
codebase="/spice/SpiceX.cab"
classid="clsid:ACD6D89C-938D-49B4-8E81-DDBD13F4B48A" width="0"
height="0"></OBJECT>';
    } catch (ex) {
        alert("Epic Fail!: " + ex.Description);
    }
}
</script>

</head>
<body>
    <p>
    <p><b id='SpiceX'>Spice ActiveX Plugin</b> </p>
    <button onclick='installSpice()'>Install Spice Plugin</button>
    </p>
</body>
</html>

- Save the file
- You will now need to restart the ovirt-engine service EG: systemctl
restart ovirt-engine.service OR service ovirt-engine restart
- The installer page will now be available at http://<url to ovirt
server>/spice.html EX: http://ovirt.azeroth.net/spice.html
- Navigate to that page and click the install button
- IE will prompt you to deploy/install the SpiceX cabinet file
- It may gripe about an unsigned or untrusted source, acknowledge this an
proceed anyways
- If the install succeeds the text "Spice ActiveX Plugin" on the page will
change to blank (it's actually the plugin with null values)
- The console button in the user and webadmin portals will now launch the
new virt-viwer spice based console!

Happy Spice Consoling to your VM's from Windows!

*NOTE*
To uninstall the plugin:
- The below removes the add-on from IE (EG: removes knowledge of
"application/x-spice")
- pop a command terminal and type:
On Windows XP: regsvr32 /u "C:\Documents and Settings\Administrator\Local
Settings\Application Data\virt-viewer\bin\SpiceX.dll"
On Windows 7 regsvr32 /u C:\Documents and Settings\Administrator\Local
Settings\AppData\virt-viewer\bin\SpiceX.dll"
- Next we need to remove the rest of virt-viewer
- Go to add/remove programs and uninstall virt-viewer, this removes the
rest of virt-viewer from the system

[Users] HowTo: Spice ActiveX Plugin/Virt Viewer Console on oVirt 3.1

Dead Horse