From 8784e41a1c8bf7f03d9d79fcc77e312967ee298a Mon Sep 17 00:00:00 2001
From: =?utf8?q?Fa=CC=81bio=20Madeira?=
Date: Mon, 26 Jun 2017 15:49:04 +0100
Subject: [PATCH] JWS-122 & JWS-116 New documentation entry with instructions
on how to use the JABAWS Docker image and new built html
pages.
---
docs/v_2_2_0/changelog.rst | 2 +
docs/v_2_2_0/docker.rst | 48 +++++
docs/v_2_2_0/getting_started.rst | 4 +
docs/v_2_2_0/index.rst | 1 +
website/docs/_sources/changelog.rst.txt | 2 +
website/docs/_sources/docker.rst.txt | 48 +++++
website/docs/_sources/getting_started.rst.txt | 4 +
website/docs/_sources/index.rst.txt | 1 +
website/docs/_static/basic.css | 2 +-
website/docs/_static/doctools.js | 2 +-
website/docs/_static/pygments.css | 4 +
website/docs/_static/searchtools.js | 2 +-
website/docs/_static/websupport.js | 2 +-
website/docs/advanced.html | 7 +-
website/docs/changelog.html | 2 +
website/docs/citations.html | 1 +
website/docs/client.html | 1 +
website/docs/develop.html | 1 +
website/docs/docker.html | 271 +++++++++++++++++++++++++
website/docs/genindex.html | 1 +
website/docs/getting_started.html | 2 +
website/docs/included_tools.html | 1 +
website/docs/index.html | 6 +
website/docs/jabaws_manual.pdf | Bin 464077 -> 469683 bytes
website/docs/objects.inv | Bin 1756 -> 1809 bytes
website/docs/search.html | 1 +
website/docs/searchindex.js | 2 +-
website/docs/stats.html | 5 +-
website/docs/va.html | 5 +-
website/docs/war.html | 1 +
30 files changed, 417 insertions(+), 12 deletions(-)
create mode 100644 docs/v_2_2_0/docker.rst
create mode 100644 website/docs/_sources/docker.rst.txt
create mode 100644 website/docs/docker.html
diff --git a/docs/v_2_2_0/changelog.rst b/docs/v_2_2_0/changelog.rst
index e24d5a6..cbd023a 100644
--- a/docs/v_2_2_0/changelog.rst
+++ b/docs/v_2_2_0/changelog.rst
@@ -13,6 +13,7 @@ The website and documentation were improved:
* Documentation was updated to reflect the latest changes introduced in the project.
* Usage Statistics are now cached and refreshed every hour for improved website loading times.
* Service Status are now similarly cached and monitored every 10 minutes.
+* We now provide a `Docker`_ image which allows for JABAWS to be run in Docker containers.
* Downloading the JABAWS distributions no longer require 'sign in' or 'sign up' to a user account.
* The pre-configured JABAWS Amazon Machine Image (AMI), which allowed for JABAWS to be run in the Amazon EC2 cloud, is no longer provided due to very limited use by the scientific community peers.
@@ -30,6 +31,7 @@ The versions of several application programs provided by JABAWS were bumped to t
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
.. _AACon: http://www.compbio.dundee.ac.uk/aacon/
+.. _Docker: https://www.docker.com/
------------
diff --git a/docs/v_2_2_0/docker.rst b/docs/v_2_2_0/docker.rst
new file mode 100644
index 0000000..66fd290
--- /dev/null
+++ b/docs/v_2_2_0/docker.rst
@@ -0,0 +1,48 @@
+Docker Container
+================
+
+An alternative to running the JABAWS Virtual Appliance (VA) or the JABAWS Web Application aRchive (WAR) in your local machine, is to use `Docker`_ to handle all the requirements to deploy JABAWS in Tomcat. We provide a `Dockerfile`_, which Docker uses to build an exact image of the required system, (i.e. Apache Tomcat server with the JABAWS WAR deployed).
+
+------------
+
+.. _docker_installing:
+
+Installing Docker
+-----------------
+
+In order to run JABAWS using `Docker`_, you need docker installed and running in your system. Installation instructions are provided in the `Docker documentation pages`_.
+
+------------
+
+.. _jabaws_docker:
+
+Running JABAWS with Docker
+--------------------------
+
+Once you have docker installed and running in your machine:
+
+.. code:: bash
+
+ docker build -t jabaws:2.2 http://www.compbio.dundee.ac.uk/jabaws22/archive/docker/Dockerfile
+
+This will download the required Docker contexts (Tomcat, etc.) and setup JABAWS. Once the setup is finished you can run the JABAWS container with:
+
+
+.. code:: bash
+
+ docker run --rm -it -p 8080:8080 jabaws:2.2
+
+This will launch Tomcat and deploy JABAWS. By accessing ``localhost:8080/jabaws/`` you can verify whether the JABAWS is running properly.
+You can then use your Docker JABAWS container to power your analysis using `Jalview`_ or the `JABAWS CLI`_.
+
+
+------------
+
+.. links
+.. _Docker: https://www.docker.com/
+.. _Docker documentation pages: https://docs.docker.com/engine/installation/
+.. _JABAWS Virtual Appliance (VA): va.html
+.. _JABAWS Web Application aRchive (WAR): war.html
+.. _Dockerfile: http://www.compbio.dundee.ac.uk/jabaws22/archive/docker/Dockerfile
+.. _Jalview: getting_started.html#jalview-and-the-jabaws-public-server
+.. _JABAWS CLI: getting_started.html#command-line-client-cli
diff --git a/docs/v_2_2_0/getting_started.rst b/docs/v_2_2_0/getting_started.rst
index b0d63b1..c857989 100644
--- a/docs/v_2_2_0/getting_started.rst
+++ b/docs/v_2_2_0/getting_started.rst
@@ -7,6 +7,8 @@ JABAWS consists of a server and a client, but unlike most bioinformatics web-ser
The public server based on JABAWS 2.1 at the `University of Dundee`_ has been in production since October 2013 and serviced over 442,000 jobs for users worldwide.
+**New:** You can now run JABAWS with `Docker`_. `Click here to learn more`_.
+
------------
.. _benefits:
@@ -163,3 +165,5 @@ Alternatively you can use Jalview to complete the testing.
.. _VMWare Player: http://www.vmware.com/products/player
.. _VMWare Fusion: http://www.vmware.com/products/fusion/overview.html
.. _VA documentation pages: va.html
+.. _Docker: https://www.docker.com/
+.. _Click here to learn more: docker.html
diff --git a/docs/v_2_2_0/index.rst b/docs/v_2_2_0/index.rst
index 3807d9a..e61ff9b 100644
--- a/docs/v_2_2_0/index.rst
+++ b/docs/v_2_2_0/index.rst
@@ -19,6 +19,7 @@ JABAWS documentation is also available in *pdf*. `Download it here`_!
client
war
va
+ docker
advanced
develop
stats
diff --git a/website/docs/_sources/changelog.rst.txt b/website/docs/_sources/changelog.rst.txt
index e24d5a6..cbd023a 100644
--- a/website/docs/_sources/changelog.rst.txt
+++ b/website/docs/_sources/changelog.rst.txt
@@ -13,6 +13,7 @@ The website and documentation were improved:
* Documentation was updated to reflect the latest changes introduced in the project.
* Usage Statistics are now cached and refreshed every hour for improved website loading times.
* Service Status are now similarly cached and monitored every 10 minutes.
+* We now provide a `Docker`_ image which allows for JABAWS to be run in Docker containers.
* Downloading the JABAWS distributions no longer require 'sign in' or 'sign up' to a user account.
* The pre-configured JABAWS Amazon Machine Image (AMI), which allowed for JABAWS to be run in the Amazon EC2 cloud, is no longer provided due to very limited use by the scientific community peers.
@@ -30,6 +31,7 @@ The versions of several application programs provided by JABAWS were bumped to t
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
.. _AACon: http://www.compbio.dundee.ac.uk/aacon/
+.. _Docker: https://www.docker.com/
------------
diff --git a/website/docs/_sources/docker.rst.txt b/website/docs/_sources/docker.rst.txt
new file mode 100644
index 0000000..66fd290
--- /dev/null
+++ b/website/docs/_sources/docker.rst.txt
@@ -0,0 +1,48 @@
+Docker Container
+================
+
+An alternative to running the JABAWS Virtual Appliance (VA) or the JABAWS Web Application aRchive (WAR) in your local machine, is to use `Docker`_ to handle all the requirements to deploy JABAWS in Tomcat. We provide a `Dockerfile`_, which Docker uses to build an exact image of the required system, (i.e. Apache Tomcat server with the JABAWS WAR deployed).
+
+------------
+
+.. _docker_installing:
+
+Installing Docker
+-----------------
+
+In order to run JABAWS using `Docker`_, you need docker installed and running in your system. Installation instructions are provided in the `Docker documentation pages`_.
+
+------------
+
+.. _jabaws_docker:
+
+Running JABAWS with Docker
+--------------------------
+
+Once you have docker installed and running in your machine:
+
+.. code:: bash
+
+ docker build -t jabaws:2.2 http://www.compbio.dundee.ac.uk/jabaws22/archive/docker/Dockerfile
+
+This will download the required Docker contexts (Tomcat, etc.) and setup JABAWS. Once the setup is finished you can run the JABAWS container with:
+
+
+.. code:: bash
+
+ docker run --rm -it -p 8080:8080 jabaws:2.2
+
+This will launch Tomcat and deploy JABAWS. By accessing ``localhost:8080/jabaws/`` you can verify whether the JABAWS is running properly.
+You can then use your Docker JABAWS container to power your analysis using `Jalview`_ or the `JABAWS CLI`_.
+
+
+------------
+
+.. links
+.. _Docker: https://www.docker.com/
+.. _Docker documentation pages: https://docs.docker.com/engine/installation/
+.. _JABAWS Virtual Appliance (VA): va.html
+.. _JABAWS Web Application aRchive (WAR): war.html
+.. _Dockerfile: http://www.compbio.dundee.ac.uk/jabaws22/archive/docker/Dockerfile
+.. _Jalview: getting_started.html#jalview-and-the-jabaws-public-server
+.. _JABAWS CLI: getting_started.html#command-line-client-cli
diff --git a/website/docs/_sources/getting_started.rst.txt b/website/docs/_sources/getting_started.rst.txt
index b0d63b1..c857989 100644
--- a/website/docs/_sources/getting_started.rst.txt
+++ b/website/docs/_sources/getting_started.rst.txt
@@ -7,6 +7,8 @@ JABAWS consists of a server and a client, but unlike most bioinformatics web-ser
The public server based on JABAWS 2.1 at the `University of Dundee`_ has been in production since October 2013 and serviced over 442,000 jobs for users worldwide.
+**New:** You can now run JABAWS with `Docker`_. `Click here to learn more`_.
+
------------
.. _benefits:
@@ -163,3 +165,5 @@ Alternatively you can use Jalview to complete the testing.
.. _VMWare Player: http://www.vmware.com/products/player
.. _VMWare Fusion: http://www.vmware.com/products/fusion/overview.html
.. _VA documentation pages: va.html
+.. _Docker: https://www.docker.com/
+.. _Click here to learn more: docker.html
diff --git a/website/docs/_sources/index.rst.txt b/website/docs/_sources/index.rst.txt
index 3807d9a..e61ff9b 100644
--- a/website/docs/_sources/index.rst.txt
+++ b/website/docs/_sources/index.rst.txt
@@ -19,6 +19,7 @@ JABAWS documentation is also available in *pdf*. `Download it here`_!
client
war
va
+ docker
advanced
develop
stats
diff --git a/website/docs/_static/basic.css b/website/docs/_static/basic.css
index 7ed0e58..dc88b5a 100644
--- a/website/docs/_static/basic.css
+++ b/website/docs/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/website/docs/_static/doctools.js b/website/docs/_static/doctools.js
index 8163495..5654977 100644
--- a/website/docs/_static/doctools.js
+++ b/website/docs/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/website/docs/_static/pygments.css b/website/docs/_static/pygments.css
index 8213e90..20c4814 100644
--- a/website/docs/_static/pygments.css
+++ b/website/docs/_static/pygments.css
@@ -47,8 +47,10 @@
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
+.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
+.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
@@ -59,7 +61,9 @@
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #06287e } /* Name.Function.Magic */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
+.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/website/docs/_static/searchtools.js b/website/docs/_static/searchtools.js
index bbfb3ac..c821573 100644
--- a/website/docs/_static/searchtools.js
+++ b/website/docs/_static/searchtools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/website/docs/_static/websupport.js b/website/docs/_static/websupport.js
index 98e7f40..53f6a45 100644
--- a/website/docs/_static/websupport.js
+++ b/website/docs/_static/websupport.js
@@ -4,7 +4,7 @@
*
* sphinx.websupport utilities for all documentation.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/website/docs/advanced.html b/website/docs/advanced.html
index 6966c9b..b11e77b 100644
--- a/website/docs/advanced.html
+++ b/website/docs/advanced.html
@@ -37,7 +37,7 @@
-
+
@@ -97,6 +97,7 @@
@@ -534,7 +535,7 @@ After you have completed the editing your configuration may look like this:
Help Pages
-
+
@@ -568,7 +569,7 @@ After you have completed the editing your configuration may look like this:
Next
- Previous
+ Previous
diff --git a/website/docs/changelog.html b/website/docs/changelog.html
index b4de96b..5f51ba8 100644
--- a/website/docs/changelog.html
+++ b/website/docs/changelog.html
@@ -96,6 +96,7 @@
Documentation was updated to reflect the latest changes introduced in the project.
Usage Statistics are now cached and refreshed every hour for improved website loading times.
Service Status are now similarly cached and monitored every 10 minutes.
+
We now provide a Docker image which allows for JABAWS to be run in Docker containers.
Downloading the JABAWS distributions no longer require ‘sign in’ or ‘sign up’ to a user account.
The pre-configured JABAWS Amazon Machine Image (AMI), which allowed for JABAWS to be run in the Amazon EC2 cloud, is no longer provided due to very limited use by the scientific community peers.
An alternative to running the JABAWS Virtual Appliance (VA) or the JABAWS Web Application aRchive (WAR) in your local machine, is to use Docker to handle all the requirements to deploy JABAWS in Tomcat. We provide a Dockerfile, which Docker uses to build an exact image of the required system, (i.e. Apache Tomcat server with the JABAWS WAR deployed).
In order to run JABAWS using Docker, you need docker installed and running in your system. Installation instructions are provided in the Docker documentation pages.
This will download the required Docker contexts (Tomcat, etc.) and setup JABAWS. Once the setup is finished you can run the JABAWS container with:
+
dockerrun--rm-it-p8080:8080jabaws:2.2
+
+
+
This will launch Tomcat and deploy JABAWS. By accessing localhost:8080/jabaws/ you can verify whether the JABAWS is running properly.
+You can then use your Docker JABAWS container to power your analysis using Jalview or the JABAWS CLI.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/website/docs/genindex.html b/website/docs/genindex.html
index a5513cc..e8eff2b 100644
--- a/website/docs/genindex.html
+++ b/website/docs/genindex.html
@@ -96,6 +96,7 @@
JABAWS is a collection of web services for bioinformatics, and currently provides services that make it easy to access well-known multiple sequence alignment and protein disorder prediction programs (see the list of currently supported programs). Future versions of JABAWS will incorporate other tools.
JABAWS consists of a server and a client, but unlike most bioinformatics web-service systems, you can download and run both parts on your own computer! If you want a server just for yourself, then download and install the JABAWS Virtual Appliance (VA). It requires no configuration and is simple to install. If you want to install JABAWS for your lab or institution then download the JABAWS Web Application aRchive (WAR). It is slightly more complicated to configure but is very straightforward too. Finally, if you want to script against any version of JABAWS or are interested in writing your own client, the JABAWS Command Line Interface (CLI) client is what you need.
The public server based on JABAWS 2.1 at the University of Dundee has been in production since October 2013 and serviced over 442,000 jobs for users worldwide.