website/docs/va.html

   1
   2
   3 <!DOCTYPE html>
   4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>Virtual Appliance (VA) &mdash; JABAWS 2.2 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29     <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  30
  31
  32
  33
  34
  35         <link rel="index" title="Index"
  36               href="genindex.html"/>
  37         <link rel="search" title="Search" href="search.html"/>
  38     <link rel="top" title="JABAWS 2.2 documentation" href="index.html"/>
  39         <link rel="next" title="Docker Container" href="docker.html"/>
  40         <link rel="prev" title="Web Application Archive (WAR)" href="war.html"/>
  41
  42
  43   <script src="_static/js/modernizr.min.js"></script>
  44
  45 </head>
  46
  47 <body class="wy-body-for-nav" role="document">
  48
  49
  50   <div class="wy-grid-for-nav">
  51
  52
  53     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  54       <div class="wy-side-scroll">
  55         <div class="wy-side-nav-search">
  56
  57
  58
  59             <a href="index.html" class="icon icon-home"> JABAWS
  60
  61
  62
  63           </a>
  64
  65
  66
  67
  68               <div class="version">
  69                 2.2
  70               </div>
  71
  72
  73
  74
  75 <div role="search">
  76   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  77     <input type="text" name="q" placeholder="Search docs" />
  78     <input type="hidden" name="check_keywords" value="yes" />
  79     <input type="hidden" name="area" value="default" />
  80   </form>
  81 </div>
  82
  83
  84         </div>
  85
  86         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  87
  88
  89
  90
  91
  92
  93               <p class="caption"><span class="caption-text">Contents:</span></p>
  94 <ul class="current">
  95 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
  96 <li class="toctree-l1"><a class="reference internal" href="included_tools.html">Included Tools</a></li>
  97 <li class="toctree-l1"><a class="reference internal" href="client.html">Command Line Client (CLI)</a></li>
  98 <li class="toctree-l1"><a class="reference internal" href="war.html">Web Application Archive (WAR)</a></li>
  99 <li class="toctree-l1 current"><a class="current reference internal" href="#">Virtual Appliance (VA)</a><ul>
 100 <li class="toctree-l2"><a class="reference internal" href="#installing">Installing</a></li>
 101 <li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
 102 <li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a><ul>
 103 <li class="toctree-l3"><a class="reference internal" href="#vm-configuration">VM configuration</a></li>
 104 <li class="toctree-l3"><a class="reference internal" href="#jabaws-configuration">JABAWS configuration</a></li>
 105 </ul>
 106 </li>
 107 </ul>
 108 </li>
 109 <li class="toctree-l1"><a class="reference internal" href="docker.html">Docker Container</a></li>
 110 <li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li>
 111 <li class="toctree-l1"><a class="reference internal" href="develop.html">For Developers</a></li>
 112 <li class="toctree-l1"><a class="reference internal" href="stats.html">Usage Statistics</a></li>
 113 <li class="toctree-l1"><a class="reference internal" href="citations.html">Citations</a></li>
 114 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
 115 </ul>
 116
 117
 118
 119         </div>
 120       </div>
 121     </nav>
 122
 123     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 124
 125
 126       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 127
 128           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 129           <a href="index.html">JABAWS</a>
 130
 131       </nav>
 132
 133
 134
 135       <div class="wy-nav-content">
 136         <div class="rst-content">
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153 <div role="navigation" aria-label="breadcrumbs navigation">
 154
 155   <ul class="wy-breadcrumbs">
 156
 157       <li><a href="index.html">Docs</a> &raquo;</li>
 158
 159       <li>Virtual Appliance (VA)</li>
 160
 161
 162       <li class="wy-breadcrumbs-aside">
 163
 164
 165             <!-- <a href="_sources/va.rst.txt" rel="nofollow"> View page source</a> -->
 166             <a href="../">Return to the JABAWS homepage</a>
 167
 168
 169       </li>
 170
 171   </ul>
 172
 173
 174   <hr/>
 175 </div>
 176           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 177            <div itemprop="articleBody">
 178
 179   <div class="section" id="virtual-appliance-va">
 180 <h1>Virtual Appliance (VA)<a class="headerlink" href="#virtual-appliance-va" title="Permalink to this headline">¶</a></h1>
 181 <p>The JABAWS Virtual Appliance is a way to run a JABAWS server locally, without the need to connect to the internet or configure JABAWS. What the appliance provides is a &#8216;virtual server machine&#8217; (or more simply - <em>virtual machine</em> or <em>VM</em>), running an installation of the JABAWS Web Application Archive (WAR) on <a class="reference external" href="https://www.turnkeylinux.org/tomcat">TurnKey Linux</a> 12.1 (Standlone Tomcat). 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.</p>
 182 <p>You can run the appliance with freely available program such as <a class="reference external" href="http://www.vmware.com/products/player">VMware Player</a>, but you will need to install it first. We have tested the JABAWS appliance with VMware Player v 3.1.2 on Windows and Linux, and VMware Fusion on Mac. However, you are not limited to these virtualization systems and can use the JABAWS Appliance with any other virtualization platform. You can use <a class="reference external" href="https://code.vmware.com/web/dp/tool/ovf/4.1.0">VMware OVF</a> tool to prepare JABAWS image for a different virtualization platform e.g. <a class="reference external" href="https://www.virtualbox.org/">VirtualBox</a>. <a class="reference external" href="https://www.virtualbox.org/">VirtualBox</a> can also use the <code class="docutils literal"><span class="pre">jabaws*.vmdk</span></code> directly as an <em>existing preconfigured virtual hard disk file</em>, when creating a new Linux 2.4 / 3.x / 4.x 64-bit VM.</p>
 183 <div class="admonition note">
 184 <p class="first admonition-title">Note</p>
 185 <p class="last">The appliance best suits users who would like to use the JABAWS web-services locally. This might be because they do not want to access systems over an internet, or just want to keep their data private. It is also 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>
 186 </div>
 187 <p>For servers that will be used heavily, we recommend that a JABAWS Server WAR distribution is deployed, rather than the Virtual Appliance version of JABAWS. This is because the JABAWS appliance is pre-configured to use only 1 CPU and 512M of memory (where the minimum amount of memory required for a JABAWS server is about 378M), which is unlikely to be sufficient for heavy computation. It is possible to reconfigure the virtual appliance so it uses more computation resources, 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>
 188 <hr class="docutils" />
 189 <div class="section" id="installing">
 190 <span id="va-installing"></span><h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h2>
 191 <div class="admonition tip">
 192 <p class="first admonition-title">Tip</p>
 193 <p class="last">Check if you are running the recommended version of VWMare.</p>
 194 </div>
 195 <p>The free <a class="reference external" href="http://www.vmware.com/products/player">VMware Player</a> can be used to run the JABAWS services from the Windows and Linux host operating systems. <a class="reference external" href="http://www.vmware.com/products/fusion/overview.html">VMware Fusion</a>, a commercial VMware product, offers virtual machine support for Mac.</p>
 196 <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 &#8220;Open Virtual Machine&#8221; and point the Player to the location of the JABAWS, then choose the <code class="docutils literal"><span class="pre">jabaws*.vmx</span></code> file to open an appliance.</p>
 197 <p>When you play the machine for the first time the Player might ask you whether &#8220;This virtual machine may have been moved or copied.&#8221;, say that you have copied it. That is all.</p>
 198 <hr class="docutils" />
 199 </div>
 200 <div class="section" id="usage">
 201 <span id="va-usage"></span><h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
 202 <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>
 203 <a class="reference internal image-reference" href="_images/VMware_cpu.png"><img alt="_images/VMware_cpu.png" class="align-left" src="_images/VMware_cpu.png" style="width: 672.6px; height: 253.64999999999998px;" /></a>
 204 <p>The VMware Player screen shot above displays JABAWS VM CPU settings.</p>
 205 <hr class="docutils" />
 206 </div>
 207 <div class="section" id="configuration">
 208 <span id="va-config"></span><h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
 209 <div class="section" id="vm-configuration">
 210 <span id="va-vm-config"></span><h3>VM configuration<a class="headerlink" href="#vm-configuration" title="Permalink to this headline">¶</a></h3>
 211 <p><strong>VMware info</strong></p>
 212 <ul class="simple">
 213 <li>CPUs : 1</li>
 214 <li>RAM : 512 MB</li>
 215 <li>Networking : Host only (the VM has no access to the outside network, nothing from the outside network can access the VM)</li>
 216 <li>Hard disk : 20 GB (expanding)</li>
 217 <li>VMware tools : Installed</li>
 218 </ul>
 219 <p><strong>OS information</strong></p>
 220 <ul class="simple">
 221 <li>OS : TurnKey Linux (v. 14.1, Standalone Tomcat) based on Debian GNU/Linux 8 (Jessie)</li>
 222 <li>Installation : Oracle Java 7, Tomcat 7, JABAWS v. 2.2</li>
 223 <li>IPv4 address : dhcp</li>
 224 <li>IPv6 address : auto</li>
 225 <li>DNS name : none</li>
 226 <li>Name server : dhcp</li>
 227 <li>Route : dhcp</li>
 228 <li>Keyboard : US_intl</li>
 229 </ul>
 230 <p><strong>Login credentials</strong></p>
 231 <ul class="simple">
 232 <li>Root password: JabawsAdmin1</li>
 233 <li>MySQL password: JabawsAdmin1</li>
 234 <li>Tomcat admin password: JabawsAdmin2</li>
 235 </ul>
 236 <p><strong>Services available at the virtial machine IP (e.g. VM_IP = 172.16.232.149)</strong></p>
 237 <ul class="simple">
 238 <li>Tomcat Web Server: <a class="reference external" href="http://VM_IP">http://VM_IP</a> (e.g. <a class="reference external" href="http://172.16.232.149">http://172.16.232.149</a>)</li>
 239 <li>Jabaws URL: <a class="reference external" href="http://VM_IP/jabaws">http://VM_IP/jabaws</a> (e.g. <a class="reference external" href="http://172.16.232.149/jabaws">http://172.16.232.149/jabaws</a>)</li>
 240 <li>Web Shell: <a class="reference external" href="https://VM_IP:12320/">https://VM_IP:12320/</a> (e.g. <a class="reference external" href="https://172.16.232.149:12320">https://172.16.232.149:12320</a>)</li>
 241 <li>Webmean: <a class="reference external" href="https://VM_IP:12321/">https://VM_IP:12321/</a> (e.g. <a class="reference external" href="https://172.16.232.149:12321">https://172.16.232.149:12321</a>)</li>
 242 <li>SSH/SFTP: <a class="reference external" href="mailto:root&#37;&#52;&#48;VM_IP">root<span>&#64;</span>VM_IP</a> (e.g. ssh <a class="reference external" href="mailto:root&#37;&#52;&#48;172&#46;16&#46;232&#46;149">root<span>&#64;</span>172<span>&#46;</span>16<span>&#46;</span>232<span>&#46;</span>149</a>)</li>
 243 </ul>
 244 <hr class="docutils" />
 245 </div>
 246 <div class="section" id="jabaws-configuration">
 247 <span id="va-jabaws-config"></span><h3>JABAWS configuration<a class="headerlink" href="#jabaws-configuration" title="Permalink to this headline">¶</a></h3>
 248 <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-&gt;Tools-&gt;Preferences-&gt;Web Services -&gt; New Service URL, and add JABAWS URL into the box provided. For more information please refer to <a class="reference external" href="http://www.jalview.org/help/html/webServices/JABAWS.html">Jalview help pages</a>.</p>
 249 <a class="reference internal image-reference" href="_images/vm_welcome_screen.png"><img alt="_images/vm_welcome_screen.png" class="align-left" src="_images/vm_welcome_screen.png" style="width: 697.3px; height: 437.95px;" /></a>
 250 <p>If you click on Advanced Menu, you will see the configuration console, similar to the one below.</p>
 251 <a class="reference internal image-reference" href="_images/VMware_booted.png"><img alt="_images/VMware_booted.png" class="align-left" src="_images/VMware_booted.png" style="width: 698.25px; height: 437.95px;" /></a>
 252 <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>
 253 </div>
 254 </div>
 255 </div>
 256
 257
 258            </div>
 259            <div class="articleComments">
 260
 261            </div>
 262           </div>
 263           <footer>
 264
 265     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 266
 267         <a href="docker.html" class="btn btn-neutral float-right" title="Docker Container" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 268
 269
 270         <a href="war.html" class="btn btn-neutral" title="Web Application Archive (WAR)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 271
 272     </div>
 273
 274
 275   <hr/>
 276
 277   <div role="contentinfo">
 278     <p><a href="../">JABAWS 2.2</a>
 279         &copy; Copyright 2017, Peter Troshin, Alexander Sherstnev, Jim Procter, Daniel Barton, Fábio Madeira, Alexey Drozdetskiy, Suzanne Duce and Geoff Barton.
 280
 281     </p>
 282   </div>
 283   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 284
 285 </footer>
 286         </div>
 287       </div>
 288
 289     </section>
 290
 291   </div>
 292
 293
 294
 295
 296
 297     <script type="text/javascript">
 298         var DOCUMENTATION_OPTIONS = {
 299             URL_ROOT:'./',
 300             VERSION:'2.2',
 301             LANGUAGE:'None',
 302             COLLAPSE_INDEX:false,
 303             FILE_SUFFIX:'.html',
 304             HAS_SOURCE:  true,
 305             SOURCELINK_SUFFIX: '.txt'
 306         };
 307     </script>
 308       <script type="text/javascript" src="_static/jquery.js"></script>
 309       <script type="text/javascript" src="_static/underscore.js"></script>
 310       <script type="text/javascript" src="_static/doctools.js"></script>
 311
 312
 313
 314
 315
 316     <script type="text/javascript" src="_static/js/theme.js"></script>
 317
 318
 319
 320
 321   <script type="text/javascript">
 322       jQuery(function () {
 323           SphinxRtdTheme.StickyNav.enable();
 324       });
 325   </script>
 326
 327
 328 </body>
 329 </html>