Skip to content

Commit 48753d6

Browse files
amjjbonvinVGPReys
andauthored
Update docker-install.md (#16)
* Update docker-install.md Added instructions to build the container from the latest version of HADDOCK3 * small upgrades --------- Co-authored-by: VGPReys <v.g.p.reys@uu.nl>
1 parent a86e87e commit 48753d6

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

src/docker-install.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,54 @@
11
# Using HADDOCK3 through its docker image
22

33
As part of the possible usage of HADDOCK3, we also provide a ready to use `docker` image of HADDOCK3, where tools and packages are already installed.
4+
Note that this image corresponds to the latest release of HADDOCK3, and not the latest version. To use the latest version in docker rather build it directly ([see below](#building-your-own-docker-container-from-the-latest-version-of-haddock3)).
45

56
## DOCKER
67

78
To be able to use a provided image, you first need to have `docker` installed.
89
Please follow the instructions you can find there: [https://www.docker.com/](https://www.docker.com/).
910

1011

11-
## Installing HADDOCK3 from provided image
12+
## Installing HADDOCK3 from provided images
13+
14+
### Installing the latest release
1215

1316
```bash
14-
# Install the latest haddock3 version
1517
docker pull ghcr.io/haddocking/haddock3:latest
1618
docker tag ghcr.io/haddocking/haddock3:latest haddock3
19+
```
20+
21+
### Install a specific version
22+
23+
To install a specific version of haddock3, you must specify which release you are interested in (e.g.: `2025.05.0`)
24+
25+
```bash
26+
docker run ghcr.io/haddocking/haddock3:2025.05.0
27+
docker tag ghcr.io/haddocking/haddock3:2025.05.0 haddock3
28+
```
29+
30+
Check [here](https://github.com/haddocking/haddock3/pkgs/container/haddock3/versions?filters%5Bversion_type%5D=tagged) to see the list of available releases.
1731

18-
## OR
32+
## Building your own docker container from the latest version of HADDOCK3
1933

20-
# Install a haddock3 specific version (e.g: 2024.12.0b7)
21-
docker run ghcr.io/haddocking/haddock3:2024.12.0b7
22-
docker tag ghcr.io/haddocking/haddock3:2024.12.0b7 haddock3
34+
With this approach, you will be building a new docker image from the latest version available in the main branch of the [haddock3 GitHub repository](https://github.com/haddocking/haddock3).
2335

24-
# Run HADDOCK with a workflow file, e.g. myworkflow.cfg
36+
```bash
37+
# Build a container from the latest haddock3 version
38+
git clone https://github.com/haddocking/haddock3.git
39+
cd haddock3
40+
docker build . --label haddock3 --tag haddock3
41+
```
42+
43+
## Run HADDOCK with a workflow file, e.g. myworkflow.cfg
44+
45+
```bash
2546
docker run \
2647
-v $(pwd):/cwd \
2748
--workdir /cwd \
2849
-u $(id -u) \
2950
haddock3 \
3051
myworkflow.cfg
31-
3252
```
53+
54+

0 commit comments

Comments
 (0)