66fd290599523eb03cb9bdbc33b056a70034f839
[jabaws.git] / website / docs / _sources / docker.rst.txt
1 Docker Container
2 ================
3
4 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).
5
6 ------------
7
8 .. _docker_installing:
9
10 Installing Docker
11 -----------------
12
13 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`_.
14
15 ------------
16
17 .. _jabaws_docker:
18
19 Running JABAWS with Docker
20 --------------------------
21
22 Once you have docker installed and running in your machine:
23
24 .. code:: bash
25
26       docker build -t jabaws:2.2 http://www.compbio.dundee.ac.uk/jabaws22/archive/docker/Dockerfile
27
28 This will download the required Docker contexts (Tomcat, etc.) and setup JABAWS. Once the setup is finished you can run the JABAWS container with:
29
30
31 .. code:: bash
32
33       docker run --rm -it -p 8080:8080 jabaws:2.2
34
35 This will launch Tomcat and deploy JABAWS. By accessing ``localhost:8080/jabaws/`` you can verify whether the JABAWS is running properly.
36 You can then use your Docker JABAWS container to power your analysis using `Jalview`_ or the `JABAWS CLI`_.
37
38
39 ------------
40
41 .. links
42 .. _Docker: https://www.docker.com/
43 .. _Docker documentation pages: https://docs.docker.com/engine/installation/
44 .. _JABAWS Virtual Appliance (VA): va.html
45 .. _JABAWS Web Application aRchive (WAR): war.html
46 .. _Dockerfile: http://www.compbio.dundee.ac.uk/jabaws22/archive/docker/Dockerfile
47 .. _Jalview: getting_started.html#jalview-and-the-jabaws-public-server
48 .. _JABAWS CLI: getting_started.html#command-line-client-cli