<ul>\r
<li><a href="#whatisvm">What is JABAWS Virtual Appliance?</a></li>\r
<li><a href="#whenvm">When to use virtual appliance</a> </li>\r
- <li><a href="#howtoinstallvm">How to install VMWare Player or VirtualBox</a></li>\r
+ <li><a href="#howtoinstallvm">How to install VMware Player </a></li>\r
<li><a href="#vmplayer">VMware Player appliance configuration </a></li>\r
- <li><a href="#virtualbox">VirtualBox appliance configuration</a></li>\r
<li><a href="#jabawsAppliance">JABAWS Appliance details </a></li>\r
<li><a href="#jalviewWithJaba">Configuring Jalview to work with your JABAWS VM</a></li>\r
<li><a href="#vmiaccess">VM Network Settings </a></li>\r
</ul>\r
\r
-<p><strong>Troubleshooting</strong></p>\r
-<ul>\r
- <li><a href="#vmbexc"> VirtualBox fails to open the VM due to VERR_VMX_MSR_LOCKED_OR_DISABLED exception</a></li>\r
- <li><a href="#vboxinvalidstate">VirtualBox 4.0 fails to import the VM due to VBOX_E_INVALID_OBJECT_STATE exception </a></li>\r
- <li><a href="#ovfOnVmware">VMWare Player fails to open the VM with "Fail to query source for information" exception</a></li>\r
-</ul>\r
+<p> </p>\r
<h3><a name="whatisvm" id="whatisvm"></a>What is the JABAWS Server Virtual Appliance?</h3>\r
<p>The JABAWS <a href="http://en.wikipedia.org/wiki/Virtual_appliance">Virtual Appliance</a> is a \r
way to run JABAWS server locally without the need to connect to the internet or configure JABAWS. \r
What the appliance provides is a 'virtual server machine' (or more simply - virtual machine or VM), running an installation of the JABAWS \r
Web Application Archive (WAR) on TurnKey Linux. Once this has started up, it displays a message indicating the IP address of the JABAWS server, allowing any JABAWS client (such as Jalview or the JABAWS command line client) to connect to it.<br/>\r
-You can run the appliance with freely available programs such as <a href="http://www.vmware.com/products/player">VMWare Player</a> or \r
-<a href="http://www.virtualbox.org/wiki/Download_Old_Builds_3_2">Oracle VirtualBox 3.2.x</a>, but you will need to install them first. We have tested the JABAWS appliance \r
-with VMware Player v 3.1.2 on Windows and Linux, and <a href="http://www.virtualbox.org/wiki/Download_Old_Builds_3_2">VirtualBox </a> v. 3.2.12 on Windows, Linux and Mac. \r
- However, you are not limited to these virtualization systems and can use the JABAWS appliance with any commercial alternative. </p>\r
+You can run the appliance with freely available program such as <a href="http://www.vmware.com/products/player">VMware Player</a>, but you will need to install it first. We have tested the JABAWS appliance \r
+with VMware Player v 3.1.2 on Windows and Linux, and VMware Fusion on Mac. \r
+ However, you are not limited to these virtualization systems and can use the JABAWS appliance with any other virtualization platform. You can use <a href="http://communities.vmware.com/community/vmtn/server/vsphere/automationtools/ovf">VMware OVF tool</a> to convert JABAWS image to a different virtualization format e.g. OVF.</p>\r
<h3><a name="whenvm" id="whenvm"/></a>When to use the JABAWS Virtual Appliance</h3>\r
-<p>The appliance best suits users who would like to use the JABA web services locally. This might be because they do want to access \r
-systems over an internet or local intranet connection, or alternately, want to keep their data private. It is also \r
-the recommended option for users who want to install JABAWS on Windows, which does not support all the bioinformatics programs that JABAWS can run. \r
-<br/>Since the appliance is a self contained unit of software, it is also an attractive option for Linux, UNIX or Mac users wishing to set up JABAWS services quickly.</p>\r
-<h3><a name="whennotvm" id="whennotvm"/>When <em>not</em> to use the JABAWS Virtual Appliance</h3><p>\r
+<p>The appliance best suits users who would like to use the JABA web services locally. This might be because they do not want to access \r
+systems over an internet, or just want to keep their data private. It is also \r
+the recommended option for users who want to install JABAWS on Windows, which does not support all the bioinformatics programs that JABAWS can run.</p>\r
+<h3><a name="whennotvm" id="whennotvm"/>When <em>not</em> to use the JABAWS Virtual Appliance</h3>\r
+<p>\r
For servers that will be used heavily, we recommend that a <a href="man_serverwar.html#instwar">JABAWS Server WAR distribution</a> is deployed, rather than the Virtual Appliance version of JABAWS. \r
This is because the JABAWS appliance is pre-configured to use only 1 CPU and 512M of memory \r
(where the minimum amount of memory required for a JABAWS server is about 378M), which is unlikely to be sufficient for heavy computation. \r
It is possible to reconfigure the virtual appliance so it uses more computation resources, \r
-but for most production environments, the JABAWS WAR distribution will be more easy to deploy and tune to take advantage of the resources available.</p>\r
+but for most production environments, the JABAWS WAR distribution will be easier to deploy and fine tune to take advantage of the available resources.</p>\r
\r
-<h3><a name="howtoinstallvm" id="howtoinstallvm"></a>How to install VMWare Player or VirtualBox</h3>\r
+<h3><a name="howtoinstallvm" id="howtoinstallvm"></a>How to install VMware Player</h3>\r
<p>Please see the <a href="http://downloads.vmware.com/d/info/desktop_downloads/vmware_player/3_0">VMware Player</a> \r
-and <a href="http://www.virtualbox.org/wiki/Download_Old_Builds_3_2">Oracle VirtualBox</a> web sites for up to date instructions and downloads.</p>\r
+ web sites for up to date instructions and downloads.</p>\r
\r
<h3><a name="vmplayer" id="vmplayer"/>VMware Player appliance configuration </h3>\r
-<p>The free <a href="http://downloads.vmware.com/d/info/desktop_downloads/vmware_player/3_0">VMware Player</a> can be used to run the JABAWS services from the Windows and Linux host operating systems, there is no support for Mac at the time of writing (December 2010). \r
-However, <a href="https://www.vmware.com/vmwarestore/buyfusion.html">VMware Fusion</a>, a commercial VMware product, offers virtual machine support for Mac computers too. </p>\r
+<p>The free <a href="http://downloads.vmware.com/d/info/desktop_downloads/vmware_player/3_0">VMware Player</a> can be used to run the JABAWS services from the Windows and Linux host operating systems. <a href="https://www.vmware.com/vmwarestore/buyfusion.html">VMware Fusion</a>, a commercial VMware product, offers virtual machine support for Mac. </p>\r
<p>To run the JABAWS server on VMware player, unpack the JABAWS VM into one of the folders on your local hard drive. Open VMware Player, click "Open Virtual Machine" and point the Player to the location of the JABAWS, then choose the JABAWS.vmx file to open an appliance. </p>\r
<p>When you play the machine for the first time the Player might ask you whether "This virtual machine may have been moved or copied.", say that you have copied it. That is all. </p>\r
-<h3><a name="virtualbox" id="virtualbox"/></a>VirtualBox appliance configuration</h3>\r
-<p>VirtualBox can be used to run JABAWS services from Windows, Linux, Solaris or Mac host operating systems. Use the VitualBox "Import Appliance" option to import the JABAWS. Please bear in mind that to benefit from multiple CPU support under the VirtualBox software you need to enable<a href="http://en.wikipedia.org/wiki/X86_virtualization"> hardware virtualization extensions</a>, such as Intel Virtualization VT-x or AMD-V support in the BIOS of your computer. Unfortunately, we were unable to find a reliable way to do it on Mac, so some Macs running VirtualBox will be limited to one CPU only, irrespective of the number of CPUs of the host machine. </p>\r
-<p>We found that, by default, virtualization extensions are enabled in VirtualBox irrespective of whether your computer supports them. You will get the <a href="#vmbexc">VERR_VMX_MSR_LOCKED_OR_DISABLED</a> exception if your computer does not support the extensions or their support is disabled. Just deselect the checkboxes shown on the screen shot below to solve the problem. </p>\r
-<p>VirtualBox JABAWS VM configuration screen shot displaying virtualization settings.</p>\r
-<p><img src="images/vmb_virtual.png" alt="VT-x extension on VirtualBox" width="669" height="535" /></p>\r
<h3><a name="jabawsAppliance" id="jabawsAppliance"/>JABAWS Appliance details</h3>\r
<p>By default, the JABAWS virtual appliance is configured with 512M of memory and 1 CPU, but you are free to change these settings. If you have more than one CPU or CPU core on your computer you can make them available for the JABAWS virtual machine by editing virtual machine settings. Please bear in mind that more CPU power will not make a single calculation go faster, but it will enable the VM to do calculations in parallel. Similarly, you can add more memory to the virtual machine. More memory lets your VM deal with larger tasks, e.g. work with large alignments.</p>\r
<p>The VMware Player screen shot below displays JABAWS VM CPU settings. </p>\r
- VMware tools : Installed</p>\r
<p><strong>OS info</strong><br />\r
- OS : TurnKey Linux, based on Ubuntu 8.0.4 JEOS (Just-Enough-Operation-System)<br />\r
- - Installation : Oracle Java 6, Tomcat 6, JABAWS v. 1.0 <br />\r
+ - Installation : Oracle Java 6, Tomcat 7, JABAWS v. 2.0 <br />\r
- Hostname : tomcat <br />\r
- IPv4 address : dhcp<br />\r
- IPv6 address : auto<br />\r
<li>SSH/SFTP<br />\r
<em>Access:</em> root@VM_IP</li>\r
</ul>\r
-<p>Where VM_IP is the VM IP address. Under VMware Player host only networking, the first VM may have 192.168.227.128 IP address. Under VirtualBox host only networking, first VM may have 192.168.56.101 IP address.</p>\r
+<p>Where VM_IP is the VM IP address. Under VMware Player host only networking, the first VM may have 192.168.227.128 IP address. </p>\r
<h3><a name="jalviewWithJaba" id="jalviewWithJaba"/>Configuring Jalview to work with your JABAWS VM</a> </h3>\r
<p>After booting the JABAWS VM, you should see similar screen, however, the IP address of your VM may be different. To enable Jalview to work with your JABAWS appliance you need to go to Jalview->Tools->Preferences->Web Services -> New Service URL, and add JABAWS URL into the box provided. For more information please refer to Jalview <a href="http://www.jalview.org/help/html/webServices/JABAWS.html">help pages</a>. </p>\r
<p><img src="images/vm_welcome_screen.png" alt="JABAWS welcome screen" width="734" height="461" /></p>\r
<p><img src="images/VMware_booted.png" alt="JABAWS welcome screen" width="735" height="461" /></p>\r
<p>If you need to configure a static IP address the configuration console will help you with this. Shutting down the VM is best from the configuration console as well.</p>\r
<h3><a name="vmiaccess" id="vmiaccess"/></a></a>VM Network Settings </h3>\r
-<p>By default the JABAWS VM is configured to use host-only networking. This means that the host can communicate with the VM via a network, but no other machines can. Similarly, the VM cannot communicate with any other computers apart from the host. If you want to connect to the Internet from the VM, configure your VM to use NAT network. However, you will not be able to connect to the VM from the host in such case. If you want to be able to connect to your VM and let VM connect to the internet at the same time you would have to use a Bridged network. In such a case you would have to configure the VM IP address manually (unless of course your network has a DHCP server to do that)</p>\r
-<h3><a name="vmbexc" id="vmbexc"/></a>VirtualBox fails to open the VM due to VERR_VMX_MSR_LOCKED_OR_DISABLED exception</h3>\r
-<p>VERR_VMX_MSR_LOCKED_OR_DISABLED exception means that Intel Virtualization technology is disabled or not supported by your computer. If you have such a problem, please make sure you have configured the JABAWS VM with 1 CPU and disabled VT-X extensions. Alternatively you can enable virtualization extensions ion from the BIOS of your computer. Unfortunately, we cannot give you exact instructions on how to do this, as this would depend on your computer BIOS manufacturer. For MACs it may not be possible at all. </p>\r
-<h3><a name="vboxinvalidstate" id="vboxinvalidstate"></a>VirtualBox 4.0.0 fails to import the VM due to VBOX_E_INVALID_OBJECT_STATE exception </h3>\r
-<p>VirtualBox version 4.x.x is not compatible with JABAWS virtual appliance. Please download the previous version of <a href="http://www.virtualbox.org/wiki/Download_Old_Builds_3_2">VirtualBox</a> 3.2.12 to use with JABAWS VA.</p>\r
-<h3><a name="ovfOnVmware" id="ovfOnVmware"/></a>VMWare Player fails to open the VM with "Fail to query source for information" exception</h3>\r
-<p>At the time of writing, the latest version of VMware Player 3.1.2 supported only a legacy OVF version 0.9. Whereas OVF packaged with JABAWS VM is version 1.0. Please use VMX - VMware specific configuration file with all VMware products. </p>\r
+<p>By default the JABAWS VM is configured to use host-only networking. This means that the host can communicate with the VM via a network, but no other machines can. Similarly, the VM cannot communicate with any other computers apart from the host. If you want to connect to the Internet from the VM, configure your VM to use NAT network. However, you will not be able to connect to the VM from the host in such case. If you want to be able to connect to your VM and let VM connect to the internet at the same time you would have to use a Bridged network. In such a case you would have to configure the VM IP address manually (unless of course your network has a DHCP server to do that)</a></p>\r
</div>\r
\r
<!-- content end-->\r
-<div id="copyright">Last update: 1 April 2011<br />\r
+<div id="copyright">Last update: 10 August 2011<br />\r
Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of\r
Dundee, UK</div>\r
</div>\r
git://source.jalview.org / jabaws.git / commitdiff