JWS-122 & JWS-116 New documentation entry with instructions on how to use the JABAWS...

[jabaws.git] / website / docs / _sources / docker.rst.txt

diff --git a/website/docs/_sources/docker.rst.txt b/website/docs/_sources/docker.rst.txt
new file mode 100644 (file)
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