Adding new web service, getting rid of virtual box in docs
[jabaws.git] / website / man_serverwar.html
index 5d092e0..0dc1ce3 100644 (file)
@@ -1,8 +1,9 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE html PUBLIC "XHTML 1.0 Strict"\r
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
 <html xmlns="http://www.w3.org/1999/xhtml">\r
 <head>\r
-<meta name="Last-modified" content="Mon, 11 Dec 2010 01:03:33 GMT"/>\r
+<meta name="Last-modified" content="Mon, 4 Apr 2011 12:00:00 GMT"/>\r
 <title>Java Bioinformatics Analyses Web Services (JABAWS) Server Web Aplication aRchive manual</title>\r
 <link href="ws.css" rel="stylesheet" type="text/css" media=\r
 "screen, projection, handheld, tv" />\r
 <div id="page">\r
 <div id="banner">\r
 <table> \r
-<tr><td style="width:130px;"><a href="http://www.dundee.ac.uk"><img class="logo" src="images/uod_lt.gif"  alt="University of Dundee"  title="University of Dundee" longdesc="http://www.dundee.ac.uk"/></a></td>\r
-<td class="bg"><h1><span class="headeru">JA</span>va <span class=\r
-"headeru">B</span>ioinformatics <span class="headeru">A</span>nalysis <span class="headeru">W</span>eb <span\r
-class="headeru">S</span>ervices</h1></td>\r
+<tr><td style="width:158px;"><a href="http://www.dundee.ac.uk"><img src="images/uod_lt_long.gif"  alt="University of Dundee" width="158" height="90" class="logo"  title="University of Dundee" longdesc="http://www.dundee.ac.uk"/></a></td>\r
+<td class="bg"><img src="images/jabaws2.png" alt="JABAWS-2.0:Disorder" width="353" height="67" title="JABAWS-2.0:Disorder"/></td>\r
+<td class="bg"><img src="images/banner_right.png" alt="Disorder" width="200" height="80"/></td>\r
 </tr>\r
-</table></div><!-- banner end-->\r
+</table>\r
+</div><!-- banner end-->\r
 \r
 <div id="wrapper">\r
 <div id="panel"><a href="index.html">Home</a> \r
-    <a class="selected" href="manual.html">Manual</a> \r
+        <a href="quick_start.html">Getting Started</a> \r
+    <a class="selected" href="man_about.html">Manual</a> \r
        <div id="submenu">\r
-               <a href="manual.html">Quick Start Guide</a>\r
                <a href="man_about.html">About</a>\r
                <a href="man_servervm.html" title="JABAWS Server as Virtual Appliance">Server VA</a>\r
                <a class="selected" href="man_serverwar.html" title="JABAWS Server as Web Application aRchive">Server WAR</a>\r
                <a href="man_configuration.html" >Server<br/>\r
                Configuration</a>\r
                <a href="man_client.html" title="JABAWS Command Line Client">CMD Client</a>\r
+               <a href="man_stats.html" title="JABAWS Usage Statistics">Usage Statistics</a>\r
                <a href="man_dev.html" title="Accessing JABAWS from your program">Accessing<br/>\r
                JABAWS</a>      \r
+               <a href="man_server_dev.html" >JABAWS Development</a>\r
        </div>\r
 <a href="download.html">Download</a> \r
-<a href="http://www.compbio.dundee.ac.uk">Barton Group</a> \r
-</div>\r
+<a href="contacts.html">Contact Us</a>\r
+<a href="PublicAnnualStat" title="JABAWS server usage statistics">Usage Statistics</a>\r
+<a href="http://www.compbio.dundee.ac.uk" title="University of Dundee, The Barton Group" >Barton Group</a></div>\r
 \r
 <!-- panel end-->\r
 <div id="content">\r
@@ -53,8 +57,7 @@ class="headeru">S</span>ervices</h1></td>
     programs for your system</a></li>\r
   <li><a href="#haveexec">Reuse the binaries that are\r
     already in your system</a></li>\r
-  <li><a href="#obtainexec">Obtaining alignment\r
-    programs for your operating system</a></li>\r
+  <li><a href="#obtainexec">Obtaining command line binaries </a><a href="#obtainexec">for your operating system</a></li>\r
   <li><a href="#usingWsTester">Testing JABAWS Server</a></li>\r
   <li><a href="#diffcontexts">Running many JABAWS instances on the same server</a> </li>\r
   <li><a href="#nocluster">JABAWS on a single server</a></li>\r
@@ -70,18 +73,18 @@ class="headeru">S</span>ervices</h1></td>
 version 2.4 of the Java Servlet specification, and a Java 6 runtime\r
 environment. We recommend using an official Oracle Java 6 runtime\r
 environment, and <a\r
-href="http://tomcat.apache.org/download-60.cgi">Apache-Tomcat</a> web application server version 6, but other versions may work as well. </p>\r
+href="http://tomcat.apache.org/download-60.cgi">Apache-Tomcat</a> web application server version 6, but other versions may work as well.<br/><span class="attention">Please Note:</span> The JABAWS WAR is not generally compatible with older Mac systems based on the PowerPC architecture, since Java 1.6 is not available to run JABAWS.</p>\r
 \r
-<p>JABAWS Web Application aRchive can run on any host operating system that supports Java. However JABAWS depends on the third party programs which are not available for all operating systems. In particular, only Clustal and Muscle are currently available for MS Windows platform.\r
+<p>JABAWS Web Application aRchive can run on any host operating system that supports Java 1.6. However JABAWS depends on a number of third party programs which are not available for all operating systems. In particular, only Clustal and Muscle are currently available for MS Windows platform.\r
   <!-- todo: link to help about obtaining and installing tomcat -->\r
 </p>\r
-<p>JABAWS comes with pre-compiled MS Windows and Linux IA32 binaries and contains all the binaries sources.</p>\r
+<p>JABAWS comes with pre-compiled MS Windows and Linux IA32 binaries, as well as the source code and build scripts necessary to recompile them.</p>\r
 <p>To run JABAWS on the cluster you must have shared disk space accessible from all cluster nodes. </p>\r
 <h3><a name="instwar" id="instwar"></a>Installing the JABAWS WAR file</h3>\r
 <p>JABAWS is distributed as a web application archive (WAR). To\r
 deploy JABAWS in Apache-Tomcat - simply drop the war file into the\r
 <span class="highlight">webapps</span> directory of a running\r
-Tomcat, and it will do the rest. If you used this deployment procedure, <span class="attention">do not remove</span> jabaws war file, otherwise Tomcat will undeploy your application!  </p>\r
+Tomcat, and it will do the rest. If you used this deployment procedure, <span class="attention">do not remove</span> the jabaws WAR file, otherwise Tomcat will undeploy your application! The context path for your deployed application will be the same as the name of the war file. For example, assuming the Tomcat server is running on the <span class="hightlight">localhost:8080</span> and <strong>jaba.war</strong> file is put into the <span class="hightlight">&lt;tomcat server root&gt;/webapps</span> directory, the deployed application from the jaba.war file then can be accessed by this URL http://localhost:8080/<strong>jaba</strong>. </p>\r
 <p>For any other web application\r
   server, please follow your server's specific deployment procedure\r
   for 'WAR' files. If you install JABAWS on a MS Windows machine, then\r
@@ -117,7 +120,7 @@ they must first be made executable using the provided <a name=
  For this run each binary, without any command line options or\r
 input files. If you see an error message complaining about missing\r
 libraries or other problems, then you probably need to <a href=\r
-"#recompbinaries">recompile the binaries</a>. with</li>\r
+"#recompbinaries">recompile the binaries</a>.</li>\r
 \r
 <li>Restart the Tomcat.</li>\r
 </ol>\r
@@ -181,8 +184,7 @@ Then the default configuration will work for you. More information
 about <span class="hightlight">the\r
 Executable.properties</span> file is given in the <a href="man_configuration.html#exec">JABAWS Configuration chapter.</a></p>\r
 \r
-<h3><a name="obtainexec" id="obtainexec">Obtaining alignment\r
-programs for your operating system</a></h3>\r
+<h3><a name="obtainexec" id="obtainexec">Obtaining command line binaries for your operating system</a></h3>\r
 \r
 <p>You could search for pre-packaged compiled executable in your\r
 system package repository or alternately, download pre-compiled\r
@@ -191,11 +193,13 @@ replace the executables supplied with the downloaded ones, or
 modify the paths in <span class=\r
 "hightlight">executable.properties</span> as described above. Below are some suggestions on where you may be able to get the binaries for your system. </p>\r
 <ul>\r
+  <li><a href="http://www.clustal.org/omega/#Download">Clustal Omega </a></li>\r
   <li><a href="ftp://ftp.ebi.ac.uk/pub/software/clustalw2/2.0.12/">ClustalW</a></li>\r
   <li><a href="http://mafft.cbrc.jp/alignment/software/">Mafft</a></li>\r
   <li><a href="http://www.drive5.com/muscle/download3.6.html">Muscle</a></li>\r
   <li><a href="http://www.tcoffee.org/Packages/Binaries/">Tcoffee</a></li>\r
-  <li>Probcons (Linux <a href="http://www.compbio.dundee.ac.uk/jabaws/archive/binaries/linuxI386/probcons/">I386</a> | <a href="http://www.compbio.dundee.ac.uk/jabaws/archive/binaries/linuxAMD64/probcons/">AMD64</a>)</li>\r
+  <li>Probcons (Linux <a href="http://www.compbio.dundee.ac.uk/jabaws/archive/binaries/linux_x86/probcons">x86</a> | <a href="http://www.compbio.dundee.ac.uk/jabaws/archive/binaries/linux_x64/probcons">x64</a> | <a href="http://www.compbio.dundee.ac.uk/jabaws/archive/binaries/mac/probcons">Mac</a>)</li>\r
+  <li>IUPred (Linux <a href="http://www.compbio.dundee.ac.uk/jabaws/archive/binaries/linux_x86/iupred">x86</a> | <a href="http://www.compbio.dundee.ac.uk/jabaws/archive/binaries/linux_x64/iupred">x64</a> | <a href="http://www.compbio.dundee.ac.uk/jabaws/archive/binaries/mac/iupred">Mac</a>)</li>\r
 </ul>\r
 <h3><a name="usingWsTester" id="usingWsTester"></a>Testing JABAWS Server </h3>\r
 <p>First of all make sure that Tomcat server is started successfully. If this was the case, then you should see JABAWS home page when you navigate to your Tomcat JABAWS context path e.g. <span class="code">http://myhost.compbio.ac.uk:8080/jabaws</span>If you see it, then it is time to make sure that web services are working too. Assuming that you have unpacked/deployed JABAWS from the server war file, you should be able to navigate to the test program which can be found in &lt;webapplicationpath&gt;/WEB-INF/lib/jabaws-client.jar file. To run the tests type:<span class="code"> java -jar jabaws-client.jar -h=&lt;Your web application server host name, port and JABAWS context path&gt;</span></p>\r
@@ -230,16 +234,16 @@ modify the paths in <span class=
 <p class="code">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br />\r
   &lt;Context antiResourceLocking=&quot;false&quot; privileged=&quot;true&quot;  /&gt;</p>\r
 <p>This should be sufficient to prevent Tomcat from removing your JABAWS from WEBAPPS. For more information about the Tomcat deployer <a href="http://tomcat.apache.org/tomcat-6.0-doc/deployer-howto.html">read this documentation on the Apache-Tomcat web site</a>.</p>\r
-<h3><a name="tomdeploy" id="tomdeploy"></a>Apache-Tomcat fails to deploy jaba.war file </h3>\r
+<h3><a name="tomdeploy" id="tomdeploy"></a>Apache-Tomcat fails to deploy jabaws.war file </h3>\r
 <ul>\r
   <li>Make sure Tomcat have sufficient access rights to read your war file. </li>\r
   <li>Restart the Tomcat, sometimes it will not since that the new war file is added without restart</li>\r
-  <li>If Tomcat still refuses to unpack the war file, unpack it manually into web application folder (the war file is just a zip archive). <a href="manual.html#setexecflag"> </a> Restart the Tomcat.</li>\r
+  <li>If Tomcat still refuses to unpack the war file, unpack it manually into web application folder (the war file is just a zip archive). Restart the Tomcat.</li>\r
 </ul>\r
 </div>\r
 \r
 <!-- content end-->\r
-<div id="copyright">Last update: 7 January 2011<br />\r
+<div id="copyright">Last update: 1 August 2011<br />\r
  Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of\r
 Dundee, UK</div>\r
 </div>\r