Skip to content

Update docker-install.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 23, 2025
Merged

Update docker-install.md #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a560e76
Update docker-install.md
amjjbonvin Jul 23, 2025
73afabd
small upgrades
VGPReys Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 30 additions & 8 deletions src/docker-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,54 @@
# Using HADDOCK3 through its docker image

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.
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)).

## DOCKER

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


## Installing HADDOCK3 from provided image
## Installing HADDOCK3 from provided images

### Installing the latest release

```bash
# Install the latest haddock3 version
docker pull ghcr.io/haddocking/haddock3:latest
docker tag ghcr.io/haddocking/haddock3:latest haddock3
```

### Install a specific version

To install a specific version of haddock3, you must specify which release you are interested in (e.g.: `2025.05.0`)

```bash
docker run ghcr.io/haddocking/haddock3:2025.05.0
docker tag ghcr.io/haddocking/haddock3:2025.05.0 haddock3
```

Check [here](https://github.com/haddocking/haddock3/pkgs/container/haddock3/versions?filters%5Bversion_type%5D=tagged) to see the list of available releases.

## OR
## Building your own docker container from the latest version of HADDOCK3

# Install a haddock3 specific version (e.g: 2024.12.0b7)
docker run ghcr.io/haddocking/haddock3:2024.12.0b7
docker tag ghcr.io/haddocking/haddock3:2024.12.0b7 haddock3
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).

# Run HADDOCK with a workflow file, e.g. myworkflow.cfg
```bash
# Build a container from the latest haddock3 version
git clone https://github.com/haddocking/haddock3.git
cd haddock3
docker build . --label haddock3 --tag haddock3
```

## Run HADDOCK with a workflow file, e.g. myworkflow.cfg

```bash
docker run \
-v $(pwd):/cwd \
--workdir /cwd \
-u $(id -u) \
haddock3 \
myworkflow.cfg

```


Loading