website/v_2_1_0/manual_qs_war.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4
   5 <head>
   6 <meta name="Last-modified" content="Fri, 28 Jun 2013 12:00:00 GMT"/>
   7 <title>Java Bioinformatics Analyses Web Services (JABAWS) manual - getting started</title>
   8 <link href="ws.css" rel="stylesheet" type="text/css" media="screen, projection, handheld, tv" />
   9 <link href="print.css" rel="stylesheet" type="text/css" media="print" />
  10 <link href='http://fonts.googleapis.com/css?family=Yanone+Kaffeesatz:700' rel='stylesheet' type='text/css' />
  11 <script type="text/javascript" src="prototype-1.6.0.3.js"></script>
  12 </head>
  13
  14 <body>
  15 <div id="page">
  16
  17 <div id="banner">
  18 <table>
  19 <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>
  20 <td class="bg"><img src="images/jabaws21.png" width="256" height="67" alt="JABAWS-2.1" title="Java Bioinformatics Analysis Web Services version 2.1"/></td>
  21 <td class="bg"><img src="images/banner_right.png" alt="Disorder" width="200" height="80"/></td>
  22 </tr>
  23 </table>
  24 </div><!-- banner end-->
  25
  26 <div id="wrapper">
  27 <div id="panel">
  28         <a class="newa" href="index.html">Home</a>
  29         <a class="newpressed" href="quick_start.html">Getting Started</a>
  30         <a class="newa" href="man_about.html">Manual</a>
  31         <a class="newa" href="http://www.compbio.dundee.ac.uk/download">Download</a>
  32         <a class="newa" href="PublicAnnualStat" title="JABAWS server usage statistics">Usage Statistics</a>
  33         <a class="newa" href="ServiceStatus" title="JABAWS webservices status. Click to test all web services. Please be patient while the services are being checked">Services Status</a>
  34         <a class="newa" href="contacts.html">Contact Us</a>
  35         <a class="newa" href="http://www.compbio.dundee.ac.uk" title="University of Dundee, The Barton Group" >Barton Group</a>
  36         <a class="newa" href="jabaws_funding.html">Funding</a>
  37 </div>
  38 <!-- panel end-->
  39
  40
  41 <div id="content">
  42 <h2 id="headtitle">Getting Started</h2>
  43 <h3><a name="whichjaba" id="whichjaba"></a>Choose a JABAWS distribution</h3>
  44 <table id="choicematrix">
  45 <tr>
  46   <th>I want to use JABAWS for...</th>
  47   <th>Quick Guide</th>
  48 </tr>
  49 <tr>
  50   <td>Running Muptiple Sequence Alignments through Jalview on my <strong>own</strong> computer</td>
  51   <td><a href="manual_qs_va.html#qsc">JABAWS Virtual Appliance (VA)</a></td>
  52 </tr>
  53 <tr>
  54   <td>Running JABAWS on the <strong>cloud</strong>, for one or many users</td>
  55   <td><a href="manual_qs_amazon.html#qsc">JABAWS on the Amazon cloud </a></td>
  56 </tr>
  57 <tr>
  58   <td>Running JABAWS for my group, lab, or organization on the <strong>local</strong> infrastructure </td>
  59   <td><a href="manual_qs_war.html#qsc">JABAWS Web Application aRchive (WAR)</a></td>
  60 </tr>
  61 <tr>
  62   <td>Accessing a JABAWS server from my own code</td>
  63   <td><a href="manual_qs_client.html#qsc">JABAWS Java Client</a></td>
  64 </tr>
  65 </table>
  66
  67
  68 <a name="qsc"/>
  69 <h3>Installing A JABAWS Server Web Application Archive (WAR) package</h3>
  70 <p>
  71   This is for anyone who wants to run JABAWS for their group, lab or organization, or wants to enable
  72   their local JABA server to use the cluster or perform very large tasks.
  73 </p>
  74
  75 <ol>
  76         <li>Download the <a href="http://www.compbio.dundee.ac.uk/download">JABAWS WAR file</a></li>
  77         <li>Download and install <a href="http://tomcat.apache.org/download-70.cgi">Apache-Tomcat</a>.<br/>
  78                 <span class="hightlight">You will need at least Tomcat version 5.5 of  (we would recommend version 7.0) and at least Java 1.6 (i.e. JAVA 6).</span>
  79         </li>
  80         <li>Drop the JABAWS WAR file into <span class="hightlight">tomcat/webapps</span> directory.</li>
  81         <li>(Re)start the Tomcat.</li>
  82         <li>Once the tomcat has started, it should automatically unpack the WAR into the webapps directory (if it doesn't, then you'll need to do this manually, it's just a zip archive in the end).</li>
  83         <li> If you are on Mac or other unix-like architecture with GNU compilers available or you'd like to get a maximum performance <br/>
  84                 <span class="hightlight">cd</span> to <span class="hightlight">webapps/jabaws/binaries/src/</span>
  85                 and execute <span class="hightlight">./compilebin.sh</span> script to compile all binaries JABAWS depends on.
  86         </li>
  87 </ol>
  88
  89 <h3>Testing</h3>
  90 <p>You can test that your JABAWS server is working in several ways.</p>
  91 <ol>
  92 <li>Visit Services Status page available from the JABAWS main page using your web browser.</li>
  93
  94 <li>If you are working on the command line, then use the command line client shipped with the JABAWS war to test it by running:
  95   <span class="code">java -jar &lt;Path to tomcat WebApp directory&gt;/jabaws/WEB-INF/lib/jaba-client.jar -h=http://localhost:8080/jabaws</span>
  96   In this example we assumed that your JABAWS server URL is <span class="hightlight">http://localhost:8080</span> and JABAWS context path is <span class="hightlight">jabaws</span>
  97 </li>
  98 <li>Alternately, you can point Jalview at your new server:
  99 <ul>
 100   <li>Launch the desktop version of <a href="http://www.jalview.org/download.html">Jalview</a></li>
 101   <li>Open the Jalview desktop's preferences panel (from the Tools-&gt;Preferences menu option), select the <span class="hightlight">Webservices</span> panel and press the <span class="hightlight">New Service URL</span> button.</li>
 102   <li>Enter the URL for the tomcat server, including the context path for the JABAWS web app (e.g. http://localhost:8080/jabaws).</li>
 103 </ul>
 104 </li></ol>
 105
 106 <!--  TODO put JABAWS CMD test instructions here -->
 107 </div> <!-- content end-->
 108 <div id="copyright">Last update: 30 April 2014<br/>Sasha Sherstnev, Peter Troshin, Jim Procter and Geoff Barton, The Barton Group, University of Dundee, UK</div>
 109 </div><!-- wrapper end -->
 110
 111
 112 <!-- Google analitics -->
 113 <script type="text/javascript">
 114 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
 115 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
 116 </script>
 117 <script type="text/javascript">
 118 try{
 119 var pageTracker = _gat._getTracker("UA-5356328-1");
 120 pageTracker._trackPageview();
 121 } catch(err) {}
 122 </script>
 123 </div> <!-- page end -->
 124 </body>
 125 </html>