Skip to content

Commit 0fa8e3a

Browse files
committed
using galaxy container
1 parent 361d63f commit 0fa8e3a

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

book/_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ parts:
1414
- file: how-to-guides/view-visualizations
1515
- file: how-to-guides/pipeline-resumption
1616
- file: how-to-guides/use-the-workshop-container
17+
- file: how-to-guides/use-the-galaxy-container
1718
- file: how-to-guides/get-involved
1819
- caption: Explanations
1920
chapters:
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
(galaxy-container)=
2+
# How to use the QIIME 2 galaxy container
3+
4+
The QIIME 2 galaxy docker container enables you to use QIIME 2 through the galaxy interface on your own hardware.
5+
6+
## This is copy pasted from the workshop container instructions. Wonder if we should dedup it somehow.
7+
8+
We recommend using either [Podman](https://podman.io) or [Docker](https://docker.com).
9+
Before you jump in with QIIME 2, follow the "Get Started" (i.e., install) instructions for one or the other on the project's website, and confirm that it's working according to the Podman's or Docker's instructions.
10+
(We don't link to their instructions here so that we don't send you to an outdated link.)
11+
12+
```{admonition} Podman versus Docker
13+
:class: dropdown, question
14+
We don't take much of a stance on whether Podman or Docker is a better tool for using QIIME 2 - teaching with either is still pretty new to us.
15+
16+
Podman seems to have some interesting benefits though, including ease of transition to paid cloud environments (via [Kubernetes](https://www.digitalocean.com/products/kubernetes)) if you need more computational resources than you have access to.
17+
Podman also doesn't require that you have root/admin access on the computer where you're using it, so may work better if you're using computer hardware that is administered by others (such as a laptop computer owned and maintained by your employer).
18+
19+
You can find a perspective on the differences between the two from the developers of Podman [here](https://www.redhat.com/en/topics/containers/what-is-podman#podman-vs-docker).
20+
```
21+
22+
(pull-image)=
23+
## Pulling and starting the container image
24+
25+
After downloading and learning to use your chosen program, run the following command in a terminal (if using `podman` simply swap `podman` in for `docker` in the command):
26+
27+
```shell
28+
docker run -d \
29+
-p 8080:80 \
30+
-p 8021:21 \
31+
-p 8020:20 \
32+
quay.io/qiime2/<distribution>-galaxy:<epoch>
33+
```
34+
35+
This will both pull and start the container.
36+
37+
(use-container)=
38+
## Using the container image
39+
40+
Open a web browser and navigate to localhost:8080. You will get a 502 page while galaxy is booting. Within a few minutes you should be able to refresh and see the galaxy page.

0 commit comments

Comments
 (0)